]> granicus.if.org Git - postgresql/commitdiff
Make documentation of --help and --version options more consistent
authorPeter Eisentraut <peter_e@gmx.net>
Sun, 17 Jun 2012 23:44:00 +0000 (02:44 +0300)
committerPeter Eisentraut <peter_e@gmx.net>
Sun, 17 Jun 2012 23:46:59 +0000 (02:46 +0300)
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.

45 files changed:
contrib/oid2name/oid2name.c
contrib/pg_archivecleanup/pg_archivecleanup.c
contrib/pg_standby/pg_standby.c
contrib/pg_upgrade/option.c
contrib/pgbench/pgbench.c
contrib/vacuumlo/vacuumlo.c
doc/src/sgml/oid2name.sgml
doc/src/sgml/pgarchivecleanup.sgml
doc/src/sgml/pgbench.sgml
doc/src/sgml/pgstandby.sgml
doc/src/sgml/pgtestfsync.sgml
doc/src/sgml/pgtesttiming.sgml
doc/src/sgml/ref/createuser.sgml
doc/src/sgml/ref/dropdb.sgml
doc/src/sgml/ref/dropuser.sgml
doc/src/sgml/ref/ecpg-ref.sgml
doc/src/sgml/ref/initdb.sgml
doc/src/sgml/ref/pg_basebackup.sgml
doc/src/sgml/ref/pg_config-ref.sgml
doc/src/sgml/ref/pg_ctl-ref.sgml
doc/src/sgml/ref/pg_receivexlog.sgml
doc/src/sgml/ref/postgres-ref.sgml
doc/src/sgml/vacuumlo.sgml
src/backend/main/main.c
src/bin/initdb/initdb.c
src/bin/pg_basebackup/pg_basebackup.c
src/bin/pg_basebackup/pg_receivexlog.c
src/bin/pg_config/pg_config.c
src/bin/pg_controldata/pg_controldata.c
src/bin/pg_ctl/pg_ctl.c
src/bin/pg_dump/pg_dump.c
src/bin/pg_dump/pg_dumpall.c
src/bin/pg_dump/pg_restore.c
src/bin/pg_resetxlog/pg_resetxlog.c
src/bin/psql/help.c
src/bin/scripts/clusterdb.c
src/bin/scripts/createdb.c
src/bin/scripts/createlang.c
src/bin/scripts/createuser.c
src/bin/scripts/dropdb.c
src/bin/scripts/droplang.c
src/bin/scripts/dropuser.c
src/bin/scripts/reindexdb.c
src/bin/scripts/vacuumdb.c
src/interfaces/ecpg/preproc/ecpg.c

index c7ba1bd101076425bd4c2d8b167cbcdc007b7030..e8a389e49e796ca8d492641a08da63ae433bba41 100644 (file)
@@ -179,20 +179,20 @@ help(const char *progname)
                   "Usage:\n"
                   "  %s [OPTION]...\n"
                   "\nOptions:\n"
-                  "  -d DBNAME    database to connect to\n"
-                  "  -f FILENODE  show info for table with given file node\n"
-                  "  -H HOSTNAME  database server host or socket directory\n"
-                  "  -i           show indexes and sequences too\n"
-                  "  -o OID       show info for table with given OID\n"
-                  "  -p PORT      database server port number\n"
-                  "  -q           quiet (don't show headers)\n"
-                  "  -s           show all tablespaces\n"
-                  "  -S           show system objects too\n"
-                  "  -t TABLE     show info for named table\n"
-                  "  -U NAME      connect as specified database user\n"
-                  "  -x           extended (show additional columns)\n"
-                  "  --help       show this help, then exit\n"
-                  "  --version    output version information, then exit\n"
+                  "  -d DBNAME      database to connect to\n"
+                  "  -f FILENODE    show info for table with given file node\n"
+                  "  -H HOSTNAME    database server host or socket directory\n"
+                  "  -i             show indexes and sequences too\n"
+                  "  -o OID         show info for table with given OID\n"
+                  "  -p PORT        database server port number\n"
+                  "  -q             quiet (don't show headers)\n"
+                  "  -s             show all tablespaces\n"
+                  "  -S             show system objects too\n"
+                  "  -t TABLE       show info for named table\n"
+                  "  -U NAME        connect as specified database user\n"
+                  "  -V, --version  output version information, then exit\n"
+                  "  -x             extended (show additional columns)\n"
+                  "  -?, --help     show this help, then exit\n"
                   "\nThe default action is to show all database OIDs.\n\n"
                   "Report bugs to <pgsql-bugs@postgresql.org>.\n",
                   progname, progname);
