Add command-line documentation for pg_upgrade.

2 files changed, 113 insertions, 10 deletions

diff --git a/doc/src/sgml/oid2name.sgml b/doc/src/sgml/oid2name.sgml
index d2ab3f4c226..cf73cc9c154 100644
--- a/doc/src/sgml/oid2name.sgml
+++ b/doc/src/sgml/oid2name.sgml
@@ -1,4 +1,4 @@
-<!-- $PostgreSQL: pgsql/doc/src/sgml/oid2name.sgml,v 1.4 2007/12/11 02:31:49 tgl Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/oid2name.sgml,v 1.5 2010/05/19 20:20:38 momjian Exp $ -->
 
 <sect1 id="oid2name">
  <title>oid2name</title>
@@ -31,16 +31,16 @@
    <application>oid2name</application> connects to a target database and
    extracts OID, filenode, and/or table name information.  You can also have
    it show database OIDs or tablespace OIDs.  The program is controlled by
-   a large number of command-line switches, as shown in
-   <xref linkend="oid2name-switches">.
+   a large number of command-line options, as shown in
+   <xref linkend="oid2name-options">.
   </para>
 
-  <table id="oid2name-switches">
-   <title><application>oid2name</> switches</title>
+  <table id="oid2name-options">
+   <title><application>oid2name</> options</title>
    <tgroup cols="2">
     <thead>
      <row>
-      <entry>Switch</entry>
+      <entry>Option</entry>
       <entry>Description</entry>
      </row>
     </thead>
@@ -122,8 +122,8 @@
    and <literal>-t</> takes a tablename (actually, it's a LIKE
    pattern, so you can use things like <literal>foo%</>).
    You can use as many
-   of these switches as you like, and the listing will include all objects
-   matched by any of the switches.  But note that these switches can only
+   of these options as you like, and the listing will include all objects
+   matched by any of the options.  But note that these options can only
    show objects in the database given by <literal>-d</>.
   </para>
 
@@ -131,7 +131,7 @@
    If you don't give any of <literal>-o</>, <literal>-f</> or <literal>-t</>,
    but do give <literal>-d</>, it will list all tables in the database
    named by <literal>-d</>.  In this mode, the <literal>-S</> and
-   <literal>-i</> switches control what gets listed.
+   <literal>-i</> options control what gets listed.
   </para>
 
   <para>
diff --git a/doc/src/sgml/pgupgrade.sgml b/doc/src/sgml/pgupgrade.sgml
index 0fd13fa7037..c12a3bb4da1 100644
--- a/doc/src/sgml/pgupgrade.sgml
+++ b/doc/src/sgml/pgupgrade.sgml
@@ -1,4 +1,4 @@
-<!-- $PostgreSQL: pgsql/doc/src/sgml/pgupgrade.sgml,v 1.5 2010/05/18 15:41:36 mha Exp $ -->
+<!-- $PostgreSQL: pgsql/doc/src/sgml/pgupgrade.sgml,v 1.6 2010/05/19 20:20:38 momjian Exp $ -->
 
 <sect1 id="pgupgrade">
  <title>pg_upgrade</title>
@@ -28,6 +28,109 @@
  </sect2>
 
  <sect2>
+  <title><application>pg_upgrade</> options</title>
+
+   <para>
+    <application>pg_upgrade</application> accepts the following command-line arguments:
+
+    <variablelist>
+
+     <varlistentry>
+      <term><literal>-d</literal> <replaceable>OLDDATADIR</></term>
+      <term><literal>--old-datadir</literal> <replaceable>OLDDATADIR</></term>
+      <listitem><para>specify the old cluster data directory</para></listitem>
+     </varlistentry>
+
+     <varlistentry>
+      <term><literal>-D</literal> <replaceable>NEWDATADIR</></term>
+      <term><literal>--new-datadir</literal> <replaceable>NEWDATADIR</></term>
+      <listitem><para>specify the new cluster data directory</para></listitem>
+     </varlistentry>
+
+     <varlistentry>
+      <term><literal>-b</literal> <replaceable>OLDBINDIR</></term>
+      <term><literal>--old-bindir</literal> <replaceable>OLDBINDIR</></term>
+      <listitem><para>specify the old cluster executable directory</para></listitem>
+     </varlistentry>
+
+     <varlistentry>
+      <term><literal>-B</literal> <replaceable>NEWBINDIR</></term>
+      <term><literal>--new-bindir</literal> <replaceable>NEWBINDIR</></term>
+      <listitem><para>specify the new cluster executable directory</para></listitem>
+     </varlistentry>
+
+     <varlistentry>
+      <term><literal>-p</literal> <replaceable>portnum</></term>
+      <term><literal>--old-port</literal> <replaceable>portnum</></term>
+      <listitem><para>specify the old cluster port number</para></listitem>
+     </varlistentry>
+
+     <varlistentry>
+      <term><literal>-P</literal> <replaceable>portnum</></term>
+      <term><literal>--new-port</literal> <replaceable>portnum</></term>
+      <listitem><para>specify the new cluster port number</para></listitem>
+     </varlistentry>
+
+     <varlistentry>
+      <term><literal>-u</literal> <replaceable>username</></term>
+      <term><literal>--user</literal> <replaceable>username</></term>
+      <listitem><para>clusters superuser</para></listitem>
+     </varlistentry>
+
+     <varlistentry>
+      <term><literal>-c</literal></term>
+      <term><literal>--check</literal></term>
+      <listitem><para>check clusters only, don't change any data</para></listitem>
+     </varlistentry>
+
+     <varlistentry>
+      <term><literal>-d</literal></term>
+      <term><literal>--debug</literal></term>
+      <listitem><para>enable debugging</para></listitem>
+     </varlistentry>
+
+     <varlistentry>
+      <term><literal>-G</literal> <replaceable>DEBUGFILENAME</></term>
+      <term><literal>--debugfile</literal> <replaceable>DEBUGFILENAME</></term>
+      <listitem><para>output debugging activity to file</para></listitem>
+     </varlistentry>
+
+     <varlistentry>
+      <term><literal>-k</literal></term>
+      <term><literal>--link</literal></term>
+      <listitem><para>link instead of copying files to new cluster</para></listitem>
+     </varlistentry>
+
+     <varlistentry>
+      <term><literal>-l</literal> <replaceable>LOGFILENAME</></term>
+      <term><literal>--logfile</literal> <replaceable>LOGFILENAME</></term>
+      <listitem><para>log session activity to file</para></listitem>
+     </varlistentry>
+
+     <varlistentry>
+      <term><literal>-v</literal></term>
+      <term><literal>--verbose</literal></term>
+      <listitem><para>enable verbose output</para></listitem>
+     </varlistentry>
+
+     <varlistentry>
+      <term><literal>-V</literal></term>
+      <term><literal>--version</literal></term>
+      <listitem><para>display version information, then exit</para></listitem>
+     </varlistentry>
+
+     <varlistentry>
+      <term><literal>-h</literal></term>
+      <term><literal>--help</literal></term>
+      <listitem><para>show help, then exit</para></listitem>
+     </varlistentry>
+
+    </variablelist>
+   </para>
+
+ </sect2>
+
+ <sect2>
   <title>Upgrade Steps</title>
 
   <orderedlist>