ctdb-doc: Move --listen documentation from debugging options
authorMartin Schwenke <martin@meltin.net>
Sun, 19 Apr 2015 23:18:08 +0000 (09:18 +1000)
committerAmitay Isaacs <amitay@samba.org>
Mon, 27 Apr 2015 01:32:11 +0000 (03:32 +0200)
There are valid real-world use cases.  Improve the documentation.

Signed-off-by: Martin Schwenke <martin@meltin.net>
Reviewed-by: Amitay Isaacs <amitay@gmail.com>
ctdb/doc/ctdbd.1.xml

index b5feea2fe650bc435174770f453c2a0979d418c4..558e5342b7df8fa7dc0f4f25a7d3ac1f310b55ce 100644 (file)
        </listitem>
       </varlistentry>
 
+      <varlistentry>
+       <term>--listen=<parameter>IPADDR</parameter></term>
+       <listitem>
+         <para>
+           IPADDR is the private IP address that ctdbd will bind to.
+         </para>
+         <para>
+           By default ctdbd will select the first address from the
+           nodes list that in can bind to.  See also
+           <citetitle>--nlist</citetitle>.
+         </para>
+         <para>
+           This option is only required when automatic address
+           detection can not be used.  This can be the case when
+           running multiple ctdbd daemons/nodes on the same physical
+           host (usually for testing), using InfiniBand for the
+           private network or on Linux when sysctl
+           net.ipv4.ip_nonlocal_bind=1.
+         </para>
+       </listitem>
+      </varlistentry>
+
       <varlistentry>
        <term>--logging=<parameter>STRING</parameter></term>
        <listitem>
        </listitem>
       </varlistentry>
 
-      <varlistentry>
-       <term>--listen=<parameter>IPADDR</parameter></term>
-       <listitem>
-         <para>
-           This specifies which IP address that ctdbd will bind to.
-         </para>
-         <para>
-           By default ctdbd will bind to the first address it finds in
-           the <filename>/etc/ctdb/nodes</filename> file that is also
-           present on the local system.
-         </para>
-         <para>
-           This option is only required when you want to run multiple
-           ctdbd daemons/nodes on the same physical host in which case
-           there would be multiple entries in
-           <filename>/etc/ctdb/nodes</filename> that would match a
-           local interface.
-         </para>
-       </listitem>
-      </varlistentry>
-
       <varlistentry>
        <term>--nopublicipcheck</term>
        <listitem>