Fix for OPENDJ-458: Man pages for common tools shouldn't be the same for to...

Mark Craig

21.03.2012 68d4fea882db22fbb79cb99b595074f012eb9b32

Fix for OPENDJ-458: Man pages for common tools shouldn't be the same for tools in server and toolkit

 opendj3/src/main/docbkx/admin-guide/index.xml

@@ -100,14 +100,14 @@
   <xinclude:include href='../shared/man-encode-password.xml' />
   <xinclude:include href='../shared/man-export-ldif.xml' />
   <xinclude:include href='../shared/man-import-ldif.xml' />
   <xinclude:include href='../shared/man-ldapcompare.xml' />
   <xinclude:include href='man-ldapcompare.xml' />
   <xinclude:include href='../shared/man-ldapdelete.xml' />
   <xinclude:include href='../shared/man-ldapmodify.xml' />
   <xinclude:include href='../shared/man-ldappasswordmodify.xml' />
   <xinclude:include href='../shared/man-ldapsearch.xml' />
   <xinclude:include href='man-ldapmodify.xml' />
   <xinclude:include href='man-ldappasswordmodify.xml' />
   <xinclude:include href='man-ldapsearch.xml' />
   <xinclude:include href='../shared/man-ldif-diff.xml' />
   <xinclude:include href='../shared/man-ldifmodify.xml' />
   <xinclude:include href='../shared/man-ldifsearch.xml' />
   <xinclude:include href='man-ldifmodify.xml' />
   <xinclude:include href='man-ldifsearch.xml' />
   <xinclude:include href='../shared/man-list-backends.xml' />
   <xinclude:include href='../shared/man-make-ldif.xml' />
   <xinclude:include href='../shared/man-manage-account.xml' />

 opendj3/src/main/docbkx/admin-guide/man-ldapcompare.xml

New file
@@ -0,0 +1,328 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
  ! CCPL HEADER START
  !
  ! This work is licensed under the Creative Commons
  ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
  ! To view a copy of this license, visit
  ! http://creativecommons.org/licenses/by-nc-nd/3.0/
  ! or send a letter to Creative Commons, 444 Castro Street,
  ! Suite 900, Mountain View, California, 94041, USA.
  !
  ! You can also obtain a copy of the license at
  ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
  ! If applicable, add the following below this CCPL HEADER, with the fields
  ! enclosed by brackets "[]" replaced with your own identifying information:
  !      Portions Copyright [yyyy] [name of copyright owner]
  !
  ! CCPL HEADER END
  !
  !      Copyright 2011-2012 ForgeRock AS
  !    
-->
<refentry xml:id='ldapcompare-1'
 xmlns='http://docbook.org/ns/docbook'
 version='5.0' xml:lang='en'
 xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
 xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
 xmlns:xlink='http://www.w3.org/1999/xlink'
 xmlns:xinclude='http://www.w3.org/2001/XInclude'>
 <info><copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright></info>
 <refmeta>
  <refentrytitle>ldapcompare</refentrytitle><manvolnum>1</manvolnum>
  <refmiscinfo class="software">OpenDJ</refmiscinfo>
  <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
 </refmeta>
 <refnamediv>
  <refname>ldapcompare</refname>
  <refpurpose>perform LDAP compare operations</refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  <cmdsynopsis>
   <command>ldapcompare</command>
   <arg choice="req">options</arg>
   <group><arg>attribute</arg><arg>:</arg><arg>value</arg></group>
   <arg choice="opt" rep="repeat">DN</arg>
  </cmdsynopsis>
 </refsynopsisdiv>
 <refsect1>
  <title>Description</title>
  <para>This utility can be used to perform LDAP compare operations in the
  directory.</para>
 </refsect1>
 <refsect1>
  <title>Options</title>
  <para>The following options are supported.</para>
  <variablelist>
   <varlistentry>
    <term><option>--assertionFilter {filter}</option></term>
    <listitem>
     <para>Use the LDAP assertion control with the provided filter</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-c, --continueOnError</option></term>
    <listitem>
     <para>Continue processing even if there are errors</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-f, --filename {file}</option></term>
    <listitem>
     <para>LDIF file containing one DN per line of entries to compare</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-J, --control {controloid[:criticality[:value|::b64value|:&lt;filePath]]}</option></term>
    <listitem>
     <para>Use a request control with the provided information</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-n, --dry-run</option></term>
    <listitem>
     <para>Show what would be done but do not perform any operation</para>
    </listitem>
   </varlistentry>
  </variablelist>
  <refsect2>
   <title>LDAP Connection Options</title>
   <variablelist>
    <varlistentry>
     <term><option>--connectTimeout {timeout}</option></term>
     <listitem>
      <para>Maximum length of time (in milliseconds) that can be taken to
      establish a connection.  Use '0' to specify no time out.</para>
      <para>Default value: 30000</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-D, --bindDN {bindDN}</option></term>
     <listitem>
      <para>DN to use to bind to the server</para>
      <para>Default value: cn=Directory Manager</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-h, --hostname {host}</option></term>
     <listitem>
      <para>Directory server hostname or IP address</para>
      <para>Default value: localhost.localdomain</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>
     <listitem>
      <para>Bind password file</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-K, --keyStorePath {keyStorePath}</option></term>
     <listitem>
      <para> Certificate key store path</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-N, --certNickname {nickname}</option></term>
     <listitem>
      <para>Nickname of certificate for SSL client authentication</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-o, --saslOption {name=value}</option></term>
     <listitem>
      <para>SASL bind options</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-p, --port {port}</option></term>
     <listitem>
      <para>Directory server port number</para>
      <para>Default value: 389</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-P, --trustStorePath {trustStorePath}</option></term>
     <listitem>
      <para>Certificate trust store path</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-q, --useStartTLS</option></term>
     <listitem>
      <para>Use StartTLS to secure communication with the server</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-r, --useSASLExternal</option></term>
     <listitem>
      <para>Use the SASL EXTERNAL authentication mechanism</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>--trustStorePassword {trustStorePassword}</option></term>
     <listitem>
      <para>Certificate trust store PIN</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
     <listitem>
      <para>Certificate key store PIN file</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-U, --trustStorePasswordFile {path}</option></term>
     <listitem>
      <para>Certificate trust store PIN file</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-V, --ldapVersion {version}</option></term>
     <listitem>
      <para>LDAP protocol version number</para>
      <para>Default value: 3</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-w, --bindPassword {bindPassword}</option></term>
     <listitem>
      <para>Password to use to bind to the server</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
     <listitem>
      <para>Certificate key store PIN</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-X, --trustAll</option></term>
     <listitem>
      <para>Trust all server SSL certificates</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-Z, --useSSL</option></term>
     <listitem>
      <para>Use SSL for secure communication with the server</para>
     </listitem>
    </varlistentry>
   </variablelist>
  </refsect2>
  <refsect2>
   <title>Utility Input/Output Options</title>
   <variablelist>
    <varlistentry>
     <term><option>-i, --encoding {encoding}</option></term>
     <listitem>
      <para>Use the specified character set for command-line input</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>--noPropertiesFile</option></term>
     <listitem>
      <para>No properties file will be used to get default command line
      argument values</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>--propertiesFilePath {propertiesFilePath}</option></term>
     <listitem>
      <para>Path to the file containing default property values used for
      command line arguments</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-s, --script-friendly</option></term>
     <listitem>
      <para>Use script-friendly mode</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-v, --verbose</option></term>
     <listitem>
      <para>Use verbose mode</para>
     </listitem>
    </varlistentry>
   </variablelist>
  </refsect2>
  <refsect2>
   <title>General Options</title>
   <variablelist>
    <varlistentry>
     <term><option>--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>
  </refsect2>
 </refsect1>
 <refsect1>
  <title>Exit Codes</title>
   <variablelist>
    <varlistentry>
     <term>0</term>
     <listitem>
      <para>The command completed successfully.</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><replaceable>ldap-error</replaceable></term>
     <listitem>
      <para>An LDAP error occurred while processing the operation.</para>
      <para>LDAP result codes are described in <link
      xlink:href="http://tools.ietf.org/html/rfc4511#appendix-A">RFC
      4511</link>. Also see the additional information for details.</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>89</term>
     <listitem>
      <para>An error occurred while parsing the command-line arguments.</para>
     </listitem>
    </varlistentry>
   </variablelist>
 </refsect1>
 <refsect1>
  <title>Files</title>
  <para>You can use <filename>~/.opendj/tools.properties</filename> to set
  the defaults for bind DN, host name, and port number as in the following
  example.</para>
  <programlisting language="ini">hostname=directory.example.com
port=1389
bindDN=uid=kvaughan,ou=People,dc=example,dc=com

ldapcompare.port=1389
ldapdelete.port=1389
ldapmodify.port=1389
ldappasswordmodify.port=1389
ldapsearch.port=1389</programlisting>
 </refsect1>
 <refsect1>
  <title>Examples</title>
  <para>The following examples demonstrate comparing Babs Jensen's UID.</para>
  <para>The following example uses a matching UID value.</para>
  <screen>$ ldapcompare -p 1389 uid:bjensen uid=bjensen,ou=people,dc=example,dc=com
