pg_xlogdump: document --path behavior

The previous --path documentation and --help output were wrong in both
its meaning and the defaults.

Reviewed-by: Michael Paquier

Backpatch-through: 9.6
This commit is contained in:
Bruce Momjian 2017-01-10 22:38:13 -05:00
parent 22a85b3fbe
commit 1c15f84348
2 changed files with 9 additions and 5 deletions

View File

@ -117,9 +117,12 @@ PostgreSQL documentation
<term><option>--path=<replaceable>path</replaceable></option></term>
<listitem>
<para>
Directory in which to find log segment files. The default is to search
for them in the <literal>pg_xlog</literal> subdirectory of the current
directory.
Specifies a directory to search for log segment files or a
directory with a <literal>pg_xlog</literal> subdirectory that
contains such files. The default is to search in the current
directory, the <literal>pg_xlog</literal> subdirectory of the
current directory, and the <literal>pg_xlog</literal> subdirectory
of <envar>PGDATA</envar>.
</para>
</listitem>
</varlistentry>

View File

@ -679,8 +679,9 @@ usage(void)
printf(" -e, --end=RECPTR stop reading at log position RECPTR\n");
printf(" -f, --follow keep retrying after reaching end of WAL\n");
printf(" -n, --limit=N number of records to display\n");
printf(" -p, --path=PATH directory in which to find log segment files\n");
printf(" (default: ./pg_xlog)\n");
printf(" -p, --path=PATH directory in which to find log segment files or a\n");
printf(" directory with a ./pg_xlog that contains such files\n"
" (default: current directory, ./pg_xlog, PGDATA/pg_xlog)\n");
printf(" -r, --rmgr=RMGR only show records generated by resource manager RMGR\n");
printf(" use --rmgr=list to list valid resource manager names\n");
printf(" -s, --start=RECPTR start reading at log position RECPTR\n");