doc: document the --print-emptyrecords switch in the "ctdb" manpage.
authorMichael Adam <obnox@samba.org>
Tue, 29 Nov 2011 12:28:35 +0000 (13:28 +0100)
committerMichael Adam <obnox@samba.org>
Tue, 29 Nov 2011 12:43:32 +0000 (13:43 +0100)
doc/ctdb.1.xml

index a57c67faa3798ba9c6af82ade5e95cb6c630bff4..e421993fb47f1d86920d0f4cc0cab9cb6fb3afd6 100644 (file)
@@ -30,6 +30,7 @@
                <arg choice="opt">--usage</arg>
                <arg choice="opt">-d --debug=&lt;INTEGER&gt;</arg>
                <arg choice="opt">--socket=&lt;filename&gt;</arg>
+               <arg choice="opt">--print-emptyrecords</arg>
        </cmdsynopsis>
        
 </refsynopsisdiv>
         </listitem>
       </varlistentry>
 
+      <varlistentry><term>--print-emptyrecords</term>
+        <listitem>
+          <para>
+            This enables printing of empty records when dumping databases
+            with the catdb, cattbd and dumpdbbackup commands. Records with
+            empty data segment are considered deleted by ctdb and cleaned
+            by the vacuuming mechanism, so this switch can come in handy for
+            debugging the vacuuming behaviour.
+          </para>
+        </listitem>
+      </varlistentry>
+
     </variablelist>
   </refsect1>