Comparing type uid with value bjensen in entry
uid=bjensen,ou=people,dc=example,dc=com
Compare operation returned true for entry
uid=bjensen,ou=people,dc=example,dc=com</screen>
  <para>The following example uses a UID value that does not match.</para>
  <screen>$ ldapcompare -p 1389 uid:beavis uid=bjensen,ou=people,dc=example,dc=com
Comparing type uid with value beavis in entry
uid=bjensen,ou=people,dc=example,dc=com
Compare operation returned false for entry
uid=bjensen,ou=people,dc=example,dc=com</screen>
 </refsect1>
</refentry>

 opendj3/src/main/docbkx/admin-guide/man-ldapmodify.xml

New file
@@ -0,0 +1,405 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
  ! CCPL HEADER START
  !
  ! This work is licensed under the Creative Commons
  ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
  ! To view a copy of this license, visit
  ! http://creativecommons.org/licenses/by-nc-nd/3.0/
  ! or send a letter to Creative Commons, 444 Castro Street,
  ! Suite 900, Mountain View, California, 94041, USA.
  !
  ! You can also obtain a copy of the license at
  ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
  ! If applicable, add the following below this CCPL HEADER, with the fields
  ! enclosed by brackets "[]" replaced with your own identifying information:
  !      Portions Copyright [yyyy] [name of copyright owner]
  !
  ! CCPL HEADER END
  !
  !      Copyright 2011-2012 ForgeRock AS
  !    
-->
<refentry xml:id='ldapmodify-1'
 xmlns='http://docbook.org/ns/docbook'
 version='5.0' xml:lang='en'
 xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
 xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
 xmlns:xlink='http://www.w3.org/1999/xlink'
 xmlns:xinclude='http://www.w3.org/2001/XInclude'>
 <info><copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright></info>
 <refmeta>
  <refentrytitle>ldapmodify</refentrytitle><manvolnum>1</manvolnum>
  <refmiscinfo class="software">OpenDJ</refmiscinfo>
  <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
 </refmeta>
 <refnamediv>
  <refname>ldapmodify</refname>
  <refpurpose>perform LDAP modify, add, delete, mod DN operations</refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  <cmdsynopsis>
   <command>ldapmodify</command>
   <arg choice="req">options</arg>
  </cmdsynopsis>
 </refsynopsisdiv>
 <refsect1>
  <title>Description</title>
  <para>This utility can be used to perform LDAP modify, add, delete, and
  modify DN operations in the directory.</para>
  <para>When not using a file to specify modifications, end your input with
  EOF (Ctrl+D on UNIX, Ctrl+Z on Windows).</para>
 </refsect1>
 <refsect1>
  <title>Options</title>
  <para>The following options are supported.</para>
  <variablelist>
   <varlistentry>
    <term><option>-a, --defaultAdd</option></term>
    <listitem>
     <para>Treat records with no changetype as add operations</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>--assertionFilter {filter}</option></term>
    <listitem>
     <para>Use the LDAP assertion control with the provided filter</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-c, --continueOnError</option></term>
    <listitem>
     <para>Continue processing even if there are errors</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-f, --filename {file}</option></term>
    <listitem>
     <para>LDIF file containing the changes to apply</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-J, --control {controloid[:criticality[:value|::b64value|:&lt;filePath]]}</option></term>
    <listitem>
     <para>Use a request control with the provided information</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-n, --dry-run</option></term>
    <listitem>
     <para>Show what would be done but do not perform any operation</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>--postReadAttributes {attrList}</option></term>
    <listitem>
     <para>Use the LDAP ReadEntry post-read control</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>--preReadAttributes {attrList}</option></term>
    <listitem>
     <para>Use the LDAP ReadEntry pre-read control</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-Y, --proxyAs {authzID}</option></term>
    <listitem>
     <para>Use the proxied authorization control with the given authorization
     ID</para>
    </listitem>
   </varlistentry>
  </variablelist>
  <refsect2>
   <title>LDAP Connection Options</title>
   <variablelist>
    <varlistentry>
     <term><option>--connectTimeout {timeout}</option></term>
     <listitem>
      <para>Maximum length of time (in milliseconds) that can be taken to
      establish a connection.  Use '0' to specify no time out.</para>
      <para>Default value: 30000</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-D, --bindDN {bindDN}</option></term>
     <listitem>
      <para>DN to use to bind to the server</para>
      <para>Default value: cn=Directory Manager</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-E, --reportAuthzID</option></term>
     <listitem>
      <para>Use the authorization identity control</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-h, --hostname {host}</option></term>
     <listitem>
      <para>Directory server hostname or IP address</para>
      <para>Default value: localhost.localdomain</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>
     <listitem>
      <para>Bind password file</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-K, --keyStorePath {keyStorePath}</option></term>
     <listitem>
      <para> Certificate key store path</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-N, --certNickname {nickname}</option></term>
     <listitem>
      <para>Nickname of certificate for SSL client authentication</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-o, --saslOption {name=value}</option></term>
     <listitem>
      <para>SASL bind options</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-p, --port {port}</option></term>
     <listitem>
      <para>Directory server port number</para>
      <para>Default value: 389</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-P, --trustStorePath {trustStorePath}</option></term>
     <listitem>
      <para>Certificate trust store path</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-q, --useStartTLS</option></term>
     <listitem>
      <para>Use StartTLS to secure communication with the server</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-r, --useSASLExternal</option></term>
     <listitem>
      <para>Use the SASL EXTERNAL authentication mechanism</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>--trustStorePassword {trustStorePassword}</option></term>
     <listitem>
      <para>Certificate trust store PIN</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
     <listitem>
      <para>Certificate key store PIN file</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-U, --trustStorePasswordFile {path}</option></term>
     <listitem>
      <para>Certificate trust store PIN file</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-V, --ldapVersion {version}</option></term>
     <listitem>
      <para>LDAP protocol version number</para>
      <para>Default value: 3</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-w, --bindPassword {bindPassword}</option></term>
     <listitem>
      <para>Password to use to bind to the server</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
     <listitem>
      <para>Certificate key store PIN</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-X, --trustAll</option></term>
     <listitem>
      <para>Trust all server SSL certificates</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-Z, --useSSL</option></term>
     <listitem>
      <para>Use SSL for secure communication with the server</para>
     </listitem>
    </varlistentry>
   </variablelist>
  </refsect2>
  <refsect2>
   <title>Utility Input/Output Options</title>
   <variablelist>
    <varlistentry>
     <term><option>-i, --encoding {encoding}</option></term>
     <listitem>
      <para>Use the specified character set for command-line input</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>--noPropertiesFile</option></term>
     <listitem>
      <para>No properties file will be used to get default command line
      argument values</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>--propertiesFilePath {propertiesFilePath}</option></term>
     <listitem>
      <para>Path to the file containing default property values used for
      command line arguments</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-v, --verbose</option></term>
     <listitem>
      <para>Use verbose mode</para>
     </listitem>
    </varlistentry>
   </variablelist>
  </refsect2>
  <refsect2>
   <title>General Options</title>
   <variablelist>
    <varlistentry>
     <term><option>--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>
  </refsect2>
 </refsect1>
 <refsect1>
  <title>Exit Codes</title>
   <variablelist>
    <varlistentry>
     <term>0</term>
     <listitem>
      <para>The command completed successfully.</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><replaceable>ldap-error</replaceable></term>
     <listitem>
      <para>An LDAP error occurred while processing the operation.</para>
      <para>LDAP result codes are described in <link
      xlink:href="http://tools.ietf.org/html/rfc4511#appendix-A">RFC
      4511</link>. Also see the additional information for details.</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>89</term>
     <listitem>
      <para>An error occurred while parsing the command-line arguments.</para>
     </listitem>
    </varlistentry>
   </variablelist>
 </refsect1>
 <refsect1>
  <title>Files</title>
  <para>You can use <filename>~/.opendj/tools.properties</filename> to set
  the defaults for bind DN, host name, and port number as in the following
  example.</para>
  <programlisting language="ini">hostname=directory.example.com
port=1389
bindDN=uid=kvaughan,ou=People,dc=example,dc=com

ldapcompare.port=1389
ldapdelete.port=1389
ldapmodify.port=1389
ldappasswordmodify.port=1389
ldapsearch.port=1389</programlisting>
 </refsect1>
 <refsect1>
  <title>Examples</title>
  <para>The following example demonstrates use of the command to add an entry
  to the directory.</para>
  <screen>$ cat newuser.ldif 
dn: uid=newuser,ou=People,dc=example,dc=com
uid: newuser
facsimileTelephoneNumber: +1 408 555 1213
objectClass: person
objectClass: organizationalPerson
objectClass: inetOrgPerson
objectClass: posixAccount
objectClass: top
givenName: New
cn: New User
cn: Real Name
telephoneNumber: +1 408 555 1212
sn: Jensen
roomNumber: 1234
homeDirectory: /home/newuser
uidNumber: 10389
mail: newuser@example.com
l: South Pole
ou: Product Development
ou: People
gidNumber: 10636

