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

diff --git a/doc/src/sgml/ref/pg_xlogdump.sgml b/doc/src/sgml/ref/pg_xlogdump.sgml
index 177caab00d4e524e822787b56eac98b417bc1267..16ca4434231274ccebed1d84699931848485140e 100644 (file)
--- a/doc/src/sgml/ref/pg_xlogdump.sgml
+++ b/doc/src/sgml/ref/pg_xlogdump.sgml
@@ -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>

diff --git a/src/bin/pg_xlogdump/pg_xlogdump.c b/src/bin/pg_xlogdump/pg_xlogdump.c
index 9ad9321e1f9361f08d9f44212842ee011bff018b..5c546ceb79784316833fe518ef3d7b71a4c5b638 100644 (file)
--- a/src/bin/pg_xlogdump/pg_xlogdump.c
+++ b/src/bin/pg_xlogdump/pg_xlogdump.c
@@ -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");