external-software/github_OpenIdentityPlatform_OpenDJ.git

			@@ -568,386 +568,8 @@
			REF_SHORT_DESC_SEARCHRATE=measure search throughput and response time

			# 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">\n \
			net.ipv4.tcp_fin_timeout = 30\n \
			net.ipv4.tcp_tw_recycle = 1\n \
			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, \
			thus using the search as a form of change notification. \
			</para> \
			\
			<variablelist> \
			<para> \
			The optional <literal>changetype</literal> setting defines \
			the kinds of updates that result in notification. \
			If you do not set the <literal>changetype</literal>, \
			the default behavior is to send notifications for all updates. \
			</para> \
			\
			<varlistentry> \
			<term><literal>add</literal></term> \
			<listitem> \
			<para> \
			Send notifications for LDAP add operations. \
			</para> \
			</listitem> \
			</varlistentry> \
			\
			<varlistentry> \
			<term><literal>del</literal></term> \
			<term><literal>delete</literal></term> \
			<listitem> \
			<para> \
			Send notifications for LDAP delete operations. \
			</para> \
			</listitem> \
			</varlistentry> \
			\
			<varlistentry> \
			<term><literal>mod</literal></term> \
			<term><literal>modify</literal></term> \
			<listitem> \
			<para> \
			Send notifications for LDAP modify operations. \
			</para> \
			</listitem> \
			</varlistentry> \
			\
			<varlistentry> \
			<term><literal>moddn</literal></term> \
			<term><literal>modrdn</literal></term> \
			<term><literal>modifydn</literal></term> \
			<listitem> \
			<para> \
			Send notifications for LDAP modify DN (rename and move) operations. \
			</para> \
			</listitem> \
			</varlistentry> \
			\
			<varlistentry> \
			<term><literal>all</literal></term> \
			<term><literal>any</literal></term> \
			<listitem> \
			<para> \
			Send notifications for all LDAP update operations. \
			</para> \
			</listitem> \
			</varlistentry> \
			</variablelist> \
			\
			<variablelist> \
			<para> \
			The optional <literal>changesonly</literal> setting defines \
			whether the server returns existing entries as well as changes. \
			</para> \
			\
			<varlistentry> \
			<term><literal>true</literal></term> \
			<listitem> \
			<para> \
			Do not return existing entries, \
			but instead only notifications about changes. \
			</para> \
			\
			<para> \
			This is the default setting. \
			</para> \
			</listitem> \
			</varlistentry> \
			\
			<varlistentry> \
			<term><literal>false</literal></term> \
			<listitem> \
			<para> \
			Also return existing entries. \
			</para> \
			</listitem> \
			</varlistentry> \
			</variablelist> \
			\
			<variablelist> \
			<para> \
			The optional <literal>entrychgcontrols</literal> setting defines \
			whether the server returns an Entry Change Notification control \
			with each entry notification. \
			The Entry Change Notification control provides additional information \
			about the change that caused the entry to be returned by the search. \
			In particular, it indicates the change type, \
			the change number if available, \
			and the previous DN if the change type was a modify DN operation. \
			</para> \
			\
			<varlistentry> \
			<term><literal>true</literal></term> \
			<listitem> \
			<para> \
			Do request the Entry Change Notification control. \
			</para> \
			\
			<para> \
			This is the default setting. \
			</para> \
			</listitem> \
			</varlistentry> \
			\
			<varlistentry> \
			<term><literal>false</literal></term> \
			<listitem> \
			<para> \
			Do not request the Entry Change Notification control. \
			</para> \
			</listitem> \
			</varlistentry> \
			</variablelist>
			SUPPLEMENT_DESCRIPTION_CONTROLS=<para> \
			For some <replaceable>controloid</replaceable> values, \
			you can replace object identifiers with user-friendly strings. \
			\
			The strings are listed here in lower case, but the case is not important. \
			You can use camelCase if you prefer, for example. \
			</para> \
			\
			<variablelist> \
			<varlistentry> \
			<term><literal>accountusable</literal></term> \
			<term><literal>accountusability</literal></term> \
			<listitem> \
			<para>Account Usability Control, Object Identifier: 1.3.6.1.4.1.42.2.27.9.5.8</para> \
			</listitem> \
			</varlistentry> \
			\
			<varlistentry> \
			<term><literal>authzid</literal></term> \
			<term><literal>authorizationidentity</literal></term> \
			<listitem> \
			<para>Authorization Identity Request Control, Object Identifier: 2.16.840.1.113730.3.4.16</para> \
			</listitem> \
			</varlistentry> \
			\
			<varlistentry> \
			<term><literal>effectiverights</literal></term> \
			<term><literal>geteffectiverights</literal></term> \
			<listitem> \
			<para>Get Effective Rights Request Control, Object Identifier: 1.3.6.1.4.1.42.2.27.9.5.2</para> \
			</listitem> \
			</varlistentry> \
			\
			<varlistentry> \
			<term><literal>managedsait</literal></term> \
			<listitem> \
			<para>Manage DSAIT Request Control, Object Identifier: 2.16.840.1.113730.3.4.2</para> \
			</listitem> \
			</varlistentry> \
			\
			<varlistentry> \
			<term><literal>noop</literal></term> \
			<term><literal>no-op</literal></term> \
			<listitem> \
			<para>No-Op Control, Object Identifier: 1.3.6.1.4.1.4203.1.10.2</para> \
			</listitem> \
			</varlistentry> \
			\
			<varlistentry> \
			<term><literal>pwpolicy</literal></term> \
			<term><literal>passwordpolicy</literal></term> \
			<listitem> \
			<para>Password Policy Control, Object Identifier: 1.3.6.1.4.1.42.2.27.8.5.1</para> \
			</listitem> \
			</varlistentry> \
			\
			<varlistentry> \
			<term><literal>realattrsonly</literal></term> \
			<term><literal>realattributesonly</literal></term> \
			<listitem> \
			<para>Real Attributes Only Request Control, Object Identifier: 2.16.840.1.113730.3.4.17</para> \
			</listitem> \
			</varlistentry> \
			\
			<varlistentry> \
			<term><literal>subtreedelete</literal></term> \
			<term><literal>treedelete</literal></term> \
			<listitem> \
			<para>Subtree Delete Request Control, Object Identifier: 1.2.840.113556.1.4.805</para> \
			</listitem> \
			</varlistentry> \
			\
			<varlistentry> \
			<term><literal>virtualattrsonly</literal></term> \
			<term><literal>virtualattributesonly</literal></term> \
			<listitem> \
			<para>Virtual Attributes Only Request Control, Object Identifier: 2.16.840.1.113730.3.4.19</para> \
			</listitem> \
			</varlistentry> \
			</variablelist>
			SUPPLEMENT_DESCRIPTION_RATE_TOOLS=<xinclude:include href="description-rate-tools.xml" />
			SUPPLEMENT_DESCRIPTION_MAKELDIF=<xinclude:include href="description-makeldif.xml" />
			SUPPLEMENT_DESCRIPTION_RESOURCE_PATH=<xinclude:include href="description-resource-path.xml" />
			SUPPLEMENT_DESCRIPTION_PSEARCH_INFO=<xinclude:include href="description-psearch-info.xml" />
			SUPPLEMENT_DESCRIPTION_CONTROLS=<xinclude:include href="variablelist-ldap-controls.xml" />