$ ldapmodify -p 1389 -a -f newuser.ldif
 -D uid=kvaughan,ou=people,dc=example,dc=com -w bribery
Processing ADD request for uid=newuser,ou=People,dc=example,dc=com
ADD operation successful for DN uid=newuser,ou=People,dc=example,dc=com</screen>

 <para>The following example demonstrates adding a Description attribute
 to the new user's entry.</para>
 <screen>$ cat newdesc.ldif 
dn: uid=newuser,ou=People,dc=example,dc=com
changetype: modify
add: description
description: A new user's entry

$ ldapmodify -p 1389 -f newdesc.ldif
 -D uid=kvaughan,ou=people,dc=example,dc=com -w bribery
Processing MODIFY request for uid=newuser,ou=People,dc=example,dc=com
MODIFY operation successful for DN uid=newuser,ou=People,dc=example,dc=com</screen>
 
 <para>The following example demonstrates changing the Description attribute
 for the new user's entry.</para>
 <screen>$ cat moddesc.ldif 
dn: uid=newuser,ou=People,dc=example,dc=com
changetype: modify
replace: description
description: Another description

$ ldapmodify -p 1389 -f moddesc.ldif
 -D uid=kvaughan,ou=people,dc=example,dc=com -w bribery
Processing MODIFY request for uid=newuser,ou=People,dc=example,dc=com
MODIFY operation successful for DN uid=newuser,ou=People,dc=example,dc=com</screen>
 
 <para>The following example demonstrates deleting the new user's entry.</para>
 <screen>$ cat deluser.ldif 
dn: uid=newuser,ou=People,dc=example,dc=com
changetype: delete

$ ldapmodify -p 1389 -f deluser.ldif
 -D uid=kvaughan,ou=people,dc=example,dc=com -w bribery
Processing DELETE request for uid=newuser,ou=People,dc=example,dc=com
DELETE operation successful for DN uid=newuser,ou=People,dc=example,dc=com</screen>
 </refsect1>
</refentry>

 opendj3/src/main/docbkx/admin-guide/man-ldappasswordmodify.xml

New file
@@ -0,0 +1,318 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
  ! CCPL HEADER START
  !
  ! This work is licensed under the Creative Commons
  ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
  ! To view a copy of this license, visit
  ! http://creativecommons.org/licenses/by-nc-nd/3.0/
  ! or send a letter to Creative Commons, 444 Castro Street,
  ! Suite 900, Mountain View, California, 94041, USA.
  !
  ! You can also obtain a copy of the license at
  ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
  ! If applicable, add the following below this CCPL HEADER, with the fields
  ! enclosed by brackets "[]" replaced with your own identifying information:
  !      Portions Copyright [yyyy] [name of copyright owner]
  !
  ! CCPL HEADER END
  !
  !      Copyright 2011-2012 ForgeRock AS
  !    
-->
<refentry xml:id='ldappasswordmodify-1'
 xmlns='http://docbook.org/ns/docbook'
 version='5.0' xml:lang='en'
 xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
 xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
 xmlns:xlink='http://www.w3.org/1999/xlink'
 xmlns:xinclude='http://www.w3.org/2001/XInclude'>
 <info><copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright></info>
 <refmeta>
  <refentrytitle>ldappasswordmodify</refentrytitle><manvolnum>1</manvolnum>
  <refmiscinfo class="software">OpenDJ</refmiscinfo>
  <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
 </refmeta>
 <refnamediv>
  <refname>ldappasswordmodify</refname>
  <refpurpose>perform LDAP password modifications</refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  <cmdsynopsis>
   <command>ldappasswordmodify</command>
   <arg choice="req">options</arg>
  </cmdsynopsis>
 </refsynopsisdiv>
 <refsect1>
  <title>Description</title>
  <para>This utility can be used to perform LDAP password modify operations in
  the directory.</para>
 </refsect1>
 <refsect1>
  <title>Options</title>
  <para>The following options are supported.</para>
  <variablelist>
   <varlistentry>
    <term><option>-a, --authzID {authzID}</option></term>
    <listitem>
     <para>Authorization ID for the user entry whose password should be changed</para>
     <para>The authorization ID is a string having either the prefix
     <literal>dn:</literal> followed by the user's distinguished name, or
     the prefix <literal>u:</literal> followed by a user identifier that
     depends on the identity mapping used to match the user identifier to
     an entry in the directory. Examples include
     <literal>dn:uid=bjensen,ou=People,dc=example,dc=com</literal>, and, if
     we assume that <literal>bjensen</literal> is mapped to Barbara Jensen's
     entry, <literal>u:bjensen</literal>.</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-A, --provideDNForAuthzID</option></term>
    <listitem>
     <para>Use the bind DN as the authorization ID for the password modify
     operation</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-c, --currentPassword {currentPassword}</option></term>
    <listitem>
     <para>Current password for the target user</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-C, --currentPasswordFile {file}</option></term>
    <listitem>
     <para>Path to a file containing the current password for the target user</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-J, --control {controloid[:criticality[:value|::b64value|:&lt;filePath]]}</option></term>
    <listitem>
     <para>Use a request control with the provided information</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-n, --newPassword {newPassword}</option></term>
    <listitem>
     <para>New password to provide for the target user</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-N, --newPasswordFile {file}</option></term>
    <listitem>
     <para>Path to a file containing the new password to provide for the
     target user</para>
    </listitem>
   </varlistentry>
  </variablelist>
  <refsect2>
   <title>LDAP Connection Options</title>
   <variablelist>
    <varlistentry>
     <term><option>--certNickname {nickname}</option></term>
     <listitem>
      <para>Nickname of certificate for SSL client authentication</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>--connectTimeout {timeout}</option></term>
     <listitem>
      <para>Maximum length of time (in milliseconds) that can be taken to
      establish a connection.  Use '0' to specify no time out.</para>
      <para>Default: 30000</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-D, --bindDN {bindDN}</option></term>
     <listitem>
      <para>DN to use to bind to the server</para>
      <para>Default value: cn=Directory Manager</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-h, --hostname {host}</option></term>
     <listitem>
      <para>Directory server hostname or IP address</para>
      <para>Default value: localhost.localdomain</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>
     <listitem>
      <para>Bind password file</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-K, --keyStorePath {keyStorePath}</option></term>
     <listitem>
      <para> Certificate key store path</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-p, --port {port}</option></term>
     <listitem>
      <para>Directory server port number</para>
      <para>Default value: 389</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-P, --trustStorePath {trustStorePath}</option></term>
     <listitem>
      <para>Certificate trust store path</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-q, --useStartTLS</option></term>
     <listitem>
      <para>Use StartTLS to secure communication with the server</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>--trustStorePassword {trustStorePassword}</option></term>
     <listitem>
      <para>Certificate trust store PIN</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
     <listitem>
      <para>Certificate key store PIN file</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-U, --trustStorePasswordFile {path}</option></term>
     <listitem>
      <para>Certificate trust store PIN file</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-w, --bindPassword {bindPassword}</option></term>
     <listitem>
      <para>Password to use to bind to the server</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
     <listitem>
      <para>Certificate key store PIN</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-X, --trustAll</option></term>
     <listitem>
      <para>Trust all server SSL certificates</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-Z, --useSSL</option></term>
     <listitem>
      <para>Use SSL for secure communication with the server</para>
     </listitem>
    </varlistentry>
   </variablelist>
  </refsect2>
  <refsect2>
   <title>Utility Input/Output Options</title>
   <variablelist>
    <varlistentry>
     <term><option>--noPropertiesFile</option></term>
     <listitem>
      <para>No properties file will be used to get default command line
      argument values</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>--propertiesFilePath {propertiesFilePath}</option></term>
     <listitem>
      <para>Path to the file containing default property values used for
      command line arguments</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-?, -H, --help</option></term>
     <listitem>
      <para>Display usage information</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-V, --version</option></term>
     <listitem>
      <para>Display directory server version information</para>
     </listitem>
    </varlistentry>
   </variablelist>
  </refsect2>
  <refsect2>
   <title>General Options</title>
   <variablelist>
    <varlistentry>
     <term><option>--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>
  </refsect2>
 </refsect1>
 <refsect1>
  <title>Exit Codes</title>
   <variablelist>
    <varlistentry>
     <term>0</term>
     <listitem>
      <para>The command completed successfully.</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><replaceable>ldap-error</replaceable></term>
     <listitem>
      <para>An LDAP error occurred while processing the operation.</para>
      <para>LDAP result codes are described in <link
      xlink:href="http://tools.ietf.org/html/rfc4511#appendix-A">RFC
      4511</link>. Also see the additional information for details.</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>89</term>
     <listitem>
      <para>An error occurred while parsing the command-line arguments.</para>
     </listitem>
    </varlistentry>
   </variablelist>
 </refsect1>
 <refsect1>
  <title>Files</title>
  <para>You can use <filename>~/.opendj/tools.properties</filename> to set
  the defaults for bind DN, host name, and port number as in the following
  example.</para>
  <programlisting language="ini">hostname=directory.example.com
