database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-07-30 11:03:19 +03:00
Code Activity

Reorder pg_ctl promote after pg_ctl status

Browse Source 
Since start/stop/restart/reload/status is a kind of standard command
set, it seems odd to insert the special-purpose "promote" in between
the closely related "restart" and "reload".  So put it after "status"
in code and documentation.

Put the documentation of the -U option in some sensible place.

Rewrite the synopsis sentence in help and documentation to make it
less of a growing mouthful.
This commit is contained in:
Peter Eisentraut
2011-06-08 20:51:25 +03:00
parent b7e8feb33e
commit 1bcdd66315
2 changed files with 71 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
doc/src/sgml/ref/pg_ctl-ref.sgml
View File

@ -12,7 +12,7 @@ PostgreSQL documentation
<refnamediv>
<refname>pg_ctl</refname>
<refpurpose>initialize, start, stop, or restart a <productname>PostgreSQL</productname> server</refpurpose>
<refpurpose>initialize, start, stop, or control a <productname>PostgreSQL</productname> server</refpurpose>
</refnamediv>
<indexterm zone="app-pg-ctl">
@ -75,13 +75,6 @@ PostgreSQL documentation
<arg>-o <replaceable>options</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>pg_ctl</command>
<arg choice="plain">promote</arg>
<arg>-s</arg>
<arg>-D <replaceable>datadir</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>pg_ctl</command>
<arg choice="plain">reload</arg>
@ -95,6 +88,13 @@ PostgreSQL documentation
<arg>-D <replaceable>datadir</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>pg_ctl</command>
<arg choice="plain">promote</arg>
<arg>-s</arg>
<arg>-D <replaceable>datadir</replaceable></arg>
</cmdsynopsis>
<cmdsynopsis>
<command>pg_ctl</command>
<arg choice="plain">kill</arg>
@ -190,12 +190,6 @@ PostgreSQL documentation
command-line options.
</para>
<para>
In <option>promote</option> mode, the standby server that is
running in the specified data directory is commanded to exit
recovery and begin read-write operations.
</para>
<para>
<option>reload</option> mode simply sends the
<command>postgres</command> process a <systemitem>SIGHUP</>
@ -213,6 +207,12 @@ PostgreSQL documentation
displayed.
</para>
<para>
In <option>promote</option> mode, the standby server that is
running in the specified data directory is commanded to exit
recovery and begin read-write operations.
</para>
<para>
<option>kill</option> mode allows you to send a signal to a specified
process. This is particularly valuable for <productname>Microsoft Windows</>
@ -396,16 +396,6 @@ PostgreSQL documentation
</listitem>
</varlistentry>
<varlistentry>
<term><option>-U <replaceable class="parameter">username</replaceable></option></term>
<listitem>
<para>
User name for the user to start the service. For domain users, use the
format <literal>DOMAIN\username</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-P <replaceable class="parameter">password</replaceable></option></term>
<listitem>
@ -426,6 +416,16 @@ PostgreSQL documentation
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-U <replaceable class="parameter">username</replaceable></option></term>
<listitem>
<para>
User name for the user to start the service. For domain users, use the
format <literal>DOMAIN\username</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>