From ab6e5ceab3ea9ece12d2e596aaa99894c4f50646 Mon Sep 17 00:00:00 2001
From: Ian Barwick <ian@2ndquadrant.com>
Date: Mon, 25 Nov 2019 10:12:09 +0900
Subject: [PATCH] doc: add reference to "ssh_options"

This is listed in "repmgr.conf.sample" but not the main documentation.
---
 doc/configuration-file-optional-settings.xml | 21 ++++++++++++++++++++
 1 file changed, 21 insertions(+)

diff --git a/doc/configuration-file-optional-settings.xml b/doc/configuration-file-optional-settings.xml
index 2e8cc24c..6c915f79 100644
--- a/doc/configuration-file-optional-settings.xml
+++ b/doc/configuration-file-optional-settings.xml
@@ -119,6 +119,27 @@
       </listitem>
     </varlistentry>
 
+    <varlistentry id="repmgr-conf-ssh-options" xreflabel="ssh_options">
+      <term><varname>ssh_options</varname> (<type>string</type>)
+        <indexterm>
+          <primary><varname>ssh_options</varname> configuration file parameter</primary>
+        </indexterm>
+      </term>
+      <listitem>
+        <para>
+          Options to append to the <command>ssh</command> command when executed
+          by &repmgr;.
+        </para>
+        <para>
+          We recommend adding <literal>-q</literal> to suppress any superfluous
+          SSH chatter such as login banners, and also an explicit
+          <option>ConnectTimeout</option> value,
+          e.g.:
+<programlisting>
+ssh_options='-q -o ConnectTimeout=10'</programlisting>
+        </para>
+      </listitem>
+    </varlistentry>
 
   </variablelist>
 </sect1>