regenerated ctdbd manpage
authorRonnie Sahlberg <sahlberg@ronnie>
Tue, 10 Jul 2007 22:27:22 +0000 (08:27 +1000)
committerRonnie Sahlberg <sahlberg@ronnie>
Tue, 10 Jul 2007 22:27:22 +0000 (08:27 +1000)
doc/ctdbd.1
doc/ctdbd.1.html

index 682d813028e96919d2a4cbdd6ecd03007526cbc0..a50aa3fe64fb184cb51399db2a57b391e289ba07 100644 (file)
@@ -1,6 +1,6 @@
 .\"     Title: ctdbd
 .\"    Author: 
-.\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
+.\" Generator: DocBook XSL Stylesheets v1.71.0 <http://docbook.sf.net/>
 .\"      Date: 07/10/2007
 .\"    Manual: 
 .\"    Source: 
@@ -31,91 +31,91 @@ ctdbd is the main component in clustered Samba that provides a high\-awailabilit
 .SH "OPTIONS"
 .PP
 \-? \-\-help
-.RS 4
+.RS 3n
 Print some help text to the screen.
 .RE
 .PP
 \-\-usage
-.RS 4
+.RS 3n
 Print useage information to the screen.
 .RE
 .PP
 \-\-reclock=<filename>
-.RS 4
+.RS 3n
 This is the name of the lock file stored of the shared cluster filesystem that ctdbd uses to arbitrate which node has the role of recovery\-master. This file must be stored on shared storage.
 .RE
 .PP
 \-\-nlist=<filename>
-.RS 4
+.RS 3n
 This file contains a list of the private ip addresses of every node in the cluster. There is one line/ip address for each node. This file must be the same for all nodes in the cluster.
 .sp
 This file is usually /etc/ctdb/nodes .
 .RE
 .PP
 \-\-dbdir=<directory>
-.RS 4
+.RS 3n
 This is the directory on local storage where ctdbd keeps the local copy of the TDB databases. This directory is local for each node and should not be stored on the shared cluster filesystem.
 .sp
 This directory would usually be /var/ctdb .
 .RE
 .PP
 \-i \-\-interactive
-.RS 4
+.RS 3n
 By default ctdbd will detach itself from the shell and run in the background as a daemon. This option makes ctdbd to start in interactive mode.
 .RE
 .PP
 \-\-public_addresses=<filename>
-.RS 4
+.RS 3n
 When used with IP takeover this specifies a file containing the public ip addresses to use on the cluster. This file contains one entry for each node in the cluster.
 .sp
 This is usually the file /etc/ctdb/public_addresses
 .RE
 .PP
 \-\-public\-interface=<interface>
-.RS 4
+.RS 3n
 When used with IP takeover this option specifies which physical interface should be used to attach the public addresses to.
 .RE
 .PP
 \-\-event\-script=<filename>
-.RS 4
+.RS 3n
 This option is used to specify which events script that ctdbd will use to manage services when the cluster configuration changes.
 .sp
 This will normally be /etc/ctdb/events which is part of the ctdb distribution.
 .RE
 .PP
 \-\-logfile=<filename>
-.RS 4
+.RS 3n
 This is the file where ctdbd will write its log. This is usually /var/log/log.ctdb .
 .RE
 .PP
 \-\-listen=<address>
-.RS 4
+.RS 3n
 This specifies which ip address ctdb will bind to. By default ctdbd will bind to the first address it finds in the /etc/ctdb/nodes file and which is also present on the local system in which case you do not need to provide this option.
 .sp
 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 /etc/ctdb/nodes what would match a local interface.
 .RE
 .PP
 \-\-transport=<STRING>
-.RS 4
+.RS 3n
 This option specifies which transport to use for ctdbd internode communications. The default is "tcp".
 .sp
 Suported transports are "tcp" and "infiniband".
 .RE
 .PP
 \-\-socket=<filename>
-.RS 4
+.RS 3n
 This specifies the name of the domain socket that ctdbd will create. This socket is used for local clients to attach to and communicate with the ctdbd daemon.
 .sp
 The default is /tmp/ctdb.socket . You only need to use this option if you plan to run multiple ctdbd daemons on the same physical host.
 .RE
 .PP
 \-d \-\-debug=<DEBUGLEVEL>
-.RS 4
+.RS 3n
 This option sets the debuglevel on the ctdbd daemon which controls what will be written to the logfile. The default is 0 which will only log important events and errors. A larger number will provide additional logging.
 .RE
 .PP
 \-\-torture
-.RS 4
+.RS 3n
 This option is only used for development and testing of ctdbd. It adds artificial errors and failures to the common codepaths in ctdbd to verify that ctdbd can recover correctly for failures.
 .sp
 You do NOT want to use this option unless you are developing and testing new functionality in ctdbd.
@@ -136,7 +136,7 @@ Since the private addresses are only available to the network when the correspon
       Example /etc/ctdb/nodes for a four node cluster:
       
 .sp
-.RS 4
+.RS 3n
 .nf
         10.1.1.1
         10.1.1.2
@@ -160,7 +160,7 @@ The list of public addresses also contain the netmask for that address. the reas
       Example /etc/ctdb/public_addresses for a four node cluster:
       
 .sp
-.RS 4
+.RS 3n
 .nf
         11.1.1.1/24
         11.1.1.2/24
@@ -192,7 +192,7 @@ ctdb(1), onnode(1)
 \fI\%http://ctdb.samba.org/\fR
 .SH "COPYRIGHT/LICENSE"
 .sp
-.RS 4
+.RS 3n
 .nf
 Copyright (C) Andrew Tridgell 2007
 Copyright (C) Ronnie sahlberg 2007
