From 72a6dc4f5a9d8e983e554b2aa588a93dfbc16e61 Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Fri, 13 Feb 2015 07:00:36 +0000
Subject: [PATCH] CR-6068 OPENDJ-1785 Add "extra" doc into code for generated content
---
opendj-ldap-toolkit/src/main/resources/com/forgerock/opendj/ldap/tools/tools.properties | 187 ++++++++++++++++++++++++++++++++++++++++++++++
1 files changed, 184 insertions(+), 3 deletions(-)
diff --git a/opendj-ldap-toolkit/src/main/resources/com/forgerock/opendj/ldap/tools/tools.properties b/opendj-ldap-toolkit/src/main/resources/com/forgerock/opendj/ldap/tools/tools.properties
index cf01496..ccb33df 100755
--- a/opendj-ldap-toolkit/src/main/resources/com/forgerock/opendj/ldap/tools/tools.properties
+++ b/opendj-ldap-toolkit/src/main/resources/com/forgerock/opendj/ldap/tools/tools.properties
@@ -288,7 +288,9 @@
INFO_LDAPCOMPARE_TOOL_DESCRIPTION=This utility can be used to perform \
LDAP compare operations in the Directory Server
INFO_LDAPMODIFY_TOOL_DESCRIPTION=This utility can be used to perform LDAP \
- modify, add, delete, and modify DN operations in the Directory Server
+ modify, add, delete, and modify DN operations in the Directory Server. \
+ When not using a file to specify modifications, end your input with EOF \
+ (Ctrl+D on UNIX, Ctrl+Z on Windows)
INFO_LDAPPWMOD_TOOL_DESCRIPTION=This utility can be used to perform LDAP \
password modify operations in the Directory Server
INFO_LDAPSEARCH_TOOL_DESCRIPTION=This utility can be used to perform LDAP \
@@ -439,13 +441,16 @@
\ \ \ \ -F -c 4 -t 4 -b "dc=example,dc=com" -g "rand(0,2000)" "(uid=user.%%d)"
INFO_ADDRATE_TOOL_DESCRIPTION=This utility can be used to measure \
add and optionally delete throughput and response time of a directory server using \
- user-defined entries.\n\
+ user-defined entries. \
+ The {template-file-path} argument identifies a template file \
+ that has the same form as a template file for the makeldif command. \
+ For details, see makeldif.template.\n\
\nExamples:\n \ This example is adding entries and randomly deleting them while \
the number of entries added is greater than 10,000: \n \
addrate -p 1389 -f -c 10 -C random -s 10000 addrate.template \n \
This example adds entries and starts to delete them in the same \
order if their age is greater than a certain time: \n \
- addrate -p 1389 -f -c 10 -C fifo -a 2 addrate.template
+ addrate -p 1389 -f -c 10 -C fifo -a 2 addrate.template
INFO_SEARCHRATE_TOOL_DESCRIPTION_BASEDN=Base DN format string.
INFO_MODRATE_TOOL_DESCRIPTION=This utility can be used to measure \
modify throughput and response time of a directory service using \
@@ -549,6 +554,182 @@
INFO_ADDRATE_DESCRIPTION_NOPURGE=Disable the purge phase when the tool stops.
# Supplements to descriptions for generated reference documentation.
+SUPPLEMENT_DESCRIPTION_RATE_TOOLS=<para> \
+ When you do not use the <option>-f</option> option \
+ to keep connections open and rebind on the connections, \
+ the tool can exhaust the available ports and 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 how long to wait in seconds 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>
+SUPPLEMENT_DESCRIPTION_MAKELDIF=<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 LDAP Toolkit, \
+ such as <filename>example.template</filename>, \
+ or <filename>people_and_groups.template</filename>. \
+ </para> \
+ </listitem> \
+ </itemizedlist> \
+ \
+ <para> \
+ The OpenDJ 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>
+SUPPLEMENT_DESCRIPTION_RESOURCE_PATH=<para> \
+ The utility looks for resources in the following locations in this order:\
+ </para> \
+ \
+ <orderedlist> \
+ <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>
SUPPLEMENT_DESCRIPTION_PSEARCH_INFO=<para> \
A persistent search allows the client to continue receiving new results \
whenever changes are made to data that is in the scope of the search, \
--
Gitblit v1.10.0