Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit8cc55b1

Browse files
committed
Improve wording of initdb and pg_controldata manual pages.
gabrielle <gorthx@gmail.com>
1 parent48ff391 commit8cc55b1

File tree

4 files changed

+26
-24
lines changed

4 files changed

+26
-24
lines changed

‎doc/src/sgml/ref/initdb.sgml

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,9 @@ PostgreSQL documentation
2222
<refsynopsisdiv>
2323
<cmdsynopsis>
2424
<command>initdb</command>
25-
<arg rep="repeat"><replaceable>option</></arg>
25+
<arg rep="repeat"><replaceable>option</replaceable></arg>
2626
<group choice="plain">
27-
<arg>--pgdata</arg>
27+
<arg>--pgdata=</arg>
2828
<arg>-D </arg>
2929
<replaceable>directory</replaceable>
3030
</group>
@@ -186,16 +186,14 @@ PostgreSQL documentation
186186
</varlistentry>
187187

188188
<varlistentry>
189-
<term><option>-X <replaceable class="parameter">directory</replaceable></option></term>
190-
<term><option>--xlogdir=<replaceable class="parameter">directory</replaceable></option></term>
189+
<term><option>--pwfile=<replaceable>filename</></option></term>
191190
<listitem>
192191
<para>
193-
This option specifies thedirectory where the transaction log
194-
should be stored.
192+
Makes <command>initdb</command> read thedatabase superuser's password
193+
from a file. The first line of the file is taken as the password.
195194
</para>
196195
</listitem>
197196
</varlistentry>
198-
199197
<varlistentry>
200198
<term><option>-U <replaceable class="parameter">username</replaceable></option></term>
201199
<term><option>--username=<replaceable class="parameter">username</replaceable></option></term>
@@ -226,14 +224,16 @@ PostgreSQL documentation
226224
</varlistentry>
227225

228226
<varlistentry>
229-
<term><option>--pwfile=<replaceable>filename</></option></term>
227+
<term><option>-X <replaceable class="parameter">directory</replaceable></option></term>
228+
<term><option>--xlogdir=<replaceable class="parameter">directory</replaceable></option></term>
230229
<listitem>
231230
<para>
232-
Makes <command>initdb</command> read thedatabase superuser's password
233-
from a file. The first line of the file is taken as the password.
231+
This option specifies thedirectory where the transaction log
232+
should be stored.
234233
</para>
235234
</listitem>
236235
</varlistentry>
236+
237237
</variablelist>
238238
</para>
239239

‎doc/src/sgml/ref/pg_controldata.sgml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ PostgreSQL documentation
2222
<refsynopsisdiv>
2323
<cmdsynopsis>
2424
<command>pg_controldata</command>
25+
<arg><replaceable class="parameter">option</replaceable></arg>
2526
<arg><replaceable class="parameter">datadir</replaceable></arg>
2627
</cmdsynopsis>
2728
</refsynopsisdiv>

‎doc/src/sgml/ref/pg_ctl-ref.sgml

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -499,22 +499,22 @@ PostgreSQL documentation
499499
<title>Starting the Server</title>
500500

501501
<para>
502-
To startup a server:
502+
To startthe server:
503503
<screen>
504504
<prompt>$</prompt> <userinput>pg_ctl start</userinput>
505505
</screen>
506506
</para>
507507

508508
<para>
509-
An example of startingthe server, and waiting until the server is
510-
acceptingconnection:
509+
To startthe server, waiting until the server is
510+
acceptingconnections:
511511
<screen>
512512
<prompt>$</prompt> <userinput>pg_ctl -w start</userinput>
513513
</screen>
514514
</para>
515515

516516
<para>
517-
For a server using port 5433, and
517+
To start the server using port 5433, and
518518
running without <function>fsync</function>, use:
519519
<screen>
520520
<prompt>$</prompt> <userinput>pg_ctl -o "-F -p 5433" start</userinput>
@@ -530,7 +530,10 @@ PostgreSQL documentation
530530
<prompt>$</prompt> <userinput>pg_ctl stop</userinput>
531531
</screen>
532532
The <option>-m</option> option allows control over
533-
<emphasis>how</emphasis> the server shuts down.
533+
<emphasis>how</emphasis> the server shuts down:
534+
<screen>
535+
<prompt>$</prompt> <userinput>pg_ctl stop -m fast</userinput>
536+
</screen>
534537
</para>
535538
</refsect2>
536539

@@ -557,7 +560,7 @@ PostgreSQL documentation
557560
</para>
558561

559562
<para>
560-
To restart using port 5433 and disable <function>fsync</> upon restart:
563+
To restart using port 5433, disabling <function>fsync</> upon restart:
561564
<screen>
562565
<prompt>$</prompt> <userinput>pg_ctl -o "-F -p 5433" restart</userinput>
563566
</screen>

‎doc/src/sgml/ref/postgres-ref.sgml

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,9 @@ PostgreSQL documentation
6666
The <command>postgres</command> command can also be called in
6767
single-user mode. The primary use for this mode is during
6868
bootstrapping by <xref linkend="app-initdb">. Sometimes it is used
69-
for debugging or disaster recovery (but note that running a single-user
69+
for debugging or disaster recovery; note that running a single-user
7070
server is not truly suitable for debugging the server, since no
71-
realistic interprocess communication and locking will happen).
71+
realistic interprocess communication and locking will happen.
7272
When invoked in single-user
7373
mode from the shell, the user can enter queries and the results
7474
will be printed to the screen, but in a form that is more useful
@@ -413,8 +413,8 @@ PostgreSQL documentation
413413
<term><option>-P</option></term>
414414
<listitem>
415415
<para>
416-
Ignore system indexes when reading system tables (but still update
417-
the indexes when modifying the tables). This is useful when
416+
Ignore system indexes when reading system tables,but still update
417+
the indexes when modifying the tables. This is useful when
418418
recovering from damaged system indexes.
419419
</para>
420420
</listitem>
@@ -763,13 +763,11 @@ PostgreSQL documentation
763763

764764
<para>
765765
To start <command>postgres</command> with a specific
766-
port:
766+
port, e.g. 1234:
767767
<screen>
768768
<prompt>$</prompt> <userinput>postgres -p 1234</userinput>
769769
</screen>
770-
This command will start up <command>postgres</command>
771-
communicating through the port 1234. In order to connect to this
772-
server using <application>psql</>, you would need to run it as
770+
To connect to this server using <application>psql</>, specify this port with the -p option:
773771
<screen>
774772
<prompt>$</prompt> <userinput>psql -p 1234</userinput>
775773
</screen>

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp