Rename user-facing tools with "xlog" in the name to say "wal".

This means pg_receivexlog because pg_receivewal, pg_resetxlog
becomes pg_resetwal, and pg_xlogdump becomes pg_waldump.

Author: robertmhaas

doc/src/sgml/protocol.sgml

@@ -1321,7 +1321,7 @@ the connection to be used for logical replication from that database.
 psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
 </programlisting>
  However, it is often more useful to use
- <xref linkend="app-pgreceivexlog"> (for physical replication) or
+ <xref linkend="app-pgreceivewal"> (for physical replication) or
  <xref linkend="app-pgrecvlogical"> (for logical replication).
 </para>
 

doc/src/sgml/ref/allfiles.sgml

@@ -198,15 +198,15 @@ Complete list of usable sgml source files in this directory.
 <!ENTITY pgDump             SYSTEM "pg_dump.sgml">
 <!ENTITY pgDumpall          SYSTEM "pg_dumpall.sgml">
 <!ENTITY pgIsready          SYSTEM "pg_isready.sgml">
-<!ENTITY pgReceivexlog      SYSTEM "pg_receivexlog.sgml">
+<!ENTITY pgReceivewal       SYSTEM "pg_receivewal.sgml">
 <!ENTITY pgRecvlogical      SYSTEM "pg_recvlogical.sgml">
-<!ENTITY pgResetxlog        SYSTEM "pg_resetxlog.sgml">
+<!ENTITY pgResetwal         SYSTEM "pg_resetwal.sgml">
 <!ENTITY pgRestore          SYSTEM "pg_restore.sgml">
 <!ENTITY pgRewind           SYSTEM "pg_rewind.sgml">
 <!ENTITY pgtestfsync        SYSTEM "pgtestfsync.sgml">
 <!ENTITY pgtesttiming       SYSTEM "pgtesttiming.sgml">
 <!ENTITY pgupgrade          SYSTEM "pgupgrade.sgml">
-<!ENTITY pgxlogdump         SYSTEM "pg_xlogdump.sgml">
+<!ENTITY pgwaldump         SYSTEM "pg_waldump.sgml">
 <!ENTITY postgres           SYSTEM "postgres-ref.sgml">
 <!ENTITY postmaster         SYSTEM "postmaster.sgml">
 <!ENTITY psqlRef            SYSTEM "psql-ref.sgml">

doc/src/sgml/ref/pg_receivexlog.sgml renamed to doc/src/sgml/ref/pg_receivewal.sgml

@@ -1,27 +1,27 @@
 <!--
-doc/src/sgml/ref/pg_receivexlog.sgml
+doc/src/sgml/ref/pg_receivewal.sgml
 PostgreSQL documentation
 -->
 
-<refentry id="app-pgreceivexlog">
- <indexterm zone="app-pgreceivexlog">
-  <primary>pg_receivexlog</primary>
+<refentry id="app-pgreceivewal">
+ <indexterm zone="app-pgreceivewal">
+  <primary>pg_receivewal</primary>
  </indexterm>
 
  <refmeta>
-  <refentrytitle>pg_receivexlog</refentrytitle>
+  <refentrytitle>pg_receivewal</refentrytitle>
   <manvolnum>1</manvolnum>
   <refmiscinfo>Application</refmiscinfo>
  </refmeta>
 
  <refnamediv>
-  <refname>pg_receivexlog</refname>
+  <refname>pg_receivewal</refname>
   <refpurpose>stream transaction logs from a <productname>PostgreSQL</productname> server</refpurpose>
  </refnamediv>
 
  <refsynopsisdiv>
   <cmdsynopsis>
-   <command>pg_receivexlog</command>
+   <command>pg_receivewal</command>
    <arg rep="repeat"><replaceable>option</></arg>
   </cmdsynopsis>
  </refsynopsisdiv>
@@ -31,7 +31,7 @@ PostgreSQL documentation
    Description
   </title>
   <para>
-   <application>pg_receivexlog</application> is used to stream the transaction log
+   <application>pg_receivewal</application> is used to stream the transaction log
    from a running <productname>PostgreSQL</productname> cluster. The transaction
    log is streamed using the streaming replication protocol, and is written
    to a local directory of files. This directory can be used as the archive