port=1389
bindDN=uid=kvaughan,ou=People,dc=example,dc=com

ldapcompare.port=1389
ldapdelete.port=1389
ldapmodify.port=1389
ldappasswordmodify.port=1389
ldapsearch.port=1389</programlisting>
 </refsect1>
 <refsect1>
  <title>Examples</title>
  <para>The following example demonstrates a user changing the password
  for her entry.</para>
  <screen>$ cat /tmp/currpwd.txt /tmp/newpwd.txt
bribery
secret12
$ ldappasswordmodify -p 1389 -C /tmp/currpwd.txt -N /tmp/newpwd.txt
-A -D uid=kvaughan,ou=people,dc=example,dc=com -w bribery
The LDAP password modify operation was successful</screen>
 </refsect1>
</refentry>

 opendj3/src/main/docbkx/admin-guide/man-ldapsearch.xml

New file
@@ -0,0 +1,462 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
  ! CCPL HEADER START
  !
  ! This work is licensed under the Creative Commons
  ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
  ! To view a copy of this license, visit
  ! http://creativecommons.org/licenses/by-nc-nd/3.0/
  ! or send a letter to Creative Commons, 444 Castro Street,
  ! Suite 900, Mountain View, California, 94041, USA.
  !
  ! You can also obtain a copy of the license at
  ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
  ! If applicable, add the following below this CCPL HEADER, with the fields
  ! enclosed by brackets "[]" replaced with your own identifying information:
  !      Portions Copyright [yyyy] [name of copyright owner]
  !
  ! CCPL HEADER END
  !
  !      Copyright 2011-2012 ForgeRock AS
  !    
-->
<refentry xml:id='ldapsearch-1'
 xmlns='http://docbook.org/ns/docbook'
 version='5.0' xml:lang='en'
 xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
 xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
 xmlns:xlink='http://www.w3.org/1999/xlink'
 xmlns:xinclude='http://www.w3.org/2001/XInclude'>
 <info><copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright></info>
 <refmeta>
  <refentrytitle>ldapsearch</refentrytitle><manvolnum>1</manvolnum>
  <refmiscinfo class="software">OpenDJ</refmiscinfo>
  <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
 </refmeta>
 <refnamediv>
  <refname>ldapsearch</refname>
  <refpurpose>perform LDAP search operations</refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  <cmdsynopsis>
   <command>ldapsearch</command>
   <arg choice="req">options</arg>
   <arg choice="opt">filter</arg>
   <arg choice="opt" rep="repeat">attributes</arg>
  </cmdsynopsis>
 </refsynopsisdiv>
 <refsect1>
  <title>Description</title>
  <para>This utility can be used to perform LDAP search operations in the
  directory.</para>
  <para>In the list of attributes to return, you can specify
  <literal>*</literal> to return all user attributes, <literal>+</literal> to
  return all operational attributes, and
  <literal>@<replaceable>object-class</replaceable></literal> to return
  all attributes associated with the <replaceable>object-class</replaceable>
  such as <literal>@person</literal>.</para>
 </refsect1>
 <refsect1>
  <title>Options</title>
  <para>The following options are supported.</para>
  <variablelist>
   <varlistentry>
    <term><option>-a, --dereferencePolicy {dereferencePolicy}</option></term>
    <listitem>
     <para>Alias dereference policy ('never', 'always', 'search', or 'find')</para>
     <para>Default value: never</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-A, --typesOnly</option></term>
    <listitem>
     <para>Only retrieve attribute names but not their values</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>--assertionFilter {filter}</option></term>
    <listitem>
     <para>Use the LDAP assertion control with the provided filter</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-b, --baseDN {baseDN}</option></term>
    <listitem>
     <para>Base DN format string</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-c, --continueOnError</option></term>
    <listitem>
     <para>Continue processing even if there are errors</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-C, --persistentSearch ps[:changetype[:changesonly[:entrychgcontrols]]]</option></term>
    <listitem>
     <para>Use the persistent search control</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>--countEntries</option></term>
    <listitem>
     <para>Count the number of entries returned by the server</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-e, --getEffectiveRightsAttribute {attribute}</option></term>
    <listitem>
     <para>Specifies geteffectiverights control specific attribute list</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-f, --filename {file}</option></term>
    <listitem>
     <para>LDIF file containing the changes to apply</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-g, --getEffectiveRightsAuthzid {authzID}</option></term>
    <listitem>
     <para>Use geteffectiverights control with the provided authzid</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-G, --virtualListView {before:after:index:count | before:after:value}</option></term>
    <listitem>
     <para>Use the virtual list view control to retrieve the specified results page</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-J, --control {controloid[:criticality[:value|::b64value|:&lt;filePath]]}</option></term>
    <listitem>
     <para>Use a request control with the provided information</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-l, --timeLimit {timeLimit}</option></term>
    <listitem>
     <para>Maximum length of time in seconds to allow for the search</para>
     <para>Default value: 0</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>--matchedValuesFilter {filter}</option></term>
    <listitem>
     <para>Use the LDAP matched values control with the provided filter</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-n, --dry-run</option></term>
    <listitem>
     <para>Show what would be done but do not perform any operation</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-s, --searchScope {searchScope}</option></term>
    <listitem>
     <para>Search scope ('base', 'one', 'sub', or 'subordinate')</para>
     <para>Default value: sub</para>
     <para><literal>subordinate</literal> is an LDAP extension that might
     not work with all LDAP servers.</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-S, --sortOrder {sortOrder}</option></term>
    <listitem>
     <para>Sort the results using the provided sort order</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>--simplePageSize {numEntries}</option></term>
    <listitem>
     <para>Use the simple paged results control with the given page size</para>
     <para>Default value: 1000</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>--subEntries</option></term>
    <listitem>
     <para>Use subentries control to specify that subentries are visible and
     normal entries are not</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-Y, --proxyAs {authzID}</option></term>
    <listitem>
     <para>Use the proxied authorization control with the given authorization
     ID</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-z, --sizeLimit {sizeLimit}</option></term>
    <listitem>
     <para>Maximum number of entries to return from the search</para>
     <para>Default value: 0</para>
    </listitem>
   </varlistentry>
  </variablelist>
  <refsect2>
   <title>LDAP Connection Options</title>
   <variablelist>
    <varlistentry>
     <term><option>--connectTimeout {timeout}</option></term>
     <listitem>
      <para>Maximum length of time (in milliseconds) that can be taken to
      establish a connection.  Use '0' to specify no time out.</para>
      <para>Default value: 30000</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-D, --bindDN {bindDN}</option></term>
     <listitem>
      <para>DN to use to bind to the server</para>
      <para>Default value: cn=Directory Manager</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-E, --reportAuthzID</option></term>
     <listitem>
      <para>Use the authorization identity control</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-h, --hostname {host}</option></term>
     <listitem>
      <para>Directory server hostname or IP address</para>
      <para>Default value: localhost.localdomain</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>
     <listitem>
      <para>Bind password file</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-K, --keyStorePath {keyStorePath}</option></term>
     <listitem>
      <para> Certificate key store path</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-N, --certNickname {nickname}</option></term>
     <listitem>
      <para>Nickname of certificate for SSL client authentication</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-o, --saslOption {name=value}</option></term>
     <listitem>
      <para>SASL bind options</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-p, --port {port}</option></term>
     <listitem>
      <para>Directory server port number</para>
      <para>Default value: 389</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-P, --trustStorePath {trustStorePath}</option></term>
     <listitem>
      <para>Certificate trust store path</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-q, --useStartTLS</option></term>
     <listitem>
      <para>Use StartTLS to secure communication with the server</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-r, --useSASLExternal</option></term>
     <listitem>
      <para>Use the SASL EXTERNAL authentication mechanism</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>--trustStorePassword {trustStorePassword}</option></term>
     <listitem>
      <para>Certificate trust store PIN</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
     <listitem>
      <para>Certificate key store PIN file</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-U, --trustStorePasswordFile {path}</option></term>
     <listitem>
      <para>Certificate trust store PIN file</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>--usePasswordPolicyControl</option></term>
     <listitem>
      <para>Use the password policy request control</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-V, --ldapVersion {version}</option></term>
     <listitem>
      <para>LDAP protocol version number</para>
      <para>Default value: 3</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-w, --bindPassword {bindPassword}</option></term>
     <listitem>
      <para>Password to use to bind to the server</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
     <listitem>
      <para>Certificate key store PIN</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-X, --trustAll</option></term>
     <listitem>
      <para>Trust all server SSL certificates</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-Z, --useSSL</option></term>
     <listitem>
      <para>Use SSL for secure communication with the server</para>
     </listitem>
    </varlistentry>
   </variablelist>
  </refsect2>
  <refsect2>
   <title>Utility Input/Output Options</title>
   <variablelist>
    <varlistentry>
     <term><option>-i, --encoding {encoding}</option></term>
     <listitem>
      <para>Use the specified character set for command-line input</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>--noPropertiesFile</option></term>
     <listitem>
      <para>No properties file will be used to get default command line
      argument values</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>--propertiesFilePath {propertiesFilePath}</option></term>
     <listitem>
      <para>Path to the file containing default property values used for
      command line arguments</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-T, --dontWrap</option></term>
     <listitem><para>Do not wrap long lines</para></listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-v, --verbose</option></term>
     <listitem>
      <para>Use verbose mode</para>
     </listitem>
    </varlistentry>
   </variablelist>
  </refsect2>
  <refsect2>
   <title>General Options</title>
   <variablelist>
    <varlistentry>
     <term><option>--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>
  </refsect2>
 </refsect1>
 <refsect1>
  <title>Exit Codes</title>
   <variablelist>
    <varlistentry>
     <term>0</term>
     <listitem>
      <para>The command completed successfully.</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><replaceable>ldap-error</replaceable></term>
     <listitem>
      <para>An LDAP error occurred while processing the operation.</para>
      <para>LDAP result codes are described in <link
      xlink:href="http://tools.ietf.org/html/rfc4511#appendix-A">RFC
      4511</link>. Also see the additional information for details.</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term>89</term>
     <listitem>
      <para>An error occurred while parsing the command-line arguments.</para>
     </listitem>
    </varlistentry>
   </variablelist>
 </refsect1>
 <refsect1>
  <title>Files</title>
  <para>You can use <filename>~/.opendj/tools.properties</filename> to set
  the defaults for bind DN, host name, and port number as in the following
  example.</para>
  <programlisting language="ini">hostname=directory.example.com
