From: Bruce Momjian Date: Fri, 19 Feb 2010 14:36:45 +0000 (+0000) Subject: Document --version and --help options for all client applications (they X-Git-Tag: REL9_0_ALPHA4~1 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=f8f0140d73b23b92062465c4977a71a6ee336eea;p=postgresql Document --version and --help options for all client applications (they all support it). Per report from Josh Kupershmidt --- diff --git a/doc/src/sgml/ref/clusterdb.sgml b/doc/src/sgml/ref/clusterdb.sgml index 055f0a5a26..c805cddae6 100644 --- a/doc/src/sgml/ref/clusterdb.sgml +++ b/doc/src/sgml/ref/clusterdb.sgml @@ -1,5 +1,5 @@ @@ -129,6 +129,27 @@ PostgreSQL documentation + + + + + + Print the clusterdb version and exit. + + + + + + + + + + Show help about clusterdb command line + arguments, and exit. + + + + diff --git a/doc/src/sgml/ref/createdb.sgml b/doc/src/sgml/ref/createdb.sgml index 0856e0f621..1e7ecf4de8 100644 --- a/doc/src/sgml/ref/createdb.sgml +++ b/doc/src/sgml/ref/createdb.sgml @@ -1,5 +1,5 @@ @@ -168,6 +168,28 @@ PostgreSQL documentation + + + + + + + Print the createdb version and exit. + + + + + + + + + + Show help about createdb command line + arguments, and exit. + + + + diff --git a/doc/src/sgml/ref/createlang.sgml b/doc/src/sgml/ref/createlang.sgml index 52aabdc3d0..30bd528680 100644 --- a/doc/src/sgml/ref/createlang.sgml +++ b/doc/src/sgml/ref/createlang.sgml @@ -1,5 +1,5 @@ @@ -96,6 +96,27 @@ PostgreSQL documentation + + + + + + Print the createlang version and exit. + + + + + + + + + + Show help about createlang command line + arguments, and exit. + + + + diff --git a/doc/src/sgml/ref/createuser.sgml b/doc/src/sgml/ref/createuser.sgml index eecf8c4fe2..99582f8722 100644 --- a/doc/src/sgml/ref/createuser.sgml +++ b/doc/src/sgml/ref/createuser.sgml @@ -1,5 +1,5 @@ @@ -243,6 +243,28 @@ PostgreSQL documentation + + + + + + + Print the createuser version and exit. + + + + + + + + + + Show help about createuser command line + arguments, and exit. + + + + diff --git a/doc/src/sgml/ref/dropdb.sgml b/doc/src/sgml/ref/dropdb.sgml index 2451a198a9..76e0190238 100644 --- a/doc/src/sgml/ref/dropdb.sgml +++ b/doc/src/sgml/ref/dropdb.sgml @@ -1,5 +1,5 @@ @@ -86,7 +86,30 @@ PostgreSQL documentation + + + + + + + Print the dropdb version and exit. + + + + + + + + + + Show help about dropdb command line + arguments, and exit. + + + + + diff --git a/doc/src/sgml/ref/droplang.sgml b/doc/src/sgml/ref/droplang.sgml index 107a28b8aa..6dd5847b86 100644 --- a/doc/src/sgml/ref/droplang.sgml +++ b/doc/src/sgml/ref/droplang.sgml @@ -1,5 +1,5 @@ @@ -104,6 +104,27 @@ PostgreSQL documentation + + + + + + Print the droplang version and exit. + + + + + + + + + + Show help about droplang command line + arguments, and exit. + + + + diff --git a/doc/src/sgml/ref/dropuser.sgml b/doc/src/sgml/ref/dropuser.sgml index 9df53ddc10..31a6f0009c 100644 --- a/doc/src/sgml/ref/dropuser.sgml +++ b/doc/src/sgml/ref/dropuser.sgml @@ -1,5 +1,5 @@ @@ -88,6 +88,28 @@ PostgreSQL documentation + + + + + + + Print the dropuser version and exit. + + + + + + + + + + Show help about dropuser command line + arguments, and exit. + + + + diff --git a/doc/src/sgml/ref/ecpg-ref.sgml b/doc/src/sgml/ref/ecpg-ref.sgml index 626dc406e6..8e71c27768 100644 --- a/doc/src/sgml/ref/ecpg-ref.sgml +++ b/doc/src/sgml/ref/ecpg-ref.sgml @@ -1,5 +1,5 @@ @@ -159,28 +159,30 @@ PostgreSQL documentation Print additional information including the version and the - include path. + "include" path. - + - Show a brief summary of the command usage, then exit. + Print the ecpg version and exit. - + - Output version information, then exit. + Show help about ecpg command line + arguments, and exit. + diff --git a/doc/src/sgml/ref/initdb.sgml b/doc/src/sgml/ref/initdb.sgml index 875a0e5eae..e9353da777 100644 --- a/doc/src/sgml/ref/initdb.sgml +++ b/doc/src/sgml/ref/initdb.sgml @@ -1,5 +1,5 @@ @@ -280,6 +280,28 @@ PostgreSQL documentation + + + + + + + Print the initdb version and exit. + + + + + + + + + + Show help about initdb command line + arguments, and exit. + + + + diff --git a/doc/src/sgml/ref/pg_controldata.sgml b/doc/src/sgml/ref/pg_controldata.sgml index 62695963e2..fcf01873b3 100644 --- a/doc/src/sgml/ref/pg_controldata.sgml +++ b/doc/src/sgml/ref/pg_controldata.sgml @@ -1,5 +1,5 @@ @@ -40,7 +40,11 @@ PostgreSQL documentation This utility can only be run by the user who initialized the cluster because it requires read access to the data directory. You can specify the data directory on the command line, or use - the environment variable PGDATA. + the environment variable PGDATA. This utility supports the options + -V and --version, which print the + pg_controldata version and exit. It also + supports options -? and --help, which output the + supported arguments. diff --git a/doc/src/sgml/ref/pg_dump.sgml b/doc/src/sgml/ref/pg_dump.sgml index 86d75b973f..3286c9575a 100644 --- a/doc/src/sgml/ref/pg_dump.sgml +++ b/doc/src/sgml/ref/pg_dump.sgml @@ -1,5 +1,5 @@ @@ -483,6 +483,16 @@ PostgreSQL documentation + + + + + + Print the pg_dump version and exit. + + + + @@ -645,6 +655,18 @@ PostgreSQL documentation + + + + + + + Show help about pg_dump command line + arguments, and exit. + + + + diff --git a/doc/src/sgml/ref/pg_dumpall.sgml b/doc/src/sgml/ref/pg_dumpall.sgml index bf41b5ead8..ce4b9f49bf 100644 --- a/doc/src/sgml/ref/pg_dumpall.sgml +++ b/doc/src/sgml/ref/pg_dumpall.sgml @@ -1,5 +1,5 @@ @@ -248,6 +248,16 @@ PostgreSQL documentation + + + + + + Print the pg_dumpall version and exit. + + + + @@ -346,6 +356,17 @@ PostgreSQL documentation + + + + + + Show help about pg_dumpall command line + arguments, and exit. + + + + diff --git a/doc/src/sgml/ref/pg_resetxlog.sgml b/doc/src/sgml/ref/pg_resetxlog.sgml index a9d34298e4..ab8c664a2b 100644 --- a/doc/src/sgml/ref/pg_resetxlog.sgml +++ b/doc/src/sgml/ref/pg_resetxlog.sgml @@ -1,5 +1,5 @@ @@ -178,6 +178,14 @@ PostgreSQL documentation This is mainly a debugging tool, but can be useful as a sanity check before allowing pg_resetxlog to proceed for real. + + + The -V and --version options print + the pg_resetxlog version and exit. The + options -? and --help show supported arguments, + and exit. + + diff --git a/doc/src/sgml/ref/pg_restore.sgml b/doc/src/sgml/ref/pg_restore.sgml index 0e86e0862f..e71f932f58 100644 --- a/doc/src/sgml/ref/pg_restore.sgml +++ b/doc/src/sgml/ref/pg_restore.sgml @@ -1,4 +1,4 @@ - + @@ -402,6 +402,16 @@ + + + + + + Print the pg_restore version and exit. + + + + @@ -484,6 +494,17 @@ + + + + + + Show help about pg_restore command line + arguments, and exit. + + + + diff --git a/doc/src/sgml/ref/psql-ref.sgml b/doc/src/sgml/ref/psql-ref.sgml index 64d96a2183..039ad0e301 100644 --- a/doc/src/sgml/ref/psql-ref.sgml +++ b/doc/src/sgml/ref/psql-ref.sgml @@ -1,5 +1,5 @@ @@ -514,6 +514,7 @@ PostgreSQL documentation + diff --git a/doc/src/sgml/ref/reindexdb.sgml b/doc/src/sgml/ref/reindexdb.sgml index 936edb9c3d..1e98e07842 100644 --- a/doc/src/sgml/ref/reindexdb.sgml +++ b/doc/src/sgml/ref/reindexdb.sgml @@ -139,7 +139,30 @@ PostgreSQL documentation - + + + + + + + Print the reindexdb version and exit. + + + + + + + + + + Show help about reindexdb command line + arguments, and exit. + + + + + + diff --git a/doc/src/sgml/ref/vacuumdb.sgml b/doc/src/sgml/ref/vacuumdb.sgml index f24c02be1b..76324df160 100644 --- a/doc/src/sgml/ref/vacuumdb.sgml +++ b/doc/src/sgml/ref/vacuumdb.sgml @@ -1,5 +1,5 @@ @@ -175,6 +175,16 @@ PostgreSQL documentation + + + + + + Print the vacuumdb version and exit. + + + + @@ -185,6 +195,17 @@ PostgreSQL documentation + + + + + + Show help about vacuumdb command line + arguments, and exit. + + + +