@@ -40,16 +40,16 @@ PostgreSQL documentation
   </para>
 
   <para>
-   <application>pg_receivexlog</application> streams the transaction
+   <application>pg_receivewal</application> streams the transaction
    log in real time as it's being generated on the server, and does not wait
    for segments to complete like <xref linkend="guc-archive-command"> does.
    For this reason, it is not necessary to set
    <xref linkend="guc-archive-timeout"> when using
-    <application>pg_receivexlog</application>.
+    <application>pg_receivewal</application>.
   </para>
 
   <para>
-   Unlike the WAL receiver of a PostgreSQL standby server, <application>pg_receivexlog</>
+   Unlike the WAL receiver of a PostgreSQL standby server, <application>pg_receivewal</>
    by default flushes WAL data only when a WAL file is closed.
    The option <option>--synchronous</> must be specified to flush WAL data
    in real time.
@@ -68,7 +68,7 @@ PostgreSQL documentation
 
   <para>
    If the connection is lost, or if it cannot be initially established,
-   with a non-fatal error, <application>pg_receivexlog</application> will
+   with a non-fatal error, <application>pg_receivewal</application> will
    retry the connection indefinitely, and reestablish streaming as soon
    as possible. To avoid this behavior, use the <literal>-n</literal>
    parameter.
@@ -132,17 +132,17 @@ PostgreSQL documentation
       <term><option>--slot=<replaceable class="parameter">slotname</replaceable></option></term>
       <listitem>
         <para>
-         Require <application>pg_receivexlog</application> to use an existing
+         Require <application>pg_receivewal</application> to use an existing
          replication slot (see <xref linkend="streaming-replication-slots">).
-         When this option is used, <application>pg_receivexlog</> will report
+         When this option is used, <application>pg_receivewal</> will report
          a flush position to the server, indicating when each segment has been
          synchronized to disk so that the server can remove that segment if it
          is not otherwise needed.
         </para>
 
         <para>
          When the replication client
-         of <application>pg_receivexlog</application> is configured on the
+         of <application>pg_receivewal</application> is configured on the
          server as a synchronous standby, then using a replication slot will
          report the flush position to the server, but only when a WAL file is
          closed.  Therefore, that configuration will cause transactions on the
@@ -164,7 +164,7 @@ PostgreSQL documentation
 
        <para>
         This option should be specified if the replication client
-        of <application>pg_receivexlog</application> is configured on the
+        of <application>pg_receivewal</application> is configured on the
         server as a synchronous standby, to ensure that timely feedback is
         sent to the server.
        </para>
@@ -209,7 +209,7 @@ PostgreSQL documentation
        </para>
        <para>
         The option is called <literal>--dbname</> for consistency with other
-        client applications, but because <application>pg_receivexlog</application>
+        client applications, but because <application>pg_receivewal</application>
         doesn't connect to any particular database in the cluster, database
         name in the connection string will be ignored.
        </para>
@@ -273,15 +273,15 @@ PostgreSQL documentation
       <term><option>--password</option></term>
       <listitem>
        <para>
-        Force <application>pg_receivexlog</application> to prompt for a
+        Force <application>pg_receivewal</application> to prompt for a
         password before connecting to a database.
        </para>
 
        <para>
         This option is never essential, since
-        <application>pg_receivexlog</application> will automatically prompt
+        <application>pg_receivewal</application> will automatically prompt
         for a password if the server demands password authentication.
-        However, <application>pg_receivexlog</application> will waste a
+        However, <application>pg_receivewal</application> will waste a
         connection attempt finding out that the server wants a password.
         In some cases it is worth typing <option>-W</> to avoid the extra
         connection attempt.
@@ -292,7 +292,7 @@ PostgreSQL documentation
    </para>
 
    <para>
-    <application>pg_receivexlog</application> can perform one of the two
+    <application>pg_receivewal</application> can perform one of the two
     following actions in order to control physical replication slots:
 
     <variablelist>
@@ -327,7 +327,7 @@ PostgreSQL documentation
        <term><option>--version</></term>
        <listitem>
        <para>
-       Print the <application>pg_receivexlog</application> version and exit.
+       Print the <application>pg_receivewal</application> version and exit.
        </para>
        </listitem>
      </varlistentry>
