add documentation for the vacuum and repack commands.

document the -T option to ctdb

diff --git a/doc/ctdb.1 b/doc/ctdb.1
index f20780c3b12cbbfd1dd9300c869786449acf180e..49738255ca4698a6fc67034781cf4d07f73c8cc4 100644 (file)
--- a/doc/ctdb.1
+++ b/doc/ctdb.1
@@ -1,11 +1,11 @@
 .\"     Title: ctdb
 .\"    Author: 
 .\" Generator: DocBook XSL Stylesheets v1.71.0 <http://docbook.sf.net/>
-.\"      Date: 09/14/2007
+.\"      Date: 01/10/2008
 .\"    Manual: 
 .\"    Source: 
 .\"
-.TH "CTDB" "1" "09/14/2007" "" ""
+.TH "CTDB" "1" "01/10/2008" "" ""
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
@@ -16,7 +16,7 @@ ctdb \- clustered tdb database management utility
 .HP 29
 \fBctdb [ OPTIONS ] COMMAND ...\fR
 .HP 5
-\fBctdb\fR [\-n\ <node>] [\-Y] [\-t\ <timeout>] [\-?\ \-\-help] [\-\-usage] [\-d\ \-\-debug=<INTEGER>] [\-\-socket=<filename>]
+\fBctdb\fR [\-n\ <node>] [\-Y] [\-t\ <timeout>] [\-T\ <timelimit>] [\-?\ \-\-help] [\-\-usage] [\-d\ \-\-debug=<INTEGER>] [\-\-socket=<filename>]
 .SH "DESCRIPTION"
 .PP
 ctdb is a utility to view and manage a ctdb cluster.
@@ -36,7 +36,12 @@ Produce output in machine readable form for easier parsing by scripts. Not all c
 .PP
 \-t <timeout>
 .RS 3n
-How long should ctdb wait for a command to complete before timing out. Default is 3 seconds.
+How long should ctdb wait for the local ctdb daemon to respond to a command before timing out. Default is 3 seconds.
+.RE
+.PP
+\-T <timelimit>
+.RS 3n
+A limit on how long the ctdb command will run for before it will be aborted. When this timelimit has been exceeded the ctdb command will terminate.
 .RE
 .PP
 \-? \-\-help
@@ -327,6 +332,32 @@ This command will kill the specified TCP connection by issuing a TCP RST to the
 This command will will send a TCP tickle to the source host for the specified TCP connection. A TCP tickle is a TCP ACK packet with an invalid sequence and acknowledge number and will when received by the source host result in it sending an immediate correct ACK back to the other end.
 .PP
 TCP tickles are useful to "tickle" clients after a IP failover has occured since this will make the client immediately recognize the TCP connection has been disrupted and that the client will need to reestablish. This greatly speeds up the time it takes for a client to detect and reestablish after an IP failover in the ctdb cluster.
+.SS "repack [max_freelist]"
+.PP
+Over time, when records are created and deleted in a TDB, the TDB list of free space will become fragmented. This can lead to a slowdown in accessing TDB records. This command is used to defragment a TDB database and pruning the freelist.
+.PP
+If [max_freelist] is specified, then a database will only be repacked if it has more than this number of entries in the freelist.
+.PP
+During repacking of the database, the entire TDB database will be locked to prevent writes. If samba tries to write to a record in the database during a repack operation, samba will block until the repacking has completed.
+.PP
+This command can be disruptive and can cause samba to block for the duration of the repack operation. In general, a repack operation will take less than one second to complete.
+.PP
+A repack operation will only defragment the local TDB copy of the CTDB database. You need to run this command on all of the nodes to repack a CTDB database completely.
+.PP
+Example: ctdb repack 1000
+.PP
+By default, this operation is issued from the 00.ctdb event script every 5 minutes.
+.SS "vacuum [max_records]"
+.PP
+Over time CTDB databases will fill up with empty deleted records which will lead to a progressive slow down of CTDB database access. This command is used to prune all databases and delete all empty records from the cluster.
+.PP
+By default, vacuum will delete all empty records from all databases. If [max_records] is specified, only databases with that many or more empty records will be pruned.
+.PP
+Vacuum only deletes those records where the local node is the lmaster. To delete all records from the entire cluster you need to run a vacuum from each node. This command is not disruptive. Samba is unaffected and will still be able to read/write records normally while the database is being vacuumed.
+.PP
+Example: ctdb vacuum
+.PP
+By default, this operation is issued from the 00.ctdb event script every 5 minutes.
 .SH "DEBUGGING COMMANDS"
 .PP
 These commands are primarily used for CTDB development and testing and should not be used for normal administration.

