Draft tools ref complete for Admin and Dev guides

Mark Craig

21.32.2011 def05ed8de5b653d3fed997ca56444e4f60a4dca

 opendj3/src/main/docbkx/shared/man-dbtest.xml

@@ -35,72 +35,110 @@
 </refmeta>
 <refnamediv>
  <refname>dbtest</refname>
  <refpurpose>TODO one-line description</refpurpose>
  <refpurpose>gather OpenDJ JE database debugging information</refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  <cmdsynopsis>
   <command>dbtest</command>
   <command><replaceable>subcommand</replaceable></command>
   <arg choice="opt">--options</arg>
   <command>subcommand</command>
   <arg>options</arg>
  </cmdsynopsis>
 </refsynopsisdiv>
 <refsect1>
  <title>Description</title>
  <para>TODO description.</para>
  <para>This utility can be used to debug the JE database.</para>
 </refsect1>
 <refsect1>
  <title>Global Options</title>
  <title>Subcommands</title>
  <para>The following subcommands are supported.</para>
   <variablelist>
    <varlistentry>
     <term><command>dbtest dump-database-container</command></term>
     <listitem>
      <para>Dump records from a database container</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><command>dbtest list-database-containers</command></term>
     <listitem>
      <para>List the database containers for an entry container</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><command>dbtest list-entry-containers</command></term>
     <listitem>
      <para>List the entry containers for a root container</para>
     </listitem>
    </varlistentry>
     <varlistentry>
     <term><command>dbtest list-index-status</command></term>
     <listitem>
      <para>List the status of indexes in an entry container</para>
     </listitem>
    </varlistentry>
     <varlistentry>
     <term><command>dbtest list-root-containers</command></term>
     <listitem>
      <para>List the root containers used by all JE backends</para>
     </listitem>
    </varlistentry>
   </variablelist>
 </refsect1>
 <refsect1>
  <title>Options</title>
  <para>The following global options are supported.</para>
  <para>For other options, see <command>dbtest
  <replaceable>subcommand</replaceable> --help</command>.</para>
  <variablelist>
   <varlistentry>
    <term><option>TODO</option></term>
    <term><option>--version</option></term>
    <listitem>
     <para>TODO Description.</para>
     <para>Display version information</para>
    </listitem>
   </varlistentry>
    <varlistentry>
    <term><option>-?, -H, --help</option></term>
    <listitem>
     <para>Display usage information</para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>
 <refsect1>
  <title>Subcommands</title>
  <para>The following subcommands are supported.</para>
  <refsect2>
   <para>TODO Description.</para>
   <cmdsynopsis>
    <command>dbtest</command>
    <command>TODO</command>
    <arg choice="opt">--options</arg>
   </cmdsynopsis>
   <variablelist>
    <varlistentry>
     <term><option>TODO</option></term>
     <listitem>
      <para>TODO description.</para>
     </listitem>
    </varlistentry>
   </variablelist>
  </refsect2>
 </refsect1>
 <refsect1>
  <title>Files</title>
  <para>TODO if command has configuration file.</para>
 </refsect1>
 <refsect1>
  <title>Environment</title>
  <para>TODO if command reads environment variables.</para>
 </refsect1>
 <refsect1>
  <title>Exit Codes</title>
   <variablelist>
    <varlistentry>
     <term>TODO exit code</term>
     <term>0</term>
     <listitem>
      <para>TODO description.</para>
      <para>The command completed successfully.</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>&gt; 0</term>
     <listitem>
      <para>An error occurred.</para>
     </listitem>
    </varlistentry>
   </variablelist>
 </refsect1>
 <refsect1>
  <title>Examples</title>
  <para>TODO</para>
  <para>The following example displays debugging information about the
  equality index for <literal>sudoUser</literal>.</para>
  <screen width="80">$ dbtest dump-database-container -n userRoot -b dc=example,dc=com \
&gt; -d sudoUser.equality
Indexed Value (6 bytes): %admin
Entry ID List (8 bytes): 165 

Indexed Value (5 bytes): %sudo
Entry ID List (8 bytes): 164 

Indexed Value (4 bytes): root
Entry ID List (8 bytes): 163 


Total Records: 3
Total / Average Key Size: 13 bytes / 4 bytes
Total / Average Data Size: 24 bytes / 8 bytes</screen>
 </refsect1>
</refentry>