port=1389
bindDN=uid=kvaughan,ou=People,dc=example,dc=com

ldapcompare.port=1389
ldapdelete.port=1389
ldapmodify.port=1389
ldappasswordmodify.port=1389
ldapsearch.port=1389</programlisting>
 </refsect1>
 <refsect1>
  <title>Examples</title>
  <para>The following example searches for entries with UID containing
  <literal>jensen</literal>, returning only DNs and uid values.</para>
  <screen>$ ldapsearch -p 1389 -b dc=example,dc=com "(uid=*jensen*)" uid
dn: uid=ajensen,ou=People,dc=example,dc=com
uid: ajensen

dn: uid=bjensen,ou=People,dc=example,dc=com
uid: bjensen

dn: uid=gjensen,ou=People,dc=example,dc=com
uid: gjensen

dn: uid=jjensen,ou=People,dc=example,dc=com
uid: jjensen

dn: uid=kjensen,ou=People,dc=example,dc=com
uid: kjensen

dn: uid=rjensen,ou=People,dc=example,dc=com
uid: rjensen

dn: uid=tjensen,ou=People,dc=example,dc=com
uid: tjensen


Result Code:  0 (Success)</screen>
 </refsect1>
</refentry>

 opendj3/src/main/docbkx/admin-guide/man-ldifmodify.xml

New file
@@ -0,0 +1,152 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
  ! CCPL HEADER START
  !
  ! This work is licensed under the Creative Commons
  ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
  ! To view a copy of this license, visit
  ! http://creativecommons.org/licenses/by-nc-nd/3.0/
  ! or send a letter to Creative Commons, 444 Castro Street,
  ! Suite 900, Mountain View, California, 94041, USA.
  !
  ! You can also obtain a copy of the license at
  ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
  ! If applicable, add the following below this CCPL HEADER, with the fields
  ! enclosed by brackets "[]" replaced with your own identifying information:
  !      Portions Copyright [yyyy] [name of copyright owner]
  !
  ! CCPL HEADER END
  !
  !      Copyright 2011-2012 ForgeRock AS
  !    
-->
<refentry xml:id='ldifmodify-1'
 xmlns='http://docbook.org/ns/docbook'
 version='5.0' xml:lang='en'
 xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
 xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
 xmlns:xlink='http://www.w3.org/1999/xlink'
 xmlns:xinclude='http://www.w3.org/2001/XInclude'>
 <info><copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright></info>
 <refmeta>
  <refentrytitle>ldifmodify</refentrytitle><manvolnum>1</manvolnum>
  <refmiscinfo class="software">OpenDJ</refmiscinfo>
  <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
 </refmeta>
 <refnamediv>
  <refname>ldifmodify</refname>
  <refpurpose>apply LDIF changes to LDIF</refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  <cmdsynopsis>
   <command>ldifmodify</command>
   <arg choice="req">options</arg>
  </cmdsynopsis>
 </refsynopsisdiv>
 <refsect1>
  <title>Description</title>
  <para>This utility can be used to apply a set of modify, add, and delete
  operations against data in an LDIF file.</para>
 </refsect1>
 <refsect1>
  <title>Options</title>
  <para>The following options are supported.</para>
  <variablelist>
   <varlistentry>
    <term><option>-m, --changesLDIF {ldifFile}</option></term>
    <listitem>
     <para>LDIF file containing the changes to apply.</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-s, --sourceLDIF {ldifFile}</option></term>
    <listitem>
     <para>LDIF file containing the data to be updated.</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-t, --targetLDIF {ldifFile}</option></term>
    <listitem>
     <para>File to which the updated data should be written.</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>Exit Codes</title>
  <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>The following example demonstrates use of the command.</para>
  <screen>$ 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/newdiff.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.

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

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

 opendj3/src/main/docbkx/admin-guide/man-ldifsearch.xml

New file
@@ -0,0 +1,185 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
  ! CCPL HEADER START
  !
  ! This work is licensed under the Creative Commons
  ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
  ! To view a copy of this license, visit
  ! http://creativecommons.org/licenses/by-nc-nd/3.0/
  ! or send a letter to Creative Commons, 444 Castro Street,
  ! Suite 900, Mountain View, California, 94041, USA.
  !
  ! You can also obtain a copy of the license at
  ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
  ! If applicable, add the following below this CCPL HEADER, with the fields
  ! enclosed by brackets "[]" replaced with your own identifying information:
  !      Portions Copyright [yyyy] [name of copyright owner]
  !
  ! CCPL HEADER END
  !
  !      Copyright 2011-2012 ForgeRock AS
  !    
-->
<refentry xml:id='ldifsearch-1'
 xmlns='http://docbook.org/ns/docbook'
 version='5.0' xml:lang='en'
 xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
 xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
 xmlns:xlink='http://www.w3.org/1999/xlink'
 xmlns:xinclude='http://www.w3.org/2001/XInclude'>
 <info><copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright></info>
 <refmeta>
  <refentrytitle>ldifsearch</refentrytitle><manvolnum>1</manvolnum>
  <refmiscinfo class="software">OpenDJ</refmiscinfo>
  <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
 </refmeta>
 <refnamediv>
  <refname>ldifsearch</refname>
  <refpurpose>search LDIF with LDAP filters</refpurpose>
 </refnamediv>
 <refsynopsisdiv>
  <cmdsynopsis>
   <command>ldifsearch</command>
   <arg choice="req">options</arg>
   <arg choice="opt">filter</arg>
   <arg choice="opt" rep="repeat">attribute</arg>
  </cmdsynopsis>
 </refsynopsisdiv>
 <refsect1>
  <title>Description</title>
  <para>This utility can be used to perform search operations against data in
  an LDIF file.</para>
 </refsect1>
 <refsect1>
  <title>Options</title>
  <para>The following options are supported.</para>
  <variablelist>
   <varlistentry>
    <term><option>-b, --baseDN {baseDN}</option></term>
    <listitem>
     <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>Exit Codes</title>
  <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>The following example demonstrates use of the command.</para>
  <screen>$ 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>

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

@@ -20,7 +20,7 @@
  !
  ! CCPL HEADER END
  !
  !      Copyright 2011 ForgeRock AS
  !      Copyright 2011-2012 ForgeRock AS
  !    
-->
<refentry xml:id='ldapcompare-1'
@@ -30,11 +30,11 @@
 xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
 xmlns:xlink='http://www.w3.org/1999/xlink'
 xmlns:xinclude='http://www.w3.org/2001/XInclude'>
 <info><copyright><year>2011</year><holder>ForgeRock AS</holder></copyright></info>
 <info><copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright></info>
 <refmeta>
  <refentrytitle>ldapcompare</refentrytitle><manvolnum>1</manvolnum>
  <refmiscinfo class="software">OpenDJ</refmiscinfo>
  <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
  <refmiscinfo class="version"><?eval ${currentSDKversion}?></refmiscinfo>
 </refmeta>
 <refnamediv>
  <refname>ldapcompare</refname>

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

@@ -20,7 +20,7 @@
  !
  ! CCPL HEADER END
  !
  !      Copyright 2011 ForgeRock AS
  !      Copyright 2011-2012 ForgeRock AS
  !    
