Draft tools ref complete for Admin and Dev guides

Mark Craig

21.32.2011 def05ed8de5b653d3fed997ca56444e4f60a4dca

 opendj3/src/main/docbkx/shared/man-make-ldif.xml

@@ -35,72 +35,82 @@
 </refmeta>
 <refnamediv>
  <refname>make-ldif</refname>
  <refpurpose>TODO one-line description</refpurpose>
  <refpurpose>generate test LDIF</refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  <cmdsynopsis>
   <command>make-ldif</command>
   <command><replaceable>subcommand</replaceable></command>
   <arg choice="opt">--options</arg>
   <arg choice="req">options</arg>
  </cmdsynopsis>
 </refsynopsisdiv>
 <refsect1>
  <title>Description</title>
  <para>TODO description.</para>
  <para>This utility can be used to generate LDIF data based on a definition
  in a template file.</para>
 </refsect1>
 <refsect1>
  <title>Global Options</title>
  <para>The following global options are supported.</para>
  <title>Options</title>
  <para>The following options are supported.</para>
  <variablelist>
   <varlistentry>
    <term><option>TODO</option></term>
    <term><option>-o, --ldifFile {file}</option></term>
    <listitem>
     <para>TODO Description.</para>
     <para>The path to the LDIF file to be written.</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-s, --randomSeed {seed}</option></term>
    <listitem>
     <para>The seed to use to initialize the random number generator.</para>
     <para>Default value: 0</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-t, --templateFile {file}</option></term>
    <listitem>
     <para>The path to the template file with information about the LDIF data
     to generate.</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-V, --version</option></term>
    <listitem>
     <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>make-ldif</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>
     <listitem>
      <para>TODO description.</para>
     </listitem>
    </varlistentry>
   </variablelist>
  <variablelist>
   <varlistentry>
    <term>0</term>
    <listitem>
     <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 uses the default template to generate LDIF.</para>
  <screen width="80">$ make-ldif -t ../config/MakeLDIF/example.template -o ../ldif/generated.ldif
Processed 1000 entries
Processed 2000 entries
...
Processed 10000 entries
LDIF processing complete.  10003 entries written</screen>
 </refsect1>
</refentry>