diff --git a/doc/ctdb.1.html b/doc/ctdb.1.html
index 4e0d056815bd74e14f58d86974975fdb482185fc..5d9d963db90e23130fda87e4e28bcf681e48aee4 100644 (file)
--- a/doc/ctdb.1.html
+++ b/doc/ctdb.1.html
@@ -1,6 +1,6 @@
-<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>ctdb</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="ctdb.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ctdb &#8212; clustered tdb database management utility</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">ctdb [ OPTIONS ] COMMAND ...</code> </p></div><div class="cmdsynopsis"><p><code class="command">ctdb</code>  [-n &lt;node&gt;] [-Y] [-t &lt;timeout&gt;] [-? --help] [--usage] [-d --debug=&lt;INTEGER&gt;] [--socket=&lt;filename&gt;]</p></div></div><div class="refsect1" lang="en"><a name="id2480829"></a><h2>DESCRIPTION</h2><p>
+<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>ctdb</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="ctdb.1"></a><div class="titlepage"></div><div class="refnamediv"><h2>Name</h2><p>ctdb &#8212; clustered tdb database management utility</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><div class="cmdsynopsis"><p><code class="command">ctdb [ OPTIONS ] COMMAND ...</code> </p></div><div class="cmdsynopsis"><p><code class="command">ctdb</code>  [-n &lt;node&gt;] [-Y] [-t &lt;timeout&gt;] [-T &lt;timelimit&gt;] [-? --help] [--usage] [-d --debug=&lt;INTEGER&gt;] [--socket=&lt;filename&gt;]</p></div></div><div class="refsect1" lang="en"><a name="id2480839"></a><h2>DESCRIPTION</h2><p>
       ctdb is a utility to view and manage a ctdb cluster.
-    </p></div><div class="refsect1" lang="en"><a name="id2480839"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-n &lt;pnn&gt;</span></dt><dd><p>
+    </p></div><div class="refsect1" lang="en"><a name="id2480849"></a><h2>OPTIONS</h2><div class="variablelist"><dl><dt><span class="term">-n &lt;pnn&gt;</span></dt><dd><p>
             This specifies the physical node number on which to execute the 
            command. Default is to run the command on the deamon running on 
            the local host.
@@ -10,7 +10,11 @@
           </p></dd><dt><span class="term">-Y</span></dt><dd><p>
             Produce output in machine readable form for easier parsing by scripts. Not all commands support this option.
           </p></dd><dt><span class="term">-t &lt;timeout&gt;</span></dt><dd><p>
-            How long should ctdb wait for a command to complete before timing out. Default is 3 seconds.
+            How long should ctdb wait for the local ctdb daemon to respond to a command before timing out. Default is 3 seconds.
+          </p></dd><dt><span class="term">-T &lt;timelimit&gt;</span></dt><dd><p>
+            A limit on how long the ctdb command will run for before it will
+           be aborted. When this timelimit has been exceeded the ctdb command will
+           terminate.
           </p></dd><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>
@@ -24,11 +28,11 @@
             You only need to specify this parameter if you run multiple ctdb 
             daemons on the same physical host and thus can not use the default
             name for the domain socket.
-          </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2481134"></a><h2>Administrative Commands</h2><p>
+          </p></dd></dl></div></div><div class="refsect1" lang="en"><a name="id2481159"></a><h2>Administrative Commands</h2><p>
       These are commands used to monitor and administrate a CTDB cluster.
-    </p><div class="refsect2" lang="en"><a name="id2481143"></a><h3>status</h3><p>
+    </p><div class="refsect2" lang="en"><a name="id2481168"></a><h3>status</h3><p>
         This command shows the current status of the ctdb node.
