Skip to content

Commit 67fd5f3

Browse files
bmomjianbmomjian
committed
Add command-line documentation for pg_upgrade.
1 parent 3245bd5 commit 67fd5f3

File tree

2 files changed

+113
-10
lines changed

2 files changed

+113
-10
lines changed

‎doc/src/sgml/oid2name.sgml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $PostgreSQL: pgsql/doc/src/sgml/oid2name.sgml,v 1.4 2007/12/11 02:31:49 tgl Exp $ -->
1+
<!-- $PostgreSQL: pgsql/doc/src/sgml/oid2name.sgml,v 1.5 2010/05/19 20:20:38 momjian Exp $ -->
22

33
<sect1 id="oid2name">
44
<title>oid2name</title>
@@ -31,16 +31,16 @@
3131
<application>oid2name</application> connects to a target database and
3232
extracts OID, filenode, and/or table name information. You can also have
3333
it show database OIDs or tablespace OIDs. The program is controlled by
34-
a large number of command-line switches, as shown in
35-
<xref linkend="oid2name-switches">.
34+
a large number of command-line options, as shown in
35+
<xref linkend="oid2name-options">.
3636
</para>
3737

38-
<table id="oid2name-switches">
39-
<title><application>oid2name</> switches</title>
38+
<table id="oid2name-options">
39+
<title><application>oid2name</> options</title>
4040
<tgroup cols="2">
4141
<thead>
4242
<row>
43-
<entry>Switch</entry>
43+
<entry>Option</entry>
4444
<entry>Description</entry>
4545
</row>
4646
</thead>
@@ -122,16 +122,16 @@
122122
and <literal>-t</> takes a tablename (actually, it's a LIKE
123123
pattern, so you can use things like <literal>foo%</>).
124124
You can use as many
125-
of these switches as you like, and the listing will include all objects
126-
matched by any of the switches. But note that these switches can only
125+
of these options as you like, and the listing will include all objects
126+
matched by any of the options. But note that these options can only
127127
show objects in the database given by <literal>-d</>.
128128
</para>
129129

130130
<para>
131131
If you don't give any of <literal>-o</>, <literal>-f</> or <literal>-t</>,
132132
but do give <literal>-d</>, it will list all tables in the database
133133
named by <literal>-d</>. In this mode, the <literal>-S</> and
134-
<literal>-i</> switches control what gets listed.
134+
<literal>-i</> options control what gets listed.
135135
</para>
136136

137137
<para>

‎doc/src/sgml/pgupgrade.sgml

Lines changed: 104 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!-- $PostgreSQL: pgsql/doc/src/sgml/pgupgrade.sgml,v 1.5 2010/05/18 15:41:36 mha Exp $ -->
1+
<!-- $PostgreSQL: pgsql/doc/src/sgml/pgupgrade.sgml,v 1.6 2010/05/19 20:20:38 momjian Exp $ -->
22

33
<sect1 id="pgupgrade">
44
<title>pg_upgrade</title>
@@ -27,6 +27,109 @@
2727

2828
</sect2>
2929

30+
<sect2>
31+
<title><application>pg_upgrade</> options</title>
32+
33+
<para>
34+
<application>pg_upgrade</application> accepts the following command-line arguments:
35+
36+
<variablelist>
37+
38+
<varlistentry>
39+
<term><literal>-d</literal> <replaceable>OLDDATADIR</></term>
40+
<term><literal>--old-datadir</literal> <replaceable>OLDDATADIR</></term>
41+
<listitem><para>specify the old cluster data directory</para></listitem>
42+
</varlistentry>
43+
44+
<varlistentry>
45+
<term><literal>-D</literal> <replaceable>NEWDATADIR</></term>
46+
<term><literal>--new-datadir</literal> <replaceable>NEWDATADIR</></term>
47+
<listitem><para>specify the new cluster data directory</para></listitem>
48+
</varlistentry>
49+
50+
<varlistentry>
51+
<term><literal>-b</literal> <replaceable>OLDBINDIR</></term>
52+
<term><literal>--old-bindir</literal> <replaceable>OLDBINDIR</></term>
53+
<listitem><para>specify the old cluster executable directory</para></listitem>
54+
</varlistentry>
55+
56+
<varlistentry>
57+
<term><literal>-B</literal> <replaceable>NEWBINDIR</></term>
58+
<term><literal>--new-bindir</literal> <replaceable>NEWBINDIR</></term>
59+
<listitem><para>specify the new cluster executable directory</para></listitem>
60+
</varlistentry>
61+
62+
<varlistentry>
63+
<term><literal>-p</literal> <replaceable>portnum</></term>
64+
<term><literal>--old-port</literal> <replaceable>portnum</></term>
65+
<listitem><para>specify the old cluster port number</para></listitem>
66+
</varlistentry>
67+
68+
<varlistentry>
69+
<term><literal>-P</literal> <replaceable>portnum</></term>
70+
<term><literal>--new-port</literal> <replaceable>portnum</></term>
71+
<listitem><para>specify the new cluster port number</para></listitem>
72+
</varlistentry>
73+
74+
<varlistentry>
75+
<term><literal>-u</literal> <replaceable>username</></term>
76+
<term><literal>--user</literal> <replaceable>username</></term>
77+
<listitem><para>clusters superuser</para></listitem>
78+
</varlistentry>
79+
80+
<varlistentry>
81+
<term><literal>-c</literal></term>
82+
<term><literal>--check</literal></term>
83+
<listitem><para>check clusters only, don't change any data</para></listitem>
84+
</varlistentry>
85+
86+
<varlistentry>
87+
<term><literal>-d</literal></term>
88+
<term><literal>--debug</literal></term>
89+
<listitem><para>enable debugging</para></listitem>
90+
</varlistentry>
91+
92+
<varlistentry>
93+
<term><literal>-G</literal> <replaceable>DEBUGFILENAME</></term>
94+
<term><literal>--debugfile</literal> <replaceable>DEBUGFILENAME</></term>
95+
<listitem><para>output debugging activity to file</para></listitem>
96+
</varlistentry>
97+
98+
<varlistentry>
99+
<term><literal>-k</literal></term>
100+
<term><literal>--link</literal></term>
101+
<listitem><para>link instead of copying files to new cluster</para></listitem>
102+
</varlistentry>
103+
104+
<varlistentry>
105+
<term><literal>-l</literal> <replaceable>LOGFILENAME</></term>
106+
<term><literal>--logfile</literal> <replaceable>LOGFILENAME</></term>
107+
<listitem><para>log session activity to file</para></listitem>
108+
</varlistentry>
109+
110+
<varlistentry>
111+
<term><literal>-v</literal></term>
112+
<term><literal>--verbose</literal></term>
113+
<listitem><para>enable verbose output</para></listitem>
114+
</varlistentry>
115+
116+
<varlistentry>
117+
<term><literal>-V</literal></term>
118+
<term><literal>--version</literal></term>
119+
<listitem><para>display version information, then exit</para></listitem>
120+
</varlistentry>
121+
122+
<varlistentry>
123+
<term><literal>-h</literal></term>
124+
<term><literal>--help</literal></term>
125+
<listitem><para>show help, then exit</para></listitem>
126+
</varlistentry>
127+
128+
</variablelist>
129+
</para>
130+
131+
</sect2>
132+
30133
<sect2>
31134
<title>Upgrade Steps</title>
32135

0 commit comments

Comments
 (0)