Draft tools ref complete for Admin and Dev guides

Mark Craig

21.32.2011 def05ed8de5b653d3fed997ca56444e4f60a4dca

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

@@ -35,72 +35,149 @@
 </refmeta>
 <refnamediv>
  <refname>ldifsearch</refname>
  <refpurpose>TODO one-line description</refpurpose>
  <refpurpose>search LDIF with LDAP filters</refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  <cmdsynopsis>
   <command>ldifsearch</command>
   <command><replaceable>subcommand</replaceable></command>
   <arg choice="opt">--options</arg>
   <arg choice="req">options</arg>
   <arg choice="opt">filter</arg>
   <arg choice="opt" rep="repeat">attribute</arg>
  </cmdsynopsis>
 </refsynopsisdiv>
 <refsect1>
  <title>Description</title>
  <para>TODO description.</para>
  <para>This utility can be used to perform search operations against data in
  an LDIF 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>-b, --baseDN {baseDN}</option></term>
    <listitem>
     <para>TODO Description.</para>
     <para>The base DN for the search.  Multiple base DNs may be specified by
     providing the option multiple times.  If no base DN is provided, then the
     root DSE will be used.</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-f, --filterFile {filterFile}</option></term>
    <listitem>
     <para>The path to the file containing the search filter(s) to use.  If
     this is not provided, then the filter must be provided on the command line
     after all configuration options.</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-l, --ldifFile {ldifFile}</option></term>
    <listitem>
     <para>LDIF file containing the data to search.  Multiple files may be
     specified by providing the option multiple times. If no files are provided,
     the data will be read from standard input.</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-o, --outputFile {outputFile}</option></term>
    <listitem>
     <para>The path to the output file to which the matching entries should be
     written.  If this is not provided, then the data will be written to
     standard output.</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, --searchScope {scope}</option></term>
    <listitem>
     <para>The scope for the search.  It must be one of 'base', 'one', 'sub',
     or 'subordinate'.  If it is not provided, then 'sub' will be used.</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-t, --timeLimit {timeLimit}</option></term>
    <listitem>
     <para>Maximum length of time (in seconds) to spend processing.</para>
     <para>Default value: 0</para>
    </listitem>
   </varlistentry>
    <varlistentry>
    <term><option>-T, --dontWrap</option></term>
    <listitem>
     <para>Long lines should not be wrapped.</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-V, --version</option></term>
    <listitem>
     <para>Display version information.</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-z, --sizeLimit {sizeLimit}</option></term>
    <listitem>
     <para>Maximum number of matching entries to return.</para>
     <para>Default value: 0</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>ldifsearch</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.</para>
  <screen width="80">$ ldifsearch -l /path/to/Example.ldif -b dc=example,dc=com uid=bjensen
dn: uid=bjensen,ou=People,dc=example,dc=com
objectClass: person
objectClass: organizationalPerson
objectClass: inetOrgPerson
objectClass: posixAccount
objectClass: top
uid: bjensen
userpassword: hifalutin
facsimiletelephonenumber: +1 408 555 1992
givenname: Barbara
cn: Barbara Jensen
cn: Babs Jensen
telephonenumber: +1 408 555 1862
sn: Jensen
roomnumber: 0209
homeDirectory: /home/bjensen
mail: bjensen@example.com
l: Cupertino
ou: Product Development
ou: People
uidNumber: 1076
gidNumber: 1000

</screen>
 </refsect1>
</refentry>