-->
<refentry xml:id='ldapmodify-1'
@@ -30,11 +30,11 @@
 xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
 xmlns:xlink='http://www.w3.org/1999/xlink'
 xmlns:xinclude='http://www.w3.org/2001/XInclude'>
 <info><copyright><year>2011</year><holder>ForgeRock AS</holder></copyright></info>
 <info><copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright></info>
 <refmeta>
  <refentrytitle>ldapmodify</refentrytitle><manvolnum>1</manvolnum>
  <refmiscinfo class="software">OpenDJ</refmiscinfo>
  <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
  <refmiscinfo class="version"><?eval ${currentSDKversion}?></refmiscinfo>
 </refmeta>
 <refnamediv>
  <refname>ldapmodify</refname>

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

@@ -34,7 +34,7 @@
 <refmeta>
  <refentrytitle>ldappasswordmodify</refentrytitle><manvolnum>1</manvolnum>
  <refmiscinfo class="software">OpenDJ</refmiscinfo>
  <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
  <refmiscinfo class="version"><?eval ${currentSDKversion}?></refmiscinfo>
 </refmeta>
 <refnamediv>
  <refname>ldappasswordmodify</refname>
@@ -89,6 +89,13 @@
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-F, --newPasswordFile {file}</option></term>
    <listitem>
     <para>Path to a file containing the new password to provide for the
     target user</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-J, --control {controloid[:criticality[:value|::b64value|:&lt;filePath]]}</option></term>
    <listitem>
     <para>Use a request control with the provided information</para>
@@ -100,32 +107,11 @@
     <para>New password to provide for the target user</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-N, --newPasswordFile {file}</option></term>
    <listitem>
     <para>Path to a file containing the new password to provide for the
     target user</para>
    </listitem>
   </varlistentry>
  </variablelist>
  <refsect2>
   <title>LDAP Connection Options</title>
   <variablelist>
    <varlistentry>
     <term><option>--certNickname {nickname}</option></term>
     <listitem>
      <para>Nickname of certificate for SSL client authentication</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>--connectTimeout {timeout}</option></term>
     <listitem>
      <para>Maximum length of time (in milliseconds) that can be taken to
      establish a connection.  Use '0' to specify no time out.</para>
      <para>Default: 30000</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-D, --bindDN {bindDN}</option></term>
     <listitem>
      <para>DN to use to bind to the server</para>
@@ -133,6 +119,12 @@
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-E, --reportAuthzID</option></term>
     <listitem>
      <para>Use the authorization identity control</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-h, --hostname {host}</option></term>
     <listitem>
      <para>Directory server hostname or IP address</para>
@@ -152,6 +144,18 @@
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-N, --certNickname {nickname}</option></term>
     <listitem>
      <para>Nickname of certificate for SSL client authentication</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-o, --saslOption {name=value}</option></term>
     <listitem>
      <para>SASL bind options</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-p, --port {port}</option></term>
     <listitem>
      <para>Directory server port number</para>
@@ -171,7 +175,7 @@
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>--trustStorePassword {trustStorePassword}</option></term>
     <term><option>-T, --trustStorePassword {trustStorePassword}</option></term>
     <listitem>
      <para>Certificate trust store PIN</para>
     </listitem>
@@ -189,6 +193,19 @@
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>--usePasswordPolicyControl</option></term>
     <listitem>
      <para>Use the password policy request control</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-V, --ldapVersion {version}</option></term>
     <listitem>
      <para>LDAP protocol version number</para>
      <para>Default value: 3</para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-w, --bindPassword {bindPassword}</option></term>
     <listitem>
      <para>Password to use to bind to the server</para>
@@ -238,9 +255,9 @@
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><option>-V, --version</option></term>
     <term><option>-v, --verbose</option></term>
     <listitem>
      <para>Display directory server version information</para>
      <para>Use verbose mode</para>
     </listitem>
    </varlistentry>
   </variablelist>

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

@@ -20,7 +20,7 @@
  !
  ! CCPL HEADER END
  !
  !      Copyright 2011 ForgeRock AS
  !      Copyright 2011-2012 ForgeRock AS
  !    
-->
<refentry xml:id='ldapsearch-1'
@@ -30,11 +30,11 @@
 xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
 xmlns:xlink='http://www.w3.org/1999/xlink'
 xmlns:xinclude='http://www.w3.org/2001/XInclude'>
 <info><copyright><year>2011</year><holder>ForgeRock AS</holder></copyright></info>
 <info><copyright><year>2011-2012</year><holder>ForgeRock AS</holder></copyright></info>
 <refmeta>
  <refentrytitle>ldapsearch</refentrytitle><manvolnum>1</manvolnum>
  <refmiscinfo class="software">OpenDJ</refmiscinfo>
  <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
  <refmiscinfo class="version"><?eval ${currentSDKversion}?></refmiscinfo>
 </refmeta>
 <refnamediv>
  <refname>ldapsearch</refname>

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

@@ -34,7 +34,7 @@
 <refmeta>
  <refentrytitle>ldifmodify</refentrytitle><manvolnum>1</manvolnum>
  <refmiscinfo class="software">OpenDJ</refmiscinfo>
  <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
  <refmiscinfo class="version"><?eval ${currentSDKversion}?></refmiscinfo>
 </refmeta>
 <refnamediv>
  <refname>ldifmodify</refname>
@@ -44,6 +44,8 @@
  <cmdsynopsis>
   <command>ldifmodify</command>
   <arg choice="req">options</arg>
   <arg choice="plain">source</arg>
   <arg choice="opt">changes</arg>
  </cmdsynopsis>
 </refsynopsisdiv>
 <refsect1>
@@ -56,21 +58,16 @@
  <para>The following options are supported.</para>
  <variablelist>
   <varlistentry>
    <term><option>-m, --changesLDIF {ldifFile}</option></term>
    <term><option>-c, --continueOnError</option></term>
    <listitem>
     <para>LDIF file containing the changes to apply.</para>
     <para>Continue processing even if there are errors</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-s, --sourceLDIF {ldifFile}</option></term>
    <term><option>-o, --outputLDIF {file}</option></term>
    <listitem>
     <para>LDIF file containing the data to be updated.</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-t, --targetLDIF {ldifFile}</option></term>
    <listitem>
     <para>File to which the updated data should be written.</para>
     <para>Write updated entries to {file} instead of stdout</para>
     <para>Default value: stdout</para>
    </listitem>
   </varlistentry>
   <varlistentry>
@@ -107,7 +104,7 @@
 <refsect1>
  <title>Examples</title>
  <para>The following example demonstrates use of the command.</para>
  <screen>$ cat /path/to/newuser.ldif 
  <screen>$ cat /path/to/newuser.ldif
dn: uid=newuser,ou=People,dc=example,dc=com
uid: newuser
objectClass: person
@@ -119,8 +116,8 @@
ou: People
mail: newuser@example.com
userPassword: changeme
  
$ cat /path/to/newdiff.ldif 

$ cat /path/to/newdiff.ldif
dn: uid=newuser,ou=People,dc=example,dc=com
changetype: modify
add: userPassword
@@ -132,21 +129,20 @@
add: description
description: A new description.

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

mail: newuser@example.com
userPassword: secret12
description: A new description.
</screen>
 </refsect1>
</refentry>

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

@@ -34,7 +34,7 @@
 <refmeta>
  <refentrytitle>ldifsearch</refentrytitle><manvolnum>1</manvolnum>
  <refmiscinfo class="software">OpenDJ</refmiscinfo>
  <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
  <refmiscinfo class="version"><?eval ${currentSDKversion}?></refmiscinfo>
 </refmeta>
 <refnamediv>
  <refname>ldifsearch</refname>
@@ -44,6 +44,7 @@
  <cmdsynopsis>
   <command>ldifsearch</command>
   <arg choice="req">options</arg>
   <arg choice="plain">source</arg>
   <arg choice="opt">filter</arg>
   <arg choice="opt" rep="repeat">attribute</arg>
  </cmdsynopsis>
@@ -58,62 +59,42 @@
  <para>The following options are supported.</para>
  <variablelist>
   <varlistentry>
    <term><option>-A, --typesOnly</option></term>
    <listitem>
     <para>Only retrieve attribute names but not their values</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-b, --baseDN {baseDN}</option></term>
    <listitem>
     <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>
     <para>Search base DN</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>
     <para>File containing a list of search filter strings</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-l, --ldifFile {ldifFile}</option></term>
    <term><option>-l, --timeLimit {timeLimit}</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>
     <para>Maximum length of time in seconds to allow for the search</para>
     <para>Default value: 0</para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-o, --outputFile {outputFile}</option></term>
    <term><option>-o, --outputFile {File}</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>
     <para>Write search results to {file} instead of stdout</para>
     <para>Default: stdout</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>
     <para>Search scope ('base', 'one', 'sub', or 'subordinate')</para>
     <para>Default value: sub</para>
    </listitem>
   </varlistentry>
   <varlistentry>
