Draft tools ref complete for Admin and Dev guides

Mark Craig

21.32.2011 def05ed8de5b653d3fed997ca56444e4f60a4dca

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

@@ -35,72 +35,151 @@
 </refmeta>
 <refnamediv>
  <refname>ldif-diff</refname>
  <refpurpose>TODO one-line description</refpurpose>
  <refpurpose>compare small LDIF files</refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  <cmdsynopsis>
   <command>ldif-diff</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 compare two LDIF files and report the
  differences in LDIF format.</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>-a, --ignoreAttrs {file}</option></term>
    <listitem>
     <para>TODO Description.</para>
     <para>File containing a list of attributes to ignore when computing the
     difference.</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>--checkSchema</option></term>
    <listitem>
     <para>Takes into account the syntax of the attributes as defined in the
     schema to make the value comparison. The provided LDIF files must conform
     to the server schema.</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-e, --ignoreEntries {file}</option></term>
    <listitem>
     <para>File containing a list of entries (DN) to ignore when computing the
     difference.</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-o, --outputLDIF {file}</option></term>
    <listitem>
     <para>File to which the output should be written.</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-O, --overwriteExisting</option></term>
    <listitem>
     <para>Any existing output file should be overwritten rather than appending
     to it.</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-s, --sourceLDIF {file}</option></term>
    <listitem>
     <para>LDIF file to use as the source data.</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-S, --singleValueChanges</option></term>
    <listitem>
     <para>Each attribute-level change should be written as a separate
     modification per attribute value rather than one modification per
     entry.</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-t, --targetLDIF {file}</option></term>
    <listitem>
     <para>LDIF file to use as the target data.</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>ldif-diff</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 demonstrates use of the command with two
  small LDIF files.</para>
  <screen width="80">$ cat /path/to/newuser.ldif 
dn: uid=newuser,ou=People,dc=example,dc=com
uid: newuser
objectClass: person
objectClass: organizationalPerson
objectClass: inetOrgPerson
objectClass: top
cn: New User
sn: User
ou: People
mail: newuser@example.com
userPassword: changeme

$ cat /path/to/neweruser.ldif 
dn: uid=newuser,ou=People,dc=example,dc=com
uid: newuser
objectClass: person
objectClass: organizationalPerson
objectClass: inetOrgPerson
objectClass: top
cn: New User
sn: User
ou: People
mail: newuser@example.com
userPassword: secret12
description: A new description.

$ ldif-diff -s /path/to/newuser.ldif -t /path/to/neweruser.ldif
dn: uid=newuser,ou=People,dc=example,dc=com
changetype: modify
add: userPassword
userPassword: secret12
-
delete: userPassword
userPassword: changeme
-
add: description
description: A new description.
</screen>
 </refsect1>
</refentry>