@@ -16,7 +16,7 @@ PostgreSQL documentation
1616
1717 <refnamediv>
1818 <refname>pg_receivexlog</refname>
19- <refpurpose>streams transaction logs from a <productname>PostgreSQL</productname> cluster </refpurpose>
19+ <refpurpose>stream transaction logs from a <productname>PostgreSQL</productname> server </refpurpose>
2020 </refnamediv>
2121
2222 <refsynopsisdiv>
@@ -71,10 +71,6 @@ PostgreSQL documentation
7171 <refsect1>
7272 <title>Options</title>
7373
74- <para>
75- The following command-line options control the location and format of the
76- output.
77-
7874 <variablelist>
7975 <varlistentry>
8076 <term><option>-D <replaceable class="parameter">directory</replaceable></option></term>
@@ -88,22 +84,6 @@ PostgreSQL documentation
8884 </para>
8985 </listitem>
9086 </varlistentry>
91- </variablelist>
92- </para>
93- <para>
94- The following command-line options control the running of the program.
95-
96- <variablelist>
97- <varlistentry>
98- <term><option>-n</option></term>
99- <term><option>--no-loop</option></term>
100- <listitem>
101- <para>
102- Don't loop on connection errors. Instead, exit right away with
103- an error.
104- </para>
105- </listitem>
106- </varlistentry>
10787
10888 <varlistentry>
10989 <term><option>-F <replaceable class="parameter">interval</replaceable></option></term>
@@ -120,6 +100,50 @@ PostgreSQL documentation
120100 </listitem>
121101 </varlistentry>
122102
103+ <varlistentry>
104+ <term><option>-n</option></term>
105+ <term><option>--no-loop</option></term>
106+ <listitem>
107+ <para>
108+ Don't loop on connection errors. Instead, exit right away with
109+ an error.
110+ </para>
111+ </listitem>
112+ </varlistentry>
113+
114+ <varlistentry>
115+ <term><option>-s <replaceable class="parameter">interval</replaceable></option></term>
116+ <term><option>--status-interval=<replaceable class="parameter">interval</replaceable></option></term>
117+ <listitem>
118+ <para>
119+ Specifies the number of seconds between status packets sent back to the
120+ server. This allows for easier monitoring of the progress from server.
121+ A value of zero disables the periodic status updates completely,
122+ although an update will still be sent when requested by the server, to
123+ avoid timeout disconnect. The default value is 10 seconds.
124+ </para>
125+ </listitem>
126+ </varlistentry>
127+
128+ <varlistentry>
129+ <term><option>-S <replaceable>slotname</replaceable></option></term>
130+ <term><option>--slot=<replaceable class="parameter">slotname</replaceable></option></term>
131+ <listitem>
132+ <para>
133+ Require <application>pg_receivexlog</application> to use an existing
134+ replication slot (see <xref linkend="streaming-replication-slots">).
135+ When this option is used, <application>pg_receivexlog</> will report
136+ a flush position to the server, indicating when each segment has been
137+ synchronized to disk so that the server can remove that segment if it
138+ is not otherwise needed. When using this parameter, it is important
139+ to make sure that <application>pg_receivexlog</> cannot become the
140+ synchronous standby through an incautious setting of
141+ <xref linkend="guc-synchronous-standby-names">; it does not flush
142+ data frequently enough for this to work correctly.
143+ </para>
144+ </listitem>
145+ </varlistentry>
146+
123147 <varlistentry>
124148 <term><option>-v</option></term>
125149 <term><option>--verbose</option></term>
@@ -129,9 +153,7 @@ PostgreSQL documentation
129153 </para>
130154 </listitem>
131155 </varlistentry>
132-
133156 </variablelist>
134- </para>
135157
136158 <para>
137159 The following command-line options control the database connection parameters.
@@ -181,20 +203,6 @@ PostgreSQL documentation
181203 </listitem>
182204 </varlistentry>
183205
184- <varlistentry>
185- <term><option>-s <replaceable class="parameter">interval</replaceable></option></term>
186- <term><option>--status-interval=<replaceable class="parameter">interval</replaceable></option></term>
187- <listitem>
188- <para>
189- Specifies the number of seconds between status packets sent back to the
190- server. This allows for easier monitoring of the progress from server.
191- A value of zero disables the periodic status updates completely,
192- although an update will still be sent when requested by the server, to
193- avoid timeout disconnect. The default value is 10 seconds.
194- </para>
195- </listitem>
196- </varlistentry>
197-
198206 <varlistentry>
199207 <term><option>-U <replaceable>username</replaceable></option></term>
200208 <term><option>--username=<replaceable class="parameter">username</replaceable></option></term>
@@ -240,27 +248,6 @@ PostgreSQL documentation
240248 </para>
241249 </listitem>
242250 </varlistentry>
243-
244- <varlistentry>
245- <term><option>-S <replaceable>slotname</replaceable></option></term>
246- <term><option>--slot=<replaceable class="parameter">slotname</replaceable></option></term>
247- <listitem>
248- <para>
249- Require <application>pg_receivexlog</application> to use an existing
250- replication slot (see <xref linkend="streaming-replication-slots">).
251- When this option is used, <application>pg_receivexlog</> will report
252- a flush position to the server, indicating when each segment has been
253- synchronized to disk so that the server can remove that segment if it
254- is not otherwise needed. When using this parameter, it is important
255- to make sure that <application>pg_receivexlog</> cannot become the
256- synchronous standby through an incautious setting of
257- <xref linkend="guc-synchronous-standby-names">; it does not flush
258- data frequently enough for this to work correctly. In
259- <option>--create-slot</option> mode, create the slot with this name.
260- In <option>--drop-slot</option> mode, delete the slot with this name.
261- </para>
262- </listitem>
263- </varlistentry>
264251 </variablelist>
265252 </para>
266253
0 commit comments