index a226101bbc47b36e3f21a9ae374b65adbcf5b166..8f77998de12f95f41bb95c3e05a14de6cdf18047 100644 (file)
@@ -249,11 +249,11 @@ usage(void)
        printf("Usage:\n");
        printf("  %s [OPTION]... ARCHIVELOCATION OLDESTKEPTWALFILE\n", progname);
        printf("\nOptions:\n");
-       printf("  -d         generate debug output (verbose mode)\n");
-       printf("  -n         dry run, show the names of the files that would be removed\n");
-       printf("  -x EXT     clean up files if they have this extension\n");
-       printf("  --help     show this help, then exit\n");
-       printf("  --version  output version information, then exit\n");
+       printf("  -d             generate debug output (verbose mode)\n");
+       printf("  -n             dry run, show the names of the files that would be removed\n");
+       printf("  -V, --version  output version information, then exit\n");
+       printf("  -x EXT         clean up files if they have this extension\n");
+       printf("  -?, --help     show this help, then exit\n");
        printf("\n"
                   "For use as archive_cleanup_command in recovery.conf when standby_mode = on:\n"
                   "  archive_cleanup_command = 'pg_archivecleanup [OPTION]... ARCHIVELOCATION %%r'\n"
index 57241ff897056df1f7757a590598cb6fe430eefd..84941ede137a7cb30f979ef584038edb00a48c46 100644 (file)
@@ -527,9 +527,9 @@ usage(void)
        printf("  -s SLEEPTIME       seconds to wait between file checks (min=1, max=60,\n"
                   "                     default=5)\n");
        printf("  -t TRIGGERFILE     trigger file to initiate failover (no default)\n");
+       printf("  -V, --version      output version information, then exit\n");
        printf("  -w MAXWAITTIME     max seconds to wait for a file (0=no limit) (default=0)\n");
-       printf("  --help             show this help, then exit\n");
-       printf("  --version          output version information, then exit\n");
+       printf("  -?, --help         show this help, then exit\n");
        printf("\n"
                   "Main intended use as restore_command in recovery.conf:\n"
                   "  restore_command = 'pg_standby [OPTION]... ARCHIVELOCATION %%f %%p %%r'\n"
index ccf00434d3b610238900fa372360a8dcdcbe70b4..43394a0fb4a8e488459765c8c77ab65c796b6cc6 100644 (file)
@@ -236,7 +236,7 @@ Options:\n\
   -u, --user=NAME               cluster superuser (default \"%s\")\n\
   -v, --verbose                 enable verbose internal logging\n\
   -V, --version                 display version information, then exit\n\
-  -h, --help                    show this help, then exit\n\
+  -?, -h, --help                show this help, then exit\n\
 \n\
 Before running pg_upgrade you must:\n\
   create a new database cluster (using the new version of initdb)\n\
index 25fb15a847155db6f852ae82343bc98b1d5d0b64..f2fdc6c56f67acb9f56a72eb23d08349fd301cd3 100644 (file)
@@ -368,12 +368,12 @@ usage(const char *progname)
                   "  -T NUM       duration of benchmark test in seconds\n"
                   "  -v           vacuum all four standard tables before tests\n"
                   "\nCommon options:\n"
-                  "  -d           print debugging output\n"
-                  "  -h HOSTNAME  database server host or socket directory\n"
-                  "  -p PORT      database server port number\n"
-                  "  -U USERNAME  connect as specified database user\n"
-                  "  --help       show this help, then exit\n"
-                  "  --version    output version information, then exit\n"
+                  "  -d             print debugging output\n"
+                  "  -h HOSTNAME    database server host or socket directory\n"
+                  "  -p PORT        database server port number\n"
+                  "  -U USERNAME    connect as specified database user\n"
+                  "  -V, --version  output version information, then exit\n"
+                  "  -?, --help     show this help, then exit\n"
                   "\n"
                   "Report bugs to <pgsql-bugs@postgresql.org>.\n",
                   progname, progname);
index 958a496b24abb85a82cb1f738d02db1ac9ff22b6..7f5287c27aea3ffade4340f408ea37e3776353bd 100644 (file)
@@ -384,16 +384,17 @@ usage(const char *progname)
        printf("%s removes unreferenced large objects from databases.\n\n", progname);
        printf("Usage:\n  %s [OPTION]... DBNAME...\n\n", progname);
        printf("Options:\n");
-       printf("  -h HOSTNAME  database server host or socket directory\n");
-       printf("  -l LIMIT     commit after removing each LIMIT large objects\n");
-       printf("  -n           don't remove large objects, just show what would be done\n");
-       printf("  -p PORT      database server port\n");
-       printf("  -U USERNAME  user name to connect as\n");
-       printf("  -w           never prompt for password\n");
-       printf("  -W           force password prompt\n");
-       printf("  -v           write a lot of progress messages\n");
-       printf("  --help       show this help, then exit\n");
-       printf("  --version    output version information, then exit\n");
+       printf("  -l LIMIT       commit after removing each LIMIT large objects\n");
+       printf("  -n             don't remove large objects, just show what would be done\n");
+       printf("  -v             write a lot of progress messages\n");
+       printf("  -V, --version  output version information, then exit\n");
+       printf("  -?, --help     show this help, then exit\n");
+       printf("\nConnection options:\n");
+       printf("  -h HOSTNAME    database server host or socket directory\n");
+       printf("  -p PORT        database server port\n");
+       printf("  -U USERNAME    user name to connect as\n");
+       printf("  -w             never prompt for password\n");
+       printf("  -W             force password prompt\n");
        printf("\n");
        printf("Report bugs to <pgsql-bugs@postgresql.org>.\n");
 }
index 30e8bb1972c67d45a14d28a00eb19a7e1762e8e4..5e39677496b5fab6a63bfe04912491b9af3e4c99 100644 (file)
      <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>
 
index 44e8bbdfc2404e15d379e24a48ccd5b77244d60b..932914bc2f890de845917cc2ee1d6838b6a11aeb 100644 (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>
index 1b0905fa271d6fb69fb2dc98dfe58c02729b6dce..4a80b46416d4e610b6fbc6d174731f99b85653bb 100644 (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>
 
index 0fe3f646bc0cc2e92dff0625b70624c46569fc4d..ca2b5c078dc81237e55d2b65c22dc540ed27c5d4 100644 (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>
 
index d8c0c4580882bd852072bbbe78576af59743ba73..95ba3b81e0c876d6c4970a1315b05fe0587b8408 100644 (file)
       </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>
 
index 486be831237c3659aae8f9cc67dac56c6569647b..f74d63e68831752f6a16e89b62b802676d327dda 100644 (file)
       </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>
 
index dedc97f2233c7579e35c3c11cada8f22a5f86e93..2f1ea2fb73bb9fdd463cefcd965a40610fb13d8b 100644 (file)
@@ -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>
index ba781cce52b5bd05918ce1021add76617e6b3321..4593604f3bc96124162438d03fcb377aa9d14128 100644 (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>
index 891bbd60371136bab8eab4327d1c3b412aa5199c..180fb0bb62e67469a0e7bd007bd095a121cdac97 100644 (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>
index 9c13e93a271c3ff00c042c482310cc81ccb9c9ef..edd20dcdd557526cbcb07ff86104093ba39113e4 100644 (file)
@@ -202,6 +202,7 @@ PostgreSQL documentation
     </varlistentry>
 
     <varlistentry>
+     <term><option>-?</option></term>
      <term><option>--help</option></term>
      <listitem>
       <para>
index b2e94e83d8e00cd5b053f42db0b0a9ddd7de5918..11484468ddda8449aa015857250377e967ef3f20 100644 (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>
index d03bedd12a999000d0bf2cded0e5116060ea9ff1..ebd6e1e9f8686a4f91275bd514e03a676732fa7a 100644 (file)
@@ -431,7 +431,7 @@ PostgreSQL documentation
    </para>
 
    <para>
-    Other, less commonly used, options are also available:
+    Other options are also available:
 
     <variablelist>
      <varlistentry>
index 2246b74df01aa12e8edb8e5d4f40dd96aee56777..5aac38b3cec88879b5c8337f318cc4dfe6ae28d4 100644 (file)
       </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,
index 1409e0c44e4ff7ea49d65e37c895f792e9fab2ef..37826e9c6c399c9de0563bc7d34aade37fd00257 100644 (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">
index 5eefefbe87497e7d34e52aa72e166372fd19848c..63cff4788036c93a09482eb295456a326154d971 100644 (file)
@@ -211,7 +211,7 @@ PostgreSQL documentation
    </para>
 
    <para>
-    Other, less commonly used, options are also available:
+    Other options are also available:
 
     <variablelist>
      <varlistentry>
index d8e9825d13ebb335bf870a5c74d14561fb4f9800..4e5cd02589c8ebdcdfb68afdb06a492f24e06de6 100644 (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>
 
index 4640744e8b7080aa9d03cc2f99277e84a2f4f0ab..b9629bf2f5450e51f5eeba954130974510ea126b 100644 (file)
  <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>
    </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>
 
     </listitem>
    </varlistentry>
   </variablelist>
+  </para>
  </refsect1>
 
  <refsect1>
index 7203481a04b7ffb003c5bf32e35307aa80c5aa44..c7d48e95ad6c3eeadf3e23aabdd162c64ea31334 100644 (file)
@@ -295,10 +295,10 @@ help(const char *progname)
        printf(_("  -p PORT            port number to listen on\n"));
        printf(_("  -s                 show statistics after each query\n"));
        printf(_("  -S WORK-MEM        set amount of memory for sorts (in kB)\n"));
+       printf(_("  -V, --version      output version information, then exit\n"));
        printf(_("  --NAME=VALUE       set run-time parameter\n"));
        printf(_("  --describe-config  describe configuration parameters, then exit\n"));
-       printf(_("  --help             show this help, then exit\n"));
-       printf(_("  --version          output version information, then exit\n"));
+       printf(_("  -?, --help         show this help, then exit\n"));
 
        printf(_("\nDeveloper options:\n"));
        printf(_("  -f s|i|n|m|h       forbid use of some plan types\n"));
index 3789948cdfb82af769295e6cec88dca7a427cbc2..bac8385d39ff934ca213f6174c96db47440ef269 100644 (file)
@@ -2534,8 +2534,8 @@ usage(const char *progname)
        printf(_("  -n, --noclean             do not clean up after errors\n"));
        printf(_("  -s, --show                show internal settings\n"));
        printf(_("\nOther options:\n"));
-       printf(_("  -?, --help                show this help, then exit\n"));
        printf(_("  -V, --version             output version information, then exit\n"));
+       printf(_("  -?, --help                show this help, then exit\n"));
        printf(_("\nIf the data directory is not specified, the environment variable PGDATA\n"
                         "is used.\n"));
        printf(_("\nReport bugs to <pgsql-bugs@postgresql.org>.\n"));
index 44fd8a969dd4df247f919fb6734126fc496f505f..bc67a3cb4d4ae21151a6025567a37eba8f99d8c6 100644 (file)
@@ -118,8 +118,8 @@ usage(void)
        printf(_("  -l, --label=LABEL        set backup label\n"));
        printf(_("  -P, --progress           show progress information\n"));
        printf(_("  -v, --verbose            output verbose messages\n"));
-       printf(_("  --help                   show this help, then exit\n"));
-       printf(_("  --version                output version information, then exit\n"));
+       printf(_("  -V, --version            output version information, then exit\n"));
+       printf(_("  -?, --help               show this help, then exit\n"));
        printf(_("\nConnection options:\n"));
        printf(_("  -s, --statusint=INTERVAL time between status packets sent to server (in seconds)\n"));
        printf(_("  -h, --host=HOSTNAME      database server host or socket directory\n"));
index faa30b2bf06d28b8b7780e042498141894a2e746..20adb653cf1f16d60db3f30f925e77ecf4ed8449 100644 (file)
@@ -60,8 +60,8 @@ usage(void)
        printf(_("  -D, --directory=DIR      receive transaction log files into this directory\n"));
        printf(_("  -n, --noloop             do not loop on connection lost\n"));
        printf(_("  -v, --verbose            output verbose messages\n"));
-       printf(_("  -?, --help               show this help, then exit\n"));
        printf(_("  -V, --version            output version information, then exit\n"));
+       printf(_("  -?, --help               show this help, then exit\n"));
        printf(_("\nConnection options:\n"));
        printf(_("  -s, --statusint=INTERVAL time between status packets sent to server (in seconds)\n"));
        printf(_("  -h, --host=HOSTNAME      database server host or socket directory\n"));
index 6bd3451e4c6bd282754c9d69497b4194ab905cc1..b94cf53f544b7f7d79c4bbfa2b2f9c7267699f13 100644 (file)
@@ -454,7 +454,7 @@ help(void)
        printf(_("  --ldflags_sl          show LDFLAGS_SL value used when PostgreSQL was built\n"));
        printf(_("  --libs                show LIBS value used when PostgreSQL was built\n"));
        printf(_("  --version             show the PostgreSQL version\n"));
-       printf(_("  --help                show this help, then exit\n"));
+       printf(_("  -?, --help            show this help, then exit\n"));
        printf(_("\nWith no arguments, all known items are shown.\n\n"));
        printf(_("Report bugs to <pgsql-bugs@postgresql.org>.\n"));
 }
index c00183ab4feb41786f83764df5f2b1812aafe0bb..38c263c08be4d74d28170a5f0d1b1d29d869bdb2 100644 (file)
@@ -31,17 +31,11 @@ static void
 usage(const char *progname)
 {
        printf(_("%s displays control information of a PostgreSQL database cluster.\n\n"), progname);
-       printf
-               (
-                _(
-                  "Usage:\n"
-                  "  %s [OPTION] [DATADIR]\n\n"
-                  "Options:\n"
-                  "  --help         show this help, then exit\n"
-                  "  --version      output version information, then exit\n"
-                  ),
-                progname
-               );
+       printf(_("Usage:\n"));
+       printf(_("  %s [OPTION] [DATADIR]\n"), progname);
+       printf(_("\nOptions:\n"));
+       printf(_("  -V, --version  output version information, then exit\n"));
+       printf(_("  -?, --help     show this help, then exit\n"));
        printf(_("\nIf no data directory (DATADIR) is specified, "
                         "the environment variable PGDATA\nis used.\n\n"));
        printf(_("Report bugs to <pgsql-bugs@postgresql.org>.\n"));
index d7b836762d8a66e9fb0d51156abaa5b28af2498e..3826312b8edad3405f025dc28b15284d4f563252 100644 (file)
@@ -1768,10 +1768,10 @@ do_help(void)
        printf(_("  -D, --pgdata=DATADIR   location of the database storage area\n"));
        printf(_("  -s, --silent           only print errors, no informational messages\n"));
        printf(_("  -t, --timeout=SECS     seconds to wait when using -w option\n"));
+       printf(_("  -V, --version          output version information, then exit\n"));
        printf(_("  -w                     wait until operation completes\n"));
        printf(_("  -W                     do not wait until operation completes\n"));
-       printf(_("  --help                 show this help, then exit\n"));
-       printf(_("  --version              output version information, then exit\n"));
+       printf(_("  -?, --help             show this help, then exit\n"));
        printf(_("(The default is to wait for shutdown, but not for start or restart.)\n\n"));
        printf(_("If the -D option is omitted, the environment variable PGDATA is used.\n"));
 
index d9aeee3c8d252922711ba3da1993af243d2953e8..4780c37d302f5017b863b67fa0983fc13cfe17ed 100644 (file)
@@ -780,10 +780,10 @@ help(const char *progname)
        printf(_("  -F, --format=c|d|t|p         output file format (custom, directory, tar,\n"
                         "                               plain text (default))\n"));
        printf(_("  -v, --verbose                verbose mode\n"));
+       printf(_("  -V, --version                output version information, then exit\n"));
        printf(_("  -Z, --compress=0-9           compression level for compressed formats\n"));
        printf(_("  --lock-wait-timeout=TIMEOUT  fail after waiting TIMEOUT for a table lock\n"));
-       printf(_("  --help                       show this help, then exit\n"));
-       printf(_("  --version                    output version information, then exit\n"));
+       printf(_("  -?, --help                   show this help, then exit\n"));
 
        printf(_("\nOptions controlling the output content:\n"));
        printf(_("  -a, --data-only              dump only the data, not the schema\n"));
index 053e5fd36ae4c0860861368a69a36799bd639437..10ce2223df4a57253f4906219fd96f31593387ff 100644 (file)
@@ -538,9 +538,9 @@ help(void)
 
        printf(_("\nGeneral options:\n"));
        printf(_("  -f, --file=FILENAME          output file name\n"));
+       printf(_("  -V, --version                output version information, then exit\n"));
        printf(_("  --lock-wait-timeout=TIMEOUT  fail after waiting TIMEOUT for a table lock\n"));
-       printf(_("  --help                       show this help, then exit\n"));
-       printf(_("  --version                    output version information, then exit\n"));
+       printf(_("  -?, --help                   show this help, then exit\n"));
        printf(_("\nOptions controlling the output content:\n"));
        printf(_("  -a, --data-only              dump only the data, not the schema\n"));
        printf(_("  -c, --clean                  clean (drop) databases before recreating\n"));
index f37152719399b0d8a9340104e134c410f1194abf..f6c835be0d123de57cd2336851a51faae4bfcda9 100644 (file)
@@ -407,8 +407,8 @@ usage(const char *progname)
        printf(_("  -F, --format=c|d|t       backup file format (should be automatic)\n"));
        printf(_("  -l, --list               print summarized TOC of the archive\n"));
        printf(_("  -v, --verbose            verbose mode\n"));
-       printf(_("  --help                   show this help, then exit\n"));
-       printf(_("  --version                output version information, then exit\n"));
+       printf(_("  -V, --version            output version information, then exit\n"));
+       printf(_("  -?, --help               show this help, then exit\n"));
 
        printf(_("\nOptions controlling the restore:\n"));
        printf(_("  -a, --data-only              restore only the data, no schema\n"));
index 65ba9103a63ee8432fff1308da01d5ea610f6864..5ecf5c49304692abc3702b1089586a803f2b20f4 100644 (file)
@@ -1035,8 +1035,8 @@ usage(void)
        printf(_("  -n               no update, just show extracted control values (for testing)\n"));
        printf(_("  -o OID           set next OID\n"));
        printf(_("  -O OFFSET        set next multitransaction offset\n"));
+       printf(_("  -V, --version    output version information, then exit\n"));
        printf(_("  -x XID           set next transaction ID\n"));
-       printf(_("  --help           show this help, then exit\n"));
-       printf(_("  --version        output version information, then exit\n"));
+       printf(_("  -?, --help       show this help, then exit\n"));
        printf(_("\nReport bugs to <pgsql-bugs@postgresql.org>.\n"));
 }
index 4a37c3414caa294bd737bffc1920297213baa401..8868d7151c041512ec90605acc2b167cd68d3f40 100644 (file)
@@ -94,11 +94,11 @@ usage(void)
        printf(_("  -l, --list               list available databases, then exit\n"));
        printf(_("  -v, --set=, --variable=NAME=VALUE\n"
                         "                           set psql variable NAME to VALUE\n"));
+       printf(_("  -V, --version            output version information, then exit\n"));
        printf(_("  -X, --no-psqlrc          do not read startup file (~/.psqlrc)\n"));
        printf(_("  -1 (\"one\"), --single-transaction\n"
                         "                           execute command file as a single transaction\n"));
-       printf(_("  --help                   show this help, then exit\n"));
-       printf(_("  --version                output version information, then exit\n"));
+       printf(_("  -?, --help               show this help, then exit\n"));
 
        printf(_("\nInput and output options:\n"));
        printf(_("  -a, --echo-all           echo all input from script\n"));
index 76de70b6efc99fdc419315c4928b6e4e2bee5f1b..05b726d68ead871aa3dcb50a6c9cf135b5d3e7b4 100644 (file)
@@ -255,8 +255,8 @@ help(const char *progname)
        printf(_("  -q, --quiet               don't write any messages\n"));
        printf(_("  -t, --table=TABLE         cluster specific table only\n"));
        printf(_("  -v, --verbose             write a lot of output\n"));
-       printf(_("  --help                    show this help, then exit\n"));
-       printf(_("  --version                 output version information, then exit\n"));
+       printf(_("  -V, --version             output version information, then exit\n"));
+       printf(_("  -?, --help                show this help, then exit\n"));
        printf(_("\nConnection options:\n"));
        printf(_("  -h, --host=HOSTNAME       database server host or socket directory\n"));
        printf(_("  -p, --port=PORT           database server port\n"));
index d58c8156468c36d1fbfca1f690b580e6a8eaed3d..91b1a24fd3224c7e0fb6dd2c4f366e9955acba92 100644 (file)
@@ -260,8 +260,8 @@ help(const char *progname)
        printf(_("      --lc-ctype=LOCALE        LC_CTYPE setting for the database\n"));
        printf(_("  -O, --owner=OWNER            database user to own the new database\n"));
        printf(_("  -T, --template=TEMPLATE      template database to copy\n"));
-       printf(_("  --help                       show this help, then exit\n"));
-       printf(_("  --version                    output version information, then exit\n"));
+       printf(_("  -V, --version                output version information, then exit\n"));
+       printf(_("  -?, --help                   show this help, then exit\n"));
        printf(_("\nConnection options:\n"));
        printf(_("  -h, --host=HOSTNAME          database server host or socket directory\n"));
        printf(_("  -p, --port=PORT              database server port\n"));
index 8268eda6ed314e6177abb97015405a5f0702423b..60066af377f4f83a17bca2a95fdbb3802c88815b 100644 (file)
@@ -237,8 +237,8 @@ help(const char *progname)
        printf(_("  -d, --dbname=DBNAME       database to install language in\n"));
        printf(_("  -e, --echo                show the commands being sent to the server\n"));
        printf(_("  -l, --list                show a list of currently installed languages\n"));
-       printf(_("  --help                    show this help, then exit\n"));
-       printf(_("  --version                 output version information, then exit\n"));
+       printf(_("  -V, --version             output version information, then exit\n"));
+       printf(_("  -?, --help                show this help, then exit\n"));
        printf(_("\nConnection options:\n"));
        printf(_("  -h, --host=HOSTNAME       database server host or socket directory\n"));
        printf(_("  -p, --port=PORT           database server port\n"));
index 20a1a52a3ae0a7fbbbab3d1f9cf7050a39bf03ba..db3b5d04d8a50c166ef1c50cc8f6e28801f6d037 100644 (file)
@@ -345,12 +345,12 @@ help(const char *progname)
        printf(_("  -R, --no-createrole       role cannot create roles (default)\n"));
        printf(_("  -s, --superuser           role will be superuser\n"));
        printf(_("  -S, --no-superuser        role will not be superuser (default)\n"));
+       printf(_("  -V, --version             output version information, then exit\n"));
        printf(_("  --interactive             prompt for missing role name and attributes rather\n"
                         "                            than using defaults\n"));
        printf(_("  --replication             role can initiate replication\n"));
        printf(_("  --no-replication          role cannot initiate replication\n"));
-       printf(_("  --help                    show this help, then exit\n"));
-       printf(_("  --version                 output version information, then exit\n"));
+       printf(_("  -?, --help                show this help, then exit\n"));
        printf(_("\nConnection options:\n"));
        printf(_("  -h, --host=HOSTNAME       database server host or socket directory\n"));
        printf(_("  -p, --port=PORT           database server port\n"));
index 10ed67df8b27d0f250f0a81d50e2c2bd59a4d8eb..583655de6aec89e1e071f8a6780aec3d00a886ce 100644 (file)
@@ -157,9 +157,9 @@ help(const char *progname)
        printf(_("\nOptions:\n"));
        printf(_("  -e, --echo                show the commands being sent to the server\n"));
        printf(_("  -i, --interactive         prompt before deleting anything\n"));
+       printf(_("  -V, --version             output version information, then exit\n"));
        printf(_("  --if-exists               don't report error if database doesn't exist\n"));
-       printf(_("  --help                    show this help, then exit\n"));
-       printf(_("  --version                 output version information, then exit\n"));
+       printf(_("  -?, --help                show this help, then exit\n"));
        printf(_("\nConnection options:\n"));
        printf(_("  -h, --host=HOSTNAME       database server host or socket directory\n"));
        printf(_("  -p, --port=PORT           database server port\n"));
index 74553c19fddc325caef5ce4e136e31c9351c0c8d..4772dc514e3fa92cf280893e7a6642c79953c618 100644 (file)
@@ -238,8 +238,8 @@ help(const char *progname)
        printf(_("  -d, --dbname=DBNAME       database from which to remove the language\n"));
        printf(_("  -e, --echo                show the commands being sent to the server\n"));
        printf(_("  -l, --list                show a list of currently installed languages\n"));
-       printf(_("  --help                    show this help, then exit\n"));
-       printf(_("  --version                 output version information, then exit\n"));
+       printf(_("  -V, --version             output version information, then exit\n"));
+       printf(_("  -?, --help                show this help, then exit\n"));
        printf(_("\nConnection options:\n"));
        printf(_("  -h, --host=HOSTNAME       database server host or socket directory\n"));
        printf(_("  -p, --port=PORT           database server port\n"));
index 85b73a42ac206a0783a61639f61d4d08099017cf..d0bf6ff497841157215b03d915fd87d5bb640b20 100644 (file)
@@ -159,9 +159,9 @@ help(const char *progname)
        printf(_("  -e, --echo                show the commands being sent to the server\n"));
        printf(_("  -i, --interactive         prompt before deleting anything, and prompt for\n"
                         "                            role name if not specified\n"));
+       printf(_("  -V, --version             output version information, then exit\n"));
        printf(_("  --if-exists               don't report error if user doesn't exist\n"));
-       printf(_("  --help                    show this help, then exit\n"));
-       printf(_("  --version                 output version information, then exit\n"));
+       printf(_("  -?, --help                show this help, then exit\n"));
        printf(_("\nConnection options:\n"));
        printf(_("  -h, --host=HOSTNAME       database server host or socket directory\n"));
        printf(_("  -p, --port=PORT           database server port\n"));
index 35254f20cb241bcabc16780f6e58c4818df01df3..5b56656f0010c2e4982b7368a85fa405c631a6d4 100644 (file)
@@ -335,8 +335,8 @@ help(const char *progname)
        printf(_("  -q, --quiet               don't write any messages\n"));
        printf(_("  -s, --system              reindex system catalogs\n"));
        printf(_("  -t, --table=TABLE         reindex specific table only\n"));
-       printf(_("  --help                    show this help, then exit\n"));
-       printf(_("  --version                 output version information, then exit\n"));
+       printf(_("  -V, --version             output version information, then exit\n"));
+       printf(_("  -?, --help                show this help, then exit\n"));
        printf(_("\nConnection options:\n"));
        printf(_("  -h, --host=HOSTNAME       database server host or socket directory\n"));
        printf(_("  -p, --port=PORT           database server port\n"));
index 6221bdc30d35b290ebc5d298cac77673f275b80d..fbc132caa91bfb8c0e93a85002c30b016af8a174 100644 (file)
@@ -350,10 +350,10 @@ help(const char *progname)
        printf(_("  -q, --quiet                     don't write any messages\n"));
        printf(_("  -t, --table='TABLE[(COLUMNS)]'  vacuum specific table only\n"));
        printf(_("  -v, --verbose                   write a lot of output\n"));
+       printf(_("  -V, --version                   output version information, then exit\n"));
        printf(_("  -z, --analyze                   update optimizer statistics\n"));
        printf(_("  -Z, --analyze-only              only update optimizer statistics\n"));
-       printf(_("  --help                          show this help, then exit\n"));
-       printf(_("  --version                       output version information, then exit\n"));
+       printf(_("  -?, --help                      show this help, then exit\n"));
        printf(_("\nConnection options:\n"));
        printf(_("  -h, --host=HOSTNAME       database server host or socket directory\n"));
        printf(_("  -p, --port=PORT           database server port\n"));
index 8a4cebc6e2cb10495e2028157535b8728cba8140..7e7bae30a0b8ff8fb8c561c37564669273d6de1e 100644 (file)
@@ -54,8 +54,8 @@ help(const char *progname)
         "                 \"no_indicator\", \"prepare\", \"questionmarks\"\n"));
        printf(_("  --regression   run in regression testing mode\n"));
        printf(_("  -t             turn on autocommit of transactions\n"));
-       printf(_("  --help         show this help, then exit\n"));
        printf(_("  --version      output version information, then exit\n"));
+       printf(_("  -?, --help     show this help, then exit\n"));
        printf(_("\nIf no output file is specified, the name is formed by adding .c to the\n"
                         "input file name, after stripping off .pgc if present.\n"));
        printf(_("\nReport bugs to <pgsql-bugs@postgresql.org>.\n"));