Document --version and --help options for all client applications (they

all support it). Per report from Josh Kupershmidt

Document --version and --help options for all client applications (they
all support it). Per report from Josh Kupershmidt
f8f0140d · Bruce Momjian · 4c6c6b52 · f8f0140d · f8f0140d · f8f0140d
Commit f8f0140d authored Feb 19, 2010 by Bruce Momjian
17 changed files
--- a/doc/src/sgml/ref/clusterdb.sgml
+++ b/doc/src/sgml/ref/clusterdb.sgml
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/clusterdb.sgml,v 1.26 2010/02/19 03:50:03 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/clusterdb.sgml,v 1.27 2010/02/19 14:36:45 momjian Exp $
 PostgreSQL documentation
 -->

@@ -129,6 +129,27 @@ PostgreSQL documentation
      </listitem>
     </varlistentry>

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


--- a/doc/src/sgml/ref/createdb.sgml
+++ b/doc/src/sgml/ref/createdb.sgml
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/createdb.sgml,v 1.50 2010/02/19 03:50:03 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/createdb.sgml,v 1.51 2010/02/19 14:36:45 momjian Exp $
 PostgreSQL documentation
 -->

@@ -168,6 +168,28 @@ PostgreSQL documentation
       </para>
      </listitem>
     </varlistentry>
+
+     <varlistentry>
+       <term><option>-V</></term>
+       <term><option>--version</></term>
+       <listitem>
+       <para>
+       Print the <application>createdb</application> version and exit.
+       </para>
+       </listitem>
+     </varlistentry>
+
+    <varlistentry>
+      <term><option>-?</></term>
+      <term><option>--help</></term>
+      <listitem>
+      <para>
+      Show help about <application>createdb</application> command line
+      arguments, and exit.
+      </para>
+      </listitem>
+    </varlistentry>
+
    </variablelist>
   </para>


--- a/doc/src/sgml/ref/createlang.sgml
+++ b/doc/src/sgml/ref/createlang.sgml
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/createlang.sgml,v 1.44 2010/02/19 03:50:03 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/createlang.sgml,v 1.45 2010/02/19 14:36:45 momjian Exp $
 PostgreSQL documentation
 -->

@@ -96,6 +96,27 @@ PostgreSQL documentation
      </listitem>
     </varlistentry>

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


--- a/doc/src/sgml/ref/createuser.sgml
+++ b/doc/src/sgml/ref/createuser.sgml
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/createuser.sgml,v 1.53 2010/02/19 03:50:03 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/createuser.sgml,v 1.54 2010/02/19 14:36:45 momjian Exp $
 PostgreSQL documentation
 -->

@@ -243,6 +243,28 @@ PostgreSQL documentation
       </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>
+       <listitem>
+       <para>
+       Show help about <application>createuser</application> command line
+       arguments, and exit.
+       </para>
+       </listitem>
+     </varlistentry>
+
    </variablelist>
  </para>


--- a/doc/src/sgml/ref/dropdb.sgml
+++ b/doc/src/sgml/ref/dropdb.sgml
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.36 2010/02/19 03:50:03 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/dropdb.sgml,v 1.37 2010/02/19 14:36:45 momjian Exp $
 PostgreSQL documentation
 -->

@@ -86,7 +86,30 @@ PostgreSQL documentation
       </para>
      </listitem>
     </varlistentry>
+
+     <varlistentry>
+       <term><option>-V</></term>
+       <term><option>--version</></term>
+       <listitem>
+       <para>
+       Print the <application>dropdb</application> version and exit.
+       </para>
+       </listitem>
+     </varlistentry>
+
+     <varlistentry>
+       <term><option>-?</></term>
+       <term><option>--help</></term>
+       <listitem>
+       <para>
+       Show help about <application>dropdb</application> command line
+       arguments, and exit.
+       </para>
+       </listitem>
+     </varlistentry>
+
    </variablelist>