index 49d2fdc468ce965871553e37c8e6a77528e1e825..90b8be1113fb13ee2a1920dfda180caac8bff949 100644 (file)
@@ -1,4 +1,4 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>ctdbd</title><meta name="generator" content="DocBook XSL Stylesheets V1.72.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="ctdbd.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ctdbd &#8212; The CTDB cluster daemon</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">ctdbd</code> </p></div><div class="cmdsynopsis"><p><code class="command">ctdbd</code>  {--reclock=&lt;filename&gt;} {--nlist=&lt;filename&gt;} {--dbdir=&lt;directory&gt;} [-? --help] [--usage] [-i --interactive] [--public-addresses=&lt;filename&gt;] [--public-interface=&lt;interface&gt;] [--event-script=&lt;filename&gt;] [--logfile=&lt;filename&gt;] [--listen=&lt;address&gt;] [--transport=&lt;STRING&gt;] [--socket=&lt;filename&gt;] [-d --debug=&lt;INTEGER&gt;] [--torture]</p></div></div><div class="refsect1" lang="en"><a name="id2488930"></a><h2>DESCRIPTION</h2><p>
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>ctdbd</title><meta name="generator" content="DocBook XSL Stylesheets V1.71.0"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="refentry" lang="en"><a name="ctdbd.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ctdbd &#8212; The CTDB cluster daemon</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">ctdbd</code> </p></div><div class="cmdsynopsis"><p><code class="command">ctdbd</code>  {--reclock=&lt;filename&gt;} {--nlist=&lt;filename&gt;} {--dbdir=&lt;directory&gt;} [-? --help] [--usage] [-i --interactive] [--public-addresses=&lt;filename&gt;] [--public-interface=&lt;interface&gt;] [--event-script=&lt;filename&gt;] [--logfile=&lt;filename&gt;] [--listen=&lt;address&gt;] [--transport=&lt;STRING&gt;] [--socket=&lt;filename&gt;] [-d --debug=&lt;INTEGER&gt;] [--torture]</p></div></div><div class="refsect1" lang="en"><a name="id2481068"></a><h2>DESCRIPTION</h2><p>
       ctdbd is the main ctdb daemon.
     </p><p>
       ctdbd provides a clustered version of the TDB database with automatic rebuild/recovery of the databases upon nodefailures.
@@ -8,7 +8,7 @@
       ctdbd provides monitoring of all nodes in the cluster and automatically reconfigures the cluster and recovers upon node failures.
     </p><p>
       ctdbd is the main component in clustered Samba that provides a high-awailability load-sharing CIFS server cluster.
-    </p></div><div class="refsect1" lang="en"><a name="id2488962"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-? --help</span></dt><dd><p>
+    </p></div><div class="refsect1" lang="en"><a name="id2481100"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-? --help</span></dt><dd><p>
             Print some help text to the screen.
           </p></dd><dt><span class="term">--usage</span></dt><dd><p>
             Print useage information to the screen.
             This option is only used for development and testing of ctdbd. It adds artificial errors and failures to the common codepaths in ctdbd to verify that ctdbd can recover correctly for failures.
           </p><p>
             You do NOT want to use this option unless you are developing and testing new functionality in ctdbd.
-          </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2490376"></a><h2>Private vs Public addresses</h2><p>
+          </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2528438"></a><h2>Private vs Public addresses</h2><p>
       When used for ip takeover in a HA environment, each node in a ctdb 
       cluster has two ip addresses assigned to it. One private and one public.
-    </p><div class="refsect2" lang="en"><a name="id2490386"></a><h3>Private address</h3><p>
+    </p><div class="refsect2" lang="en"><a name="id2528448"></a><h3>Private address</h3><p>
         This is the physical ip address of the node which is configured in 
         linux and attached to a physical interface. This address uniquely
         identifies a physical node in the cluster and is the ip addresses
@@ -89,7 +89,7 @@
         10.1.1.2
         10.1.1.3
         10.1.1.4
-      </pre></div><div class="refsect2" lang="en"><a name="id2490432"></a><h3>Public address</h3><p>
+      </pre></div><div class="refsect2" lang="en"><a name="id2528495"></a><h3>Public address</h3><p>
         A public address on the other hand is not attached to an interface.
         This address is managed by ctdbd itself and is attached/detached to
         a physical node at runtime. You should NOT have this address configured
         In this example, if node 3 fails, its public address can be taken over 
         by node 2 since node 2 is on the same subnet as 3 but not by node 0 or 
         node 1 since node 0 and 1 are both on a different subnet from node 3.
-      </p></div></div><div class="refsect1" lang="en"><a name="id2536612"></a><h2>Node status</h2><p>
+      </p></div></div><div class="refsect1" lang="en"><a name="id2528564"></a><h2>Node status</h2><p>
       The current status of each node in the cluster can be viewed by the 
       'ctdb status' command.
     </p><p>
       investigated and require an administrative action to rectify. This node 
       does not perticipate in the CTDB cluster but can still be communicated 
       with. I.e. ctdb commands can be sent to it.
-    </p></div><div class="refsect1" lang="en"><a name="id2536669"></a><h2>SEE ALSO</h2><p>
+    </p></div><div class="refsect1" lang="en"><a name="id2528621"></a><h2>SEE ALSO</h2><p>
       ctdb(1), onnode(1)
       <a href="http://ctdb.samba.org/" target="_top">http://ctdb.samba.org/</a>
-    </p></div><div class="refsect1" lang="en"><a name="id2536682"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
+    </p></div><div class="refsect1" lang="en"><a name="id2528634"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
 Copyright (C) Andrew Tridgell 2007<br>
 Copyright (C) Ronnie sahlberg 2007<br>
 <br>