Skip to content

P
Postgres FD Implementation
Commit 238d21d7 authored by Bruce Momjian's avatar Bruce Momjian
Browse files
Options

Modify pg_standby, pgbench, and pg_upgrade manual pages to be consistent 

in their display of command-line options with other client applications.
parent 7ff79fa4
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 411 additions and 329 deletions
contrib/pg_upgrade/option.c
View file @ 238d21d7
......@@ -226,21 +226,21 @@ usage(migratorContext *ctx)
printf(_("\nUsage: pg_upgrade [OPTIONS]...\n\
\n\
Options:\n\
-b, --old-bindir=OLDBINDIR old cluster executable directory\n\
-B, --new-bindir=NEWBINDIR new cluster executable directory\n\
-c, --check check clusters only, don't change any data\n\
-d, --old-datadir=OLDDATADIR old cluster data directory\n\
-D, --new-datadir=NEWDATADIR new cluster data directory\n\
-g, --debug enable debugging\n\
-G, --debugfile=DEBUGFILENAME output debugging activity to file\n\
-k, --link link instead of copying files to new cluster\n\
-l, --logfile=LOGFILENAME log session activity to file\n\
-p, --old-port=portnum old cluster port number (default %d)\n\
-P, --new-port=portnum new cluster port number (default %d)\n\
-u, --user=username clusters superuser (default \"%s\")\n\
-v, --verbose enable verbose output\n\
-V, --version display version information, then exit\n\
-h, --help show this help, then exit\n\
-b, --old-bindir=old_bindir old cluster executable directory\n\
-B, --new-bindir=new_bindir new cluster executable directory\n\
-c, --check check clusters only, don't change any data\n\
-d, --old-datadir=old_datadir old cluster data directory\n\
-D, --new-datadir=new_datadir new cluster data directory\n\
-g, --debug enable debugging\n\
-G, --debugfile=debug_filename output debugging activity to file\n\
-k, --link link instead of copying files to new cluster\n\
-l, --logfile=log_filename log session activity to file\n\
-p, --old-port=old_portnum old cluster port number (default %d)\n\
-P, --new-port=new_portnum new cluster port number (default %d)\n\
-u, --user=username clusters superuser (default \"%s\")\n\
-v, --verbose enable verbose output\n\
-V, --version display version information, 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\
......
doc/src/sgml/oid2name.sgml
View file @ 238d21d7
<!-- $PostgreSQL: pgsql/doc/src/sgml/oid2name.sgml,v 1.7 2010/05/20 03:45:38 momjian Exp $ -->
<!-- $PostgreSQL: pgsql/doc/src/sgml/oid2name.sgml,v 1.8 2010/05/25 15:55:28 momjian Exp $ -->
<sect1 id="oid2name">
<title>oid2name</title>
......@@ -36,7 +36,7 @@
</sect2>
<sect2>
<title><application>oid2name</> options</title>
<title><application>oid2name</> Options</title>
<para>
<application>oid2name</application> accepts the following command-line arguments:
......
doc/src/sgml/pgbench.sgml
View file @ 238d21d7
This diff is collapsed.
doc/src/sgml/pgstandby.sgml
View file @ 238d21d7
<!-- $PostgreSQL: pgsql/doc/src/sgml/pgstandby.sgml,v 2.10 2009/06/25 12:03:11 heikki Exp $ -->
<!-- $PostgreSQL: pgsql/doc/src/sgml/pgstandby.sgml,v 2.11 2010/05/25 15:55:28 momjian Exp $ -->
<sect1 id="pgstandby">
<title>pg_standby</title>
......@@ -122,99 +122,114 @@ pg_standby <optional> <replaceable>option</> ... </optional> <replaceable>archiv
</variablelist>
</para>
<table>
<title><application>pg_standby</> options</title>
<tgroup cols="3">
<thead>
<row>
<entry>Option</entry>
<entry>Default</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>-c</></entry>
<entry>yes</entry>
<entry>
Use <literal>cp</> or <literal>copy</> command to restore WAL files
from archive.
</entry>
</row>
<row>
<entry><literal>-d</></entry>
<entry>no</entry>
<entry>Print lots of debug logging output on <filename>stderr</>.</entry>
</row>
<row>
<entry><literal>-k</> <replaceable>numfiles</></entry>
<entry>0</entry>
<entry>
Remove files from <replaceable>archivelocation</replaceable> so that
no more than this many WAL files before the current one are kept in the
archive. Zero (the default) means not to remove any files from
<replaceable>archivelocation</replaceable>.
This parameter will be silently ignored if
<replaceable>restartwalfile</replaceable> is specified, since that
specification method is more accurate in determining the correct
archive cut-off point.
Use of this parameter is <emphasis>deprecated</> as of
<productname>PostgreSQL</> 8.3; it is safer and more efficient to
specify a <replaceable>restartwalfile</replaceable> parameter. A too
small setting could result in removal of files that are still needed
for a restart of the standby server, while a too large setting wastes
archive space.
</entry>
</row>
<row>
<entry><literal>-r</> <replaceable>maxretries</></entry>
<entry>3</entry>
<entry>
Set the maximum number of times to retry the copy command if it
fails. After each failure, we wait for <replaceable>sleeptime</> *
<replaceable>num_retries</>
</sect2>
<sect2>
<title><application>pg_standby</> Options</title>
<para>
<application>pg_standby</application> accepts the following command-line arguments:
<variablelist>
<varlistentry>
<term><option>-c</option></term>
<listitem>
<para>
Use <literal>cp</> or <literal>copy</> command to restore WAL files
from archive. This is the only supported behavior so this option is useless.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-d</option></term>
<listitem>
<para>
Print lots of debug logging output on <filename>stderr</>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-k</option></term>
<listitem>
<para>
Remove files from <replaceable>archivelocation</replaceable> so that
no more than this many WAL files before the current one are kept in the
archive. Zero (the default) means not to remove any files from
<replaceable>archivelocation</replaceable>.
This parameter will be silently ignored if
<replaceable>restartwalfile</replaceable> is specified, since that
specification method is more accurate in determining the correct
archive cut-off point.
Use of this parameter is <emphasis>deprecated</> as of
<productname>PostgreSQL</> 8.3; it is safer and more efficient to
specify a <replaceable>restartwalfile</replaceable> parameter. A too
small setting could result in removal of files that are still needed
for a restart of the standby server, while a too large setting wastes
archive space.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-r</option> <replaceable>maxretries</></term>
<listitem>
<para>
Set the maximum number of times to retry the copy command if
it fails (default 3). After each failure, we wait for
<replaceable>sleeptime</> * <replaceable>num_retries</>
so that the wait time increases progressively. So by default,
we will wait 5 secs, 10 secs, then 15 secs before reporting
the failure back to the standby server. This will be
interpreted as end of recovery and the standby will come
up fully as a result.
</entry>
</row>
<row>
<entry><literal>-s</> <replaceable>sleeptime</></entry>
<entry>5</entry>
<entry>
Set the number of seconds (up to 60) to sleep between tests to see
if the WAL file to be restored is available in the archive yet.
The default setting is not necessarily recommended;
consult <xref linkend="warm-standby"> for discussion.
</entry>
</row>
<row>
<entry><literal>-t</> <replaceable>triggerfile</></entry>
<entry>none</entry>
<entry>
Specify a trigger file whose presence should cause failover.
It is recommended that you use a structured filename to
avoid confusion as to which server is being triggered
when multiple servers exist on the same system; for example
<filename>/tmp/pgsql.trigger.5432</>.
</entry>
</row>
<row>
<entry><literal>-w</> <replaceable>maxwaittime</></entry>
<entry>0</entry>
<entry>
Set the maximum number of seconds to wait for the next WAL file,
after which a fast failover will be performed.
A setting of zero (the default) means wait forever.
The default setting is not necessarily recommended;
consult <xref linkend="warm-standby"> for discussion.
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-s</option> <replaceable>sleeptime</></term>
<listitem>
<para>
Set the number of seconds (up to 60, default 5) to sleep between
tests to see if the WAL file to be restored is available in
the archive yet. The default setting is not necessarily
recommended; consult <xref linkend="warm-standby"> for discussion.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-t</option> <replaceable>triggerfile</></term>
<listitem>
<para>
Specify a trigger file whose presence should cause failover.
It is recommended that you use a structured filename to
avoid confusion as to which server is being triggered
when multiple servers exist on the same system; for example
<filename>/tmp/pgsql.trigger.5432</>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-w</option> <replaceable>maxwaittime</></term>
<listitem>
<para>
Set the maximum number of seconds to wait for the next WAL file,
after which a fast failover will be performed.
A setting of zero (the default) means wait forever.
The default setting is not necessarily recommended;
consult <xref linkend="warm-standby"> for discussion.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</sect2>
<sect2>
......
doc/src/sgml/pgupgrade.sgml
View file @ 238d21d7
<!-- $PostgreSQL: pgsql/doc/src/sgml/pgupgrade.sgml,v 1.11 2010/05/25 14:50:56 momjian Exp $ -->
<!-- $PostgreSQL: pgsql/doc/src/sgml/pgupgrade.sgml,v 1.12 2010/05/25 15:55:28 momjian Exp $ -->
<sect1 id="pgupgrade">
<title>pg_upgrade</title>
......@@ -38,7 +38,7 @@
</sect2>
<sect2>
<title><application>pg_upgrade</> options</title>
<title><application>pg_upgrade</> Options</title>
<para>
<application>pg_upgrade</application> accepts the following command-line arguments:
......@@ -46,13 +46,13 @@
<variablelist>
<varlistentry>
<term><option>-b</option> <replaceable>OLDBINDIR</></term>
<term><option>-b</option> <replaceable>old_bindir</></term>
<term><option>--old-bindir</option> <replaceable>OLDBINDIR</></term>
<listitem><para>specify the old cluster executable directory</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-B</option> <replaceable>NEWBINDIR</></term>
<term><option>-B</option> <replaceable>new_bindir</></term>
<term><option>--new-bindir</option> <replaceable>NEWBINDIR</></term>
<listitem><para>specify the new cluster executable directory</para></listitem>
</varlistentry>
......@@ -64,13 +64,13 @@
</varlistentry>
<varlistentry>
<term><option>-d</option> <replaceable>OLDDATADIR</></term>
<term><option>-d</option> <replaceable>old_datadir</></term>
<term><option>--old-datadir</option> <replaceable>OLDDATADIR</></term>
<listitem><para>specify the old cluster data directory</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-D</option> <replaceable>NEWDATADIR</></term>
<term><option>-D</option> <replaceable>new_datadir</></term>
<term><option>--new-datadir</option> <replaceable>NEWDATADIR</></term>
<listitem><para>specify the new cluster data directory</para></listitem>
</varlistentry>
......@@ -82,7 +82,7 @@
</varlistentry>
<varlistentry>
<term><option>-G</option> <replaceable>DEBUGFILENAME</></term>
<term><option>-G</option> <replaceable>debug_filename</></term>
<term><option>--debugfile</option> <replaceable>DEBUGFILENAME</></term>
<listitem><para>output debugging activity to file</para></listitem>
</varlistentry>
......@@ -94,19 +94,19 @@
</varlistentry>
<varlistentry>
<term><option>-l</option> <replaceable>LOGFILENAME</></term>
<term><option>-l</option> <replaceable>log_filename</></term>
<term><option>--logfile</option> <replaceable>LOGFILENAME</></term>
<listitem><para>log session activity to file</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-p</option> <replaceable>portnum</></term>
<term><option>-p</option> <replaceable>old_portnum</></term>
<term><option>--old-port</option> <replaceable>portnum</></term>
<listitem><para>specify the old cluster port number</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-P</option> <replaceable>portnum</></term>
<term><option>-P</option> <replaceable>new_portnum</></term>
<term><option>--new-port</option> <replaceable>portnum</></term>
<listitem><para>specify the new cluster port number</para></listitem>
</varlistentry>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment