<?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
! 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
! 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
! Portions Copyright 2013 Jens Elkner
!
-->
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:xi="http://www.w3.org/2001/XInclude">
<refmeta>
<refentrytitle><application>make-ldif</application></refentrytitle>
</refmeta>
<refnamediv>
<refname><application>make-ldif</application></refname>
<refpurpose>generate test LDIF</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>make-ldif</command>
<arg>-o <replaceable class="parameter">outfile</replaceable></arg>
<arg>-s <replaceable class="parameter">seed</replaceable></arg>
<arg>-t <replaceable class="parameter">templFile</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsection>
<title>Description</title>
<para>
This utility can be used to generate LDIF data based on a definition in a
template file.
</para>
</refsection>
<refsection>
<title>Options</title>
<para>The following options are supported.</para>
<variablelist>
<varlistentry>
<term><option>-o, --ldifFile</option> <replaceable
class="parameter">file</replaceable></term>
<listitem>
<para>
The path to the LDIF file to be written.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-s, --randomSeed</option> <replaceable
class="parameter">seed</replaceable></term>
<listitem>
<para>
The seed to use to initialize the random number generator (Default: 0).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>-t, --templateFile</option> <replaceable
class="parameter">file</replaceable></term>
<listitem>
<para>
The path to the template file with information about the LDIF data to generate.
</para>
</listitem>
</varlistentry>
</variablelist>
<refsection>
<title>General Options</title>
<variablelist>
xpointer='xpointer(//para[@name="l-general"]/*)'/>
</variablelist>
</refsection>
</refsection>
<refsection>
<title>Examples</title>
<informalexample>
<para>
The following example uses the default template to generate LDIF.
</para>
<literallayout><prompt
<screen>
Processed 1000 entries
Processed 2000 entries
...
Processed 10000 entries
LDIF processing complete. 10003 entries written
</screen>
</informalexample>
</refsection>
<refsection>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>make-ldif-template</refentrytitle><xi:include
href="common.xml" xpointer='xpointer(//manvolnum[@name="v5"])'/>
</citerefentry>,
<citerefentry><refentrytitle>opendj</refentrytitle><xi:include
href="common.xml" xpointer='xpointer(//manvolnum[@name="v5"])'/>
</citerefentry>
</para>
</refsection>
</refentry>