From a37e83c0a99ecf50c64baffc6c88c3d805d6e822 Mon Sep 17 00:00:00 2001
From: Robert Haas <rhaas@postgresql.org>
Date: Fri, 25 Jan 2013 12:01:45 -0500
Subject: Make it easy to time out pg_isready, and make the default 3 seconds.

Along the way, add a missing line to the help message.

Phil Sorber, reviewed by Fujii Masao
---
 doc/src/sgml/ref/pg_isready.sgml | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'doc/src')

diff --git a/doc/src/sgml/ref/pg_isready.sgml b/doc/src/sgml/ref/pg_isready.sgml
index ea0d3a75063..ff80a78305e 100644
--- a/doc/src/sgml/ref/pg_isready.sgml
+++ b/doc/src/sgml/ref/pg_isready.sgml
@@ -96,6 +96,18 @@ PostgreSQL documentation
       </listitem>
      </varlistentry>
 
+     <varlistentry>
+       <term><option>-t <replaceable class="parameter">seconds</replaceable></></term>
+       <term><option>--timeout=<replaceable class="parameter">seconds</replaceable></></term>
+       <listitem>
+       <para>
+        The maximum number of seconds to wait when attempting connection before
+        returning that the server is not responding. Setting to 0 disables. The
+        default is 3 seconds.
+       </para>
+       </listitem>
+     </varlistentry>
+
      <varlistentry>
        <term><option>-U <replaceable class="parameter">username</replaceable></></term>
        <term><option>--username=<replaceable class="parameter">username</replaceable></></term>
-- 
cgit v1.2.3