@@ -337,7 +337,7 @@ PostgreSQL documentation
        <term><option>--help</></term>
        <listitem>
        <para>
-       Show help about <application>pg_receivexlog</application> command line
+       Show help about <application>pg_receivewal</application> command line
        arguments, and exit.
        </para>
        </listitem>
@@ -363,7 +363,7 @@ PostgreSQL documentation
   <title>Notes</title>
 
   <para>
-   When using <application>pg_receivexlog</application> instead of
+   When using <application>pg_receivewal</application> instead of
    <xref linkend="guc-archive-command"> as the main WAL backup method, it is
    strongly recommended to use replication slots.  Otherwise, the server is
    free to recycle or remove transaction log files before they are backed up,
@@ -384,7 +384,7 @@ PostgreSQL documentation
    <literal>mydbserver</literal> and store it in the local directory
    <filename>/usr/local/pgsql/archive</filename>:
 <screen>
-<prompt>$</prompt> <userinput>pg_receivexlog -h mydbserver -D /usr/local/pgsql/archive</userinput>
+<prompt>$</prompt> <userinput>pg_receivewal -h mydbserver -D /usr/local/pgsql/archive</userinput>
 </screen></para>
  </refsect1>
 

doc/src/sgml/ref/pg_recvlogical.sgml

@@ -35,7 +35,7 @@ PostgreSQL documentation
 
   <para>
    It creates a replication-mode connection, so it is subject to the same
-   constraints as <xref linkend="app-pgreceivexlog">, plus those for logical
+   constraints as <xref linkend="app-pgreceivewal">, plus those for logical
    replication (see <xref linkend="logicaldecoding">).
   </para>
 
@@ -238,7 +238,7 @@ PostgreSQL documentation
       <listitem>
        <para>
         This option has the same effect as the option of the same name
-        in <xref linkend="app-pgreceivexlog">.  See the description there.
+        in <xref linkend="app-pgreceivewal">.  See the description there.
        </para>
       </listitem>
      </varlistentry>
@@ -411,7 +411,7 @@ PostgreSQL documentation
   <title>See Also</title>
 
   <simplelist type="inline">
-   <member><xref linkend="app-pgreceivexlog"></member>
+   <member><xref linkend="app-pgreceivewal"></member>
   </simplelist>
  </refsect1>
 </refentry>

doc/src/sgml/ref/pg_resetxlog.sgml renamed to doc/src/sgml/ref/pg_resetwal.sgml

@@ -1,38 +1,38 @@
 <!--
-doc/src/sgml/ref/pg_resetxlog.sgml
+doc/src/sgml/ref/pg_resetwal.sgml
 PostgreSQL documentation
 -->
 
-<refentry id="APP-PGRESETXLOG">
- <indexterm zone="app-pgresetxlog">
-  <primary>pg_resetxlog</primary>
+<refentry id="APP-PGRESETWAL">
+ <indexterm zone="app-pgresetwal">
+  <primary>pg_resetwal</primary>
  </indexterm>
 
  <refmeta>
-  <refentrytitle><application>pg_resetxlog</application></refentrytitle>
+  <refentrytitle><application>pg_resetwal</application></refentrytitle>
   <manvolnum>1</manvolnum>
   <refmiscinfo>Application</refmiscinfo>
  </refmeta>
 
  <refnamediv>
-  <refname>pg_resetxlog</refname>
+  <refname>pg_resetwal</refname>
   <refpurpose>reset the write-ahead log and other control information of a <productname>PostgreSQL</productname> database cluster</refpurpose>
  </refnamediv>
 
  <refsynopsisdiv>
   <cmdsynopsis>
-   <command>pg_resetxlog</command>
+   <command>pg_resetwal</command>
    <arg choice="opt"><option>-f</option></arg>
    <arg choice="opt"><option>-n</option></arg>
    <arg rep="repeat"><replaceable>option</replaceable></arg>
    <arg choice="req"><arg choice="opt"><option>-D</option></arg> <replaceable class="parameter">datadir</replaceable></arg>
   </cmdsynopsis>
  </refsynopsisdiv>
 
- <refsect1 id="R1-APP-PGRESETXLOG-1">
+ <refsect1 id="R1-APP-PGRESETWAL-1">
   <title>Description</title>
   <para>