-      </p><div class="refsect3" lang="en"><a name="id2481152"></a><h4>node status</h4><p>
+      </p><div class="refsect3" lang="en"><a name="id2481177"></a><h4>node status</h4><p>
           Node status reflects the current status of the node. There are four possible states:
         </p><p>
           OK - This node is fully functional.
@@ -40,20 +44,20 @@
           UNHEALTHY - A service provided by this node is malfunctioning and should be investigated. The CTDB daemon itself is operational and participates in the cluster. Its public IP address has been taken over by a different node and no services are currnetly being hosted. All unhealthy nodes should be investigated and require an administrative action to rectify.
         </p><p>
           BANNED - This node failed too many recovery attempts and has been banned from participating in the cluster for a period of RecoveryBanPeriod seconds. Any public IP address has been taken over by other nodes. This node does not provide any services. All banned nodes should be 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="refsect3" lang="en"><a name="id2481203"></a><h4>generation</h4><p>
+        </p></div><div class="refsect3" lang="en"><a name="id2481229"></a><h4>generation</h4><p>
           The generation id is a number that indicates the current generation 
           of a cluster instance. Each time a cluster goes through a 
           reconfiguration or a recovery its generation id will be changed.
-        </p></div><div class="refsect3" lang="en"><a name="id2481216"></a><h4>VNNMAP</h4><p>
+        </p></div><div class="refsect3" lang="en"><a name="id2481242"></a><h4>VNNMAP</h4><p>
           The list of Virtual Node Numbers. This is a list of all nodes that actively participates in the cluster and that share the workload of hosting the Clustered TDB database records.
           Only nodes that are participating in the vnnmap can become lmaster or dmaster for a database record.
-        </p></div><div class="refsect3" lang="en"><a name="id2481230"></a><h4>Recovery mode</h4><p>
+        </p></div><div class="refsect3" lang="en"><a name="id2481256"></a><h4>Recovery mode</h4><p>
           This is the current recovery mode of the cluster. There are two possible modes:
         </p><p>
           NORMAL - The cluster is fully operational.
         </p><p>
           RECOVERY - The cluster databases have all been frozen, pausing all services while the cluster awaits a recovery process to complete. A recovery process should finish within seconds. If a cluster is stuck in the RECOVERY state this would indicate a cluster malfunction which needs to be investigated.
-        </p></div><div class="refsect3" lang="en"><a name="id2481254"></a><h4>Recovery master</h4><p>
+        </p></div><div class="refsect3" lang="en"><a name="id2481280"></a><h4>Recovery master</h4><p>
           This is the cluster node that is currently designated as the recovery master. This node is responsible of monitoring the consistency of the cluster and to perform the actual recovery process when reqired.
         </p></div><p>
        Example: ctdb status
@@ -71,7 +75,7 @@ hash:2 lmaster:2
 hash:3 lmaster:3
 Recovery mode:NORMAL (0)
 Recovery master:0
-      </pre></div><div class="refsect2" lang="en"><a name="id2481285"></a><h3>ping</h3><p>
+      </pre></div><div class="refsect2" lang="en"><a name="id2481311"></a><h3>ping</h3><p>
         This command will "ping" all CTDB daemons in the cluster to verify that they are processing commands correctly.
       </p><p>
        Example: ctdb ping
@@ -82,7 +86,7 @@ response from 0 time=0.000054 sec  (3 clients)
 response from 1 time=0.000144 sec  (2 clients)
 response from 2 time=0.000105 sec  (2 clients)
 response from 3 time=0.000114 sec  (2 clients)
-      </pre></div><div class="refsect2" lang="en"><a name="id2481311"></a><h3>ip</h3><p>
+      </pre></div><div class="refsect2" lang="en"><a name="id2481337"></a><h3>ip</h3><p>
         This command will display the list of public addresses that are provided by the cluster and which physical node is currently serving this ip.
       </p><p>
        Example: ctdb ip
@@ -94,7 +98,7 @@ Number of addresses:4
 12.1.1.2         1
 12.1.1.3         2
 12.1.1.4         3
