From bb7520cc26dcd392e3dce294b685b3a0d6dae9e9 Mon Sep 17 00:00:00 2001 From: Peter Eisentraut Date: Mon, 18 Jun 2012 02:44:00 +0300 Subject: 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. --- doc/src/sgml/oid2name.sgml | 21 +++++++++++++ doc/src/sgml/pgarchivecleanup.sgml | 20 +++++++++++++ doc/src/sgml/pgbench.sgml | 20 +++++++++++++ doc/src/sgml/pgstandby.sgml | 20 +++++++++++++ doc/src/sgml/pgtestfsync.sgml | 20 +++++++++++++ doc/src/sgml/pgtesttiming.sgml | 21 +++++++++++++ doc/src/sgml/ref/createuser.sgml | 30 +++++++++---------- doc/src/sgml/ref/dropdb.sgml | 20 ++++++------- doc/src/sgml/ref/dropuser.sgml | 20 ++++++------- doc/src/sgml/ref/ecpg-ref.sgml | 1 + doc/src/sgml/ref/initdb.sgml | 6 ++++ doc/src/sgml/ref/pg_basebackup.sgml | 2 +- doc/src/sgml/ref/pg_config-ref.sgml | 11 +++++++ doc/src/sgml/ref/pg_ctl-ref.sgml | 21 +++++++++++++ doc/src/sgml/ref/pg_receivexlog.sgml | 2 +- doc/src/sgml/ref/postgres-ref.sgml | 21 +++++++++++++ doc/src/sgml/vacuumlo.sgml | 58 ++++++++++++++++++++++++++++-------- 17 files changed, 264 insertions(+), 50 deletions(-) (limited to 'doc/src') 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 @@ -97,12 +97,33 @@ show info for table(s) matching tablename_pattern + + + + + + Print the oid2name version and exit. + + + + display more information about each object shown: tablespace name, schema name, and OID + + + + + + + Show help about oid2name command line + arguments, and exit. + + + 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 @@ -106,6 +106,16 @@ pg_archivecleanup: removing file "archive/00000001000000370000000E" + + + + + + Print the pg_archivecleanup version and exit. + + + + extension @@ -126,6 +136,16 @@ pg_archivecleanup: removing file "archive/00000001000000370000000E" + + + + + + Show help about pg_archivecleanup command line + arguments, and exit. + + + 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 options dbname + + + + + + Print the pgbench version and exit. + + + + + + + + + + Show help about pgbench command line + arguments, and exit. + + + 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 @@ -198,6 +198,16 @@ restore_command = 'pg_standby archiveDir %f %p %r' + + + + + + Print the pg_standby version and exit. + + + + maxwaittime @@ -211,6 +221,16 @@ restore_command = 'pg_standby archiveDir %f %p %r' + + + + + + Show help about pg_standby command line + arguments, and exit. + + + 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 @@ + + + + + + Print the pg_test_fsync version and exit. + + + + + + + + + + Show help about pg_test_fsync command line + arguments, and exit. + + + 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 @@ + + + + + + Print the pg_test_timing version and exit. + + + + + + + + + + Show help about pg_test_timing command line + arguments, and exit. + + + + 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 - - + + + - The new user will have the REPLICATION privilege, which is - described more fully in the documentation for - . + Print the createuser version and exit. - + - + - The new user will not have the REPLICATION privilege, which is - described more fully in the documentation for - . + The new user will have the REPLICATION privilege, + which is described more fully in the documentation for . - - - + + - Print the createuser version and exit. + The new user will not have the REPLICATION + privilege, which is described more fully in the documentation for . - + 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 @@ -86,16 +86,6 @@ PostgreSQL documentation - - - - - Do not throw an error if the database does not exist. A notice is issued - in this case. - - - - @@ -106,6 +96,16 @@ PostgreSQL documentation + + + + + Do not throw an error if the database does not exist. A notice is issued + in this case. + + + + 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 @@ -91,16 +91,6 @@ PostgreSQL documentation - - - - - Do not throw an error if the user does not exist. A notice is - issued in this case. - - - - @@ -111,6 +101,16 @@ PostgreSQL documentation + + + + + Do not throw an error if the user does not exist. A notice is + issued in this case. + + + + 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 + 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 + + + + Other options: + + 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 - Other, less commonly used, options are also available: + Other options are also available: 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 @@ + + + + + + + Show help about pg_config command line + arguments, and exit. + + + 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 @@ -363,6 +363,16 @@ PostgreSQL documentation + + + + + + Print the pg_ctl version and exit. + + + + @@ -388,6 +398,17 @@ PostgreSQL documentation + + + + + + + Show help about pg_ctl command line + arguments, and exit. + + + 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 - Other, less commonly used, options are also available: + Other options are also available: 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 @@ -345,6 +345,16 @@ PostgreSQL documentation + + + + + + Print the postgres version and exit. + + + + @@ -365,6 +375,17 @@ PostgreSQL documentation + + + + + + + Show help about postgres command line + arguments, and exit. + + + 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 @@ Options - - - hostname - - Database server's host. - - + + vacuumlo accepts the following command-line arguments: + limit @@ -79,23 +75,58 @@ - port + - Database server's port. + Write a lot of progress messages. - username + + - User name to connect as. + + Print the vacuumlo version and exit. + - + + - Write a lot of progress messages. + + Show help about vacuumlo command line + arguments, and exit. + + + + + + + + vacuumlo also accepts the following command-line + arguments for connection parameters: + + + + hostname + + Database server's host. + + + + + port + + Database server's port. + + + + + username + + User name to connect as. @@ -133,6 +164,7 @@ + -- cgit v1.2.3