database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-06-25 01:02:05 +03:00
Code Activity

Make documentation of --help and --version options more consistent

Browse Source 
Before, some places didn't document the short options (-? and -V),
some documented both, some documented nothing, and they were listed in
various orders.  Now this is hopefully more consistent and complete.
This commit is contained in:
Peter Eisentraut
2012-06-18 02:44:00 +03:00
parent 3cdd19b0a6
commit 03132da3b6
45 changed files with 348 additions and 139 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
doc/src/sgml/oid2name.sgml
View File

@ -97,12 +97,33 @@
<listitem><para>show info for table(s) matching <replaceable>tablename_pattern</></para></listitem>
</varlistentry>
<varlistentry>
<term><option>-V</></term>
<term><option>--version</></term>
<listitem>
<para>
Print the <application>oid2name</application> version and exit.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-x</option></term>
<listitem><para>display more information about each object shown: tablespace name,
schema name, and OID
</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-?</></term>
<term><option>--help</></term>
<listitem>
<para>
Show help about <application>oid2name</application> command line
arguments, and exit.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>

20
doc/src/sgml/pgarchivecleanup.sgml
View File

@ -106,6 +106,16 @@ pg_archivecleanup: removing file "archive/00000001000000370000000E"
</listitem>
</varlistentry>
<varlistentry>
<term><option>-V</></term>
<term><option>--version</></term>
<listitem>
<para>
Print the <application>pg_archivecleanup</application> version and exit.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-x</option> <replaceable>extension</></term>
<listitem>
@ -126,6 +136,16 @@ pg_archivecleanup: removing file "archive/00000001000000370000000E"
</listitem>
</varlistentry>
<varlistentry>
<term><option>-?</></term>
<term><option>--help</></term>
<listitem>
<para>
Show help about <application>pg_archivecleanup</application> command line
arguments, and exit.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>

20
doc/src/sgml/pgbench.sgml
View File

@ -453,6 +453,26 @@ pgbench <optional> <replaceable>options</> </optional> <replaceable>dbname</>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-V</></term>
<term><option>--version</></term>
<listitem>
<para>
Print the <application>pgbench</application> version and exit.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-?</></term>
<term><option>--help</></term>
<listitem>
<para>
Show help about <application>pgbench</application> command line
arguments, and exit.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>

20
doc/src/sgml/pgstandby.sgml
View File

@ -198,6 +198,16 @@ restore_command = 'pg_standby <replaceable>archiveDir</> %f %p %r'
</listitem>
</varlistentry>
<varlistentry>
<term><option>-V</></term>
<term><option>--version</></term>
<listitem>
<para>
Print the <application>pg_standby</application> version and exit.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-w</option> <replaceable>maxwaittime</></term>
<listitem>
@ -211,6 +221,16 @@ restore_command = 'pg_standby <replaceable>archiveDir</> %f %p %r'
</listitem>
</varlistentry>
<varlistentry>
<term><option>-?</></term>
<term><option>--help</></term>
<listitem>
<para>
Show help about <application>pg_standby</application> command line
arguments, and exit.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>

20
doc/src/sgml/pgtestfsync.sgml
View File

@ -75,6 +75,26 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>-V</></term>
<term><option>--version</></term>
<listitem>
<para>
Print the <application>pg_test_fsync</application> version and exit.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-?</></term>
<term><option>--help</></term>
<listitem>
<para>
Show help about <application>pg_test_fsync</application> command line
arguments, and exit.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>

21
doc/src/sgml/pgtesttiming.sgml
View File

@ -56,6 +56,27 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>-V</></term>
<term><option>--version</></term>
<listitem>
<para>
Print the <application>pg_test_timing</application> version and exit.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-?</></term>
<term><option>--help</></term>
<listitem>
<para>
Show help about <application>pg_test_timing</application> command line
arguments, and exit.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>

32
doc/src/sgml/ref/createuser.sgml
View File

@ -256,13 +256,23 @@ PostgreSQL documentation
</listitem>
</varlistentry>
<varlistentry>
<term><option>-V</></term>
<term><option>--version</></term>
<listitem>
<para>
Print the <application>createuser</application> version and exit.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--replication</></term>
<listitem>
<para>
The new user will have the REPLICATION privilege, which is
described more fully in the documentation for
<xref linkend="sql-createrole">.
The new user will have the <literal>REPLICATION</literal> privilege,
which is described more fully in the documentation for <xref
linkend="sql-createrole">.
</para>
</listitem>
</varlistentry>
@ -271,23 +281,13 @@ PostgreSQL documentation
<term><option>--no-replication</></term>
<listitem>
<para>
The new user will not have the REPLICATION privilege, which is
described more fully in the documentation for
<xref linkend="sql-createrole">.
The new user will not have the <literal>REPLICATION</literal>
privilege, which is described more fully in the documentation for <xref
linkend="sql-createrole">.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-V</></term>
<term><option>--version</></term>
<listitem>
<para>
Print the <application>createuser</application> version and exit.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-?</></term>
<term><option>--help</></term>

20
doc/src/sgml/ref/dropdb.sgml
View File

