ctdb-daemon: Drop most ctdbd command-line options
[metze/samba/wip.git] / ctdb / doc / ctdbd.1.xml
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry
3         PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
4         "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
5
6 <refentry id="ctdbd.1">
7
8   <refmeta>
9     <refentrytitle>ctdbd</refentrytitle>
10     <manvolnum>1</manvolnum>
11     <refmiscinfo class="source">ctdb</refmiscinfo>
12     <refmiscinfo class="manual">CTDB - clustered TDB database</refmiscinfo>
13   </refmeta>
14
15   <refnamediv>
16     <refname>ctdbd</refname>
17     <refpurpose>The CTDB cluster daemon</refpurpose>
18   </refnamediv>
19
20   <refsynopsisdiv>
21     <cmdsynopsis>
22       <command>ctdbd</command>
23       <arg rep="repeat"><replaceable>OPTION</replaceable></arg>
24     </cmdsynopsis>
25   </refsynopsisdiv>
26
27   <refsect1>
28     <title>DESCRIPTION</title>
29     <para>
30       ctdbd is the main CTDB daemon.
31     </para>
32
33     <para>
34       Note that ctdbd is not usually invoked directly.  It is invoked
35       via <citerefentry><refentrytitle>ctdbd_wrapper</refentrytitle>
36       <manvolnum>1</manvolnum></citerefentry> or via the initscript.
37     </para>
38
39     <para>
40       See <citerefentry><refentrytitle>ctdb</refentrytitle>
41       <manvolnum>7</manvolnum></citerefentry> for an overview of CTDB.
42     </para>
43   </refsect1>
44
45   <refsect1>
46     <title>GENERAL OPTIONS</title>
47
48     <variablelist>
49       <varlistentry>
50         <term>-i, --interactive</term>
51         <listitem>
52           <para>
53             Enable interactive mode.  This will make ctdbd run in the
54             foreground and not detach from the terminal.  By default
55             ctdbd will detach itself and run in the background as a
56             daemon.
57           </para>
58         </listitem>
59       </varlistentry>
60
61       <varlistentry>
62         <term>-?, --help</term>
63         <listitem>
64           <para>
65             Display a summary of options.
66           </para>
67         </listitem>
68       </varlistentry>
69
70     </variablelist>
71   </refsect1>
72
73   <refsect1>
74     <title>SEE ALSO</title>
75     <para>
76       <citerefentry><refentrytitle>ctdb</refentrytitle>
77       <manvolnum>1</manvolnum></citerefentry>,
78
79       <citerefentry><refentrytitle>ctdbd_wrapper</refentrytitle>
80       <manvolnum>1</manvolnum></citerefentry>,
81
82       <citerefentry><refentrytitle>onnode</refentrytitle>
83       <manvolnum>1</manvolnum></citerefentry>,
84
85       <citerefentry><refentrytitle>ctdb</refentrytitle>
86       <manvolnum>7</manvolnum></citerefentry>,
87
88       <citerefentry><refentrytitle>ctdb-tunables</refentrytitle>
89       <manvolnum>7</manvolnum></citerefentry>,
90
91       <ulink url="http://ctdb.samba.org/"/>
92     </para>
93   </refsect1>
94
95   <refentryinfo>
96     <author>
97       <contrib>
98         This documentation was written by
99         Ronnie Sahlberg,
100         Amitay Isaacs,
101         Martin Schwenke
102       </contrib>
103     </author>
104
105     <copyright>
106       <year>2007</year>
107       <holder>Andrew Tridgell</holder>
108       <holder>Ronnie Sahlberg</holder>
109     </copyright>
110     <legalnotice>
111       <para>
112         This program is free software; you can redistribute it and/or
113         modify it under the terms of the GNU General Public License as
114         published by the Free Software Foundation; either version 3 of
115         the License, or (at your option) any later version.
116       </para>
117       <para>
118         This program is distributed in the hope that it will be
119         useful, but WITHOUT ANY WARRANTY; without even the implied
120         warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
121         PURPOSE.  See the GNU General Public License for more details.
122       </para>
123       <para>
124         You should have received a copy of the GNU General Public
125         License along with this program; if not, see
126         <ulink url="http://www.gnu.org/licenses"/>.
127       </para>
128     </legalnotice>
129   </refentryinfo>
130
131 </refentry>