+
  </para>

  <para>

--- a/doc/src/sgml/ref/droplang.sgml
+++ b/doc/src/sgml/ref/droplang.sgml
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/droplang.sgml,v 1.32 2009/02/26 16:02:37 petere Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/droplang.sgml,v 1.33 2010/02/19 14:36:45 momjian Exp $
 PostgreSQL documentation
 -->

@@ -104,6 +104,27 @@ PostgreSQL documentation
      </listitem>
     </varlistentry>

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


--- a/doc/src/sgml/ref/dropuser.sgml
+++ b/doc/src/sgml/ref/dropuser.sgml
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/dropuser.sgml,v 1.41 2010/02/19 03:50:03 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/dropuser.sgml,v 1.42 2010/02/19 14:36:45 momjian Exp $
 PostgreSQL documentation
 -->

@@ -88,6 +88,28 @@ PostgreSQL documentation
       </para>
      </listitem>
     </varlistentry>
+
+     <varlistentry>
+       <term><option>-V</></term>
+       <term><option>--version</></term>
+       <listitem>
+       <para>
+       Print the <application>dropuser</application> version and exit.
+       </para>
+       </listitem>
+     </varlistentry>
+
+     <varlistentry>
+       <term><option>-?</></term>
+       <term><option>--help</></term>
+       <listitem>
+       <para>
+       Show help about <application>dropuser</application> command line
+       arguments, and exit.
+       </para>
+       </listitem>
+     </varlistentry>
+
    </variablelist>
  </para>


--- a/doc/src/sgml/ref/ecpg-ref.sgml
+++ b/doc/src/sgml/ref/ecpg-ref.sgml
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/ecpg-ref.sgml,v 1.33 2010/02/19 03:50:03 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/ecpg-ref.sgml,v 1.34 2010/02/19 14:36:45 momjian Exp $
 PostgreSQL documentation
 -->

@@ -159,28 +159,30 @@ PostgreSQL documentation
     <listitem>
      <para>
       Print additional information including the version and the
-       include path.
+       "include" path.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
-     <term><option>--help</option></term>
+     <term><option>--version</option></term>
     <listitem>
      <para>
-       Show a brief summary of the command usage, then exit.
+       Print the <application>ecpg</application> version and exit.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
-     <term><option>--version</option></term>
+     <term><option>--help</option></term>
     <listitem>
      <para>
-       Output version information, then exit.
+       Show help about <application>ecpg</application> command line
+       arguments, and exit.
      </para>
     </listitem>
    </varlistentry>
+
   </variablelist>
  </para>
 </refsect1>

--- a/doc/src/sgml/ref/initdb.sgml
+++ b/doc/src/sgml/ref/initdb.sgml
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/initdb.sgml,v 1.45 2009/12/10 06:32:28 petere Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/initdb.sgml,v 1.46 2010/02/19 14:36:45 momjian Exp $
 PostgreSQL documentation
 -->

@@ -280,6 +280,28 @@ PostgreSQL documentation
       </para>
      </listitem>
     </varlistentry>
+
+     <varlistentry>
+       <term><option>-V</></term>
+       <term><option>--version</></term>
+       <listitem>
+       <para>
+       Print the <application>initdb</application> version and exit.
+       </para>
+       </listitem>
+     </varlistentry>
+
+     <varlistentry>
+       <term><option>-?</></term>
+       <term><option>--help</></term>
+       <listitem>
+       <para>
+       Show help about <application>initdb</application> command line
+       arguments, and exit.
+       </para>
+       </listitem>
+     </varlistentry>
+
    </variablelist>
   </para>


--- a/doc/src/sgml/ref/pg_controldata.sgml
+++ b/doc/src/sgml/ref/pg_controldata.sgml
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/pg_controldata.sgml,v 1.11 2008/09/23 09:20:35 heikki Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/pg_controldata.sgml,v 1.12 2010/02/19 14:36:45 momjian Exp $
 PostgreSQL documentation
 -->