-      </pre></div><div class="refsect2" lang="en"><a name="id2481336"></a><h3>getvar &lt;name&gt;</h3><p>
+      </pre></div><div class="refsect2" lang="en"><a name="id2528421"></a><h3>getvar &lt;name&gt;</h3><p>
         Get the runtime value of a tuneable variable.
       </p><p>
        Example: ctdb getvar MaxRedirectCount
@@ -102,11 +106,11 @@ Number of addresses:4
        Example output:
       </p><pre class="screen">
 MaxRedirectCount    = 3
-      </pre></div><div class="refsect2" lang="en"><a name="id2528419"></a><h3>setvar &lt;name&gt; &lt;value&gt;</h3><p>
+      </pre></div><div class="refsect2" lang="en"><a name="id2528444"></a><h3>setvar &lt;name&gt; &lt;value&gt;</h3><p>
         Set the runtime value of a tuneable variable.
       </p><p>
        Example: ctdb setvar MaxRedirectCount 5
-      </p></div><div class="refsect2" lang="en"><a name="id2528434"></a><h3>listvars</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528459"></a><h3>listvars</h3><p>
         List all tuneable variables.
       </p><p>
        Example: ctdb listvars
@@ -128,7 +132,7 @@ MonitorInterval     = 15
 EventScriptTimeout  = 20
 RecoveryGracePeriod = 60
 RecoveryBanPeriod   = 300
-      </pre></div><div class="refsect2" lang="en"><a name="id2528462"></a><h3>statistics</h3><p>
+      </pre></div><div class="refsect2" lang="en"><a name="id2528487"></a><h3>statistics</h3><p>
         Collect statistics from the CTDB daemon about how many calls it has served.
       </p><p>
        Example: ctdb statistics
@@ -170,43 +174,43 @@ CTDB version 1
  max_hop_count                      0
  max_call_latency                   4.948321 sec
  max_lockwait_latency               0.000000 sec
-      </pre></div><div class="refsect2" lang="en"><a name="id2528505"></a><h3>statisticsreset</h3><p>
+      </pre></div><div class="refsect2" lang="en"><a name="id2528530"></a><h3>statisticsreset</h3><p>
         This command is used to clear all statistics counters in a node.
       </p><p>
        Example: ctdb statisticsreset
-      </p></div><div class="refsect2" lang="en"><a name="id2528519"></a><h3>getdebug</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528545"></a><h3>getdebug</h3><p>
         Get the current debug level for the node. the debug level controls what information is written to the log file.
-      </p></div><div class="refsect2" lang="en"><a name="id2528530"></a><h3>setdebug &lt;debuglevel&gt;</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528556"></a><h3>setdebug &lt;debuglevel&gt;</h3><p>
         Set the debug level of a node. This is a number between 0 and 9 and controls what information will be written to the logfile.
-      </p></div><div class="refsect2" lang="en"><a name="id2528542"></a><h3>getpid</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528567"></a><h3>getpid</h3><p>
         This command will return the process id of the ctdb daemon.
-      </p></div><div class="refsect2" lang="en"><a name="id2528552"></a><h3>disable</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528578"></a><h3>disable</h3><p>
         This command is used to administratively disable a node in the cluster.
         A disabled node will still participate in the cluster and host
         clustered TDB records but its public ip address has been taken over by
         a different node and it no longer hosts any services.
-      </p></div><div class="refsect2" lang="en"><a name="id2528566"></a><h3>enable</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528591"></a><h3>enable</h3><p>
         Re-enable a node that has been administratively disabled.
-      </p></div><div class="refsect2" lang="en"><a name="id2528576"></a><h3>ban &lt;bantime|0&gt;</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528602"></a><h3>ban &lt;bantime|0&gt;</h3><p>
         Administratively ban a node for bantime seconds. A bantime of 0 means that the node should be permanently banned. 
       </p><p>
         A banned node does not participate in the cluster and does not host any records for the clustered TDB. Its ip address has been taken over by an other node and no services are hosted.
       </p><p>
         Nodes are automatically banned if they are the cause of too many
         cluster recoveries.