@@ -125,7 +106,7 @@
   <varlistentry>
    <term><option>-z, --sizeLimit {sizeLimit}</option></term>
    <listitem>
     <para>Maximum number of matching entries to return.</para>
     <para>Maximum number of matching entries to return from the search</para>
     <para>Default value: 0</para>
    </listitem>
   </varlistentry>
@@ -157,7 +138,7 @@
 <refsect1>
  <title>Examples</title>
  <para>The following example demonstrates use of the command.</para>
  <screen>$ ldifsearch -l /path/to/Example.ldif -b dc=example,dc=com uid=bjensen
  <screen>$ ldifsearch -b dc=example,dc=com /path/to/Example.ldif uid=bjensen
dn: uid=bjensen,ou=People,dc=example,dc=com
objectClass: person
objectClass: organizationalPerson
@@ -180,7 +161,6 @@
ou: People
uidNumber: 1076
gidNumber: 1000

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

 opends/resource/man/man1/backup.1

@@ -2,12 +2,12 @@
.\"     Title: backup
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: January\ \&03,\ \&2012
.\"      Date: 03/21/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "BACKUP" "1" "January\ \&03,\ \&2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "BACKUP" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

 opends/resource/man/man1/base64.1

@@ -2,12 +2,12 @@
.\"     Title: base64
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: January\ \&03,\ \&2012
.\"      Date: 03/21/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "BASE64" "1" "January\ \&03,\ \&2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "BASE64" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

 opends/resource/man/man1/control-panel.1

@@ -2,12 +2,12 @@
.\"     Title: control-panel
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: January\ \&03,\ \&2012
.\"      Date: 03/21/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "CONTROL\-PANEL" "1" "January\ \&03,\ \&2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "CONTROL\-PANEL" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

 opends/resource/man/man1/create-rc-script.1

@@ -2,12 +2,12 @@
.\"     Title: create-rc-script
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: January\ \&03,\ \&2012
.\"      Date: 03/21/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "CREATE\-RC\-SCRIPT" "1" "January\ \&03,\ \&2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "CREATE\-RC\-SCRIPT" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

 opends/resource/man/man1/dbtest.1

@@ -2,12 +2,12 @@
.\"     Title: dbtest
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: January\ \&03,\ \&2012
.\"      Date: 03/21/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "DBTEST" "1" "January\ \&03,\ \&2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "DBTEST" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

 opends/resource/man/man1/dsconfig.1

@@ -2,12 +2,12 @@
.\"     Title: dsconfig
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: January\ \&03,\ \&2012
.\"      Date: 03/21/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "DSCONFIG" "1" "January\ \&03,\ \&2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "DSCONFIG" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

 opends/resource/man/man1/dsframework.1

@@ -2,12 +2,12 @@
.\"     Title: dsframework
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: January\ \&03,\ \&2012
.\"      Date: 03/21/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "DSFRAMEWORK" "1" "January\ \&03,\ \&2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "DSFRAMEWORK" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

 opends/resource/man/man1/dsjavaproperties.1

@@ -2,12 +2,12 @@
.\"     Title: dsjavaproperties
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: January\ \&03,\ \&2012
.\"      Date: 03/21/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "DSJAVAPROPERTIES" "1" "January\ \&03,\ \&2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "DSJAVAPROPERTIES" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

 opends/resource/man/man1/dsreplication.1

@@ -2,12 +2,12 @@
.\"     Title: dsreplication
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: January\ \&03,\ \&2012
.\"      Date: 03/21/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "DSREPLICATION" "1" "January\ \&03,\ \&2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "DSREPLICATION" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

 opends/resource/man/man1/encode-password.1

@@ -2,12 +2,12 @@
.\"     Title: encode-password
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: January\ \&03,\ \&2012
.\"      Date: 03/21/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "ENCODE\-PASSWORD" "1" "January\ \&03,\ \&2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "ENCODE\-PASSWORD" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

 opends/resource/man/man1/export-ldif.1

@@ -2,12 +2,12 @@
.\"     Title: export-ldif
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: January\ \&03,\ \&2012
.\"      Date: 03/21/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "EXPORT\-LDIF" "1" "January\ \&03,\ \&2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "EXPORT\-LDIF" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

 opends/resource/man/man1/import-ldif.1

@@ -2,12 +2,12 @@
.\"     Title: import-ldif
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: January\ \&03,\ \&2012
.\"      Date: 03/21/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "IMPORT\-LDIF" "1" "January\ \&03,\ \&2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "IMPORT\-LDIF" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

 opends/resource/man/man1/ldapcompare.1