@@ -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 <envar>PGDATA</>.
+   the environment variable <envar>PGDATA</>.  This utility supports the options
+   <literal>-V</> and <literal>--version</>, which print the
+   <application>pg_controldata</application> version and exit.  It also
+   supports options <literal>-?</> and <literal>--help</>, which output the
+   supported arguments.
  </para>
 </refsect1>


--- a/doc/src/sgml/ref/pg_dump.sgml
+++ b/doc/src/sgml/ref/pg_dump.sgml
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.115 2010/02/19 03:50:03 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/pg_dump.sgml,v 1.116 2010/02/19 14:36:45 momjian Exp $
 PostgreSQL documentation
 -->

@@ -483,6 +483,16 @@ PostgreSQL documentation
      </listitem>
     </varlistentry>

+     <varlistentry>
+       <term><option>-V</></term>
+       <term><option>--version</></term>
+       <listitem>
+       <para>
+       Print the <application>pg_dump</application> version and exit.
+       </para>
+       </listitem>
+     </varlistentry>
+
     <varlistentry>
      <term><option>-x</></term>
      <term><option>--no-privileges</></term>
@@ -645,6 +655,18 @@ PostgreSQL documentation
       </para>
      </listitem>
     </varlistentry>
+
+     <varlistentry>
+       <term><option>-?</></term>
+       <term><option>--help</></term>
+       <listitem>
+       <para>
+       Show help about <application>pg_dump</application> command line
+       arguments, and exit.
+       </para>
+       </listitem>
+     </varlistentry>
+
    </variablelist>
   </para>


--- a/doc/src/sgml/ref/pg_dumpall.sgml
+++ b/doc/src/sgml/ref/pg_dumpall.sgml
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/pg_dumpall.sgml,v 1.80 2010/02/19 03:50:03 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/pg_dumpall.sgml,v 1.81 2010/02/19 14:36:45 momjian Exp $
 PostgreSQL documentation
 -->

@@ -248,6 +248,16 @@ PostgreSQL documentation
      </listitem>
     </varlistentry>

+     <varlistentry>
+       <term><option>-V</></term>
+       <term><option>--version</></term>
+       <listitem>
+       <para>
+       Print the <application>pg_dumpall</application> version and exit.
+       </para>
+       </listitem>
+     </varlistentry>
+
     <varlistentry>
      <term><option>-x</></term>
      <term><option>--no-privileges</></term>
@@ -346,6 +356,17 @@ PostgreSQL documentation
      </listitem>
     </varlistentry>

+     <varlistentry>
+       <term><option>-?</></term>
+       <term><option>--help</></term>
+       <listitem>
+       <para>
+       Show help about <application>pg_dumpall</application> command line
+       arguments, and exit.
+       </para>
+       </listitem>
+     </varlistentry>
+
    </variablelist>
   </para>


--- a/doc/src/sgml/ref/pg_resetxlog.sgml
+++ b/doc/src/sgml/ref/pg_resetxlog.sgml
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/pg_resetxlog.sgml,v 1.21 2008/09/23 09:20:35 heikki Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/pg_resetxlog.sgml,v 1.22 2010/02/19 14:36:45 momjian Exp $
 PostgreSQL documentation
 -->

@@ -178,6 +178,14 @@ PostgreSQL documentation
   This is mainly a debugging tool, but can be useful as a sanity check
   before allowing <command>pg_resetxlog</command> to proceed for real.
  </para>
+
+  <para>
+   The <literal>-V</> and <literal>--version</> options print 
+   the <application>pg_resetxlog</application> version and exit.  The
+   options <literal>-?</> and <literal>--help</> show supported arguments,
+   and exit.
+  </para>
+
 </refsect1>

 <refsect1>