-      </p></div><div class="refsect2" lang="en"><a name="id2528599"></a><h3>unban</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528625"></a><h3>unban</h3><p>
         This command is used to unban a node that has either been 
         administratively banned using the ban command or has been automatically
         banned by the recovery daemon.
-      </p></div><div class="refsect2" lang="en"><a name="id2528611"></a><h3>shutdown</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528637"></a><h3>shutdown</h3><p>
         This command will shutdown a specific CTDB daemon.
-      </p></div><div class="refsect2" lang="en"><a name="id2528621"></a><h3>recover</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528647"></a><h3>recover</h3><p>
         This command will trigger the recovery daemon to do a cluster
         recovery.
-      </p></div><div class="refsect2" lang="en"><a name="id2528632"></a><h3>killtcp &lt;srcip:port&gt; &lt;dstip:port&gt;</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528658"></a><h3>killtcp &lt;srcip:port&gt; &lt;dstip:port&gt;</h3><p>
         This command will kill the specified TCP connection by issuing a
         TCP RST to the srcip:port endpoint.
-      </p></div><div class="refsect2" lang="en"><a name="id2528643"></a><h3>tickle &lt;srcip:port&gt; &lt;dstip:port&gt;</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528669"></a><h3>tickle &lt;srcip:port&gt; &lt;dstip:port&gt;</h3><p>
         This command will will send a TCP tickle to the source host for the
         specified TCP connection.
        A TCP tickle is a TCP ACK packet with an invalid sequence and 
@@ -218,12 +222,42 @@ CTDB version 1
         TCP connection has been disrupted and that the client will need
         to reestablish. This greatly speeds up the time it takes for a client
         to detect and reestablish after an IP failover in the ctdb cluster.
-      </p></div></div><div class="refsect1" lang="en"><a name="id2528669"></a><h2>Debugging Commands</h2><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528694"></a><h3>repack [max_freelist]</h3><p>
+       Over time, when records are created and deleted in a TDB, the TDB list of free space will become fragmented. This can lead to a slowdown in accessing TDB records.
+       This command is used to defragment a TDB database and pruning the freelist.
+      </p><p>
+       If [max_freelist] is specified, then a database will only be repacked if it has more than this number of entries in the freelist.
+       </p><p>
+       During repacking of the database, the entire TDB database will be locked to prevent writes. If samba tries to write to a record in the database during a repack operation, samba will block until the repacking has completed.
+      </p><p>
+       This command can be disruptive and can cause samba to block for the duration of the repack operation. In general, a repack operation will take less than one second to complete.
+      </p><p>
+       A repack operation will only defragment the local TDB copy of the CTDB database. You need to run this command on all of the nodes to repack a CTDB database completely.
+       </p><p>
+       Example: ctdb repack 1000
+      </p><p>
+        By default, this operation is issued from the 00.ctdb event script every 5 minutes.
+      </p></div><div class="refsect2" lang="en"><a name="id2528740"></a><h3>vacuum [max_records]</h3><p>
+       Over time CTDB databases will fill up with empty deleted records which will lead to a progressive slow down of CTDB database access.
+       This command is used to prune all databases and delete all empty records from the cluster.
+      </p><p>
+        By default, vacuum will delete all empty records from all databases.
+        If [max_records] is specified, only databases with that many or more empty records will be pruned.
+      </p><p>
+        Vacuum only deletes those records where the local node is the lmaster.
+        To delete all records from the entire cluster you need to run a vacuum from each node.
+
+        This command is not disruptive. Samba is unaffected and will still be able to read/write records normally while the database is being vacuumed.
+      </p><p>
+       Example: ctdb vacuum
+      </p><p>
+        By default, this operation is issued from the 00.ctdb event script every 5 minutes.
+      </p></div></div><div class="refsect1" lang="en"><a name="id2528777"></a><h2>Debugging Commands</h2><p>
       These commands are primarily used for CTDB development and testing and
       should not be used for normal administration.
-    </p><div class="refsect2" lang="en"><a name="id2528680"></a><h3>process-exists &lt;pid&gt;</h3><p>
+    </p><div class="refsect2" lang="en"><a name="id2528787"></a><h3>process-exists &lt;pid&gt;</h3><p>
         This command checks if a specific process exists on the CTDB host. This is mainly used by Samba to check if remote instances of samba are still running or not.