@ -86,16 +86,6 @@ PostgreSQL documentation
</listitem>
</varlistentry>
<varlistentry>
<term><option>--if-exists</></term>
<listitem>
<para>
Do not throw an error if the database does not exist. A notice is issued
in this case.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-V</></term>
<term><option>--version</></term>
@ -106,6 +96,16 @@ PostgreSQL documentation
</listitem>
</varlistentry>
<varlistentry>
<term><option>--if-exists</></term>
<listitem>
<para>
Do not throw an error if the database does not exist. A notice is issued
in this case.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-?</></term>
<term><option>--help</></term>

20
doc/src/sgml/ref/dropuser.sgml
View File

@ -91,16 +91,6 @@ PostgreSQL documentation
</listitem>
</varlistentry>
<varlistentry>
<term><option>--if-exists</></term>
<listitem>
<para>
Do not throw an error if the user does not exist. A notice is
issued in this case.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-V</></term>
<term><option>--version</></term>
@ -111,6 +101,16 @@ PostgreSQL documentation
</listitem>
</varlistentry>
<varlistentry>
<term><option>--if-exists</></term>
<listitem>
<para>
Do not throw an error if the user does not exist. A notice is
issued in this case.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-?</></term>
<term><option>--help</></term>

1
doc/src/sgml/ref/ecpg-ref.sgml
View File

@ -202,6 +202,7 @@ PostgreSQL documentation
</varlistentry>
<varlistentry>
<term><option>-?</option></term>
<term><option>--help</option></term>
<listitem>
<para>

6
doc/src/sgml/ref/initdb.sgml
View File

@ -326,7 +326,13 @@ PostgreSQL documentation
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
Other options:
<variablelist>
<varlistentry>
<term><option>-V</></term>
<term><option>--version</></term>

2
doc/src/sgml/ref/pg_basebackup.sgml
View File

@ -431,7 +431,7 @@ PostgreSQL documentation
</para>
<para>
Other, less commonly used, options are also available:
Other options are also available:
<variablelist>
<varlistentry>

11
doc/src/sgml/ref/pg_config-ref.sgml
View File

@ -273,6 +273,17 @@
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-?</></term>
<term><option>--help</></term>
<listitem>
<para>
Show help about <application>pg_config</application> command line
arguments, and exit.
</para>
</listitem>
</varlistentry>
</variablelist>
If more than one option is given, the information is printed in that order,

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

@ -363,6 +363,16 @@ PostgreSQL documentation
</listitem>
</varlistentry>
<varlistentry>
<term><option>-V</></term>
<term><option>--version</></term>
<listitem>
<para>
Print the <application>pg_ctl</application> version and exit.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-w</option></term>
<listitem>
@ -388,6 +398,17 @@ PostgreSQL documentation
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-?</></term>
<term><option>--help</></term>
<listitem>
<para>
Show help about <application>pg_ctl</application> command line
arguments, and exit.
</para>
</listitem>
</varlistentry>
</variablelist>
<refsect2 id="app-pg-ctl-windows-options">

2
doc/src/sgml/ref/pg_receivexlog.sgml
View File

@ -211,7 +211,7 @@ PostgreSQL documentation
</para>
<para>
Other, less commonly used, options are also available:
Other options are also available:
<variablelist>
<varlistentry>

21
doc/src/sgml/ref/postgres-ref.sgml
View File

@ -345,6 +345,16 @@ PostgreSQL documentation
</listitem>
</varlistentry>
<varlistentry>
<term><option>-V</></term>
<term><option>--version</></term>
<listitem>
<para>
Print the <application>postgres</application> version and exit.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>--<replaceable>name</replaceable>=<replaceable>value</replaceable></option></term>
<listitem>
@ -365,6 +375,17 @@ PostgreSQL documentation
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-?</></term>
<term><option>--help</></term>
<listitem>
<para>
Show help about <application>postgres</application> command line
arguments, and exit.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>

60
doc/src/sgml/vacuumlo.sgml
View File

@ -50,14 +50,10 @@
<refsect1>
<title>Options</title>
<variablelist>
<varlistentry>
<term><option>-h</option> <replaceable>hostname</></term>
<listitem>
<para>Database server's host.</para>
</listitem>
</varlistentry>
<para>
<application>vacuumlo</application> accepts the following command-line arguments:
<variablelist>
<varlistentry>
<term><option>-l</option> <replaceable>limit</></term>
<listitem>
@ -78,6 +74,48 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option></term>
<listitem>
<para>Write a lot of progress messages.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-V</></term>
<term><option>--version</></term>
<listitem>
<para>
Print the <application>vacuumlo</application> version and exit.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-?</></term>
<term><option>--help</></term>
<listitem>
<para>
Show help about <application>vacuumlo</application> command line
arguments, and exit.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
<para>
<application>vacuumlo</application> also accepts the following command-line
arguments for connection parameters:
<variablelist>
<varlistentry>
<term><option>-h</option> <replaceable>hostname</></term>
<listitem>
<para>Database server's host.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-p</option> <replaceable>port</></term>
<listitem>
@ -92,13 +130,6 @@
</listitem>
</varlistentry>
<varlistentry>
<term><option>-v</option></term>
<listitem>
<para>Write a lot of progress messages.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-w</></term>
<term><option>--no-password</></term>
@ -133,6 +164,7 @@
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1>