--- a/doc/src/sgml/ref/pg_restore.sgml
+++ b/doc/src/sgml/ref/pg_restore.sgml
-<!-- $PostgreSQL: pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.83 2010/02/19 03:50:03 momjian Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/ref/pg_restore.sgml,v 1.84 2010/02/19 14:36:45 momjian Exp $ -->

 <refentry id="APP-PGRESTORE">
 <refmeta>
@@ -402,6 +402,16 @@
      </listitem>
     </varlistentry>

+     <varlistentry>
+       <term><option>-V</></term>
+       <term><option>--version</></term>
+       <listitem>
+       <para>
+       Print the <application>pg_restore</application> version and exit.
+       </para>
+       </listitem>
+     </varlistentry>
+
     <varlistentry>
      <term><option>-x</option></term>
      <term><option>--no-privileges</option></term>
@@ -484,6 +494,17 @@
      </listitem>
     </varlistentry>

+     <varlistentry>
+       <term><option>-?</></term>
+       <term><option>--help</></term>
+       <listitem>
+       <para>
+       Show help about <application>pg_restore</application> command line
+       arguments, and exit.
+       </para>
+       </listitem>
+     </varlistentry>
+
    </variablelist>
   </para>


--- a/doc/src/sgml/ref/psql-ref.sgml
+++ b/doc/src/sgml/ref/psql-ref.sgml
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/psql-ref.sgml,v 1.238 2010/02/19 03:50:03 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/psql-ref.sgml,v 1.239 2010/02/19 14:36:45 momjian Exp $
 PostgreSQL documentation
 -->

@@ -514,6 +514,7 @@ PostgreSQL documentation
      </para>
      </listitem>
    </varlistentry>
+
  </variablelist>
 </refsect1>


--- a/doc/src/sgml/ref/reindexdb.sgml
+++ b/doc/src/sgml/ref/reindexdb.sgml
@@ -139,7 +139,30 @@ PostgreSQL documentation
       </para>
      </listitem>
     </varlistentry>
-    </variablelist>
+
+    <varlistentry>
+      <term><option>-V</></term>
+      <term><option>--version</></term>
+      <listitem>
+       <para>
+       Print the <application>reindexdb</application> version and exit.
+       </para>
+      </listitem>
+    </varlistentry>
+
+    <varlistentry>
+      <term><option>-?</></term>
+      <term><option>--help</></term>
+      <listitem>
+      <para>
+      Show help about <application>reindexdb</application> command line
+      arguments, and exit.
+      </para>
+      </listitem>
+    </varlistentry>
+
+   </variablelist>
+
   </para>

   <para>

--- a/doc/src/sgml/ref/vacuumdb.sgml
+++ b/doc/src/sgml/ref/vacuumdb.sgml
 <!--
-$PostgreSQL: pgsql/doc/src/sgml/ref/vacuumdb.sgml,v 1.51 2010/02/19 03:50:03 momjian Exp $
+$PostgreSQL: pgsql/doc/src/sgml/ref/vacuumdb.sgml,v 1.52 2010/02/19 14:36:45 momjian Exp $
 PostgreSQL documentation
 -->

@@ -175,6 +175,16 @@ PostgreSQL documentation
      </listitem>
     </varlistentry>

+     <varlistentry>
+       <term><option>-V</></term>
+       <term><option>--version</></term>
+       <listitem>
+       <para>
+       Print the <application>vacuumdb</application> version and exit.
+       </para>
+       </listitem>
+     </varlistentry>
+
     <varlistentry>
      <term><option>-z</option></term>
      <term><option>--analyze</option></term>
@@ -185,6 +195,17 @@ PostgreSQL documentation
      </listitem>
     </varlistentry>

+     <varlistentry>
+       <term><option>-?</></term>
+       <term><option>--help</></term>
+       <listitem>
+       <para>
+       Show help about <application>vacuumdb</application> command line
+       arguments, and exit.
+       </para>
+       </listitem>
+     </varlistentry>
+
    </variablelist>
   </para>