-      </p></div><div class="refsect2" lang="en"><a name="id2528692"></a><h3>getdbmap</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528800"></a><h3>getdbmap</h3><p>
         This command lists all clustered TDB databases that the CTDB daemon has attahced to.
       </p><p>
        Example: ctdb getdbmap
@@ -235,21 +269,21 @@ dbid:0x42fe72c5 name:locking.tdb path:/var/ctdb/locking.tdb.0
 dbid:0x1421fb78 name:brlock.tdb path:/var/ctdb/brlock.tdb.0
 dbid:0x17055d90 name:connections.tdb path:/var/ctdb/connections.tdb.0
 dbid:0xc0bdde6a name:sessionid.tdb path:/var/ctdb/sessionid.tdb.0
-      </pre></div><div class="refsect2" lang="en"><a name="id2528719"></a><h3>catdb &lt;dbname&gt;</h3><p>
+      </pre></div><div class="refsect2" lang="en"><a name="id2528827"></a><h3>catdb &lt;dbname&gt;</h3><p>
         This command will dump a clustered TDB database to the screen. This is a debugging command.
-      </p></div><div class="refsect2" lang="en"><a name="id2528730"></a><h3>getmonmode</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528838"></a><h3>getmonmode</h3><p>
         This command returns the monutoring mode of a node. The monitoring mode is either ACTIVE or DISABLED. Normally a node will continously monitor that all other nodes that are expected are in fact connected and that they respond to commands.
       </p><p>
         ACTIVE - This is the normal mode. The node is actively monitoring all other nodes, both that the transport is connected and also that the node responds to commands. If a node becomes unavailable, it will be marked as DISCONNECTED and a recovery is initiated to restore the cluster.
       </p><p>
         DISABLED - This node is not monitoring that other nodes are available. In this mode a node failure will not be detected and no recovery will be performed. This mode is useful when for debugging purposes one wants to attach GDB to a ctdb process but wants to prevent the rest of the cluster from marking this node as DISCONNECTED and do a recovery.
-      </p></div><div class="refsect2" lang="en"><a name="id2528761"></a><h3>setmonmode &lt;0|1&gt;</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528869"></a><h3>setmonmode &lt;0|1&gt;</h3><p>
         This command can be used to explicitely disable/enable monitoring mode on a node. The main purpose is if one wants to attach GDB to a running ctdb daemon but wants to prevent the other nodes from marking it as DISCONNECTED and issuing a recovery. To do this, set monitoring mode to 0 on all nodes before attaching with GDB. Remember to set monitoring mode back to 1 afterwards.
-      </p></div><div class="refsect2" lang="en"><a name="id2528777"></a><h3>attach &lt;dbname&gt;</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528891"></a><h3>attach &lt;dbname&gt;</h3><p>
         This is a debugging command. This command will make the CTDB daemon create a new CTDB database and attach to it.
-      </p></div><div class="refsect2" lang="en"><a name="id2528788"></a><h3>dumpmemory</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528902"></a><h3>dumpmemory</h3><p>
         This is a debugging command. This command will make the ctdb daemon to write a fill memory allocation map to the log file.
-      </p></div><div class="refsect2" lang="en"><a name="id2528799"></a><h3>freeze</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528913"></a><h3>freeze</h3><p>
         This command will lock all the local TDB databases causing clients 
         that are accessing these TDBs such as samba3 to block until the
         databases are thawed.
@@ -257,12 +291,12 @@ dbid:0xc0bdde6a name:sessionid.tdb path:/var/ctdb/sessionid.tdb.0
         This is primarily used by the recovery daemon to stop all samba
         daemons from accessing any databases while the database is recovered
         and rebuilt.
-      </p></div><div class="refsect2" lang="en"><a name="id2528817"></a><h3>thaw</h3><p>
+      </p></div><div class="refsect2" lang="en"><a name="id2528932"></a><h3>thaw</h3><p>
         Thaw a previously frozen node.
