ctdb-docs: Document system options and resource controls
[metze/samba/wip.git] / ctdb / doc / ctdbd_wrapper.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_wrapper.1">
7
8   <refmeta>
9     <refentrytitle>ctdbd_wrapper</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_wrapper</refname>
17     <refpurpose>Wrapper for ctdbd</refpurpose>
18   </refnamediv>
19
20   <refsynopsisdiv>
21     <cmdsynopsis>
22       <command>ctdbd_wrapper</command>
23       <arg choice="req"><replaceable>PIDFILE</replaceable></arg>
24       <group choice="req">
25         <arg choice="plain">start</arg>
26         <arg choice="plain">stop</arg>
27       </group>
28     </cmdsynopsis>
29   </refsynopsisdiv>
30
31   <refsect1>
32     <title>DESCRIPTION</title>
33     <para>
34       ctdbd_wrapper is used to start or stop the main CTDB daemon.
35     </para>
36
37     <para>
38       <replaceable>PIDFILE</replaceable> specifies the location of the
39       file containing the PID of the main CTDB daemon.
40     </para>
41
42     <para>
43       ctdbd_wrapper constructs command-line options for ctdbd from
44       configuration variables specified in
45       <citerefentry><refentrytitle>ctdbd.conf</refentrytitle>
46       <manvolnum>5</manvolnum></citerefentry>.
47     </para>
48
49     <para>
50       See <citerefentry><refentrytitle>ctdb</refentrytitle>
51       <manvolnum>7</manvolnum></citerefentry> for an overview of CTDB.
52     </para>
53   </refsect1>
54
55   <refsect1>
56     <title>SEE ALSO</title>
57     <para>
58       <citerefentry><refentrytitle>ctdbd</refentrytitle>
59       <manvolnum>1</manvolnum></citerefentry>,
60
61       <citerefentry><refentrytitle>ctdb.sysconfig</refentrytitle>
62       <manvolnum>5</manvolnum></citerefentry>,
63
64       <citerefentry><refentrytitle>ctdbd.conf</refentrytitle>
65       <manvolnum>5</manvolnum></citerefentry>,
66
67       <citerefentry><refentrytitle>ctdb</refentrytitle>
68       <manvolnum>7</manvolnum></citerefentry>,
69
70       <ulink url="http://ctdb.samba.org/"/>
71     </para>
72   </refsect1>
73
74   <refentryinfo>
75     <author>
76       <contrib>
77         This documentation was written by
78         Amitay Isaacs,
79         Martin Schwenke
80       </contrib>
81     </author>
82
83     <copyright>
84       <year>2007</year>
85       <holder>Andrew Tridgell</holder>
86       <holder>Ronnie Sahlberg</holder>
87     </copyright>
88     <legalnotice>
89       <para>
90         This program is free software; you can redistribute it and/or
91         modify it under the terms of the GNU General Public License as
92         published by the Free Software Foundation; either version 3 of
93         the License, or (at your option) any later version.
94       </para>
95       <para>
96         This program is distributed in the hope that it will be
97         useful, but WITHOUT ANY WARRANTY; without even the implied
98         warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
99         PURPOSE.  See the GNU General Public License for more details.
100       </para>
101       <para>
102         You should have received a copy of the GNU General Public
103         License along with this program; if not, see
104         <ulink url="http://www.gnu.org/licenses"/>.
105       </para>
106     </legalnotice>
107   </refentryinfo>
108
109 </refentry>