doc: Document pg_receivewal exit behavior and status
authorPeter Eisentraut <peter_e@gmx.net>
Wed, 16 Aug 2017 00:26:58 +0000 (20:26 -0400)
committerPeter Eisentraut <peter_e@gmx.net>
Wed, 16 Aug 2017 00:26:58 +0000 (20:26 -0400)
doc/src/sgml/ref/pg_receivewal.sgml

index a17082bb11c1af25b0c545d97f010fb2a22a9148..7c82e36c7c86b97be0e6e61095133cebd6975f10 100644 (file)
@@ -73,6 +73,12 @@ PostgreSQL documentation
    as possible. To avoid this behavior, use the <literal>-n</literal>
    parameter.
   </para>
+
+  <para>
+   In the absence of fatal errors, <application>pg_receivewal</application>
+   will run until terminated by the <systemitem>SIGINT</systemitem> signal
+   (<keycombo action="simul"><keycap>Control</><keycap>C</></>).
+  </para>
  </refsect1>
 
  <refsect1>
@@ -348,6 +354,18 @@ PostgreSQL documentation
 
  </refsect1>
 
+ <refsect1>
+  <title>Exit Status</title>
+
+  <para>
+   <application>pg_receivewal</application> will exit with status 0 when
+   terminated by the <systemitem>SIGINT</systemitem> signal.  (That is the
+   normal way to end it.  Hence it is not an error.)  For fatal errors or
+   other signals, the exit status will be nonzero.
+  </para>
+
+ </refsect1>
+
  <refsect1>
   <title>Environment</title>