-      </p></div></div><div class="refsect1" lang="en"><a name="id2528828"></a><h2>SEE ALSO</h2><p>
+      </p></div></div><div class="refsect1" lang="en"><a name="id2528942"></a><h2>SEE ALSO</h2><p>
       ctdbd(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="id2528841"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
+    </p></div><div class="refsect1" lang="en"><a name="id2528955"></a><h2>COPYRIGHT/LICENSE</h2><div class="literallayout"><p><br>
 Copyright (C) Andrew Tridgell 2007<br>
 Copyright (C) Ronnie sahlberg 2007<br>
 <br>

diff --git a/doc/ctdb.1.xml b/doc/ctdb.1.xml
index 26d9ab9e6e924a2dafdc0c2c2a92ef807f61fff4..6fbf830696aeb6c334002336754d6bee7c86f6b8 100644 (file)
--- a/doc/ctdb.1.xml
+++ b/doc/ctdb.1.xml
@@ -23,6 +23,7 @@
                <arg choice="opt">-n &lt;node&gt;</arg>
                <arg choice="opt">-Y</arg>
                <arg choice="opt">-t &lt;timeout&gt;</arg>
+               <arg choice="opt">-T &lt;timelimit&gt;</arg>
                <arg choice="opt">-? --help</arg>
                <arg choice="opt">--usage</arg>
                <arg choice="opt">-d --debug=&lt;INTEGER&gt;</arg>
@@ -67,7 +68,17 @@
       <varlistentry><term>-t &lt;timeout&gt;</term>
         <listitem>
           <para>
-            How long should ctdb wait for a command to complete before timing out. Default is 3 seconds.
+            How long should ctdb wait for the local ctdb daemon to respond to a command before timing out. Default is 3 seconds.
+          </para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry><term>-T &lt;timelimit&gt;</term>
+        <listitem>
+          <para>
+            A limit on how long the ctdb command will run for before it will
+           be aborted. When this timelimit has been exceeded the ctdb command will
+           terminate.
           </para>
         </listitem>
       </varlistentry>
@@ -438,6 +449,64 @@ CTDB version 1
       </para>
     </refsect2>
 
+    <refsect2><title>repack [max_freelist]</title>
+      <para>
+       Over time, when records are created and deleted in a TDB, the TDB list of free space will become fragmented. This can lead to a slowdown in accessing TDB records.
+       This command is used to defragment a TDB database and pruning the freelist.
+      </para>
+ 
+       <para>
+       If [max_freelist] is specified, then a database will only be repacked if it has more than this number of entries in the freelist.
+       </para>
+      <para>
+       During repacking of the database, the entire TDB database will be locked to prevent writes. If samba tries to write to a record in the database during a repack operation, samba will block until the repacking has completed.
+      </para>
+ 
+      <para>
+       This command can be disruptive and can cause samba to block for the duration of the repack operation. In general, a repack operation will take less than one second to complete.
+      </para>
+ 
+      <para>
+       A repack operation will only defragment the local TDB copy of the CTDB database. You need to run this command on all of the nodes to repack a CTDB database completely.
+       </para>
+
+      <para>
+       Example: ctdb repack 1000
+      </para>
+
+      <para>
+        By default, this operation is issued from the 00.ctdb event script every 5 minutes.
+      </para>
+ 
+    </refsect2>
+
+    <refsect2><title>vacuum [max_records]</title>
+      <para>
+       Over time CTDB databases will fill up with empty deleted records which will lead to a progressive slow down of CTDB database access.
+       This command is used to prune all databases and delete all empty records from the cluster.
+      </para>
+ 
+      <para>
+        By default, vacuum will delete all empty records from all databases.
+        If [max_records] is specified, only databases with that many or more empty records will be pruned.
+      </para>
+ 
+      <para>
+        Vacuum only deletes those records where the local node is the lmaster.
+        To delete all records from the entire cluster you need to run a vacuum from each node.
+
+        This command is not disruptive. Samba is unaffected and will still be able to read/write records normally while the database is being vacuumed.
+      </para>
+
+      <para>
+       Example: ctdb vacuum
+      </para>
+ 
+      <para>
+        By default, this operation is issued from the 00.ctdb event script every 5 minutes.
+      </para>
+    </refsect2>
+
   </refsect1>