-   <command>pg_resetxlog</command> clears the write-ahead log (WAL) and
+   <command>pg_resetwal</command> clears the write-ahead log (WAL) and
    optionally resets some other control information stored in the
    <filename>pg_control</> file.  This function is sometimes needed
    if these files have become corrupted.  It should be used only as a
@@ -51,12 +51,12 @@ PostgreSQL documentation
    This utility can only be run by the user who installed the server, because
    it requires read/write access to the data directory.
    For safety reasons, you must specify the data directory on the command line.
-   <command>pg_resetxlog</command> does not use the environment variable
+   <command>pg_resetwal</command> does not use the environment variable
    <envar>PGDATA</>.
   </para>
 
   <para>
-   If <command>pg_resetxlog</command> complains that it cannot determine
+   If <command>pg_resetwal</command> complains that it cannot determine
    valid data for <filename>pg_control</>, you can force it to proceed anyway
    by specifying the <option>-f</> (force) option.  In this case plausible
    values will be substituted for the missing data.  Most of the fields can be
@@ -80,7 +80,7 @@ PostgreSQL documentation
     <term><option>-f</option></term>
     <listitem>
      <para>
-      Force <command>pg_resetxlog</command> to proceed even if it cannot determine
+      Force <command>pg_resetwal</command> to proceed even if it cannot determine
       valid data for <filename>pg_control</>, as explained above.
      </para>
     </listitem>
@@ -91,10 +91,10 @@ PostgreSQL documentation
     <listitem>
      <para>
       The <option>-n</> (no operation) option instructs
-      <command>pg_resetxlog</command> to print the values reconstructed from
+      <command>pg_resetwal</command> to print the values reconstructed from
       <filename>pg_control</> and values about to be changed, and then exit
       without modifying anything. This is mainly a debugging tool, but can be
-      useful as a sanity check before allowing <command>pg_resetxlog</command>
+      useful as a sanity check before allowing <command>pg_resetwal</command>
       to proceed for real.
      </para>
     </listitem>
@@ -115,7 +115,7 @@ PostgreSQL documentation
 
   <para>
    The following options are only needed when
-   <command>pg_resetxlog</command> is unable to determine appropriate values
+   <command>pg_resetwal</command> is unable to determine appropriate values
    by reading <filename>pg_control</>.  Safe values can be determined as
    described below.  For values that take numeric arguments, hexadecimal
    values can be specified by using the prefix <literal>0x</literal>.
@@ -152,7 +152,7 @@ PostgreSQL documentation
 
      <para>
       The transaction ID epoch is not actually stored anywhere in the database
-      except in the field that is set by <command>pg_resetxlog</command>,
+      except in the field that is set by <command>pg_resetwal</command>,
       so any value will work so far as the database itself is concerned.
       You might need to adjust this value to ensure that replication
       systems such as <application>Slony-I</> and
@@ -164,7 +164,7 @@ PostgreSQL documentation
    </varlistentry>
 
    <varlistentry>
-    <term><option>-l</option> <replaceable class="parameter">xlogfile</replaceable></term>
+    <term><option>-l</option> <replaceable class="parameter">walfile</replaceable></term>
     <listitem>
      <para>
       Manually set the WAL starting address.
@@ -182,7 +182,7 @@ PostgreSQL documentation
 
      <note>
       <para>
-       <command>pg_resetxlog</command> itself looks at the files in
+       <command>pg_resetwal</command> itself looks at the files in
        <filename>pg_wal</> and chooses a default <option>-l</> setting
        beyond the last existing file name.  Therefore, manual adjustment of
        <option>-l</> should only be needed if you are aware of WAL segment
@@ -274,11 +274,11 @@ PostgreSQL documentation
 
   <para>
    This command must not be used when the server is
-   running.  <command>pg_resetxlog</command> will refuse to start up if
+   running.  <command>pg_resetwal</command> will refuse to start up if
    it finds a server lock file in the data directory.  If the
    server crashed then a lock file might have been left
    behind; in that case you can remove the lock file to allow
-   <command>pg_resetxlog</command> to run.  But before you do
+   <command>pg_resetwal</command> to run.  But before you do
    so, make doubly certain that there is no server process still alive.
   </para>
  </refsect1>