@@ -2,12 +2,12 @@
.\"     Title: ldapcompare
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: November\ \&21,\ \&2011
.\"      Date: 03/21/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "LDAPCOMPARE" "1" "November\ \&21,\ \&2011" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "LDAPCOMPARE" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -63,13 +63,15 @@
.RS 4
Show what would be done but do not perform any operation
.RE
.PP
\fB\-Y, \-\-proxyAs {authzID}\fR
.RS 4
Use the proxied authorization control with the given authorization ID
.RE
.SS "LDAP Connection Options"
.PP
\fB\-\-connectTimeout {timeout}\fR
.RS 4
Maximum length of time (in milliseconds) that can be taken to establish a connection\&. Use \*(Aq0\*(Aq to specify no time out\&.
.sp
Default value: 30000
.RE
.PP
\fB\-D, \-\-bindDN {bindDN}\fR
.RS 4
DN to use to bind to the server
@@ -77,11 +79,6 @@
Default value: cn=Directory Manager
.RE
.PP
\fB\-E, \-\-reportAuthzID\fR
.RS 4
Use the authorization identity control
.RE
.PP
\fB\-h, \-\-hostname {host}\fR
.RS 4
Directory server hostname or IP address
@@ -126,7 +123,12 @@
Use StartTLS to secure communication with the server
.RE
.PP
\fB\-T, \-\-trustStorePassword {trustStorePassword}\fR
\fB\-r, \-\-useSASLExternal\fR
.RS 4
Use the SASL EXTERNAL authentication mechanism
.RE
.PP
\fB\-\-trustStorePassword {trustStorePassword}\fR
.RS 4
Certificate trust store PIN
.RE
@@ -141,11 +143,6 @@
Certificate trust store PIN file
.RE
.PP
\fB\-\-usePasswordPolicyControl\fR
.RS 4
Use the password policy request control
.RE
.PP
\fB\-V, \-\-ldapVersion {version}\fR
.RS 4
LDAP protocol version number
@@ -189,6 +186,11 @@
Path to the file containing default property values used for command line arguments
.RE
.PP
\fB\-s, \-\-script\-friendly\fR
.RS 4
Use script\-friendly mode
.RE
.PP
\fB\-v, \-\-verbose\fR
.RS 4
Use verbose mode
@@ -283,5 +285,5 @@
.\}
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
Copyright \(co 2011-2012 ForgeRock AS
.br

 opends/resource/man/man1/ldapdelete.1

@@ -2,12 +2,12 @@
.\"     Title: ldapdelete
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: January\ \&03,\ \&2012
.\"      Date: 03/21/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "LDAPDELETE" "1" "January\ \&03,\ \&2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "LDAPDELETE" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

 opends/resource/man/man1/ldapmodify.1

@@ -2,12 +2,12 @@
.\"     Title: ldapmodify
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: November\ \&21,\ \&2011
.\"      Date: 03/21/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "LDAPMODIFY" "1" "November\ \&21,\ \&2011" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "LDAPMODIFY" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -87,6 +87,13 @@
.RE
.SS "LDAP Connection Options"
.PP
\fB\-\-connectTimeout {timeout}\fR
.RS 4
Maximum length of time (in milliseconds) that can be taken to establish a connection\&. Use \*(Aq0\*(Aq to specify no time out\&.
.sp
Default value: 30000
.RE
.PP
\fB\-D, \-\-bindDN {bindDN}\fR
.RS 4
DN to use to bind to the server
@@ -143,7 +150,12 @@
Use StartTLS to secure communication with the server
.RE
.PP
\fB\-T, \-\-trustStorePassword {trustStorePassword}\fR
\fB\-r, \-\-useSASLExternal\fR
.RS 4
Use the SASL EXTERNAL authentication mechanism
.RE
.PP
\fB\-\-trustStorePassword {trustStorePassword}\fR
.RS 4
Certificate trust store PIN
.RE
@@ -158,11 +170,6 @@
Certificate trust store PIN file
.RE
.PP
\fB\-\-usePasswordPolicyControl\fR
.RS 4
Use the password policy request control
.RE
.PP
\fB\-V, \-\-ldapVersion {version}\fR
.RS 4
LDAP protocol version number
@@ -365,5 +372,5 @@
.\}
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
Copyright \(co 2011-2012 ForgeRock AS
.br

 opends/resource/man/man1/ldappasswordmodify.1

@@ -2,12 +2,12 @@
.\"     Title: ldappasswordmodify
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: 02/20/2012
.\"      Date: 03/21/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "LDAPPASSWORDMODIFY" "1" "02/20/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "LDAPPASSWORDMODIFY" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

 opends/resource/man/man1/ldapsearch.1

@@ -2,12 +2,12 @@
.\"     Title: ldapsearch
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: November\ \&21,\ \&2011
.\"      Date: 03/21/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "LDAPSEARCH" "1" "November\ \&21,\ \&2011" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "LDAPSEARCH" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -151,6 +151,11 @@
Default value: 1000
.RE
.PP
\fB\-\-subEntries\fR
.RS 4
Use subentries control to specify that subentries are visible and normal entries are not
.RE
.PP
\fB\-Y, \-\-proxyAs {authzID}\fR
.RS 4
Use the proxied authorization control with the given authorization ID
@@ -164,6 +169,13 @@
.RE
.SS "LDAP Connection Options"
.PP
\fB\-\-connectTimeout {timeout}\fR
.RS 4
Maximum length of time (in milliseconds) that can be taken to establish a connection\&. Use \*(Aq0\*(Aq to specify no time out\&.
.sp
Default value: 30000
.RE
.PP
\fB\-D, \-\-bindDN {bindDN}\fR
.RS 4
DN to use to bind to the server
@@ -220,7 +232,12 @@
Use StartTLS to secure communication with the server
.RE
.PP
\fB\-T, \-\-trustStorePassword {trustStorePassword}\fR
\fB\-r, \-\-useSASLExternal\fR
.RS 4
Use the SASL EXTERNAL authentication mechanism
.RE
.PP
\fB\-\-trustStorePassword {trustStorePassword}\fR
.RS 4
Certificate trust store PIN
.RE
@@ -283,7 +300,7 @@
Path to the file containing default property values used for command line arguments
.RE
.PP
\fB\-t, \-\-dontWrap\fR
\fB\-T, \-\-dontWrap\fR
.RS 4
Do not wrap long lines
.RE
@@ -384,5 +401,5 @@
.\}
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
Copyright \(co 2011-2012 ForgeRock AS
.br

 opends/resource/man/man1/ldif-diff.1

File was renamed from opends/resource/man/man1/ldifdiff.1
@@ -1,13 +1,13 @@
'\" t
.\"     Title: ldifdiff
.\"     Title: ldif-diff
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: January\ \&06,\ \&2012
.\"      Date: 03/21/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "LDIFDIFF" "1" "January\ \&06,\ \&2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "LDIF\-DIFF" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -28,10 +28,10 @@
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ldifdiff \- compare small LDIF files
ldif-diff \- compare small LDIF files
.SH "SYNOPSIS"
.HP \w'\fBldifdiff\fR\ 'u
\fBldifdiff\fR [\fIsource\fR\&.ldif] [\fItarget\fR\&.ldif] [options]
.HP \w'\fBldif\-diff\fR\ 'u
\fBldif\-diff\fR {options}
.SH "DESCRIPTION"
.PP
This utility can be used to compare two LDIF files and report the differences in LDIF format\&.
@@ -54,11 +54,31 @@
File containing a list of entries (DN) to ignore when computing the difference\&.
.RE
.PP
\fB\-o, \-\-outputLDIF {file}\fR
.RS 4
File to which the output should be written\&.
.RE
.PP
\fB\-O, \-\-overwriteExisting\fR
.RS 4
Any existing output file should be overwritten rather than appending to it\&.
.RE
.PP
\fB\-s, \-\-sourceLDIF {file}\fR
.RS 4
LDIF file to use as the source data\&.
.RE
.PP
\fB\-S, \-\-singleValueChanges\fR
.RS 4
Each attribute\-level change should be written as a separate modification per attribute value rather than one modification per entry\&.
.RE
.PP
\fB\-t, \-\-targetLDIF {file}\fR
.RS 4
LDIF file to use as the target data\&.
.RE
.PP
\fB\-V, \-\-version\fR
.RS 4
Display version information\&.
@@ -87,7 +107,7 @@
.RS 4
.\}
.nf
$ cat /path/to/newuser\&.ldif
$ cat /path/to/newuser\&.ldif 
dn: uid=newuser,ou=People,dc=example,dc=com
uid: newuser
objectClass: person
@@ -100,7 +120,7 @@
mail: newuser@example\&.com
userPassword: changeme

$ cat /path/to/neweruser\&.ldif
$ cat /path/to/neweruser\&.ldif 
dn: uid=newuser,ou=People,dc=example,dc=com
uid: newuser
objectClass: person
@@ -114,7 +134,7 @@
userPassword: secret12
description: A new description\&.

$ ldifdiff /path/to/newuser\&.ldif /path/to/neweruser\&.ldif
$ 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

 opends/resource/man/man1/ldifmodify.1

@@ -2,12 +2,12 @@
.\"     Title: ldifmodify
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: January\ \&03,\ \&2012
.\"      Date: 03/21/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "LDIFMODIFY" "1" "January\ \&03,\ \&2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "LDIFMODIFY" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

 opends/resource/man/man1/ldifsearch.1

@@ -2,12 +2,12 @@
.\"     Title: ldifsearch
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: January\ \&03,\ \&2012
.\"      Date: 03/21/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "LDIFSEARCH" "1" "January\ \&03,\ \&2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "LDIFSEARCH" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -139,7 +139,6 @@
ou: People
uidNumber: 1076
gidNumber: 1000

.fi
.if n \{\
.RE

 opends/resource/man/man1/list-backends.1

@@ -2,12 +2,12 @@
.\"     Title: list-backends
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: January\ \&03,\ \&2012
.\"      Date: 03/21/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "LIST\-BACKENDS" "1" "January\ \&03,\ \&2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "LIST\-BACKENDS" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

 opends/resource/man/man1/make-ldif.1

@@ -2,12 +2,12 @@
.\"     Title: make-ldif
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: January\ \&03,\ \&2012
.\"      Date: 03/21/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "MAKE\-LDIF" "1" "January\ \&03,\ \&2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "MAKE\-LDIF" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

 opends/resource/man/man1/manage-account.1

@@ -2,12 +2,12 @@
.\"     Title: manage-account
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: January\ \&03,\ \&2012
.\"      Date: 03/21/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "MANAGE\-ACCOUNT" "1" "January\ \&03,\ \&2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "MANAGE\-ACCOUNT" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

 opends/resource/man/man1/manage-tasks.1

@@ -2,12 +2,12 @@
.\"     Title: manage-tasks
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: January\ \&03,\ \&2012
.\"      Date: 03/21/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "MANAGE\-TASKS" "1" "January\ \&03,\ \&2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "MANAGE\-TASKS" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

 opends/resource/man/man1/rebuild-index.1

@@ -2,12 +2,12 @@
.\"     Title: rebuild-index
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: January\ \&27,\ \&2012
.\"      Date: 03/21/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "REBUILD\-INDEX" "1" "January\ \&27,\ \&2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "REBUILD\-INDEX" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

 opends/resource/man/man1/restore.1

@@ -2,12 +2,12 @@
.\"     Title: restore
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: January\ \&03,\ \&2012
.\"      Date: 03/21/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "RESTORE" "1" "January\ \&03,\ \&2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "RESTORE" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

 opends/resource/man/man1/setup.1

@@ -2,12 +2,12 @@
.\"     Title: setup
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: January\ \&03,\ \&2012
.\"      Date: 03/21/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "SETUP" "1" "January\ \&03,\ \&2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "SETUP" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

 opends/resource/man/man1/start-ds.1

@@ -2,12 +2,12 @@
.\"     Title: start-ds
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: January\ \&03,\ \&2012
.\"      Date: 03/21/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "START\-DS" "1" "January\ \&03,\ \&2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "START\-DS" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

 opends/resource/man/man1/status.1

@@ -2,12 +2,12 @@
.\"     Title: status
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: January\ \&03,\ \&2012
.\"      Date: 03/21/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "STATUS" "1" "January\ \&03,\ \&2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "STATUS" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

 opends/resource/man/man1/stop-ds.1

@@ -2,12 +2,12 @@
.\"     Title: stop-ds
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: January\ \&03,\ \&2012
.\"      Date: 03/21/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "STOP\-DS" "1" "January\ \&03,\ \&2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "STOP\-DS" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

 opends/resource/man/man1/uninstall.1

@@ -2,12 +2,12 @@
.\"     Title: uninstall
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: January\ \&03,\ \&2012
.\"      Date: 03/21/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "UNINSTALL" "1" "January\ \&03,\ \&2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "UNINSTALL" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

 opends/resource/man/man1/upgrade.1

@@ -2,12 +2,12 @@
.\"     Title: upgrade
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: January\ \&03,\ \&2012
.\"      Date: 03/21/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "UPGRADE" "1" "January\ \&03,\ \&2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "UPGRADE" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

 opends/resource/man/man1/verify-index.1

@@ -2,12 +2,12 @@
.\"     Title: verify-index
.\"    Author: 
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: January\ \&03,\ \&2012
.\"      Date: 03/21/2012
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "VERIFY\-INDEX" "1" "January\ \&03,\ \&2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.TH "VERIFY\-INDEX" "1" "03/21/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------