ctdb-daemon: Drop most ctdbd command-line options
[metze/samba/wip.git] / ctdb / doc / ctdbd.1.xml
index abab2a4121f77461a102ac3ff35d95a020241589..09803e4e24036cef8fa1c2c607f5612f0939b695 100644 (file)
     <title>GENERAL OPTIONS</title>
 
     <variablelist>
-      <varlistentry>
-       <term>-d, --debug=<parameter>DEBUGLEVEL</parameter></term>
-       <listitem>
-         <para>
-           This option sets the debug level to DEBUGLEVEL, which
-           controls what will be written by the logging
-           subsystem.  The default is 2.
-         </para>
-         <para>
-           See the <citetitle>DEBUG LEVELS</citetitle> section in
-           <citerefentry><refentrytitle>ctdb</refentrytitle>
-           <manvolnum>7</manvolnum></citerefentry> for more
-           information.
-         </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>--dbdir=<parameter>DIRECTORY</parameter></term>
-       <listitem>
-         <para>
-           DIRECTORY on local storage where ctdbd keeps a local copy of
-           TDB databases.  This directory is local for each node and
-           should not be stored on the shared cluster filesystem.
-         </para>
-         <para>
-           Defaults to <filename>/usr/local/var/lib/ctdb/volatile</filename>.
-         </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>--dbdir-persistent=<parameter>DIRECTORY</parameter></term>
-       <listitem>
-         <para>
-           DIRECTORY on local storage where ctdbd keeps a local copy of
-           persistent TDB databases.  This directory is local for each
-           node and should not be stored on the shared cluster
-           filesystem.
-         </para>
-         <para>
-           Defaults to <filename>/usr/local/var/lib/ctdb/persistent</filename>.
-         </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>--dbdir-state=<parameter>DIRECTORY</parameter></term>
-       <listitem>
-         <para>
-           DIRECTORY on local storage where ctdbd keep internal state
-           TDB files.  This directory is local for each node and
-           should not be stored on the shared cluster filesystem.
-         </para>
-         <para>
-           Defaults to <filename>/usr/local/var/lib/ctdb/state</filename>.
-         </para>
-       </listitem>
-      </varlistentry>
-
       <varlistentry>
        <term>-i, --interactive</term>
        <listitem>
        </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 the
