diff options
author | Peter Eisentraut | 2012-06-17 23:44:00 +0000 |
---|---|---|
committer | Peter Eisentraut | 2012-06-17 23:46:59 +0000 |
commit | bb7520cc26dcd392e3dce294b685b3a0d6dae9e9 (patch) | |
tree | de211eec457521ff44e438075d8d1e600e989f04 /doc/src | |
parent | 9e18eacbdff2ae2abd5ff38eee725e6399e39b41 (diff) |
Make documentation of --help and --version options more consistent
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.
Diffstat (limited to 'doc/src')
-rw-r--r-- | doc/src/sgml/oid2name.sgml | 21 | ||||
-rw-r--r-- | doc/src/sgml/pgarchivecleanup.sgml | 20 | ||||
-rw-r--r-- | doc/src/sgml/pgbench.sgml | 20 | ||||
-rw-r--r-- | doc/src/sgml/pgstandby.sgml | 20 | ||||
-rw-r--r-- | doc/src/sgml/pgtestfsync.sgml | 20 | ||||
-rw-r--r-- | doc/src/sgml/pgtesttiming.sgml | 21 | ||||
-rw-r--r-- | doc/src/sgml/ref/createuser.sgml | 30 | ||||
-rw-r--r-- | doc/src/sgml/ref/dropdb.sgml | 20 | ||||
-rw-r--r-- | doc/src/sgml/ref/dropuser.sgml | 20 | ||||
-rw-r--r-- | doc/src/sgml/ref/ecpg-ref.sgml | 1 | ||||
-rw-r--r-- | doc/src/sgml/ref/initdb.sgml | 6 | ||||
-rw-r--r-- | doc/src/sgml/ref/pg_basebackup.sgml | 2 | ||||
-rw-r--r-- | doc/src/sgml/ref/pg_config-ref.sgml | 11 | ||||
-rw-r--r-- | doc/src/sgml/ref/pg_ctl-ref.sgml | 21 | ||||
-rw-r--r-- | doc/src/sgml/ref/pg_receivexlog.sgml | 2 | ||||
-rw-r--r-- | doc/src/sgml/ref/postgres-ref.sgml | 21 | ||||
-rw-r--r-- | doc/src/sgml/vacuumlo.sgml | 58 |
17 files changed, 264 insertions, 50 deletions
diff --git a/doc/src/sgml/oid2name.sgml b/doc/src/sgml/oid2name.sgml index 30e8bb1972c..5e39677496b 100644 --- a/doc/src/sgml/oid2name.sgml +++ b/doc/src/sgml/oid2name.sgml @@ -98,11 +98,32 @@ </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> diff --git a/doc/src/sgml/pgarchivecleanup.sgml b/doc/src/sgml/pgarchivecleanup.sgml index 44e8bbdfc24..932914bc2f8 100644 --- a/doc/src/sgml/pgarchivecleanup.sgml +++ b/doc/src/sgml/pgarchivecleanup.sgml @@ -107,6 +107,16 @@ pg_archivecleanup: removing file "archive/00000001000000370000000E" </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> <para> @@ -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> diff --git a/doc/src/sgml/pgbench.sgml b/doc/src/sgml/pgbench.sgml index 1b0905fa271..4a80b46416d 100644 --- a/doc/src/sgml/pgbench.sgml +++ b/doc/src/sgml/pgbench.sgml @@ -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> diff --git a/doc/src/sgml/pgstandby.sgml b/doc/src/sgml/pgstandby.sgml index 0fe3f646bc0..ca2b5c078dc 100644 --- a/doc/src/sgml/pgstandby.sgml +++ b/doc/src/sgml/pgstandby.sgml @@ -199,6 +199,16 @@ restore_command = 'pg_standby <replaceable>archiveDir</> %f %p %r' </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> <para> @@ -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> diff --git a/doc/src/sgml/pgtestfsync.sgml b/doc/src/sgml/pgtestfsync.sgml index d8c0c458088..95ba3b81e0c 100644 --- a/doc/src/sgml/pgtestfsync.sgml +++ b/doc/src/sgml/pgtestfsync.sgml @@ -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> diff --git a/doc/src/sgml/pgtesttiming.sgml b/doc/src/sgml/pgtesttiming.sgml index 486be831237..f74d63e6883 100644 --- a/doc/src/sgml/pgtesttiming.sgml +++ b/doc/src/sgml/pgtesttiming.sgml @@ -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> diff --git a/doc/src/sgml/ref/createuser.sgml b/doc/src/sgml/ref/createuser.sgml index dedc97f2233..2f1ea2fb73b 100644 --- a/doc/src/sgml/ref/createuser.sgml +++ b/doc/src/sgml/ref/createuser.sgml @@ -257,35 +257,35 @@ PostgreSQL documentation </varlistentry> <varlistentry> - <term><option>--replication</></term> - <listitem> + <term><option>-V</></term> + <term><option>--version</></term> + <listitem> <para> - The new user will have the REPLICATION privilege, which is - described more fully in the documentation for - <xref linkend="sql-createrole">. + Print the <application>createuser</application> version and exit. </para> - </listitem> + </listitem> </varlistentry> <varlistentry> - <term><option>--no-replication</></term> + <term><option>--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 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> + <term><option>--no-replication</></term> + <listitem> <para> - Print the <application>createuser</application> version and exit. + 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> + </listitem> </varlistentry> <varlistentry> diff --git a/doc/src/sgml/ref/dropdb.sgml b/doc/src/sgml/ref/dropdb.sgml index ba781cce52b..4593604f3bc 100644 --- a/doc/src/sgml/ref/dropdb.sgml +++ b/doc/src/sgml/ref/dropdb.sgml @@ -87,16 +87,6 @@ PostgreSQL documentation </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> <listitem> @@ -107,6 +97,16 @@ PostgreSQL documentation </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> <listitem> diff --git a/doc/src/sgml/ref/dropuser.sgml b/doc/src/sgml/ref/dropuser.sgml index 891bbd60371..180fb0bb62e 100644 --- a/doc/src/sgml/ref/dropuser.sgml +++ b/doc/src/sgml/ref/dropuser.sgml @@ -92,16 +92,6 @@ PostgreSQL documentation </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> <listitem> @@ -112,6 +102,16 @@ PostgreSQL documentation </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> <listitem> diff --git a/doc/src/sgml/ref/ecpg-ref.sgml b/doc/src/sgml/ref/ecpg-ref.sgml index 9c13e93a271..edd20dcdd55 100644 --- a/doc/src/sgml/ref/ecpg-ref.sgml +++ b/doc/src/sgml/ref/ecpg-ref.sgml @@ -202,6 +202,7 @@ PostgreSQL documentation </varlistentry> <varlistentry> + <term><option>-?</option></term> <term><option>--help</option></term> <listitem> <para> diff --git a/doc/src/sgml/ref/initdb.sgml b/doc/src/sgml/ref/initdb.sgml index b2e94e83d8e..11484468ddd 100644 --- a/doc/src/sgml/ref/initdb.sgml +++ b/doc/src/sgml/ref/initdb.sgml @@ -326,7 +326,13 @@ PostgreSQL documentation </para> </listitem> </varlistentry> + </variablelist> + </para> + <para> + Other options: + + <variablelist> <varlistentry> <term><option>-V</></term> <term><option>--version</></term> diff --git a/doc/src/sgml/ref/pg_basebackup.sgml b/doc/src/sgml/ref/pg_basebackup.sgml index d03bedd12a9..ebd6e1e9f86 100644 --- a/doc/src/sgml/ref/pg_basebackup.sgml +++ b/doc/src/sgml/ref/pg_basebackup.sgml @@ -431,7 +431,7 @@ PostgreSQL documentation </para> <para> - Other, less commonly used, options are also available: + Other options are also available: <variablelist> <varlistentry> diff --git a/doc/src/sgml/ref/pg_config-ref.sgml b/doc/src/sgml/ref/pg_config-ref.sgml index 2246b74df01..5aac38b3cec 100644 --- a/doc/src/sgml/ref/pg_config-ref.sgml +++ b/doc/src/sgml/ref/pg_config-ref.sgml @@ -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, diff --git a/doc/src/sgml/ref/pg_ctl-ref.sgml b/doc/src/sgml/ref/pg_ctl-ref.sgml index 1409e0c44e4..37826e9c6c3 100644 --- a/doc/src/sgml/ref/pg_ctl-ref.sgml +++ b/doc/src/sgml/ref/pg_ctl-ref.sgml @@ -364,6 +364,16 @@ PostgreSQL documentation </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> <para> @@ -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"> diff --git a/doc/src/sgml/ref/pg_receivexlog.sgml b/doc/src/sgml/ref/pg_receivexlog.sgml index 5eefefbe874..63cff478803 100644 --- a/doc/src/sgml/ref/pg_receivexlog.sgml +++ b/doc/src/sgml/ref/pg_receivexlog.sgml @@ -211,7 +211,7 @@ PostgreSQL documentation </para> <para> - Other, less commonly used, options are also available: + Other options are also available: <variablelist> <varlistentry> diff --git a/doc/src/sgml/ref/postgres-ref.sgml b/doc/src/sgml/ref/postgres-ref.sgml index d8e9825d13e..4e5cd02589c 100644 --- a/doc/src/sgml/ref/postgres-ref.sgml +++ b/doc/src/sgml/ref/postgres-ref.sgml @@ -346,6 +346,16 @@ PostgreSQL documentation </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> <para> @@ -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> diff --git a/doc/src/sgml/vacuumlo.sgml b/doc/src/sgml/vacuumlo.sgml index 4640744e8b7..b9629bf2f54 100644 --- a/doc/src/sgml/vacuumlo.sgml +++ b/doc/src/sgml/vacuumlo.sgml @@ -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> @@ -79,23 +75,58 @@ </varlistentry> <varlistentry> - <term><option>-p</option> <replaceable>port</></term> + <term><option>-v</option></term> <listitem> - <para>Database server's port.</para> + <para>Write a lot of progress messages.</para> </listitem> </varlistentry> <varlistentry> - <term><option>-U</option> <replaceable>username</></term> + <term><option>-V</></term> + <term><option>--version</></term> <listitem> - <para>User name to connect as.</para> + <para> + Print the <application>vacuumlo</application> version and exit. + </para> </listitem> </varlistentry> <varlistentry> - <term><option>-v</option></term> + <term><option>-?</></term> + <term><option>--help</></term> <listitem> - <para>Write a lot of progress messages.</para> + <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> + <para>Database server's port.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-U</option> <replaceable>username</></term> + <listitem> + <para>User name to connect as.</para> </listitem> </varlistentry> @@ -133,6 +164,7 @@ </listitem> </varlistentry> </variablelist> + </para> </refsect1> <refsect1> |