Improve wording of initdb and pg_controldata manual pages.

gabrielle <gorthx@gmail.com>
This commit is contained in:
Bruce Momjian 2011-03-09 09:18:44 -05:00
parent 48ff3913d6
commit 8cc55b1c0f
4 changed files with 26 additions and 24 deletions

View File

@ -22,9 +22,9 @@ PostgreSQL documentation
<refsynopsisdiv> <refsynopsisdiv>
<cmdsynopsis> <cmdsynopsis>
<command>initdb</command> <command>initdb</command>
<arg rep="repeat"><replaceable>option</></arg> <arg rep="repeat"><replaceable>option</replaceable></arg>
<group choice="plain"> <group choice="plain">
<arg>--pgdata </arg> <arg>--pgdata=</arg>
<arg>-D </arg> <arg>-D </arg>
<replaceable>directory</replaceable> <replaceable>directory</replaceable>
</group> </group>
@ -186,16 +186,14 @@ PostgreSQL documentation
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-X <replaceable class="parameter">directory</replaceable></option></term> <term><option>--pwfile=<replaceable>filename</></option></term>
<term><option>--xlogdir=<replaceable class="parameter">directory</replaceable></option></term>
<listitem> <listitem>
<para> <para>
This option specifies the directory where the transaction log Makes <command>initdb</command> read the database superuser's password
should be stored. from a file. The first line of the file is taken as the password.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-U <replaceable class="parameter">username</replaceable></option></term> <term><option>-U <replaceable class="parameter">username</replaceable></option></term>
<term><option>--username=<replaceable class="parameter">username</replaceable></option></term> <term><option>--username=<replaceable class="parameter">username</replaceable></option></term>
@ -226,14 +224,16 @@ PostgreSQL documentation
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--pwfile=<replaceable>filename</></option></term> <term><option>-X <replaceable class="parameter">directory</replaceable></option></term>
<term><option>--xlogdir=<replaceable class="parameter">directory</replaceable></option></term>
<listitem> <listitem>
<para> <para>
Makes <command>initdb</command> read the database superuser's password This option specifies the directory where the transaction log
from a file. The first line of the file is taken as the password. should be stored.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</para> </para>

View File

@ -22,6 +22,7 @@ PostgreSQL documentation
<refsynopsisdiv> <refsynopsisdiv>
<cmdsynopsis> <cmdsynopsis>
<command>pg_controldata</command> <command>pg_controldata</command>
<arg><replaceable class="parameter">option</replaceable></arg>
<arg><replaceable class="parameter">datadir</replaceable></arg> <arg><replaceable class="parameter">datadir</replaceable></arg>
</cmdsynopsis> </cmdsynopsis>
</refsynopsisdiv> </refsynopsisdiv>

View File

@ -499,22 +499,22 @@ PostgreSQL documentation
<title>Starting the Server</title> <title>Starting the Server</title>
<para> <para>
To start up a server: To start the server:
<screen> <screen>
<prompt>$</prompt> <userinput>pg_ctl start</userinput> <prompt>$</prompt> <userinput>pg_ctl start</userinput>
</screen> </screen>
</para> </para>
<para> <para>
An example of starting the server, and waiting until the server is To start the server, waiting until the server is
accepting connection: accepting connections:
<screen> <screen>
<prompt>$</prompt> <userinput>pg_ctl -w start</userinput> <prompt>$</prompt> <userinput>pg_ctl -w start</userinput>
</screen> </screen>
</para> </para>
<para> <para>
For a server using port 5433, and To start the server using port 5433, and
running without <function>fsync</function>, use: running without <function>fsync</function>, use:
<screen> <screen>
<prompt>$</prompt> <userinput>pg_ctl -o "-F -p 5433" start</userinput> <prompt>$</prompt> <userinput>pg_ctl -o "-F -p 5433" start</userinput>
@ -530,7 +530,10 @@ PostgreSQL documentation
<prompt>$</prompt> <userinput>pg_ctl stop</userinput> <prompt>$</prompt> <userinput>pg_ctl stop</userinput>
</screen> </screen>
The <option>-m</option> option allows control over The <option>-m</option> option allows control over
<emphasis>how</emphasis> the server shuts down. <emphasis>how</emphasis> the server shuts down:
<screen>
<prompt>$</prompt> <userinput>pg_ctl stop -m fast</userinput>
</screen>
</para> </para>
</refsect2> </refsect2>
@ -557,7 +560,7 @@ PostgreSQL documentation
</para> </para>
<para> <para>
To restart using port 5433 and disable <function>fsync</> upon restart: To restart using port 5433, disabling <function>fsync</> upon restart:
<screen> <screen>
<prompt>$</prompt> <userinput>pg_ctl -o "-F -p 5433" restart</userinput> <prompt>$</prompt> <userinput>pg_ctl -o "-F -p 5433" restart</userinput>
</screen> </screen>

View File

@ -66,9 +66,9 @@ PostgreSQL documentation
The <command>postgres</command> command can also be called in The <command>postgres</command> command can also be called in
single-user mode. The primary use for this mode is during single-user mode. The primary use for this mode is during
bootstrapping by <xref linkend="app-initdb">. Sometimes it is used bootstrapping by <xref linkend="app-initdb">. Sometimes it is used
for debugging or disaster recovery (but note that running a single-user for debugging or disaster recovery; note that running a single-user
server is not truly suitable for debugging the server, since no server is not truly suitable for debugging the server, since no
realistic interprocess communication and locking will happen). realistic interprocess communication and locking will happen.
When invoked in single-user When invoked in single-user
mode from the shell, the user can enter queries and the results mode from the shell, the user can enter queries and the results
will be printed to the screen, but in a form that is more useful will be printed to the screen, but in a form that is more useful
@ -413,8 +413,8 @@ PostgreSQL documentation
<term><option>-P</option></term> <term><option>-P</option></term>
<listitem> <listitem>
<para> <para>
Ignore system indexes when reading system tables (but still update Ignore system indexes when reading system tables, but still update
the indexes when modifying the tables). This is useful when the indexes when modifying the tables. This is useful when
recovering from damaged system indexes. recovering from damaged system indexes.
</para> </para>
</listitem> </listitem>
@ -763,13 +763,11 @@ PostgreSQL documentation
<para> <para>
To start <command>postgres</command> with a specific To start <command>postgres</command> with a specific
port: port, e.g. 1234:
<screen> <screen>
<prompt>$</prompt> <userinput>postgres -p 1234</userinput> <prompt>$</prompt> <userinput>postgres -p 1234</userinput>
</screen> </screen>
This command will start up <command>postgres</command> To connect to this server using <application>psql</>, specify this port with the -p option:
communicating through the port 1234. In order to connect to this
server using <application>psql</>, you would need to run it as
<screen> <screen>
<prompt>$</prompt> <userinput>psql -p 1234</userinput> <prompt>$</prompt> <userinput>psql -p 1234</userinput>
</screen> </screen>