From 2daf3a6626ef94d75790b1e3a118c7cb350e1018 Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Wed, 02 Nov 2016 17:44:02 +0000
Subject: [PATCH] OPENDJ-3443 Document changes to command-line tools
---
opendj-doc-generated-ref/src/main/assembly/sdk-tools-man-pages-assembly.xml | 160 ++++++++++
opendj-doc-generated-ref/src/main/docbkx/man-pages/index.xml | 6
opendj-doc-generated-ref/src/main/docbkx/man-pages/man-makeldif-template.xml | 25
opendj-doc-generated-ref/src/main/docbkx/man-pages/authrate-examples.xml | 59 +++
opendj-doc-generated-ref/src/main/docbkx/man-pages/description-makeldif.xml | 136 ++++++++
opendj-doc-generated-ref/src/main/docbkx/man-pages/makeldif-examples.xml | 4
opendj-doc-generated-ref/src/main/docbkx/man-pages/exit-codes-0-80-89.xml | 61 +++
opendj-doc-generated-ref/pom.xml | 4
opendj-doc-generated-ref/src/main/docbkx/man-pages/ldifsearch-examples.xml | 7
opendj-doc-generated-ref/src/main/docbkx/man-pages/ldapcompare-exit-codes.xml | 7
opendj-doc-generated-ref/src/main/docbkx/man-pages/ldapmodify-examples.xml | 26
opendj-doc-generated-ref/src/main/docbkx/man-pages/ldifdiff-examples.xml | 4
opendj-doc-generated-ref/src/main/docbkx/man-pages/addrate-examples.xml | 122 +++++++
opendj-doc-generated-ref/src/main/docbkx/man-pages/ldifdiff-exit-codes.xml | 42 +
opendj-doc-generated-ref/src/main/docbkx/man-pages/searchrate-examples.xml | 55 +++
opendj-doc-generated-ref/src/main/docbkx/man-pages/ldapsearch-examples.xml | 9
opendj-core/src/main/java/org/forgerock/opendj/ldif/EntryGenerator.java | 2
opendj-doc-generated-ref/src/main/docbkx/man-pages/modrate-examples.xml | 57 +++
opendj-doc-generated-ref/src/main/docbkx/man-pages/description-rate-tools.xml | 87 +++++
opendj-server-legacy/src/main/docbkx/man-pages/index.xml | 10
opendj-doc-generated-ref/src/main/docbkx/man-pages/description-resource-path.xml | 56 +++
opendj-doc-generated-ref/src/main/docbkx/man-pages/makeldif-see-also.xml | 4
22 files changed, 872 insertions(+), 71 deletions(-)
diff --git a/opendj-core/src/main/java/org/forgerock/opendj/ldif/EntryGenerator.java b/opendj-core/src/main/java/org/forgerock/opendj/ldif/EntryGenerator.java
index c23e494..bdcc09c 100644
--- a/opendj-core/src/main/java/org/forgerock/opendj/ldif/EntryGenerator.java
+++ b/opendj-core/src/main/java/org/forgerock/opendj/ldif/EntryGenerator.java
@@ -36,7 +36,7 @@
import org.forgerock.util.Reject;
/**
- * A template driven entry generator, as used by the make-ldif tool.
+ * A template driven entry generator, as used by the makeldif tool.
* <p>
* To build a generator with default values, including default template file,
* use the empty constructor:
diff --git a/opendj-doc-generated-ref/pom.xml b/opendj-doc-generated-ref/pom.xml
index 285bffe..cef31e9 100644
--- a/opendj-doc-generated-ref/pom.xml
+++ b/opendj-doc-generated-ref/pom.xml
@@ -211,7 +211,7 @@
<name>ldapcompare</name>
<application>com.forgerock.opendj.ldap.tools.LDAPCompare</application>
<trailingSectionPaths>
- <trailingSectionPath>exit-codes-0-ldap-89.xml</trailingSectionPath>
+ <trailingSectionPath>ldapcompare-exit-codes.xml</trailingSectionPath>
<trailingSectionPath>files.xml</trailingSectionPath>
<trailingSectionPath>ldapcompare-examples.xml</trailingSectionPath>
</trailingSectionPaths>
@@ -265,7 +265,7 @@
<name>ldifdiff</name>
<application>com.forgerock.opendj.ldap.tools.LDIFDiff</application>
<trailingSectionPaths>
- <trailingSectionPath>exit-codes-0-5-6-other.xml</trailingSectionPath>
+ <trailingSectionPath>ldifdiff-exit-codes.xml</trailingSectionPath>
<trailingSectionPath>ldifdiff-examples.xml</trailingSectionPath>
</trailingSectionPaths>
</tool>
diff --git a/opendj-doc-generated-ref/src/main/assembly/sdk-tools-man-pages-assembly.xml b/opendj-doc-generated-ref/src/main/assembly/sdk-tools-man-pages-assembly.xml
index 2586947..3b1566f 100644
--- a/opendj-doc-generated-ref/src/main/assembly/sdk-tools-man-pages-assembly.xml
+++ b/opendj-doc-generated-ref/src/main/assembly/sdk-tools-man-pages-assembly.xml
@@ -96,6 +96,166 @@
<outputDirectory>man-pages</outputDirectory>
<source>${project.build.directory}/docbkx-sources/man-pages/man-searchrate.xml</source>
</file>
+
+ <file>
+ <outputDirectory>man-pages</outputDirectory>
+ <source>${project.build.directory}/docbkx-sources/man-pages/addrate-examples.xml</source>
+ </file>
+
+ <file>
+ <outputDirectory>man-pages</outputDirectory>
+ <source>${project.build.directory}/docbkx-sources/man-pages/attributes.xml</source>
+ </file>
+
+ <file>
+ <outputDirectory>man-pages</outputDirectory>
+ <source>${project.build.directory}/docbkx-sources/man-pages/authrate-examples.xml</source>
+ </file>
+
+ <file>
+ <outputDirectory>man-pages</outputDirectory>
+ <source>${project.build.directory}/docbkx-sources/man-pages/base64-examples.xml</source>
+ </file>
+
+ <file>
+ <outputDirectory>man-pages</outputDirectory>
+ <source>${project.build.directory}/docbkx-sources/man-pages/description-makeldif.xml</source>
+ </file>
+
+ <file>
+ <outputDirectory>man-pages</outputDirectory>
+ <source>${project.build.directory}/docbkx-sources/man-pages/description-psearch-info.xml</source>
+ </file>
+
+ <file>
+ <outputDirectory>man-pages</outputDirectory>
+ <source>${project.build.directory}/docbkx-sources/man-pages/description-rate-tools.xml</source>
+ </file>
+
+ <file>
+ <outputDirectory>man-pages</outputDirectory>
+ <source>${project.build.directory}/docbkx-sources/man-pages/description-resource-path.xml</source>
+ </file>
+
+ <file>
+ <outputDirectory>man-pages</outputDirectory>
+ <source>${project.build.directory}/docbkx-sources/man-pages/exit-codes-0-1.xml</source>
+ </file>
+
+ <file>
+ <outputDirectory>man-pages</outputDirectory>
+ <source>${project.build.directory}/docbkx-sources/man-pages/exit-codes-0-5-6-other.xml</source>
+ </file>
+
+ <file>
+ <outputDirectory>man-pages</outputDirectory>
+ <source>${project.build.directory}/docbkx-sources/man-pages/exit-codes-0-80-89.xml</source>
+ </file>
+
+ <file>
+ <outputDirectory>man-pages</outputDirectory>
+ <source>${project.build.directory}/docbkx-sources/man-pages/exit-codes-0-89.xml</source>
+ </file>
+
+ <file>
+ <outputDirectory>man-pages</outputDirectory>
+ <source>${project.build.directory}/docbkx-sources/man-pages/exit-codes-0-gt0.xml</source>
+ </file>
+
+ <file>
+ <outputDirectory>man-pages</outputDirectory>
+ <source>${project.build.directory}/docbkx-sources/man-pages/exit-codes-0-ldap-89.xml</source>
+ </file>
+
+ <file>
+ <outputDirectory>man-pages</outputDirectory>
+ <source>${project.build.directory}/docbkx-sources/man-pages/files.xml</source>
+ </file>
+
+ <file>
+ <outputDirectory>man-pages</outputDirectory>
+ <source>${project.build.directory}/docbkx-sources/man-pages/filters.xml</source>
+ </file>
+
+ <file>
+ <outputDirectory>man-pages</outputDirectory>
+ <source>${project.build.directory}/docbkx-sources/man-pages/ldapcompare-examples.xml</source>
+ </file>
+
+ <file>
+ <outputDirectory>man-pages</outputDirectory>
+ <source>${project.build.directory}/docbkx-sources/man-pages/ldapcompare-exit-codes.xml</source>
+ </file>
+
+ <file>
+ <outputDirectory>man-pages</outputDirectory>
+ <source>${project.build.directory}/docbkx-sources/man-pages/ldapdelete-examples.xml</source>
+ </file>
+
+ <file>
+ <outputDirectory>man-pages</outputDirectory>
+ <source>${project.build.directory}/docbkx-sources/man-pages/ldapmodify-examples.xml</source>
+ </file>
+
+ <file>
+ <outputDirectory>man-pages</outputDirectory>
+ <source>${project.build.directory}/docbkx-sources/man-pages/ldappasswordmodify-examples.xml</source>
+ </file>
+
+ <file>
+ <outputDirectory>man-pages</outputDirectory>
+ <source>${project.build.directory}/docbkx-sources/man-pages/ldapsearch-examples.xml</source>
+ </file>
+
+ <file>
+ <outputDirectory>man-pages</outputDirectory>
+ <source>${project.build.directory}/docbkx-sources/man-pages/ldifdiff-examples.xml</source>
+ </file>
+
+ <file>
+ <outputDirectory>man-pages</outputDirectory>
+ <source>${project.build.directory}/docbkx-sources/man-pages/ldifdiff-exit-codes.xml</source>
+ </file>
+
+ <file>
+ <outputDirectory>man-pages</outputDirectory>
+ <source>${project.build.directory}/docbkx-sources/man-pages/ldifmodify-examples.xml</source>
+ </file>
+
+ <file>
+ <outputDirectory>man-pages</outputDirectory>
+ <source>${project.build.directory}/docbkx-sources/man-pages/ldifsearch-examples.xml</source>
+ </file>
+
+ <file>
+ <outputDirectory>man-pages</outputDirectory>
+ <source>${project.build.directory}/docbkx-sources/man-pages/makeldif-examples.xml</source>
+ </file>
+
+ <file>
+ <outputDirectory>man-pages</outputDirectory>
+ <source>${project.build.directory}/docbkx-sources/man-pages/makeldif-see-also.xml</source>
+ </file>
+
+ <file>
+ <outputDirectory>man-pages</outputDirectory>
+ <source>${project.build.directory}/docbkx-sources/man-pages/man-makeldif-template.xml</source>
+ </file>
+
+ <file>
+ <outputDirectory>man-pages</outputDirectory>
+ <source>${project.build.directory}/docbkx-sources/man-pages/modrate-examples.xml</source>
+ </file>
+
+ <file>
+ <outputDirectory>man-pages</outputDirectory>
+ <source>${project.build.directory}/docbkx-sources/man-pages/searchrate-examples.xml</source>
+ </file>
+
+ <file>
+ <outputDirectory>man-pages</outputDirectory>
+ <source>${project.build.directory}/docbkx-sources/man-pages/variablelist-ldap-controls.xml</source>
+ </file>
</files>
<formats>
diff --git a/opendj-doc-generated-ref/src/main/docbkx/man-pages/addrate-examples.xml b/opendj-doc-generated-ref/src/main/docbkx/man-pages/addrate-examples.xml
new file mode 100644
index 0000000..02c174a
--- /dev/null
+++ b/opendj-doc-generated-ref/src/main/docbkx/man-pages/addrate-examples.xml
@@ -0,0 +1,122 @@
+<?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/opendj/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 2015 ForgeRock AS.
+ !
+-->
+<refsect1 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">
+ <title>Examples</title>
+
+ <para>
+ The following examples use this template file,
+ <filename>addrate.template</filename>:
+ </para>
+
+ <programlisting language="ldif">
+<![CDATA[
+define suffix=dc=example,dc=com
+define maildomain=example.com
+
+branch: [suffix]
+
+branch: ou=People,[suffix]
+subordinateTemplate: person
+
+template: person
+rdnAttr: uid
+objectClass: top
+objectClass: person
+objectClass: organizationalPerson
+objectClass: inetOrgPerson
+givenName: <first>
+sn: <last>
+cn: {givenName} {sn}
+initials: {givenName:1}<random:chars:ABCDEFGHIJKLMNOPQRSTUVWXYZ:1>{sn:1}
+employeeNumber: <sequential:0>
+uid: user.{employeeNumber}
+mail: {uid}@[maildomain]
+userPassword: password
+telephoneNumber: <random:telephone>
+homePhone: <random:telephone>
+pager: <random:telephone>
+mobile: <random:telephone>
+street: <random:numeric:5> <file:streets> Street
+l: <file:cities>
+st: <file:states>
+postalCode: <random:numeric:5>
+postalAddress: {cn}${street}${l}, {st} {postalCode}
+description: This is the description for {cn}.
+
+]]>
+ </programlisting>
+
+ <para>
+ The following example adds entries, and then randomly deletes them
+ when more than 10,000 entries have been added:
+ </para>
+
+ <screen>
+$ <userinput>addrate -p 1389 -D "cn=Directory Manager" -w password \
+-f -c 10 -C random -s 10000 addrate.template</userinput>
+<computeroutput>
+-----------------------------------------------------------------------
+ Throughput Response Time
+ (ops/second) (milliseconds)
+recent average recent average 99.9% 99.99% 99.999% err/sec Add%
+-----------------------------------------------------------------------
+466.7 467.2 20.738 20.738 187.00 201.00 201.00 0.0 100.00
+588.9 528.1 17.015 18.661 166.00 201.00 201.00 0.0 100.00
+1584.9 880.3 6.076 11.109 150.00 196.00 201.00 0.0 79.87
+1577.8 1054.5 6.138 9.252 132.00 192.00 201.00 0.0 50.00
+1853.0 1214.4 5.188 8.010 124.00 187.00 201.00 0.0 49.99
+^CPurge phase...
+2482.7 1426.2 3.790 6.783 114.00 187.00 201.00 0.0 9.77</computeroutput>
+ </screen>
+
+ <para>
+ The following example also adds entries, and then deletes them
+ in the order they were added after they are 10 seconds old:
+ </para>
+
+ <screen>
+$ <userinput>addrate -p 1389 -D "cn=Directory Manager" -w password \
+-f -c 10 -C fifo -a 10 addrate.template</userinput>
+<computeroutput>
+-----------------------------------------------------------------------
+ Throughput Response Time
+ (ops/second) (milliseconds)
+recent average recent average 99.9% 99.99% 99.999% err/sec Add%
+-----------------------------------------------------------------------
+2065.6 2068.1 4.646 4.646 30.00 51.00 58.00 0.0 100.00
+1479.7 1773.3 6.567 5.449 46.00 59.00 67.00 0.0 99.23
+1443.4 1663.3 6.730 5.820 56.00 112.00 120.00 0.0 50.01
+1462.6 1613.0 6.635 6.005 56.00 102.00 120.00 0.0 50.08
+1452.2 1580.8 6.678 6.129 62.00 110.00 120.00 0.0 49.97
+^CPurge phase...
+1344.5 1541.4 7.170 6.280 69.00 176.00 1900.00 0.0 17.30
+1703.3 1564.6 5.449 6.151 68.00 176.00 3000.00 0.0 0.00</computeroutput>
+ </screen>
+</refsect1>
diff --git a/opendj-doc-generated-ref/src/main/docbkx/man-pages/authrate-examples.xml b/opendj-doc-generated-ref/src/main/docbkx/man-pages/authrate-examples.xml
new file mode 100644
index 0000000..4ea365d
--- /dev/null
+++ b/opendj-doc-generated-ref/src/main/docbkx/man-pages/authrate-examples.xml
@@ -0,0 +1,59 @@
+<?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/opendj/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 2015 ForgeRock AS.
+ !
+-->
+<refsect1 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">
+ <title>Examples</title>
+
+ <para>
+ The following example demonstrates measuring simple bind performance:
+ </para>
+
+ <screen>
+$ <userinput>authrate -p 1389 -g "rand(names.txt)" \
+ -D "uid=%s,ou=people,dc=example,dc=com" -w password -c 10 -f</userinput>
+<computeroutput>-----------------------------------------------------------------
+ Throughput Response Time
+ (ops/second) (milliseconds)
+recent average recent average 99.9% 99.99% 99.999% err/sec
+-----------------------------------------------------------------
+9796.9 9816.6 1.029 1.029 12.413 161.451 161.835 0.0
+14201.1 12028.1 0.704 0.835 9.508 161.456 167.573 0.0
+14450.0 12835.9 0.692 0.782 8.989 161.835 174.518 0.0
+12934.3 12860.6 0.773 0.779 9.253 161.339 174.426 0.0
+14154.5 13121.0 0.706 0.764 9.025 161.451 177.101 0.0
+^C</computeroutput>
+ </screen>
+
+ <para>
+ The <filename>names.txt</filename> contains
+ all the user IDs for the sample suffix.
+ All user password values have been set to <literal>password</literal>
+ for this example.
+ </para>
+</refsect1>
diff --git a/opendj-doc-generated-ref/src/main/docbkx/man-pages/description-makeldif.xml b/opendj-doc-generated-ref/src/main/docbkx/man-pages/description-makeldif.xml
new file mode 100644
index 0000000..b5eaa74
--- /dev/null
+++ b/opendj-doc-generated-ref/src/main/docbkx/man-pages/description-makeldif.xml
@@ -0,0 +1,136 @@
+<?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 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 2016 ForgeRock AS.
+ !
+-->
+<!--
+ This use of <informalexample> is mild tag abuse.
+ It serves as a single container element for all the elements here.
+-->
+<informalexample
+ 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">
+
+ <para>
+ The <replaceable>template-file-path</replaceable> can be one of the following:
+ </para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ A full path to the template file such as
+ <filename>/path/to/opendj/config/MakeLDIF/example.template</filename>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ A relative path to the template file such as
+ <filename>../../my-test-data.template</filename>.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ A file name that specifies one of the template files
+ that are built into the ${opendj.product.name.full} LDAP Toolkit,
+ such as <filename>example.template</filename>,
+ or <filename>people_and_groups.template</filename>.
+ </para>
+ </listitem>
+ </itemizedlist>
+
+ <para>
+ The ${opendj.product.name.full} LDAP Toolkit includes
+ these built-in template and data files:
+ </para>
+
+ <variablelist>
+ <varlistentry>
+ <term><filename>cities</filename></term>
+ <listitem>
+ <para>
+ List of more than 200 cities.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><filename>example.template</filename></term>
+ <listitem>
+ <para>
+ Template to generate a base entry and users
+ in a branch <literal>ou=people,[suffix]</literal>,
+ where the default setting for suffix is
+ <literal>suffix=dc=example,dc=com</literal>.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><filename>first.names</filename></term>
+ <listitem>
+ <para>
+ List of more than 8000 first names.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><filename>last.names</filename></term>
+ <listitem>
+ <para>
+ List of more than 13000 last names.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><filename>people_and_groups.template</filename></term>
+ <listitem>
+ <para>
+ Template to generate a base entry, users, and groups.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><filename>states</filename></term>
+ <listitem>
+ <para>
+ List of US states by their two-character codes.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><filename>streets</filename></term>
+ <listitem>
+ <para>
+ List of more than 70 street names.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+</informalexample>
diff --git a/opendj-doc-generated-ref/src/main/docbkx/man-pages/description-rate-tools.xml b/opendj-doc-generated-ref/src/main/docbkx/man-pages/description-rate-tools.xml
new file mode 100644
index 0000000..1897c6b
--- /dev/null
+++ b/opendj-doc-generated-ref/src/main/docbkx/man-pages/description-rate-tools.xml
@@ -0,0 +1,87 @@
+<?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 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 2015 ForgeRock AS.
+ !
+-->
+<!--
+ This use of <informalexample> is mild tag abuse.
+ It serves as a single container element for all the elements here.
+-->
+<informalexample
+ 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'>
+
+ <para>
+ When you do not use the <option>-f</option> option
+ to keep connections open and rebind on the connections,
+ the tool can exhaust its available ports, causing the tool to crash.
+ You can work around this problem on test systems
+ by changing TCP settings on the system.
+ </para>
+
+ <para>
+ For example, on Linux systems, set the following parameters
+ in the <filename>/etc/sysctl.conf</filename> file:
+ </para>
+
+ <programlisting language="ini">
+net.ipv4.tcp_fin_timeout = 30
+net.ipv4.tcp_tw_recycle = 1
+net.ipv4.tcp_tw_reuse = 1
+ </programlisting>
+
+ <para>
+ The parameter <literal>net.ipv4.tcp_fin_timeout</literal>
+ sets the length of time in seconds to wait for a final FIN packet
+ before forcing a close of the socket.
+ The default is 60 (seconds).
+ </para>
+
+ <para>
+ The parameter <literal>net.ipv4.tcp_tw_recycle</literal>
+ enables fast recycling of TIME_WAIT sockets.
+ The default is 0 (false).
+ Enabling this can cause Network Address Translation (NAT) issues.
+ </para>
+
+ <para>
+ The parameter <literal>net.ipv4.tcp_tw_reuse</literal>
+ enables reuse of TIME_WAIT sockets for new connections.
+ The default is 0 (false).
+ </para>
+
+ <para>
+ These settings are recommended only for testing,
+ and <emphasis>not for production systems</emphasis>.
+ </para>
+
+ <para>
+ After making the changes to <filename>/etc/sysctl.conf</filename>,
+ reload the configuration with the <command>sysctl</command> command:
+ </para>
+
+ <screen>
+# sysctl -p
+ </screen>
+</informalexample>
diff --git a/opendj-doc-generated-ref/src/main/docbkx/man-pages/description-resource-path.xml b/opendj-doc-generated-ref/src/main/docbkx/man-pages/description-resource-path.xml
new file mode 100644
index 0000000..57f299a
--- /dev/null
+++ b/opendj-doc-generated-ref/src/main/docbkx/man-pages/description-resource-path.xml
@@ -0,0 +1,56 @@
+<?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 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 2016 ForgeRock AS.
+ !
+-->
+<!--
+ This use of <informalexample> is mild tag abuse.
+ It serves as a single container element for all the elements here.
+-->
+<orderedlist
+ 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">
+
+ <para>
+ The utility looks for resources in the following locations in this order:
+ </para>
+
+ <listitem>
+ <para>
+ The current directory where the command is run.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The resource path directory.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ The built-in files.
+ </para>
+ </listitem>
+</orderedlist>
diff --git a/opendj-doc-generated-ref/src/main/docbkx/man-pages/exit-codes-0-80-89.xml b/opendj-doc-generated-ref/src/main/docbkx/man-pages/exit-codes-0-80-89.xml
new file mode 100644
index 0000000..a1381d6
--- /dev/null
+++ b/opendj-doc-generated-ref/src/main/docbkx/man-pages/exit-codes-0-80-89.xml
@@ -0,0 +1,61 @@
+<?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
+ ! 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 2015-2016 ForgeRock AS.
+ !
+-->
+<refsect1 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">
+ <title>Exit Codes</title>
+
+ <variablelist>
+ <varlistentry>
+ <term>0</term>
+ <listitem>
+ <para>
+ The command completed successfully.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>80</term>
+ <listitem>
+ <para>
+ The command could not complete due to an input/output error.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>89</term>
+ <listitem>
+ <para>
+ An error occurred while parsing the command-line arguments.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+</refsect1>
diff --git a/opendj-doc-generated-ref/src/main/docbkx/man-pages/index.xml b/opendj-doc-generated-ref/src/main/docbkx/man-pages/index.xml
index c1ab3db..644c5e7 100644
--- a/opendj-doc-generated-ref/src/main/docbkx/man-pages/index.xml
+++ b/opendj-doc-generated-ref/src/main/docbkx/man-pages/index.xml
@@ -98,7 +98,7 @@
<xinclude:include href="man-ldapsearch.xml">
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
- <xinclude:include href="man-ldif-diff.xml">
+ <xinclude:include href="man-ldifdiff.xml">
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href="man-ldifmodify.xml">
@@ -110,10 +110,10 @@
<xinclude:include href="man-list-backends.xml">
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
- <xinclude:include href="man-make-ldif.xml">
+ <xinclude:include href="man-makeldif.xml">
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
- <xinclude:include href="man-make-ldif-template.xml" />
+ <xinclude:include href="man-makeldif-template.xml" />
<xinclude:include href="man-manage-account.xml">
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
diff --git a/opendj-doc-generated-ref/src/main/docbkx/man-pages/ldapcompare-exit-codes.xml b/opendj-doc-generated-ref/src/main/docbkx/man-pages/ldapcompare-exit-codes.xml
index ff83619..74f0e63 100644
--- a/opendj-doc-generated-ref/src/main/docbkx/man-pages/ldapcompare-exit-codes.xml
+++ b/opendj-doc-generated-ref/src/main/docbkx/man-pages/ldapcompare-exit-codes.xml
@@ -12,7 +12,7 @@
Header, with the fields enclosed by brackets [] replaced by your own identifying
information: "Portions Copyright [year] [name of copyright owner]".
- Copyright 2015 ForgeRock AS.
+ Copyright 2015-2016 ForgeRock AS.
-->
<refsect1 xmlns="http://docbook.org/ns/docbook"
version="5.0" xml:lang="en"
@@ -35,8 +35,7 @@
<term>5</term>
<listitem>
<para>
- The <option>-m</option> option was used,
- and at least one of the LDAP compare operations did not match.
+ The LDAP compare operation did not match.
</para>
</listitem>
</varlistentry>
@@ -45,7 +44,7 @@
<listitem>
<para>
The <option>-m</option> option was used,
- and all the LDAP compare operations did match.
+ and the LDAP compare operation did match.
</para>
</listitem>
</varlistentry>
diff --git a/opendj-doc-generated-ref/src/main/docbkx/man-pages/ldapmodify-examples.xml b/opendj-doc-generated-ref/src/main/docbkx/man-pages/ldapmodify-examples.xml
index 9a32c4f..f9d5496 100644
--- a/opendj-doc-generated-ref/src/main/docbkx/man-pages/ldapmodify-examples.xml
+++ b/opendj-doc-generated-ref/src/main/docbkx/man-pages/ldapmodify-examples.xml
@@ -12,7 +12,7 @@
Header, with the fields enclosed by brackets [] replaced by your own identifying
information: "Portions Copyright [year] [name of copyright owner]".
- Copyright 2015 ForgeRock AS.
+ Copyright 2015-2016 ForgeRock AS.
-->
<refsect1 xmlns="http://docbook.org/ns/docbook"
version="5.0" xml:lang="en"
@@ -23,7 +23,7 @@
<para>
The following example demonstrates use of the command
- to add an entry to the directory.
+ to add an entry to the directory:
</para>
<screen>
@@ -50,14 +50,13 @@
ou: People
gidNumber: 10636</computeroutput>
-$ <userinput>ldapmodify -p 1389 -a -f newuser.ldif \
- -D uid=kvaughan,ou=people,dc=example,dc=com -w bribery</userinput>
+$ <userinput>ldapmodify -p 1389 -D uid=kvaughan,ou=people,dc=example,dc=com -w bribery newuser.ldif</userinput>
<computeroutput>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</computeroutput>
</screen>
<para>
- The following listing shows a UNIX shell script that adds a user entry.
+ The following listing shows a UNIX shell script that adds a user entry:
</para>
<programlisting language="shell">
@@ -78,7 +77,7 @@
ADMIN=uid=kvaughan,ou=people,dc=example,dc=com
PWD=bribery
-$LDAPMODIFY -h $HOST -p $PORT -D $ADMIN -w $PWD -a <<EOF
+$LDAPMODIFY -h $HOST -p $PORT -D $ADMIN -w $PWD <<EOF
dn: uid=$1,ou=people,dc=example,dc=com
uid: $1
objectClass: top
@@ -94,7 +93,7 @@
<para>
The following example demonstrates adding a Description attribute
- to the new user's entry.
+ to the new user's entry:
</para>
<screen>
@@ -104,15 +103,14 @@
add: description
description: A new user's entry</computeroutput>
-$ <userinput>ldapmodify -p 1389 -f newdesc.ldif \
- -D uid=kvaughan,ou=people,dc=example,dc=com -w bribery</userinput>
+$ <userinput>ldapmodify -p 1389 -D uid=kvaughan,ou=people,dc=example,dc=com -w bribery newdesc.ldif</userinput>
<computeroutput>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</computeroutput>
</screen>
<para>
The following example demonstrates changing the Description attribute
- for the new user's entry.
+ for the new user's entry:
</para>
<screen>
@@ -122,14 +120,13 @@
replace: description
description: Another description</computeroutput>
-$ <userinput>ldapmodify -p 1389 -f moddesc.ldif \
- -D uid=kvaughan,ou=people,dc=example,dc=com -w bribery</userinput>
+$ <userinput>ldapmodify -p 1389 -D uid=kvaughan,ou=people,dc=example,dc=com -w bribery moddesc.ldif</userinput>
<computeroutput>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</computeroutput>
</screen>
<para>
- The following example demonstrates deleting the new user's entry.
+ The following example demonstrates deleting the new user's entry:
</para>
<screen>
@@ -137,8 +134,7 @@
<computeroutput>dn: uid=newuser,ou=People,dc=example,dc=com
changetype: delete</computeroutput>
-$ <userinput>ldapmodify -p 1389 -f deluser.ldif \
- -D uid=kvaughan,ou=people,dc=example,dc=com -w bribery</userinput>
+$ <userinput>ldapmodify -p 1389 -D uid=kvaughan,ou=people,dc=example,dc=com -w bribery deluser.ldif</userinput>
<computeroutput>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</computeroutput>
</screen>
diff --git a/opendj-doc-generated-ref/src/main/docbkx/man-pages/ldapsearch-examples.xml b/opendj-doc-generated-ref/src/main/docbkx/man-pages/ldapsearch-examples.xml
index ca86c5f..ce8a3bd 100644
--- a/opendj-doc-generated-ref/src/main/docbkx/man-pages/ldapsearch-examples.xml
+++ b/opendj-doc-generated-ref/src/main/docbkx/man-pages/ldapsearch-examples.xml
@@ -12,7 +12,7 @@
Header, with the fields enclosed by brackets [] replaced by your own identifying
information: "Portions Copyright [year] [name of copyright owner]".
- Copyright 2015 ForgeRock AS.
+ Copyright 2015-2016 ForgeRock AS.
-->
<refsect1 xmlns="http://docbook.org/ns/docbook"
version="5.0" xml:lang="en"
@@ -24,7 +24,7 @@
<para>
The following example searches for entries
with UID containing <literal>jensen</literal>,
- returning only DNs and uid values.
+ returning only DNs and uid values:
</para>
<screen>
@@ -58,7 +58,7 @@
You can also use <literal>@<replaceable>objectclass</replaceable></literal> notation
in the attribute list to return the attributes of a particular object class.
The following example shows how to return attributes
- of the <literal>inetOrgPerson</literal> object class.
+ of the <literal>inetOrgPerson</literal> object class:
</para>
<screen>
@@ -85,7 +85,7 @@
<para>
You can use <literal>+</literal> in the attribute list
- to return all operational attributes, as in the following example.
+ to return all operational attributes, as in the following example:
</para>
<screen>
@@ -94,7 +94,6 @@
numSubordinates: 0
structuralObjectClass: inetOrgPerson
etag: 0000000073c29972
-pwdPolicySubentry: cn=Default Password Policy,cn=Password Policies,cn=config
subschemaSubentry: cn=schema
hasSubordinates: false
entryDN: uid=bjensen,ou=people,dc=example,dc=com
diff --git a/opendj-doc-generated-ref/src/main/docbkx/man-pages/ldif-diff-examples.xml b/opendj-doc-generated-ref/src/main/docbkx/man-pages/ldifdiff-examples.xml
similarity index 94%
rename from opendj-doc-generated-ref/src/main/docbkx/man-pages/ldif-diff-examples.xml
rename to opendj-doc-generated-ref/src/main/docbkx/man-pages/ldifdiff-examples.xml
index fdea117..db960a9 100644
--- a/opendj-doc-generated-ref/src/main/docbkx/man-pages/ldif-diff-examples.xml
+++ b/opendj-doc-generated-ref/src/main/docbkx/man-pages/ldifdiff-examples.xml
@@ -12,7 +12,7 @@
Header, with the fields enclosed by brackets [] replaced by your own identifying
information: "Portions Copyright [year] [name of copyright owner]".
- Copyright 2015 ForgeRock AS.
+ Copyright 2015-2016 ForgeRock AS.
-->
<refsect1 xmlns="http://docbook.org/ns/docbook"
version="5.0" xml:lang="en"
@@ -53,7 +53,7 @@
userPassword: secret12
description: A new description.</computeroutput>
-$ <userinput>ldif-diff -s /path/to/newuser.ldif -t /path/to/neweruser.ldif</userinput>
+$ <userinput>ldifdiff -s /path/to/newuser.ldif -t /path/to/neweruser.ldif</userinput>
<computeroutput>dn: uid=newuser,ou=People,dc=example,dc=com
changetype: modify
add: userPassword
diff --git a/opendj-doc-generated-ref/src/main/docbkx/man-pages/make-ldif-examples.xml b/opendj-doc-generated-ref/src/main/docbkx/man-pages/ldifdiff-exit-codes.xml
similarity index 67%
copy from opendj-doc-generated-ref/src/main/docbkx/man-pages/make-ldif-examples.xml
copy to opendj-doc-generated-ref/src/main/docbkx/man-pages/ldifdiff-exit-codes.xml
index e2e2fa9..265626e 100644
--- a/opendj-doc-generated-ref/src/main/docbkx/man-pages/make-ldif-examples.xml
+++ b/opendj-doc-generated-ref/src/main/docbkx/man-pages/ldifdiff-exit-codes.xml
@@ -12,25 +12,41 @@
Header, with the fields enclosed by brackets [] replaced by your own identifying
information: "Portions Copyright [year] [name of copyright owner]".
- Copyright 2015 ForgeRock AS.
+ Copyright 2016 ForgeRock AS.
-->
<refsect1 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">
- <title>Examples</title>
+ <title>Exit Codes</title>
- <para>
- The following example uses the default template to generate LDIF.
- </para>
+ <variablelist>
+ <varlistentry>
+ <term>0</term>
+ <listitem>
+ <para>
+ No differences were found.
+ </para>
+ </listitem>
+ </varlistentry>
- <screen>
-$ <userinput>make-ldif -t ../config/MakeLDIF/example.template -o ../ldif/generated.ldif</userinput>
-<computeroutput>Processed 1000 entries
-Processed 2000 entries
-...
-Processed 10000 entries
-LDIF processing complete. 10003 entries written</computeroutput>
- </screen>
+ <varlistentry>
+ <term>1</term>
+ <listitem>
+ <para>
+ Differences were found.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>other</term>
+ <listitem>
+ <para>
+ An error occurred.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</refsect1>
diff --git a/opendj-doc-generated-ref/src/main/docbkx/man-pages/ldifsearch-examples.xml b/opendj-doc-generated-ref/src/main/docbkx/man-pages/ldifsearch-examples.xml
index a08037a..ffbd689 100644
--- a/opendj-doc-generated-ref/src/main/docbkx/man-pages/ldifsearch-examples.xml
+++ b/opendj-doc-generated-ref/src/main/docbkx/man-pages/ldifsearch-examples.xml
@@ -12,7 +12,7 @@
Header, with the fields enclosed by brackets [] replaced by your own identifying
information: "Portions Copyright [year] [name of copyright owner]".
- Copyright 2015 ForgeRock AS.
+ Copyright 2015-2016 ForgeRock AS.
-->
<refsect1 xmlns="http://docbook.org/ns/docbook"
version="5.0" xml:lang="en"
@@ -26,7 +26,7 @@
</para>
<screen>
-$ <userinput>ldifsearch -b dc=example,dc=com /path/to/Example.ldif uid=bjensen</userinput>
+$ <userinput>ldifsearch -b dc=example,dc=com Example.ldif uid=bjensen</userinput>
<computeroutput>dn: uid=bjensen,ou=People,dc=example,dc=com
objectClass: person
objectClass: organizationalPerson
@@ -60,8 +60,7 @@
</para>
<screen>
-$ <userinput>ldifsearch --ldifFile /path/to/Example.ldif \
- --baseDN dc=example,dc=com "(uid=bjensen)" @posixaccount</userinput>
+$ <userinput>ldifsearch -b dc=example,dc=com Example.ldif "(uid=bjensen)" @posixaccount</userinput>
<computeroutput>dn: uid=bjensen,ou=People,dc=example,dc=com
objectClass: person
objectClass: organizationalPerson
diff --git a/opendj-doc-generated-ref/src/main/docbkx/man-pages/make-ldif-examples.xml b/opendj-doc-generated-ref/src/main/docbkx/man-pages/makeldif-examples.xml
similarity index 90%
rename from opendj-doc-generated-ref/src/main/docbkx/man-pages/make-ldif-examples.xml
rename to opendj-doc-generated-ref/src/main/docbkx/man-pages/makeldif-examples.xml
index e2e2fa9..ffab27e 100644
--- a/opendj-doc-generated-ref/src/main/docbkx/man-pages/make-ldif-examples.xml
+++ b/opendj-doc-generated-ref/src/main/docbkx/man-pages/makeldif-examples.xml
@@ -12,7 +12,7 @@
Header, with the fields enclosed by brackets [] replaced by your own identifying
information: "Portions Copyright [year] [name of copyright owner]".
- Copyright 2015 ForgeRock AS.
+ Copyright 2015-2016 ForgeRock AS.
-->
<refsect1 xmlns="http://docbook.org/ns/docbook"
version="5.0" xml:lang="en"
@@ -26,7 +26,7 @@
</para>
<screen>
-$ <userinput>make-ldif -t ../config/MakeLDIF/example.template -o ../ldif/generated.ldif</userinput>
+$ <userinput>makeldif -t ../config/MakeLDIF/example.template -o ../ldif/generated.ldif</userinput>
<computeroutput>Processed 1000 entries
Processed 2000 entries
...
diff --git a/opendj-doc-generated-ref/src/main/docbkx/man-pages/make-ldif-see-also.xml b/opendj-doc-generated-ref/src/main/docbkx/man-pages/makeldif-see-also.xml
similarity index 93%
rename from opendj-doc-generated-ref/src/main/docbkx/man-pages/make-ldif-see-also.xml
rename to opendj-doc-generated-ref/src/main/docbkx/man-pages/makeldif-see-also.xml
index 27e8f30..55ce5bb 100644
--- a/opendj-doc-generated-ref/src/main/docbkx/man-pages/make-ldif-see-also.xml
+++ b/opendj-doc-generated-ref/src/main/docbkx/man-pages/makeldif-see-also.xml
@@ -12,7 +12,7 @@
Header, with the fields enclosed by brackets [] replaced by your own identifying
information: "Portions Copyright [year] [name of copyright owner]".
- Copyright 2015 ForgeRock AS.
+ Copyright 2015-2016 ForgeRock AS.
-->
<refsect1 xmlns="http://docbook.org/ns/docbook"
version="5.0" xml:lang="en"
@@ -22,6 +22,6 @@
<title>See Also</title>
<para>
- <xref linkend="make-ldif-template-5" />
+ <xref linkend="makeldif-template-5" />
</para>
</refsect1>
diff --git a/opendj-doc-generated-ref/src/main/docbkx/man-pages/man-make-ldif-template.xml b/opendj-doc-generated-ref/src/main/docbkx/man-pages/man-makeldif-template.xml
similarity index 96%
rename from opendj-doc-generated-ref/src/main/docbkx/man-pages/man-make-ldif-template.xml
rename to opendj-doc-generated-ref/src/main/docbkx/man-pages/man-makeldif-template.xml
index ef42dc7..c293241 100644
--- a/opendj-doc-generated-ref/src/main/docbkx/man-pages/man-make-ldif-template.xml
+++ b/opendj-doc-generated-ref/src/main/docbkx/man-pages/man-makeldif-template.xml
@@ -12,9 +12,9 @@
Header, with the fields enclosed by brackets [] replaced by your own identifying
information: "Portions Copyright [year] [name of copyright owner]".
- Copyright 2012-2015 ForgeRock AS.
+ Copyright 2012-2016 ForgeRock AS.
-->
-<refentry xml:id='make-ldif-template-5'
+<refentry xml:id='makeldif-template-5'
xmlns='http://docbook.org/ns/docbook'
version='5.0' xml:lang='en'
xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
@@ -23,20 +23,20 @@
xmlns:xlink='http://www.w3.org/1999/xlink'>
<info>
<copyright>
- <year>2012-2015</year>
+ <year>2012-2016</year>
<holder>ForgeRock AS.</holder>
</copyright>
</info>
<refmeta>
- <refentrytitle>make-ldif.template</refentrytitle><manvolnum>5</manvolnum>
+ <refentrytitle>makeldif.template</refentrytitle><manvolnum>5</manvolnum>
<refmiscinfo class="software">OpenDJ</refmiscinfo>
<refmiscinfo class="version">${docTargetVersion}</refmiscinfo>
</refmeta>
<refnamediv>
- <refname>make-ldif.template</refname>
- <refpurpose>template file for the make-ldif command</refpurpose>
+ <refname>makeldif.template</refname>
+ <refpurpose>template file for the makeldif command</refpurpose>
</refnamediv>
<refsynopsisdiv>
@@ -48,7 +48,7 @@
# Optionally include classes that define custom tags.
# Custom tag classes extend org.opends.server.tools.makeldif.Tag and
-# must be on the class path when you run make-ldif.
+# must be on the class path when you run makeldif.
#
include <replaceable>custom.makeldif.tag.ClassName</replaceable>
...
@@ -65,7 +65,7 @@
# ou=People,dc=example,dc=com
# ou=Groups,dc=example,dc=com
#
-# make-ldif generates the necessary object class definitions and RDNs.
+# makeldif generates the necessary object class definitions and RDNs.
#
# A branch can have subordinateTemplates that define templates to use for
# the branch entry.
@@ -109,13 +109,13 @@
Template files specify how to build LDIF.
They allow you to define variables, insert random values from other files,
and generally build arbitrarily large LDIF files for testing purposes.
- You pass template files to the <command>make-ldif</command> command
+ You pass template files to the <command>makeldif</command> command
when generating LDIF.
</para>
<para>
The Synopsis above shows the layout
- for a <command>make-ldif</command> template file.
+ for a <command>makeldif</command> template file.
This section focuses on what you can do to specify entry attribute values,
called <replaceable>attr-value</replaceable> in the Synopsis section.
</para>
@@ -124,7 +124,7 @@
<title>Specifying Attribute Values</title>
<para>
- When specifying attribute values in <command>make-ldif</command> templates,
+ When specifying attribute values in <command>makeldif</command> templates,
you can use static text and constants that you have defined,
enclosing names for constants in brackets, <literal>[myConstant]</literal>.
You can use more than one constant per line, as in the following example.
@@ -551,8 +551,7 @@
<title>See Also</title>
<para>
- <xref linkend="make-ldif-1" />,
- the OpenDJ directory server template file
+ <xref linkend="makeldif-1" />, the template file
<filename>/path/to/opendj/config/MakeLDIF/example.template</filename>
</para>
</refsect1>
diff --git a/opendj-doc-generated-ref/src/main/docbkx/man-pages/modrate-examples.xml b/opendj-doc-generated-ref/src/main/docbkx/man-pages/modrate-examples.xml
new file mode 100644
index 0000000..4128cd2
--- /dev/null
+++ b/opendj-doc-generated-ref/src/main/docbkx/man-pages/modrate-examples.xml
@@ -0,0 +1,57 @@
+<?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/opendj/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 2015 ForgeRock AS.
+ !
+-->
+<refsect1 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">
+ <title>Examples</title>
+
+ <para>
+ The following example demonstrates testing directory performance
+ by using the <command>modrate</command> command
+ to write random 16-character description values to all entries in a sample file:
+ </para>
+
+ <screen>
+$ <userinput>grep ^uid: /path/to/Example.ldif | sed -e "s/uid: //" > names.txt</userinput>
+$ <userinput>modrate -p 1389 -D "cn=Directory Manager" -w password -A -F -c 4 -t 4 \
+ -b "uid=%s,ou=people,dc=example,dc=com" -g "rand(names.txt)" \
+ -g "randstr(16)" 'description:%2$s'</userinput>
+<computeroutput>--------------------------------------------------------------------------
+ Throughput Response Time
+ (ops/second) (milliseconds)
+recent average recent average 99.9% 99.99% 99.999% err/sec req/res
+--------------------------------------------------------------------------
+1085.9 1088.5 993.849 993.849 2135.220 2510.361 2510.361 0.0 2.3
+2086.7 1648.8 1963.980 1683.038 3015.025 3078.628 3215.050 0.0 1.0
+3097.3 2092.6 1332.930 1524.278 2940.131 3024.811 3215.050 0.0 1.0
+3848.3 2501.4 1045.000 1352.583 2902.235 3015.863 3215.050 0.0 1.0
+3641.2 2717.4 1106.157 1290.003 2901.379 3015.597 3215.050 0.0 1.0
+3759.4 2883.0 1065.732 1243.534 2900.400 3015.501 3215.050 0.0 1.0
+^C</computeroutput>
+ </screen>
+</refsect1>
diff --git a/opendj-doc-generated-ref/src/main/docbkx/man-pages/searchrate-examples.xml b/opendj-doc-generated-ref/src/main/docbkx/man-pages/searchrate-examples.xml
new file mode 100644
index 0000000..11d8839
--- /dev/null
+++ b/opendj-doc-generated-ref/src/main/docbkx/man-pages/searchrate-examples.xml
@@ -0,0 +1,55 @@
+<?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/opendj/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 2015 ForgeRock AS.
+ !
+-->
+<refsect1 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">
+ <title>Examples</title>
+
+ <para>
+ The following example demonstrates measuring search performance:
+ </para>
+
+ <screen>
+$ <userinput>grep ^uid: /path/to/Example.ldif | sed -e "s/uid: //" > names.txt</userinput>
+$ <userinput>searchrate -p 1389 -b dc=example,dc=com -A -F -c 4 -t 4 \
+ -g "rand(names.txt)" "(uid=%s)"</userinput>
+<computeroutput>-------------------------------------------------------------------------------
+ Throughput Response Time
+ (ops/second) (milliseconds)
+recent average recent average 99.9% 99.99% 99.999% err/sec Entries/Srch
+-------------------------------------------------------------------------------
+1475.9 1475.9 0.423 0.423 6.938 126.236 126.236 0.0 1.0
+2596.5 2038.4 0.254 0.315 6.866 12.980 126.236 0.0 1.0
+3210.7 2428.2 0.205 0.267 5.733 11.710 126.236 0.0 1.0
+3080.5 2591.0 0.215 0.252 5.733 10.541 126.236 0.0 1.0
+3236.9 2720.1 0.203 0.240 5.258 10.514 126.236 0.0 1.0
+3181.1 2796.8 0.207 0.234 5.258 10.384 126.236 0.0 1.0
+3202.5 2854.8 0.206 0.229 4.825 10.384 126.236 0.0 1.0
+^C</computeroutput>
+ </screen>
+</refsect1>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/index.xml b/opendj-server-legacy/src/main/docbkx/man-pages/index.xml
index e1d87a7..b4332a4 100644
--- a/opendj-server-legacy/src/main/docbkx/man-pages/index.xml
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/index.xml
@@ -12,7 +12,7 @@
Header, with the fields enclosed by brackets [] replaced by your own identifying
information: "Portions Copyright [year] [name of copyright owner]".
- Copyright 2015 ForgeRock AS.
+ Copyright 2015-2016 ForgeRock AS.
-->
<book xml:id="reference"
xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en"
@@ -32,7 +32,7 @@
</abstract>
<copyright>
- <year>2015</year>
+ <year>2015-2016</year>
<holder>ForgeRock AS.</holder>
</copyright>
@@ -101,7 +101,7 @@
<xinclude:include href="man-ldapsearch.xml">
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
- <xinclude:include href="man-ldif-diff.xml">
+ <xinclude:include href="man-ldifdiff.xml">
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href="man-ldifmodify.xml">
@@ -113,10 +113,10 @@
<xinclude:include href="man-list-backends.xml">
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
- <xinclude:include href="man-make-ldif.xml">
+ <xinclude:include href="man-makeldif.xml">
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
- <xinclude:include href="man-make-ldif-template.xml" />
+ <xinclude:include href="man-makeldif-template.xml" />
<xinclude:include href="man-manage-account.xml">
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
--
Gitblit v1.10.0