-           <citetitle>Private address</citetitle> section in
-           <citerefentry><refentrytitle>ctdb</refentrytitle>
-           <manvolnum>7</manvolnum></citerefentry>.
-         </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>
-         <para>
-           STRING specifies where ctdbd will write its log. The
-           default is
-           file:<filename>/usr/local/var/log/log.ctdb</filename>.
-         </para>
-         <para>
-           Valid values are:
-         </para>
-         <variablelist>
-           <varlistentry>
-             <term>file:<parameter>FILENAME</parameter></term>
-             <listitem>
-               <para>
-                 FILENAME where ctdbd will write its log. This is usually
-                 <filename>/usr/local/var/log/log.ctdb</filename>.
-               </para>
-             </listitem>
-           </varlistentry>
-           <varlistentry>
-             <term>syslog<optional>:<parameter>METHOD</parameter></optional></term>
-              <listitem>
-                <para>
-                 CTDB will log to syslog.  By default this will use
-                 the syslog(3) API.
-                </para>
-               <para>
-                 Under heavy loads syslog(3) can block if the syslog
-                 daemon processes messages too slowly.  This can
-                 cause CTDB to block when logging.
-               </para>
-               <para>
-                 If METHOD is specified then it specifies an
-                 extension that causes logging to be done in a
-                 non-blocking mode.  Note that <emphasis>this may
-                 cause messages to be dropped</emphasis>.  METHOD
-                 must be one of:
-               </para>
-               <variablelist>
-                 <varlistentry>
-                   <term>nonblocking</term>
-                   <listitem>
-                     <para>
-                       CTDB will log to syslog via
-                       <filename>/dev/log</filename> in non-blocking
-                       mode.
-                     </para>
-                   </listitem>
-                 </varlistentry>
-                 <varlistentry>
-                   <term>udp</term>
-                   <listitem>
-                     <para>
-                       CTDB will log to syslog via UDP to
-                       localhost:514.  The syslog daemon must be
-                       configured to listen on (at least)
-                       localhost:514.  Most syslog daemons will log
-                       the messages with hostname "localhost" - this
-                       is a limitation of the implementation, for
-                       compatibility with more syslog daemons.
-                     </para>
-                   </listitem>
-                 </varlistentry>
-                 <varlistentry>
-                   <term>udp-rfc5424</term>
-                   <listitem>
-                     <para>
-                       As with "udp" but messages are sent in RFC5424
-                       format.  This method will log the correct
-                       hostname but is not as widely implemented in
-                       syslog daemons.
-                     </para>
-                   </listitem>
-                 </varlistentry>
-               </variablelist>
-             </listitem>
-           </varlistentry>
-         </variablelist>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>--max-persistent-check-errors=<parameter>NUM</parameter></term>
-       <listitem>
-         <para>
-           NUM specifies the maximum number of health check failures
-           allowed for persistent databases during startup.
-         </para>
-         <para>
-           The default value is 0.  Setting this to non-zero allows a
-           node with unhealthy persistent databases to startup and
-           join the cluster as long as there is another node with
-           healthy persistent databases.
-         </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>--no-lmaster</term>
-       <listitem>
-         <para>
-           This argument specifies that this node can NOT become an lmaster
-           for records in the database. This means that it will never show up
-           in the vnnmap. This feature is primarily used for making a cluster
-           span across a WAN link and use CTDB as a WAN-accelerator.
-         </para>
-         <para>
-           Please see the <citetitle>REMOTE CLUSTER NODES</citetitle>
-           section in <citerefentry><refentrytitle>ctdb</refentrytitle>
-           <manvolnum>7</manvolnum></citerefentry> for more
-           information.
-         </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>--no-recmaster</term>
-       <listitem>
-         <para>
-           This argument specifies that this node can NOT become a recmaster
-           for the database. This feature is primarily used for making a cluster
-           span across a WAN link and use CTDB as a WAN-accelerator.
-         </para>
-         <para>
-           Please see the <citetitle>REMOTE CLUSTER NODES</citetitle>
-           section in <citerefentry><refentrytitle>ctdb</refentrytitle>
-           <manvolnum>7</manvolnum></citerefentry> for more
-           information.
-         </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>--nosetsched</term>
-       <listitem>
-         <para>
-           Normally ctdbd will change its scheduler to run as a
-           real-time process. This is the default mode for a normal
-           ctdbd operation to gurarantee that ctdbd always gets the CPU
-           cycles that it needs.
-         </para>
-         <para>
-           This option is used to tell ctdbd to
-           <emphasis>not</emphasis> run as a real-time process and
-           instead run ctdbd as a normal userspace process.  This can
-           be used on a platform where real-time scheduling is not
-           supported.
-         </para>
-         <para>
-           This is also useful for debugging and when you want to run
-           ctdbd under valgrind or gdb. (You don't want to attach
-           valgrind or gdb to a real-time process.)
-         </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>--reclock=<parameter>LOCK</parameter></term>
-       <listitem>
-         <para>
-           LOCK specifies the cluster-wide mutex used to detect and
-           prevent a partitioned cluster (or "split brain").
-         </para>
-         <para>
-           For information about the recovery lock please see the
-           <citetitle>RECOVERY LOCK</citetitle> section in
-           <citerefentry><refentrytitle>ctdb</refentrytitle>
-           <manvolnum>7</manvolnum></citerefentry>.
-         </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>--script-log-level=<parameter>DEBUGLEVEL</parameter></term>
-       <listitem>
-         <para>
-           This option sets the debug level of event script output to
-           DEBUGLEVEL.  The default is ERR.
-         </para>
-         <para>
-           See the <citetitle>DEBUG LEVELS</citetitle> section in
-           <citerefentry><refentrytitle>ctdb</refentrytitle>
-           <manvolnum>7</manvolnum></citerefentry> for more
-           information.
-         </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>--start-as-disabled</term>
-       <listitem>
-         <para>
-           This makes ctdbd start in the DISABLED state.
-         </para>
-         <para>
-           To allow the node to host public IP addresses and
-           services, it must be manually enabled using the
-           <command>ctdb enable</command> command.
-         </para>
-         <para>
-           Please see the <citetitle>NODE STATES</citetitle> section
-           in <citerefentry><refentrytitle>ctdb</refentrytitle>
-           <manvolnum>7</manvolnum></citerefentry> for more
-           information about the DISABLED state.
-         </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>--start-as-stopped</term>
-       <listitem>
-         <para>
-           This makes ctdbd start in the STOPPED state.
-         </para>
-         <para>
-           To allow the node to take part in the cluster it must be
-           manually continued with the the <command>ctdb
-           enable</command> command.
-         </para>
-         <para>
-           Please see the <citetitle>NODE STATES</citetitle> section
-           in <citerefentry><refentrytitle>ctdb</refentrytitle>
-           <manvolnum>7</manvolnum></citerefentry> for more
-           information about the STOPPED state.
-         </para>
-       </listitem>
-      </varlistentry>
-
-      <varlistentry>
-       <term>--transport=tcp|infiniband</term>
-       <listitem>
-         <para>
-           This option specifies which transport to use for ctdbd
-           internode communications. The default is "tcp".
-         </para>
-         <para>
-           The "infiniband" support is not regularly tested.
-         </para>
-       </listitem>
-      </varlistentry>
-
       <varlistentry>
        <term>-?, --help</term>
        <listitem>