CR-6483 OPENDJ-1786 Automate integration of generated content

Mark Craig

27.14.2015 8a81bad1a27eb157108f63c6cc5d313a13b17be0

CR-6483 OPENDJ-1786 Automate integration of generated content

This patch replaces nearly all the server & SDK tools reference pages
with generated pages.

As explained in the comments for OPENDJ-1786,
there's still a problem with <xref> linkends inside the dsconfig page.
I've logged OPENDJ-1895 to address that.

The rest of the content seems to correspond to what we had before,
with minor formatting problems that are flagged in related JIRA issues.

Thanks to Jean-Noël R. for reviews.

 opendj-ldap-toolkit/pom.xml

@@ -21,7 +21,7 @@
 !
 ! CDDL HEADER END
 !
 !      Copyright 2011-2012 ForgeRock AS
 !      Copyright 2011-2015 ForgeRock AS.
 !    
 -->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
@@ -99,6 +99,138 @@
        </executions>
      </plugin>
      <plugin>
        <groupId>org.forgerock.opendj</groupId>
        <artifactId>opendj-maven-plugin</artifactId>
        <version>${project.version}</version>
        <executions>
          <execution>
            <id>generate-doc</id>
            <goals>
              <goal>generate-refentry</goal>
            </goals>
            <configuration>
              <outputDir>${project.build.directory}/generated-man-pages</outputDir>
              <tools>
                <tool>
                  <name>addrate</name>
                  <application>com.forgerock.opendj.ldap.tools.AddRate</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-80-89.xml</trailingSectionPath>
                    <trailingSectionPath>addrate-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                </tool>

                <tool>
                  <name>authrate</name>
                  <application>com.forgerock.opendj.ldap.tools.AuthRate</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-89.xml</trailingSectionPath>
                    <trailingSectionPath>authrate-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                </tool>

                <tool>
                  <name>ldapcompare</name>
                  <application>com.forgerock.opendj.ldap.tools.LDAPCompare</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-ldap-89.xml</trailingSectionPath>
                    <trailingSectionPath>files.xml</trailingSectionPath>
                    <trailingSectionPath>ldapcompare-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                </tool>

                <tool>
                  <name>ldapmodify</name>
                  <application>com.forgerock.opendj.ldap.tools.LDAPModify</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-ldap-89.xml</trailingSectionPath>
                    <trailingSectionPath>files.xml</trailingSectionPath>
                    <trailingSectionPath>ldapmodify-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                </tool>

                <tool>
                  <name>ldappasswordmodify</name>
                  <application>com.forgerock.opendj.ldap.tools.LDAPPasswordModify</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-ldap-89.xml</trailingSectionPath>
                    <trailingSectionPath>files.xml</trailingSectionPath>
                    <trailingSectionPath>ldappasswordmodify-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                </tool>

                <tool>
                  <name>ldapsearch</name>
                  <application>com.forgerock.opendj.ldap.tools.LDAPSearch</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>filters.xml</trailingSectionPath>
                    <trailingSectionPath>attributes.xml</trailingSectionPath>
                    <trailingSectionPath>exit-codes-0-ldap-89.xml</trailingSectionPath>
                    <trailingSectionPath>files.xml</trailingSectionPath>
                    <trailingSectionPath>ldapsearch-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                </tool>

                <tool>
                  <name>ldifdiff</name>
                  <application>com.forgerock.opendj.ldap.tools.LDIFDiff</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-5-6-other.xml</trailingSectionPath>
                    <trailingSectionPath>ldifdiff-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                </tool>

                <tool>
                  <name>ldifmodify</name>
                  <application>com.forgerock.opendj.ldap.tools.LDIFModify</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                    <trailingSectionPath>ldifmodify-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                </tool>

                <tool>
                  <name>ldifsearch</name>
                  <application>com.forgerock.opendj.ldap.tools.LDIFSearch</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                    <trailingSectionPath>ldifsearch-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                </tool>

                <tool>
                  <name>makeldif</name>
                  <application>com.forgerock.opendj.ldap.tools.MakeLDIF</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-1.xml</trailingSectionPath>
                    <trailingSectionPath>makeldif-examples.xml</trailingSectionPath>
                    <trailingSectionPath>makeldif-see-also.xml</trailingSectionPath>
                  </trailingSectionPaths>
                </tool>

                <tool>
                  <name>modrate</name>
                  <application>com.forgerock.opendj.ldap.tools.ModRate</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-89.xml</trailingSectionPath>
                    <trailingSectionPath>modrate-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                </tool>

                <tool>
                  <name>searchrate</name>
                  <application>com.forgerock.opendj.ldap.tools.SearchRate</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-89.xml</trailingSectionPath>
                    <trailingSectionPath>searchrate-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                </tool>
              </tools>
            </configuration>
          </execution>
        </executions>
      </plugin>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-jar-plugin</artifactId>
        <configuration>
@@ -130,6 +262,18 @@
              </descriptors>
            </configuration>
          </execution>
          <execution>
            <id>man-pages</id>
            <phase>package</phase>
            <goals>
              <goal>single</goal>
            </goals>
            <configuration>
              <descriptors>
                <descriptor>src/main/assembly/man-pages.xml</descriptor>
              </descriptors>
            </configuration>
          </execution>
        </executions>
      </plugin>
      <plugin>

 opendj-ldap-toolkit/src/main/assembly/man-pages.xml

New file
@@ -0,0 +1,104 @@
<?xml version="1.0"?>
<!--
 ! CDDL HEADER START
 !
 ! The contents of this file are subject to the terms of the
 ! Common Development and Distribution License, Version 1.0 only
 ! (the "License").  You may not use this file except in compliance
 ! with the License.
 !
 ! You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
 ! or http://forgerock.org/license/CDDLv1.0.html.
 ! See the License for the specific language governing permissions
 ! and limitations under the License.
 !
 ! When distributing Covered Code, include this CDDL HEADER in each
 ! file and include the License file at legal-notices/CDDLv1_0.txt.
 ! If applicable, add the following below this CDDL HEADER, with the
 ! fields enclosed by brackets "[]" replaced with your own identifying
 ! information:
 !      Portions Copyright [yyyy] [name of copyright owner]
 !
 ! CDDL HEADER END
 !
 !      Copyright 2015 ForgeRock AS.
 !    
 -->
<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2
                              http://maven.apache.org/xsd/assembly-1.1.2.xsd">
  <id>man-pages</id>

  <includeBaseDirectory>false</includeBaseDirectory>

  <!--
    Using <files> instead of <fileset> to avoid getting the full path.
    The .jar to has this file at /man-pages/man-addrate.xml for example.
  -->
  <files>
    <file>
      <outputDirectory>man-pages</outputDirectory>
      <source>target/generated-man-pages/man-addrate.xml</source>
    </file>

    <file>
      <outputDirectory>man-pages</outputDirectory>
      <source>target/generated-man-pages/man-authrate.xml</source>
    </file>

    <file>
      <outputDirectory>man-pages</outputDirectory>
      <source>target/generated-man-pages/man-ldapcompare.xml</source>
    </file>

    <file>
      <outputDirectory>man-pages</outputDirectory>
      <source>target/generated-man-pages/man-ldapmodify.xml</source>
    </file>

    <file>
      <outputDirectory>man-pages</outputDirectory>
      <source>target/generated-man-pages/man-ldappasswordmodify.xml</source>
    </file>

    <file>
      <outputDirectory>man-pages</outputDirectory>
      <source>target/generated-man-pages/man-ldapsearch.xml</source>
    </file>

    <file>
      <outputDirectory>man-pages</outputDirectory>
      <source>target/generated-man-pages/man-ldifdiff.xml</source>
    </file>

    <file>
      <outputDirectory>man-pages</outputDirectory>
      <source>target/generated-man-pages/man-ldifmodify.xml</source>
    </file>

    <file>
      <outputDirectory>man-pages</outputDirectory>
      <source>target/generated-man-pages/man-ldifsearch.xml</source>
    </file>

    <file>
      <outputDirectory>man-pages</outputDirectory>
      <source>target/generated-man-pages/man-makeldif.xml</source>
    </file>

    <file>
      <outputDirectory>man-pages</outputDirectory>
      <source>target/generated-man-pages/man-modrate.xml</source>
    </file>

    <file>
      <outputDirectory>man-pages</outputDirectory>
      <source>target/generated-man-pages/man-searchrate.xml</source>
    </file>
  </files>

  <formats>
    <format>jar</format>
  </formats>
</assembly>

 opendj-ldap-toolkit/src/main/java/com/forgerock/opendj/ldap/tools/DataSource.java

@@ -217,7 +217,7 @@

        public static LocalizableMessage getUsage() {
            return LocalizableMessage
                    .raw("\"randstr({length},<charSet>)\" Random string of specified "
                    .raw("\"randstr({length},_charSet_)\" Random string of specified "
                            + "length and optionally from characters in "
                            + "the charSet string. A range of character "
                            + "can be specified with [start-end] charSet notation. "

 opendj-ldap-toolkit/src/main/resources/com/forgerock/opendj/ldap/tools/tools.properties

@@ -581,9 +581,9 @@
    in the <filename>/etc/sysctl.conf</filename> file.                           \
   </para>                                                                       \
                                                                                 \
   <programlisting language="ini">                                               \
  net.ipv4.tcp_fin_timeout = 30                                                  \
  net.ipv4.tcp_tw_recycle = 1                                                    \
   <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>                                                             \
                                                                                 \
@@ -617,9 +617,7 @@
    reload the configuration with the <command>sysctl</command> command.         \
   </para>                                                                       \
                                                                                 \
   <screen>                                                                      \
  # sysctl -p                                                                    \
   </screen>
   <screen># sysctl -p</screen>
SUPPLEMENT_DESCRIPTION_MAKELDIF=<para>                                       \
   The <replaceable>template-file-path</replaceable> can be                  \
   one of the following:                                                     \

 opendj-maven-plugin/src/main/java/org/forgerock/opendj/maven/GenerateRefEntriesMojo.java

@@ -35,18 +35,20 @@
import org.apache.maven.plugins.annotations.ResolutionScope;
import org.apache.maven.project.MavenProject;

import java.io.BufferedOutputStream;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.PrintStream;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.io.FileWriter;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.MalformedURLException;
import java.net.URISyntaxException;
import java.net.URL;
import java.net.URLClassLoader;
import java.util.LinkedHashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Set;

/**
 * Generate DocBook RefEntry source documents for command-line tools man pages.
@@ -67,9 +69,6 @@
    @Parameter(required = true)
    private File outputDir;

    /** End of line. */
    public static final String EOL = System.getProperty("line.separator");

    /**
     * Writes a RefEntry file to the output directory for each tool.
     * Files names correspond to script names: {@code man-&lt;name>.xml}.
@@ -80,17 +79,29 @@
     */
    @Override
    public void execute() throws MojoExecutionException, MojoFailureException {
        PrintStream out = System.out;

        // Set the magic property for generating DocBook XML.
        System.setProperty("org.forgerock.opendj.gendoc", "true");

        // A Maven plugin classpath does not include project files.
        // Prepare a ClassLoader capable of loading the command-line tools.
        URLClassLoader toolsClassLoader = getBootToolsClassLoader();

        if (!isOutputDirAvailable()) {
            throw new MojoFailureException("Output directory " + outputDir.getPath() + " not available");
        }

        for (CommandLineTool tool : tools) {
            generateManPageForTool(toolsClassLoader, tool);
        }
    }

    /**
     * Returns a ClassLoader capable of loading the command-line tools.
     * @return A ClassLoader capable of loading the command-line tools.
     * @throws MojoFailureException     Failed to build classpath.
     */
    private URLClassLoader getBootToolsClassLoader() throws MojoFailureException {
        URLClassLoader toolsClassLoader;
        try {
            List<String> runtimeClasspathElements = project.getRuntimeClasspathElements();
            List<URL> runtimeUrls = new LinkedList<URL>();
            Set<URL> runtimeUrls = new LinkedHashSet<URL>();
            for (String element : runtimeClasspathElements) {
                runtimeUrls.add(new File(element).toURI().toURL());
            }
@@ -103,53 +114,99 @@
            throw new MojoFailureException("Failed to add element to classpath.", e);
        }
        debugClassPathElements(toolsClassLoader);
        return toolsClassLoader;
    }

        List<String> failures = new LinkedList<String>();
        for (CommandLineTool tool : tools) {
    /**
     * Generate a RefEntry file to the output directory for a tool.
     * The files name corresponds to the tool name: {@code man-&lt;name>.xml}.
     * @param toolsClassLoader          The ClassLoader to run the tool.
     * @param tool                      The tool to run in order to generate the page.
     * @throws MojoExecutionException   Failed to run the tool.
     * @throws MojoFailureException     Tool did not exit successfully.
     */
    private void generateManPageForTool(final URLClassLoader toolsClassLoader, final CommandLineTool tool)
            throws MojoExecutionException, MojoFailureException {
            final File manPage = new File(outputDir, "man-" + tool.getName() + ".xml");
        final String toolScript = tool.getName();
        final String toolSects  = pathsToXIncludes(tool.getTrailingSectionPaths());
        final String toolClass  = tool.getApplication();
        List<String> commands   = new LinkedList<String>();
        commands.add(getJavaCommand());
        commands.addAll(getJavaArgs(toolScript, toolSects));
        commands.add("-classpath");
        commands.add(getClassPath(toolsClassLoader));
        commands.add(toolClass);
        commands.add(getUsageArgument(toolScript));
        getLog().info("Writing man page: " + manPage.getPath());
            try {
                setSystemOut(refEntryFile(manPage.getPath()));
            } catch (FileNotFoundException e) {
                setSystemOut(out);
                failures.add(manPage.getPath());
                throw new MojoExecutionException("Failed to write " + manPage.getPath(), e);
            // Tools tend to use System.exit() so run them as separate processes.
            ProcessBuilder builder = new ProcessBuilder(commands);
            Process process = builder.start();
            writeToFile(process.getInputStream(), manPage);
            process.waitFor();
            final int result = process.exitValue();
            if (result != 0) {
                throw new MojoFailureException("Failed to write page. Tool exit code: " + result);
            }
        }  catch (InterruptedException e) {
            throw new MojoExecutionException(toolClass + " interrupted", e);
        } catch (IOException e) {
            throw new MojoExecutionException(toolClass + " not found", e);
        }
            }

            // Set the properties for script name and list of trailing sections.
            System.setProperty("com.forgerock.opendj.ldap.tools.scriptName", tool.getName());
            final String xInclude = pathsToXIncludes(tool.getTrailingSectionPaths());
            System.setProperty("org.forgerock.opendj.gendoc.trailing", xInclude);
    /**
     * Returns true if the output directory is available.
     * Attempts to create the directory if it does not exist.
     * @return True if the output directory is available.
     */
    private boolean isOutputDirAvailable() {
        return outputDir != null && (outputDir.exists() && outputDir.isDirectory() || outputDir.mkdirs());
    }

    /**
     * Returns the path to the current Java executable.
     * @return The path to the current Java executable.
     */
    private String getJavaCommand() {
        return System.getProperty("java.home") + File.separator + "bin" + File.separator + "java";
    }

    /**
     * Returns the Java args for running a tool.
     * @param scriptName        The name of the tool.
     * @param trailingSections  The man page sections to Xinclude.
     * @return The Java args for running a tool.
     */
    private List<String> getJavaArgs(final String scriptName, final String trailingSections) {
        List<String> args = new LinkedList<String>();
        args.add("-Dorg.forgerock.opendj.gendoc=true");
        args.add("-Dorg.opends.server.ServerRoot=" + System.getProperty("java.io.tmpdir"));
        args.add("-Dcom.forgerock.opendj.ldap.tools.scriptName=" + scriptName);
        args.add("-Dorg.forgerock.opendj.gendoc.trailing=" + trailingSections + "");
        return args;
    }

    /**
     * Returns the classpath for the class loader.
     * @param classLoader   Contains the URLs of the class path to return.
     * @return The classpath for the class loader.
     */
    private String getClassPath(final URLClassLoader classLoader) {
        final StringBuilder stringBuilder = new StringBuilder();
        final URL[] urls = classLoader.getURLs();
        for (int i = 0; i < urls.length; i++) {
            if (i > 0) {
                stringBuilder.append(File.pathSeparator);
            }
            try {
                final Class<?> toolClass = toolsClassLoader.loadClass(tool.getApplication());
                final Class[] argTypes = new Class[]{String[].class};
                final Method main = toolClass.getDeclaredMethod("main", argTypes);
                final String[] args = {"-?"};
                main.invoke(null, (Object) args);
            } catch (ClassNotFoundException e) {
                failures.add(manPage.getPath());
                throw new MojoExecutionException(tool.getApplication() + " not found", e);
            } catch (NoSuchMethodException e) {
                failures.add(manPage.getPath());
                throw new MojoExecutionException(tool.getApplication() + " has no main method.", e);
            } catch (IllegalAccessException e) {
                failures.add(manPage.getPath());
                throw new MojoExecutionException("Failed to run " + tool.getApplication() + ".main()", e);
            } catch (InvocationTargetException e) {
                failures.add(manPage.getPath());
                throw new MojoExecutionException("Failed to run " + tool.getApplication() + ".main()", e);
            } finally {
                setSystemOut(out);
                stringBuilder.append(new File(urls[i].toURI()).getPath());
            } catch (URISyntaxException e) {
                getLog().info("Failed to add classpath element", e);
            }
        }

        final StringBuilder list = new StringBuilder();
        if (!failures.isEmpty()) {
            for (final String failure : failures) {
                list.append(failure).append(EOL);
            }
            throw new MojoFailureException("Failed to write the following RefEntry files: " + list);
        }
        return stringBuilder.toString();
    }

    /**
@@ -173,26 +230,6 @@
    }

    /**
     * Returns a PrintStream to a file to which to write a RefEntry.
     * @param   path                    Path to the file to be written.
     * @return                          PrintStream to a file to which to write a RefEntry.
     * @throws  FileNotFoundException   Failed to open the file for writing.
     */
    private PrintStream refEntryFile(final String path) throws FileNotFoundException {
        return new PrintStream(new BufferedOutputStream(new FileOutputStream(path)), true);
    }

    /**
     * Sets the System output stream.
     * @param out   The stream to use.
     */
    private void setSystemOut(PrintStream out) {
        if (out != null) {
            System.setOut(out);
        }
    }

    /**
     * Translates relative paths to XML files into XInclude elements.
     *
     * @param paths Paths to XInclude'd files, relative to the RefEntry.
@@ -208,8 +245,40 @@
        final String nameSpace = "xinclude";
        final StringBuilder result = new StringBuilder();
        for (String path : paths) {
            result.append("<").append(nameSpace).append(":include href=\"").append(path).append("\" />").append(EOL);
            result.append("<").append(nameSpace).append(":include href='").append(path).append("' />");
        }
        return result.toString();
    }

    /**
     * Returns the usage argument.
     * @param scriptName The name of the tool.
     * @return The usage argument.
     */
    private String getUsageArgument(final String scriptName) {
        return scriptName.equals("dsjavaproperties") ? "-H" : "-?";
    }

    /**
     * Write the content of the input stream to the output file.
     * @param input     The input stream to write.
     * @param output    The file to write it to.
     * @throws IOException  Failed to write the content of the input stream.
     */
    private void writeToFile(final InputStream input, final File output) throws IOException {
        FileWriter writer = null;
        try {
            writer = new FileWriter(output);
            BufferedReader reader = new BufferedReader(new InputStreamReader(input));
            String line;
            while ((line = reader.readLine()) != null) {
                writer.write(line);
                writer.write(System.getProperty("line.separator"));
            }
        } finally {
            if (writer != null) {
                writer.close();
            }
        }
    }
}

 opendj-server-legacy/pom.xml

@@ -528,26 +528,312 @@
            </configuration>
          </execution>

          <!-- TODO: Generate man page sources
          <execution>
             <id>generate-doc</id>
             <goals>
               <goal>generate-refentry</goal>
             </goals>
             <configuration>
               <outputDir>${project.build.directory}</outputDir>
               <outputDir>${project.build.directory}/docbkx-sources/man-pages</outputDir>
               <tools>
                 <tool>
                  <name>backup</name>
                  <application>org.opends.server.tools.BackUpDB</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-1.xml</trailingSectionPath>
                    <trailingSectionPath>backup-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                 </tool>

                 <tool>
                  <name>base64</name>
                  <application>org.opends.server.util.Base64</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                    <trailingSectionPath>base64-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                 </tool>

                 <tool>
                  <name>control-panel</name>
                  <application>org.opends.guitools.controlpanel.ControlPanelLauncher</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                    <trailingSectionPath>control-panel-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                 </tool>

                 <tool>
                  <name>create-rc-script</name>
                  <application>org.opends.server.tools.CreateRCScript</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                    <trailingSectionPath>create-rc-script-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                 </tool>

                 <tool>
                  <name>dbtest</name>
                  <application>org.opends.server.tools.DBTest</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                    <trailingSectionPath>dbtest-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                 </tool>

                 <tool>
                  <name>dsconfig</name>
                  <application>org.forgerock.opendj.config.dsconfig.DSConfig</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                    <trailingSectionPath>dsconfig-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                 </tool>

                 <tool>
                  <name>dsjavaproperties</name>
                  <application>org.opends.server.tools.JavaPropertiesTool</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>dsjavaproperties-files.xml</trailingSectionPath>
                    <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                    <trailingSectionPath>dsjavaproperties-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                 </tool>

                 <tool>
                  <name>dsreplication</name>
                  <application>org.opends.server.tools.dsreplication.ReplicationCliMain</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                    <trailingSectionPath>dsreplication-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                 </tool>

                 <tool>
                  <name>encode-password</name>
                  <application>org.opends.server.tools.EncodePassword</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-5-6-other.xml</trailingSectionPath>
                    <trailingSectionPath>encode-password-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                 </tool>

                 <tool>
                  <name>export-ldif</name>
                  <application>org.opends.server.tools.ExportLDIF</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                    <trailingSectionPath>export-ldif-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                 </tool>

                 <tool>
                  <name>import-ldif</name>
                  <application>org.opends.server.tools.ImportLDIF</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                    <trailingSectionPath>export-ldif-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                 </tool>

                 <tool>
                  <name>ldapcompare</name>
                  <application>org.opends.server.tools.LDAPCompare</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>ldapcompare-exit-codes.xml</trailingSectionPath>
                    <trailingSectionPath>files.xml</trailingSectionPath>
                    <trailingSectionPath>ldapcompare-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                 </tool>

                 <tool>
                  <name>ldapdelete</name>
                  <application>org.opends.server.tools.LDAPDelete</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-ldap-89.xml</trailingSectionPath>
                    <trailingSectionPath>files.xml</trailingSectionPath>
                    <trailingSectionPath>ldapdelete-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                 </tool>

                 <tool>
                  <name>ldapmodify</name>
                  <application>org.opends.server.tools.LDAPModify</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-ldap-89.xml</trailingSectionPath>
                    <trailingSectionPath>files.xml</trailingSectionPath>
                    <trailingSectionPath>ldapmodify-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                 </tool>

                 <tool>
                  <name>ldappasswordmodify</name>
                  <application>org.opends.server.tools.LDAPPasswordModify</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-ldap-89.xml</trailingSectionPath>
                    <trailingSectionPath>files.xml</trailingSectionPath>
                    <trailingSectionPath>ldappasswordmodify-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                 </tool>

                 <tool>
                  <name>ldapsearch</name>
                  <application>org.opends.server.tools.LDAPSearch</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>../shared/refsect1.xml</trailingSectionPath>
                    <trailingSectionPath>filters.xml</trailingSectionPath>
                    <trailingSectionPath>attributes.xml</trailingSectionPath>
                    <trailingSectionPath>exit-codes-0-ldap-89.xml</trailingSectionPath>
                    <trailingSectionPath>files.xml</trailingSectionPath>
                    <trailingSectionPath>ldapsearch-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                 </tool>

                 <tool>
                  <name>ldif-diff</name>
                  <application>org.opends.server.tools.LDIFDiff</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-5-6-other.xml</trailingSectionPath>
                    <trailingSectionPath>ldif-diff-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                 </tool>

                 <tool>
                  <name>ldifmodify</name>
                  <application>org.opends.server.tools.LDIFModify</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                    <trailingSectionPath>ldifmodify-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                 </tool>

                 <tool>
                  <name>ldifsearch</name>
                  <application>org.opends.server.tools.LDIFSearch</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                    <trailingSectionPath>ldifsearch-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                 </tool>

                 <tool>
                  <name>list-backends</name>
                  <application>org.opends.server.tools.ListBackends</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                    <trailingSectionPath>list-backends-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                 </tool>

                 <tool>
                  <name>make-ldif</name>
                  <application>org.opends.server.tools.makeldif.MakeLDIF</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                    <trailingSectionPath>make-ldif-examples.xml</trailingSectionPath>
                    <trailingSectionPath>make-ldif-see-also.xml</trailingSectionPath>
                  </trailingSectionPaths>
                 </tool>

                 <tool>
                  <name>manage-account</name>
                  <application>org.opends.server.tools.ManageAccount</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-89.xml</trailingSectionPath>
                    <trailingSectionPath>manage-account-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                 </tool>

                 <tool>
                  <name>manage-tasks</name>
                  <application>org.opends.server.tools.ManageTasks</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                    <trailingSectionPath>manage-tasks-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                 </tool>

                 <tool>
                  <name>rebuild-index</name>
                  <application>org.opends.server.tools.RebuildIndex</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                    <trailingSectionPath>rebuild-index-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                 </tool>

                 <tool>
                  <name>restore</name>
                  <application>org.opends.server.tools.RestoreDB</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                    <trailingSectionPath>restore-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                 </tool>

                 <tool>
                  <name>setup</name>
                  <application>org.opends.quicksetup.installer.SetupLauncher</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                    <trailingSectionPath>setup-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                 </tool>

                 <tool>
                  <name>start-ds</name>
                  <application>org.opends.server.core.DirectoryServer</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                    <trailingSectionPath>start-ds-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                 </tool>

                 <tool>
                  <name>status</name>
                  <application>org.opends.server.tools.status.StatusCli</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                    <trailingSectionPath>status-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                 </tool>

                 <tool>
                  <name>stop-ds</name>
                  <application>org.opends.server.tools.StopDS</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                    <trailingSectionPath>stop-ds-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                 </tool>

                 <tool>
                  <name>uninstall</name>
                  <application>org.opends.guitools.uninstaller.UninstallLauncher</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>exit-codes-0-gt0.xml</trailingSectionPath>
                    <trailingSectionPath>uninstall-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                 </tool>

                 <tool>
                  <name>upgrade</name>
                  <application>org.opends.server.tools.upgrade.UpgradeCli</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>upgrade-exit-codes.xml</trailingSectionPath>
                  </trailingSectionPaths>
                 </tool>

                 <tool>
                  <name>verify-index</name>
                  <application>org.opends.server.tools.VerifyIndex</application>
                  <trailingSectionPaths>
                    <trailingSectionPath>verify-index-exit-codes.xml</trailingSectionPath>
                    <trailingSectionPath>verify-index-examples.xml</trailingSectionPath>
                  </trailingSectionPaths>
                 </tool>
               </tools>
             </configuration>
           </execution>
          -->
         </executions>
      </plugin>


 opendj-server-legacy/src/main/docbkx/man-pages/README.md

New file
@@ -0,0 +1,9 @@
Source files for the man pages are partially generated from tools sources,
partially hand-written.
See `GeneratedRefEntriesMojo` in `opendj-maven-plugin` for details.

The sources here are the hand-written pages and sections.

These sections are Xincluded into the generated sources at build time.
As a section might be Xincluded more than once in the same document,
none of the hand-written sections here has `xml:id` values.

 opendj-server-legacy/src/main/docbkx/man-pages/attributes.xml

New file
@@ -0,0 +1,82 @@
<?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>Attributes</title>

 <para>
  The optional attribute list specifies the attributes to return
  in the entries found by the search.
  In addition to identifying attributes by name
  such as <literal>cn sn mail</literal> and so forth,
  you can use the following notations, too.
 </para>

 <variablelist>
  <varlistentry>
   <term><literal>*</literal></term>
   <listitem>
    <para>
     Return all user attributes
     such as <literal>cn</literal>, <literal>sn</literal>, and <literal>mail</literal>.
    </para>
   </listitem>
  </varlistentry>

  <varlistentry>
   <term><literal>+</literal></term>
   <listitem>
    <para>
     Return all operational attributes
     such as <literal>etag</literal> and <literal>pwdPolicySubentry</literal>.
    </para>
   </listitem>
  </varlistentry>

  <varlistentry>
   <term><literal>@<replaceable>objectclass</replaceable></literal></term>
   <listitem>
    <para>
     Return all attributes of the specified object class,
     where <replaceable>objectclass</replaceable> is one of the object classes
     on the entries returned by the search.
    </para>
   </listitem>
  </varlistentry>

  <varlistentry>
   <term><literal>1.1</literal></term>
   <listitem>
    <para>
     Return no attributes, only the DNs of matching entries.
    </para>
   </listitem>
  </varlistentry>
 </variablelist>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/backup-examples.xml

New file
@@ -0,0 +1,72 @@
<?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 backs up all user data while the server is online.
 </para>

 <screen>
$ <userinput>backup -p 4444 -D "cn=Directory Manager" -w password \
 -a -d /path/to/opendj/bak -t 0</userinput>
<computeroutput>Backup task 20110613143801866 scheduled to start ...</computeroutput>
 </screen>

 <para>
  The following example schedules back up of all user data every night at 2 AM
  when the server is online,
  and notifies diradmin@example.com when finished, or on error.
 </para>

 <screen>
$ <userinput>backup -p 4444 -D "cn=Directory Manager" -w password -a \
 -d /path/to/opendj/bak --recurringTask "00 02 * * *" \
 --completionNotify diradmin@example.com --errorNotify diradmin@example.com</userinput>
<computeroutput>Recurring Backup task BackupTask-988d6adf-4d65-44bf-8546-6ea74a2480b0
scheduled successfully</computeroutput>
 </screen>

 <para>
  The following example backs up all user data while the server is offline.
 </para>

 <screen>
$ <userinput>stop-ds</userinput>
<computeroutput>Stopping Server...
...</computeroutput>

$ <userinput>backup --backupAll --backupDirectory /path/to/opendj/bak</userinput>
<computeroutput>... msg=The backup process completed successfully</computeroutput>

$ <userinput>start-ds</userinput>
<computeroutput>... The Directory Server has started successfully</computeroutput>
 </screen>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/base64-examples.xml

New file
@@ -0,0 +1,53 @@
<?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 command shows the changes from the external change log
  in human-readable format.
 </para>

 <screen>
$ <userinput>base64 decode -d YWRkOiBkZXNjcmlwdGlvbgpkZXNjcmlwdGlvbjogQSB0aGlyZCBjaGFuZ2UK\
LQpyZXBsYWNlOiBtb2RpZmllcnNOYW1lCm1vZGlmaWVyc05hbWU6IGNuPURpcmVjdG9yeSBNYW5hZ2V\
yLGNuPVJvb3QgRE5zLGNuPWNvbmZpZwotCnJlcGxhY2U6IG1vZGlmeVRpbWVzdGFtcAptb2RpZnlUaW\
1lc3RhbXA6IDIwMTEwNjEzMDcxMjEwWgotCg==</userinput>
<computeroutput>add: description
description: A third change
-
replace: modifiersName
modifiersName: cn=Directory Manager,cn=Root DNs,cn=config
-
replace: modifyTimestamp
modifyTimestamp: 20110613071210Z
-</computeroutput>
 </screen>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/control-panel-examples.xml

New file
@@ -0,0 +1,40 @@
<?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 starts the Control Panel on a remote host.
 </para>

 <screen>
$ <userinput>control-panel -r -h opendj.example.com -p 4444 &amp;</userinput>
 </screen>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/create-rc-script-examples.xml

New file
@@ -0,0 +1,43 @@
<?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 adds a script to start OpenDJ at boot time
  on a Debian-based system,
  and then updates the runlevel system to use the script.
 </para>

 <screen>
$ <userinput>sudo create-rc-script -f /etc/init.d/opendj -u opendj-user</userinput>
$ <userinput>sudo update-rc.d opendj</userinput>
 </screen>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/dbtest-examples.xml

New file
@@ -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 displays debugging information
  about the equality index for <literal>sudoUser</literal>.
 </para>

 <screen>
$ <userinput>dbtest dump-database-container -n userRoot -b dc=example,dc=com \
 -d sudoUser.equality</userinput>
<computeroutput>Indexed Value (6 bytes): %admin
Entry ID List (8 bytes): 165

Indexed Value (5 bytes): %sudo
Entry ID List (8 bytes): 164

Indexed Value (4 bytes): root
Entry ID List (8 bytes): 163


Total Records: 3
Total / Average Key Size: 13 bytes / 4 bytes
Total / Average Data Size: 24 bytes / 8 bytes</computeroutput>
 </screen>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/dsconfig-examples.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/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>
  Much of the <citetitle>OpenDJ Administration Guide</citetitle>
  consists of <command>dsconfig</command> examples with text in between.
  This section therefore remains short.
 </para>

 <para>
  The following example starts <command>dsconfig</command>
  in interactive, menu-driven mode on the default port of the current host.
 </para>

 <screen>
$ <userinput>dsconfig -h opendj.example.com -p 4444 -D "cn=Directory Manager" -w password</userinput>
<computeroutput>
>>>> OpenDJ configuration console main menu

What do you want to configure?

    1)   Access Control Handler               23)  Log Publisher
    2)   Access Log Filtering Criteria        24)  Log Retention Policy
    3)   Account Status Notification Handler  25)  Log Rotation Policy
    4)   Administration Connector             26)  Matching Rule
    5)   Alert Handler                        27)  Monitor Provider
    6)   Attribute Syntax                     28)  Password Generator
    7)   Backend                              29)  Password Policy
    8)   Backend Index                        30)  Password Storage Scheme
    9)   Backend VLV Index                    31)  Password Validator
    10)  Certificate Mapper                   32)  Plugin
    11)  Connection Handler                   33)  Plugin Root
    12)  Crypto Manager                       34)  Replication Domain
    13)  Debug Target                         35)  Replication Server
    14)  Entry Cache                          36)  Root DN
    15)  Extended Operation Handler           37)  Root DSE Backend
    16)  External Changelog Domain            38)  SASL Mechanism Handler
    17)  Global Configuration                 39)  Schema Provider
    18)  Group Implementation                 40)  Synchronization Provider
    19)  Identity Mapper                      41)  Trust Manager Provider
    20)  Key Manager Provider                 42)  Virtual Attribute
    21)  Local DB Index                       43)  Work Queue
    22)  Local DB VLV Index

    q)   quit

Enter choice:</computeroutput>
 </screen>

 <para>
  The following example demonstrates generating a batch file
  that corresponds to an interactive session enabling the debug log.
  The example then demonstrates using a modified batch file
  to disable the debug log.
 </para>

 <screen>
$ <userinput>dsconfig \
 --hostname opendj.example.com \
 --port 4444 \
 --bindDN "cn=Directory Manager" \
 --bindPassword password \
 --commandFilePath ~/enable-debug-log.batch</userinput>
 ...
$ <userinput>cat ~/enable-debug-log.batch</userinput>
<computeroutput># dsconfig session start date: 19/Oct/2011:08:52:22 +0000

# Session operation number: 1
# Operation date: 19/Oct/2011:08:55:06 +0000
dsconfig set-log-publisher-prop \
          --publisher-name File-Based\ Debug\ Logger \
          --set enabled:true \
          --hostname opendj.example.com \
          --port 4444 \
          --trustStorePath /path/to/opendj/config/admin-truststore \
          --bindDN cn=Directory\ Manager \
          --bindPassword ****** \
          --no-prompt</computeroutput>

$ <userinput>cp ~/enable-debug-log.batch ~/disable-debug-log.batch</userinput>
$ <userinput>vi ~/disable-debug-log.batch</userinput>
$ <userinput>cat ~/disable-debug-log.batch</userinput>
<computeroutput>set-log-publisher-prop \
          --publisher-name File-Based\ Debug\ Logger \
          --set enabled:false \
          --hostname opendj.example.com \
          --port 4444 \
          --trustStorePath /path/to/opendj/config/admin-truststore \
          --bindDN cn=Directory\ Manager \
          --bindPassword password \
          --no-prompt</computeroutput>

$ <userinput>dsconfig --batchFilePath ~/disable-debug-log.batch --no-prompt</userinput>
<computeroutput>set-log-publisher-prop
--publisher-name
File-Based Debug Logger
--set
enabled:false
--hostname
opendj.example.com
--port
4444
--trustStorePath
/path/to/opendj/config/admin-truststore
--bindDN
cn=Directory Manager
--bindPassword
password
--no-prompt</computeroutput>

$
 </screen>

 <para>
  Notice that the original command file looks like a shell script
  with the bind password value replaced by asterisks.
  To pass the content as a batch file to <command>dsconfig</command>,
  strip <literal>dsconfig</literal> itself,
  and include the bind password for the administrative user
  or replace that option with an alternative,
  such as reading the password from a file.
 </para>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/dsjavaproperties-examples.xml

New file
@@ -0,0 +1,43 @@
<?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 a successful run.
 </para>

 <screen>
$ <userinput>dsjavaproperties</userinput>
<computeroutput>The operation was successful.  The server commands will use the java arguments
 and java home specified in the properties file located in
 /path/to/opendj/config/java.properties</computeroutput>
 </screen>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/dsjavaproperties-files.xml

New file
@@ -0,0 +1,37 @@
<?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>Files</title>

 <para>
  This command depends on the content
  of the <filename>config/java.properties</filename> file.
 </para>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/dsreplication-examples.xml

New file
@@ -0,0 +1,86 @@
<?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 enables and then initializes replication
  for a new replica on <literal>opendj2.example.com</literal>
  from an existing replica on <literal>opendj.example.com</literal>.
 </para>

 <screen>
$ <userinput>dsreplication enable -I admin -w password -X -n -b dc=example,dc=com \
 --host1 opendj.example.com --port1 4444 --bindDN1 "cn=Directory Manager" \
 --bindPassword1 password --replicationPort1 8989 \
 --host2 opendj2.example.com --port2 4444 --bindDN2 "cn=Directory Manager" \
 --bindPassword2 password --replicationPort2 8989</userinput>

<computeroutput>Establishing connections ..... Done.
Checking registration information ..... Done.
Updating remote references on server opendj.example.com:4444 ..... Done.
Configuring Replication port on server opendj2.example.com:4444 ..... Done.
Updating replication configuration for baseDN dc=example,dc=com on server
 opendj.example.com:4444 ..... Done.
Updating replication configuration for baseDN dc=example,dc=com on server
 opendj2.example.com:4444 ..... Done.
Updating registration configuration on server
 opendj.example.com:4444 ..... Done.
Updating registration configuration on server
 opendj2.example.com:4444 ..... Done.
Updating replication configuration for baseDN cn=schema on server
 opendj.example.com:4444 ..... Done.
Updating replication configuration for baseDN cn=schema on server
 opendj2.example.com:4444 ..... Done.
Initializing registration information on server opendj2.example.com:4444 with
 the contents of server opendj.example.com:4444 ..... Done.
Initializing schema on server opendj2.example.com:4444 with the contents of
 server opendj.example.com:4444 ..... Done.

Replication has been successfully enabled.  Note that for replication to
 work you must initialize the contents of the base DN's that are being
  replicated (use dsreplication initialize to do so).

See
/var/.../opends-replication-7958637258600693490.log
for a detailed log of this operation.</computeroutput>

$ <userinput>dsreplication initialize-all -I admin -w password -X -n -b dc=example,dc=com \
 -h opendj.example.com -p 4444</userinput>

<computeroutput>Initializing base DN dc=example,dc=com with the contents from
 opendj.example.com:4444: 160 entries processed (100 % complete).
Base DN initialized successfully.

See
/var/.../opends-replication-5020375834904394170.log
for a detailed log of this operation.</computeroutput>
 </screen>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/encode-password-examples.xml

New file
@@ -0,0 +1,64 @@
<?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 encodes a password,
  and also shows comparison of a password with the encoded value.
 </para>

 <screen>
$ <userinput>encode-password -l</userinput>
<computeroutput>3DES
AES
BASE64
BLOWFISH
CLEAR
CRYPT
MD5
RC4
SHA
SMD5
SSHA
SSHA256
SSHA384
SSHA512</computeroutput>

$ <userinput>encode-password -c secret12 -s CRYPT</userinput>
<computeroutput>Encoded Password:  "{CRYPT}ZulJ6Dy3TFnrE"</computeroutput>

$ <userinput>encode-password -c secret12 -s CRYPT -e "{CRYPT}ZulJ6Dy3TFnrE" -r</userinput>
<computeroutput>The provided clear-text and encoded passwords match</computeroutput>

$ <userinput>echo $?</userinput>
<computeroutput>6</computeroutput>
 </screen>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/exit-codes-0-1.xml

New file
@@ -0,0 +1,52 @@
<?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>Exit Codes</title>

 <variablelist>
  <varlistentry>
   <term>0</term>
   <listitem>
    <para>
     The command completed successfully.
    </para>
   </listitem>
  </varlistentry>

  <varlistentry>
   <term>1</term>
   <listitem>
    <para>
     An error occurred.
    </para>
   </listitem>
  </varlistentry>
 </variablelist>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/exit-codes-0-5-6-other.xml

New file
@@ -0,0 +1,70 @@
<?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>Exit Codes</title>

 <variablelist>
  <varlistentry>
   <term>0</term>
   <listitem>
    <para>
     The command completed successfully.
    </para>
   </listitem>
  </varlistentry>

  <varlistentry>
   <term>5</term>
   <listitem>
    <para>
     The <option>-r</option> option was used, and the compare did not match.
    </para>
   </listitem>
  </varlistentry>

  <varlistentry>
   <term>6</term>
   <listitem>
    <para>
     The <option>-r</option> option was used, and the compare did match.
    </para>
   </listitem>
  </varlistentry>

  <varlistentry>
   <term>other</term>
   <listitem>
    <para>
     An error occurred.
    </para>
   </listitem>
  </varlistentry>
 </variablelist>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/exit-codes-0-89.xml

New file
@@ -0,0 +1,52 @@
<?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>Exit Codes</title>

 <variablelist>
  <varlistentry>
   <term>0</term>
   <listitem>
    <para>
     The command completed successfully.
    </para>
   </listitem>
  </varlistentry>

  <varlistentry>
   <term>89</term>
   <listitem>
    <para>
     An error occurred while parsing the command-line arguments.
    </para>
   </listitem>
  </varlistentry>
 </variablelist>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/exit-codes-0-gt0.xml

New file
@@ -0,0 +1,52 @@
<?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>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>

 opendj-server-legacy/src/main/docbkx/man-pages/exit-codes-0-ldap-89.xml

New file
@@ -0,0 +1,70 @@
<?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"
          xmlns:xlink="http://www.w3.org/1999/xlink">
 <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"
      xlink:show="new">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>

 opendj-server-legacy/src/main/docbkx/man-pages/export-ldif-examples.xml

New file
@@ -0,0 +1,43 @@
<?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 exports data to a file, <filename>Example.ldif</filename>,
  with the server offline.
 </para>

 <screen>
$ <userinput>export-ldif -b dc=example,dc=com -n userRoot -l ../ldif/Example.ldif</userinput>
<computeroutput>... category=BACKEND severity=INFORMATION ...
...Exported 160 entries and skipped 0 in 0 seconds (average rate 1428.6/sec)</computeroutput>
 </screen>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/files.xml

New file
@@ -0,0 +1,50 @@
<?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>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>

 opendj-server-legacy/src/main/docbkx/man-pages/filters.xml

New file
@@ -0,0 +1,39 @@
<?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>Filters</title>

 <para>
  The filter argument is a string representation of an LDAP search filter
  as in <literal>(cn=Babs Jensen)</literal>,
  <literal>(&amp;(objectClass=Person)(|(sn=Jensen)(cn=Babs J*)))</literal>,
  or <literal>(cn:caseExactMatch:=Fred Flintstone)</literal>.
 </para>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/import-ldif-examples.xml

New file
@@ -0,0 +1,43 @@
<?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 imports the content of a file, <filename>Example.ldif</filename>,
  with the server offline.
 </para>

 <screen>
$ <userinput>import-ldif -b dc=example,dc=com -n userRoot -l /path/to/Example.ldif</userinput>
<computeroutput>... category=RUNTIME_INFORMATION severity=NOTICE...
... msg=Import LDIF environment close took 0 seconds</computeroutput>
 </screen>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/ldapcompare-examples.xml

New file
@@ -0,0 +1,60 @@
<?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 demonstrate comparing Babs Jensen's UID.
 </para>

 <para>
  The following example uses a matching UID value.
 </para>

 <screen>
$ <userinput>ldapcompare -p 1389 uid:bjensen uid=bjensen,ou=people,dc=example,dc=com</userinput>
<computeroutput>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</computeroutput>
 </screen>

 <para>
  The following example uses a UID value that does not match.
 </para>

 <screen>
$ <userinput>ldapcompare -p 1389 uid:beavis uid=bjensen,ou=people,dc=example,dc=com</userinput>
<computeroutput>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</computeroutput>
 </screen>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/ldapcompare-exit-codes.xml

New file
@@ -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
  ! 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"
          xmlns:xlink="http://www.w3.org/1999/xlink">
 <title>Exit Codes</title>

 <variablelist>
  <varlistentry>
   <term>0</term>
   <listitem>
    <para>
     The command completed successfully.
    </para>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term>5</term>
   <listitem>
    <para>
     The <option>-m</option> option was used,
     and at least one of the LDAP compare operations did not match.
    </para>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term>6</term>
   <listitem>
    <para>
     The <option>-m</option> option was used,
     and all the LDAP compare operations did match.
    </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:show="new"
      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>

 opendj-server-legacy/src/main/docbkx/man-pages/ldapdelete-examples.xml

New file
@@ -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 command deletes a user entry from the directory.
 </para>

 <screen>
$ <userinput>ldapdelete -p 1389 -D "cn=Directory Manager" -w password \
 uid=bjensen,ou=people,dc=example,dc=com</userinput>
<computeroutput>Processing DELETE request for uid=bjensen,ou=people,dc=example,dc=com
DELETE operation successful for DN uid=bjensen,ou=people,dc=example,dc=com</computeroutput>
 </screen>

 <para>
  The following command deletes the <literal>ou=Groups</literal> entry
  and all entries underneath <literal>ou=Groups</literal>.
 </para>

 <screen>
$ <userinput>ldapdelete -p 1389 -D "cn=Directory Manager" -w password -x \
 ou=groups,dc=example,dc=com</userinput>
<computeroutput>Processing DELETE request for ou=groups,dc=example,dc=com
DELETE operation successful for DN ou=groups,dc=example,dc=com</computeroutput>
 </screen>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/ldapmodify-examples.xml

New file
@@ -0,0 +1,154 @@
<?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 use of the command
  to add an entry to the directory.
 </para>

 <screen>
$ <userinput>cat newuser.ldif</userinput>
<computeroutput>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</computeroutput>

$ <userinput>ldapmodify -p 1389 -a -f newuser.ldif \
 -D uid=kvaughan,ou=people,dc=example,dc=com -w bribery</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.
 </para>

 <programlisting language="shell">
#!/bin/sh
#
# Add a new user with the ldapmodify utility.
#

usage(){
        echo "Usage: $0 uid firstname lastname"
        exit 1
}
[[ $# -lt 3 ]] &amp;&amp; usage

LDAPMODIFY=/path/to/opendj/bin/ldapmodify
HOST=opendj.example.com
PORT=1389
ADMIN=uid=kvaughan,ou=people,dc=example,dc=com
PWD=bribery

$LDAPMODIFY -h $HOST -p $PORT -D $ADMIN -w $PWD -a &lt;&lt;EOF
dn: uid=$1,ou=people,dc=example,dc=com
uid: $1
objectClass: top
objectClass: person
objectClass: organizationalPerson
objectClass: inetOrgPerson
cn: $2 $3
givenName: $2
sn: $3
mail: $1@example.com
EOF
 </programlisting>

 <para>
  The following example demonstrates adding a Description attribute
  to the new user's entry.
 </para>

 <screen>
$ <userinput>cat newdesc.ldif</userinput>
<computeroutput>dn: uid=newuser,ou=People,dc=example,dc=com
changetype: modify
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>
<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.
 </para>

 <screen>
$ <userinput>cat moddesc.ldif</userinput>
<computeroutput>dn: uid=newuser,ou=People,dc=example,dc=com
changetype: modify
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>
<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.
 </para>

 <screen>
$ <userinput>cat deluser.ldif</userinput>
<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>
<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>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/ldappasswordmodify-examples.xml

New file
@@ -0,0 +1,46 @@
<?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 a user changing their own password.
  </para>

 <screen>
$ <userinput>cat /tmp/currpwd.txt /tmp/newpwd.txt</userinput>
<computeroutput>bribery
secret12</computeroutput>

$ <userinput>ldappasswordmodify -p 1389 -C /tmp/currpwd.txt -N /tmp/newpwd.txt \
-A -D uid=kvaughan,ou=people,dc=example,dc=com -w bribery</userinput>
<computeroutput>The LDAP password modify operation was successful</computeroutput>
 </screen>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/ldapsearch-examples.xml

New file
@@ -0,0 +1,112 @@
<?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 searches for entries
  with UID containing <literal>jensen</literal>,
  returning only DNs and uid values.
 </para>

 <screen>
$ <userinput>ldapsearch -p 1389 -b dc=example,dc=com "(uid=*jensen*)" uid</userinput>
<computeroutput>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)</computeroutput>
 </screen>

 <para>
  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.
 </para>

 <screen>
$ <userinput>ldapsearch -p 1389 -b dc=example,dc=com "(uid=bjensen)" @inetorgperson</userinput>
<computeroutput>dn: uid=bjensen,ou=People,dc=example,dc=com
givenName: Barbara
objectClass: person
objectClass: organizationalPerson
objectClass: inetOrgPerson
objectClass: posixAccount
objectClass: top
uid: bjensen
cn: Barbara Jensen
cn: Babs Jensen
telephoneNumber: +1 408 555 1862
sn: Jensen
roomNumber: 0209
mail: bjensen@example.com
l: Cupertino
ou: Product Development
ou: People
facsimileTelephoneNumber: +1 408 555 1992</computeroutput>
 </screen>

 <para>
  You can use <literal>+</literal> in the attribute list
  to return all operational attributes, as in the following example.
 </para>

 <screen>
$ <userinput>ldapsearch -p 1389 -b dc=example,dc=com "(uid=bjensen)" +</userinput>
<computeroutput>dn: uid=bjensen,ou=People,dc=example,dc=com
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
entryUUID: fc252fd9-b982-3ed6-b42a-c76d2546312c</computeroutput>
 </screen>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/ldif-diff-examples.xml

New file
@@ -0,0 +1,77 @@
<?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 use of the command with two small LDIF files.
 </para>

 <screen>
$ <userinput>cat /path/to/newuser.ldif</userinput>
<computeroutput>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</computeroutput>

$ <userinput>cat /path/to/neweruser.ldif</userinput>
<computeroutput>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: secret12
description: A new description.</computeroutput>

$ <userinput>ldif-diff -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
userPassword: secret12
-
delete: userPassword
userPassword: changeme
-
add: description
description: A new description.</computeroutput>
 </screen>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/ldifmodify-examples.xml

New file
@@ -0,0 +1,79 @@
<?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 use of the command.
 </para>

 <screen>
$ <userinput>cat /path/to/newuser.ldif</userinput>
<computeroutput>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</computeroutput>

$ <userinput>cat /path/to/newdiff.ldif</userinput>
<computeroutput>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.</computeroutput>

$ <userinput>ldifmodify -s /path/to/newuser.ldif -m /path/to/newdiff.ldif -t neweruser.ldif</userinput>

$ <userinput>cat neweruser.ldif</userinput>
<computeroutput>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</computeroutput>
 </screen>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/ldifsearch-examples.xml

New file
@@ -0,0 +1,88 @@
<?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 use of the command.
 </para>

 <screen>
$ <userinput>ldifsearch -b dc=example,dc=com /path/to/Example.ldif uid=bjensen</userinput>
<computeroutput>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</computeroutput>
 </screen>

 <para>
  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>posixAccount</literal> object class.
 </para>

 <screen>
$ <userinput>ldifsearch --ldifFile /path/to/Example.ldif \
 --baseDN dc=example,dc=com "(uid=bjensen)" @posixaccount</userinput>
<computeroutput>dn: uid=bjensen,ou=People,dc=example,dc=com
objectClass: person
objectClass: organizationalPerson
objectClass: inetOrgPerson
objectClass: posixAccount
objectClass: top
uid: bjensen
userpassword: hifalutin
cn: Barbara Jensen
cn: Babs Jensen
homeDirectory: /home/bjensen
uidNumber: 1076
gidNumber: 1000</computeroutput>
 </screen>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/list-backends-examples.xml

New file
@@ -0,0 +1,52 @@
<?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 a successful run.
 </para>

 <screen>
$ <userinput>list-backends</userinput>
<computeroutput>Backend ID         : Base DN
-------------------:----------------------
adminRoot          : cn=admin data
ads-truststore     : cn=ads-truststore
backup             : cn=backups
config             : cn=config
monitor            : cn=monitor
myCompanyRoot      : "dc=myCompany,dc=com"
myOrgRoot          : o=myOrg
schema             : cn=schema
tasks              : cn=tasks
userRoot           : "dc=example,dc=com"</computeroutput>
 </screen>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/make-ldif-examples.xml

New file
@@ -0,0 +1,45 @@
<?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 uses the default template to generate LDIF.
 </para>

 <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>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/make-ldif-see-also.xml

New file
@@ -0,0 +1,41 @@
<?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"
          xmlns:xlink="http://www.w3.org/1999/xlink">
 <title>See Also</title>

 <para>
  <link xlink:show="new"
        xlink:href="reference#makeldif-template-5"
        xlink:role="http://docbook.org/xlink/role/olink"
   ><citerefentry><refentrytitle
   >make-ldif.template</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>
 </para>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/man-make-ldif-template.xml

copy from src/main/docbkx/dev-guide/man-makeldif-template.xml
copy to opendj-server-legacy/src/main/docbkx/man-pages/man-make-ldif-template.xml
File was copied from src/main/docbkx/dev-guide/man-makeldif-template.xml
@@ -20,10 +20,10 @@
  !
  ! CCPL HEADER END
  !
  !      Copyright 2012-2014 ForgeRock AS
  !      Copyright 2012-2015 ForgeRock AS.
  !
-->
<refentry xml:id='makeldif-template-5'
<refentry xml:id='make-ldif-template-5'
          xmlns='http://docbook.org/ns/docbook'
          version='5.0' xml:lang='en'
          xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
@@ -32,20 +32,20 @@
          xmlns:xlink='http://www.w3.org/1999/xlink'>
 <info>
  <copyright>
   <year>2012-2014</year>
   <holder>ForgeRock AS</holder>
   <year>2012-2015</year>
   <holder>ForgeRock AS.</holder>
  </copyright>
 </info>

 <refmeta>
  <refentrytitle>makeldif.template</refentrytitle><manvolnum>5</manvolnum>
  <refentrytitle>make-ldif.template</refentrytitle><manvolnum>5</manvolnum>
  <refmiscinfo class="software">OpenDJ</refmiscinfo>
  <refmiscinfo class="version">${docTargetVersion}</refmiscinfo>
 </refmeta>

 <refnamediv>
  <refname>makeldif.template</refname>
  <refpurpose>template file for the makeldif command</refpurpose>
  <refname>make-ldif.template</refname>
  <refpurpose>template file for the make-ldif command</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
@@ -55,6 +55,13 @@
# In the same way you would use blank lines after entries in normal LDIF,
# leave empty lines after "entries" in template files.

# 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.
#
include <replaceable>custom.makeldif.tag.ClassName</replaceable>
...

# Optionally define constants used in the template.
# To reference constants later, put brackets around the name: [constant-name]
#
@@ -67,21 +74,16 @@
#  ou=People,dc=example,dc=com
#  ou=Groups,dc=example,dc=com
#
# makeldif generates the necessary object class definitions and RDNs.
# make-ldif generates the necessary object class definitions and RDNs.
#
# A branch can have subordinateTemplates that define templates to use for
# the branch entry. The optional <replaceable>number</replaceable> at the end
# of the subordinateTemplate specification defines how many entries to generate.
# If you do not specify a number, makeldif continues to generate entries
# indefinitely until you interrupt the command.
# the branch entry.
#
# A branch can have additional attributes generated on the branch entry. See
# the Description below for more information on specifying attribute values.
#
branch: <replaceable>suffix-dn</replaceable>
objectClass: top
objectClass: <replaceable>suffix-object-class</replaceable>
[subordinateTemplate: <replaceable>template-name</replaceable>[:<replaceable>number</replaceable>]
[subordinateTemplate: <replaceable>template-name</replaceable>:<replaceable>number</replaceable>
...]
[<replaceable>attribute</replaceable>: <replaceable>attr-value</replaceable>
...]
@@ -114,19 +116,15 @@

  <para>
   Template files specify how to build LDIF.
   They allow you to define variables,
   insert random values from other files,
   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>makeldif</command> command
   You pass template files to the <command>make-ldif</command> command
   when generating LDIF.
  </para>

  <para>
   The Synopsis above shows the layout
   for a <command>makeldif</command>
   template file.

   for a <command>make-ldif</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>
@@ -135,10 +133,9 @@
   <title>Specifying Attribute Values</title>

   <para>
    When specifying attribute values in <command>makeldif</command> templates,
    When specifying attribute values in <command>make-ldif</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.
   </para>

@@ -147,18 +144,15 @@

   <para>
    You can also use two kinds of tags when specifying attribute values.

    One kind of tag gets replaced with the value of another attribute
    in the generated entry.

    One kind of tag gets replaced
    with the value of another attribute in the generated entry.
    Such tags are delimited with braces, <literal>{ }</literal>.

    For example, if your template includes
    definitions for first name and last name attributes:
    For example, if your template includes definitions
    for first name and last name attributes:
   </para>

   <programlisting language="ldif">givenName: &lt;first>
sn: &lt;last></programlisting>
   <programlisting language="ldif">givenName: &lt;first&gt;
sn: &lt;last&gt;</programlisting>

   <para>
    Then you can define a mail attribute that uses the values of both attributes,
@@ -169,13 +163,11 @@
initials: {givenName:1}{sn:1}</programlisting>

   <para>
    The other kind of tag is delimited with <literal>&lt;</literal>
    and <literal>></literal>,
    The other kind of tag is delimited with
    <literal>&lt;</literal> and <literal>&gt;</literal>,
    as shown above in the example with
    <literal>&lt;first></literal> and <literal>&lt;last></literal>.

    <literal>&lt;first&gt;</literal> and <literal>&lt;last&gt;</literal>.
    Tag names are not case sensitive.

    Many tags can take arguments separated by colons, <literal>:</literal>,
    from the tag names within the tag.
   </para>
@@ -183,68 +175,58 @@
   <para>
    Use backslashes to escape literal start tag characters
    (<literal>&lt; [ {</literal>) as shown in the following example,
    and to escape literal end tag characters within tags
    (<literal>> ] }</literal>).
    and to escape literal end tag characters within tags (<literal>&gt; ] }</literal>).
   </para>

   <programlisting language="ldif"
           >scimMail: \{"emails": \[\{"value": "{mail}", "type": "work", "primary": true}]}
xml: \&lt;id>{uid}\&lt;/id></programlisting>
xml: \&lt;id&gt;{uid}\&lt;/id&gt;</programlisting>

   <para>
    The <command>makeldif</command> command supports the following tags.
    OpenDJ supports the following tags.
   </para>

   <varlistentry>
    <term>&lt;DN></term>
    <term>&lt;DN&gt;</term>
    <listitem>
     <para>
      The DN tag gets replaced by the distinguished name of the current entry.

      An optional integer argument specifies the sub-components
      of the DN to generate.

      An optional integer argument specifies the subcomponents of the DN to generate.
      For example, if the DN of the entry is
      <literal>uid=bjensen,ou=People,dc=example,dc=com</literal>,
      then <literal>&lt;DN:1></literal> gets replaced
      by <literal>uid=bjensen</literal>,
      and <literal>&lt;DN:-2></literal> gets replaced
      by <literal>dc=example,dc=com</literal>.
      <literal>uid=bjensen,ou=People,dc=example,dc=com</literal>
      <literal>&lt;DN:1&gt;</literal> gets replaced by <literal>uid=bjensen</literal>,
      and <literal>&lt;DN:-2&gt;</literal> gets replaced by
      <literal>dc=example,dc=com</literal>.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term>&lt;File></term>
    <term>&lt;File&gt;</term>
    <listitem>
     <para>
      The File tag gets replaced by a line from a text file you specify.

      The File tag takes a required argument,
      the path to the text file,
      The File tag takes a required argument, the path to the text file,
      and an optional second argument,
      either <literal>random</literal> or <literal>sequential</literal>.

      For the file argument, either specify an absolute path to the file
      such as <literal>&lt;file:/path/to/myDescriptions></literal>,
      or specify a path relative to the template file
      such as <literal>&lt;file:streets></literal>.

      For the file argument, either you specify an absolute path to the file
      such as <literal>&lt;file:/path/to/myDescriptions&gt;</literal>,
      or you specify a path relative to the
      <filename>/path/to/opendj/config/MakeLDIF/</filename> directory
      such as <literal>&lt;file:streets&gt;</literal>.
      For the second argument, if you specify <literal>sequential</literal>
      then lines from the file are read in sequential order.

      Otherwise, lines from the file are read in random order.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term>&lt;First></term>
    <term>&lt;First&gt;</term>
    <listitem>
     <para>
      The first name tag gets replaced by a random line from
      <filename>first.names</filename>.

      <filename>/path/to/opendj/config/MakeLDIF/first.names</filename>.
      Combinations of generated first and last names are unique,
      with integers appended to the name strings
      if not enough combinations are available.
@@ -253,55 +235,50 @@
   </varlistentry>

   <varlistentry>
    <term>&lt;GUID></term>
    <term>&lt;GUID&gt;</term>
    <listitem>
     <para>
      The GUID tag gets replaced
      by a 128-bit, type 4 (random) universally unique identifier,
      by a 128-bit, type 4 (random) universally unique identifier
      such as <literal>f47ac10b-58cc-4372-a567-0e02b2c3d479</literal>.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term>&lt;IfAbsent></term>
    <term>&lt;IfAbsent&gt;</term>
    <listitem>
     <para>
      The IfAbsent tag takes as its first argument the name of another attribute,
      and optionally as its second argument a value to use.

      This tag causes the attribute to be generated
      only if the named attribute is not present on the generated entry.

      Use this tag when you have used <literal>&lt;Presence></literal>
      Use this tag when you have used <literal>&lt;Presence&gt;</literal>
      to define another attribute that is not always present on generated entries.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term>&lt;IfPresent></term>
    <term>&lt;IfPresent&gt;</term>
    <listitem>
     <para>
      The IfPresent takes as its first argument the name of another attribute,
      and optionally as its second argument a value to use.

      This tag causes the attribute to be generated
      only if the named attribute is also present on the generated entry.

      Use this tag when you have used <literal>&lt;Presence></literal>
      Use this tag when you have used <literal>&lt;Presence&gt;</literal>
      to define another attribute that is sometimes present on generated entries.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term>&lt;Last></term>
    <term>&lt;Last&gt;</term>
    <listitem>
     <para>
      The last name tag gets replaced by a random line from
      <filename>/path/to/opendj/config/MakeLDIF/last.names</filename>.

      Combinations of generated first and last names are unique,
      with integers appended to the name strings
      if not enough combinations are available.
@@ -310,68 +287,61 @@
   </varlistentry>

   <varlistentry>
    <term>&lt;List></term>
    <term>&lt;List&gt;</term>
    <listitem>
     <para>
      The List tag gets replaced by one of the values from the list of
      arguments you provide.

      For example, <literal>&lt;List:bronze:silver:gold></literal>
      gets replaced with <literal>bronze</literal>, <literal>silver</literal>,
      or <literal>gold</literal>.
      The List tag gets replaced by one of the values
      from the list of arguments you provide.
      For example,
      <literal>&lt;List:bronze:silver:gold&gt;</literal>
      gets replaced with
      <literal>bronze</literal>, <literal>silver</literal>, or <literal>gold</literal>.
     </para>

     <para>
      You can weight arguments to ensure
      that some arguments are selected more often than others.

      For example, if you want two bronze for one silver and one gold,
      use <literal>&lt;List:bronze;2:silver;1:gold;1></literal>.
      You can weight arguments to ensure some arguments
      are selected more often than others.
      For example, if you want two bronze for one silver and one gold, use
      <literal>&lt;List:bronze;2:silver;1:gold;1&gt;</literal>.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term>&lt;ParentDN></term>
    <term>&lt;ParentDN&gt;</term>
    <listitem>
     <para>
      The ParentDN tag gets replaced
      by the distinguished name of the parent entry.

      The ParentDN tag gets replaced by the distinguished name of the parent entry.
      For example, if the DN of the entry is
      <literal>uid=bjensen,ou=People,dc=example,dc=com</literal>,
      <literal>&lt;ParentDN></literal> gets replaced by
      <literal>&lt;ParentDN&gt;</literal> gets replaced by
      <literal>ou=People,dc=example,dc=com</literal>.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term>&lt;Presence></term>
    <term>&lt;Presence&gt;</term>
    <listitem>
     <para>
      The Presence tag takes a percent argument.

      It does not get replaced by a value itself,
      but instead results in the attribute being generated
      on the percentage of entries you specify in the argument.

      For example, <literal>description: &lt;Presence:50>A description</literal>
      generates <literal>description: A description</literal>
      on half the entries.
      For example,
      <literal>description: &lt;Presence:50&gt;A description</literal> generates
      <literal>description: A description</literal> on half the entries.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term>&lt;Random></term>
    <term>&lt;Random&gt;</term>
    <listitem>
     <para>
      The Random tag lets you generate a variety of random numbers and strings.

      The Random tag has the following subtypes, which you include as arguments,
      that is <literal>&lt;Random:<replaceable>subtype</replaceable>></literal>.

      that is <literal>&lt;Random:<replaceable>subtype</replaceable>&gt;</literal>.
     </para>

     <itemizedlist>
@@ -383,9 +353,7 @@

      <listitem>
       <para>
        <literal>alpha:<replaceable
                >min-length</replaceable>:<replaceable
                >max-length</replaceable></literal>
        <literal>alpha:<replaceable>minlength</replaceable>:<replaceable>maxlength</replaceable></literal>
       </para>
      </listitem>

@@ -397,20 +365,19 @@

      <listitem>
       <para>
        <literal>numeric:<replaceable
                >minvalue</replaceable>:<replaceable
                >maxvalue</replaceable></literal>
        <literal>numeric:<replaceable>minvalue</replaceable>:<replaceable>maxvalue</replaceable></literal>
       </para>
      </listitem>

      <listitem>
       <para>
        <literal>numeric:<replaceable
                >minvalue</replaceable>:<replaceable
                >maxvalue</replaceable>:<replaceable
                >format</replaceable></literal>,
        <literal>numeric:<replaceable>minvalue</replaceable>:<replaceable
        >maxvalue</replaceable>:<replaceable>format</replaceable></literal>,
        where <replaceable>format</replaceable> is a
        <literal>java.text.DecimalFormat</literal> pattern
        <link
         xlink:href="http://docs.oracle.com/javase/7/docs/api/java/text/DecimalFormat.html"
         xlink:show="new"
        >java.text.DecimalFormat</link> pattern
       </para>
      </listitem>

@@ -422,24 +389,20 @@

      <listitem>
       <para>
        <literal>alphanumeric:<replaceable
                >min-length</replaceable>:<replaceable
                >max-length</replaceable></literal></para>
        <literal>alphanumeric:<replaceable>minlength</replaceable>:<replaceable>maxlength</replaceable></literal>
       </para>
      </listitem>

      <listitem>
       <para>
        <literal>chars:<replaceable
                >characters</replaceable>:<replaceable
                >length</replaceable></literal></para>
        <literal>chars:<replaceable>characters</replaceable>:<replaceable>length</replaceable></literal>
       </para>
      </listitem>

      <listitem>
       <para>
        <literal>chars:<replaceable
                >characters</replaceable>:<replaceable
                >min-length</replaceable>:<replaceable
                >max-length</replaceable></literal>
        <literal>chars:<replaceable>characters</replaceable>:<replaceable
         >minlength</replaceable>:<replaceable>maxlength</replaceable></literal>
       </para>
      </listitem>

@@ -451,9 +414,7 @@

      <listitem>
       <para>
        <literal>hex:<replaceable
                >min-length</replaceable>:<replaceable
                >max-length</replaceable></literal>
        <literal>hex:<replaceable>minlength</replaceable>:<replaceable>maxlength</replaceable></literal>
       </para>
      </listitem>

@@ -465,9 +426,7 @@

      <listitem>
       <para>
        <literal>base64:<replaceable
                >min-length</replaceable>:<replaceable
               >max-length</replaceable></literal>
        <literal>base64:<replaceable>minlength</replaceable>:<replaceable>maxlength</replaceable></literal>
       </para>
      </listitem>

@@ -479,7 +438,7 @@

      <listitem>
       <para>
        <literal>month:<replaceable>max-length</replaceable></literal>
        <literal>month:<replaceable>maxlength</replaceable></literal>
       </para>
      </listitem>

@@ -494,72 +453,61 @@
   </varlistentry>

   <varlistentry>
    <term>&lt;RDN></term>
    <term>&lt;RDN&gt;</term>
    <listitem>
     <para>
      The RDN tag gets replaced with the RDN of the entry.

      Use this in the template after you have specified <literal>rdnAttr</literal>
      so that the RDN has already been generated when this tag is replaced.
     </para>

     <para>
      An optional integer argument specifies the sub-components of the RDN
      to generate.
      An optional integer argument specifies the subcomponents of the RDN to generate.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term>&lt;Sequential></term>
    <term>&lt;Sequential&gt;</term>
    <listitem>
     <para>
      The Sequential tag gets replaced
      by a sequentially increasing generated integer.

      The Sequential tag gets replaced by a sequentially increasing generated integer.
      The first optional integer argument specifies the starting number.

      The second optional boolean argument specifies whether to start over
      when generating entries for a new parent entry.

      For example,
      <literal>&lt;Sequential>:42:true</literal> starts counting from 42,
      and starts over when the parent entry changes from
      <literal>o=Engineering</literal> to <literal>o=Marketing</literal>.
      The second optional boolean argument specifies
      whether to start over when generating entries for a new parent entry.
      For example, <literal>&lt;Sequential&gt;:42:true</literal> starts counting from 42,
      and starts over when the parent entry changes
      from <literal>o=Engineering</literal> to <literal>o=Marketing</literal>.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term>&lt;_DN></term>
    <term>&lt;_DN&gt;</term>
    <listitem>
     <para>The _DN tag gets replaced by the DN of the current entry with
     underscores in the place of commas.</para>
     <para>
      The _DN tag gets replaced by the DN of the current entry
      with underscores in the place of commas.
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term>&lt;_ParentDN></term>
    <term>&lt;_ParentDN&gt;</term>
    <listitem>
     <para>
      The _ParentDN tag gets replaced
      by the DN the parent entry with underscores in the place of commas.
      The _ParentDN tag gets replaced by the DN the parent entry
      with underscores in the place of commas.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1>
  <title>Examples</title>

  <para>
   The following example generates 10 organization units,
   each containing 50 entries.

   Add it next to the supporting files,
   such as <filename>first.names</filename> and <filename>last.names</filename>
   needed to generate the output.
   The following example generates 10 organization units, each containing 50 entries.
  </para>

  <programlisting language="plain"><![CDATA[define suffix=dc=example,dc=com
@@ -568,12 +516,8 @@
define numorgs=10

branch: [suffix]
objectClass: top
objectClass: domain

branch: ou=People,[suffix]
objectClass: top
objectClass: organizationalUnit
subordinateTemplate: orgunit:[numorgs]
description: This is the People container
telephoneNumber: +33 00010002
@@ -616,11 +560,12 @@
  <title>See Also</title>

  <para>
   <link xlink:show="new"
         xlink:href="dev-guide#makeldif-1"
   <link
    xlink:show="new"
    xlink:href="reference#make-ldif-1"
         xlink:role="http://docbook.org/xlink/role/olink"
           ><citerefentry><refentrytitle>makeldif</refentrytitle><manvolnum
           >1</manvolnum></citerefentry></link>,
   ><citerefentry><refentrytitle
    >make-ldif</refentrytitle><manvolnum>1</manvolnum></citerefentry></link>,
   the OpenDJ directory server template file
   <filename>/path/to/opendj/config/MakeLDIF/example.template</filename>
  </para>

 opendj-server-legacy/src/main/docbkx/man-pages/man-windows-service.xml

File was renamed from opendj-server-legacy/src/main/docbkx/reference/man-windows-service.xml
@@ -10,7 +10,7 @@
  ! 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.
  ! trunk/opendj/legal-notices/CC-BY-NC-ND.txt.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
@@ -20,7 +20,7 @@
  !
  ! CCPL HEADER END
  !
  !      Copyright 2013-2014 ForgeRock AS
  !      Copyright 2013-2015 ForgeRock AS.
  !
-->
<refentry xml:id='windows-service'
@@ -29,16 +29,24 @@
          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'>
 <info><copyright><year>2013-2014</year><holder>ForgeRock AS</holder></copyright></info>
 <info>
  <copyright>
   <year>2013-2015</year>
   <holder>ForgeRock AS.</holder>
  </copyright>
 </info>

 <refmeta>
  <refentrytitle>windows-service</refentrytitle><manvolnum>1</manvolnum>
  <refmiscinfo class="software">OpenDJ</refmiscinfo>
  <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
  <refmiscinfo class="version">${docTargetVersion}</refmiscinfo>
 </refmeta>

 <refnamediv>
  <refname>windows-service</refname>
  <refpurpose>register OpenDJ as a Windows Service</refpurpose>
 </refnamediv>

 <refsynopsisdiv>
  <cmdsynopsis>
   <command>windows-service</command>
@@ -48,8 +56,9 @@

 <refsect1>
  <title>Description</title>
  <para>This utility can be used to run OpenDJ directory server as a Windows
  Service.</para>
  <para>
   This utility can be used to run OpenDJ directory server as a Windows Service.
  </para>
 </refsect1>

 <refsect1>
@@ -59,30 +68,37 @@
   <varlistentry>
    <term><option>-c, --cleanupService <replaceable>serviceName</replaceable></option></term>
    <listitem>
     <para>Disable the service and clean up the windows registry information
     associated with the provided service name</para>
     <para>
      Disable the service and clean up the windows registry information
      associated with the provided service name
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term><option>-d, --disableService</option></term>
    <listitem>
     <para>Disable the server as a Windows service and stop the server</para>
     <para>
      Disable the server as a Windows service and stop the server
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term><option>-e, --enableService</option></term>
    <listitem>
     <para>Enable the server as a Windows service</para>
     <para>
      Enable the server as a Windows service
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term><option>-s, --serviceState</option></term>
    <listitem>
     <para>Provide information about the state of the server as a Windows
     service</para>
     <para>
      Provide information about the state of the server as a Windows service
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
@@ -95,14 +111,18 @@
   <varlistentry>
    <term><option>-V, --version</option></term>
    <listitem>
     <para>Display version information</para>
     <para>
      Display version information
     </para>
    </listitem>
   </varlistentry>

   <varlistentry>
    <term><option>-?, -H, --help</option></term>
    <listitem>
     <para>Display usage information</para>
     <para>
      Display usage information
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
@@ -115,14 +135,18 @@
    <varlistentry>
     <term>0</term>
     <listitem>
      <para>The command completed successfully.</para>
      <para>
       The command completed successfully.
      </para>
     </listitem>
    </varlistentry>

    <varlistentry>
     <term>&gt; 0</term>
     <term>> 0</term>
     <listitem>
      <para>An error occurred.</para>
      <para>
       An error occurred.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
@@ -131,14 +155,17 @@
 <refsect1>
  <title>Example</title>

  <para>The following command registers OpenDJ directory server as a Windows
  Service.</para>
  <para>
   The following command registers OpenDJ directory server as a Windows Service.
  </para>

  <screen>
C:\path\to\opendj\bat> <userinput>windows-service.bat --enableService</userinput>
  </screen>

  <para>After running this command, you can manage the service using Windows
  administration tools.</para>
  <para>
   After running this command,
   you can manage the service using Windows administration tools.
  </para>
 </refsect1>
</refentry>

 opendj-server-legacy/src/main/docbkx/man-pages/manage-account-examples.xml

New file
@@ -0,0 +1,66 @@
<?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>
  For the following examples the directory admin user, Kirsten Vaughan,
  has <literal>ds-privilege-name: password-reset</literal>
  and the following ACI on <literal>ou=People,dc=example,dc=com</literal>.
 </para>

 <programlisting language="aci">
(target="ldap:///ou=People,dc=example,dc=com") (targetattr ="*||+")(
 version 3.0;acl "Admins can run amok"; allow(all) groupdn =
 "ldap:///cn=Directory Administrators,ou=Groups,dc=example,dc=com";)
 </programlisting>

 <para>
  The following command locks a user account.
 </para>

 <screen>
$ <userinput>manage-account -p 4444 -D "uid=kvaughan,ou=people,dc=example,dc=com" \
 -w bribery set-account-is-disabled -O true \
 -b uid=bjensen,ou=people,dc=example,dc=com -X</userinput>
<computeroutput>Account Is Disabled:  true</computeroutput>
 </screen>

 <para>
  The following command unlocks a user account.
 </para>

 <screen>
$ <userinput>manage-account -p 4444 -D "uid=kvaughan,ou=people,dc=example,dc=com" \
 -w bribery clear-account-is-disabled \
 -b uid=bjensen,ou=people,dc=example,dc=com -X</userinput>
<computeroutput>Account Is Disabled:  false</computeroutput>
 </screen>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/manage-tasks-examples.xml

New file
@@ -0,0 +1,47 @@
<?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 use of the command with a server
  that does daily backups at 2:00 AM.
 </para>

 <screen>
$ <userinput>manage-tasks -p 4444 -h opendj.example.com -D "cn=Directory Manager" \
 -w password -s</userinput>
<computeroutput>
  ID                                Type    Status
  ---------------------------------------------------------------
  example-backup                    Backup  Recurring
  example-backup-20110622020000000  Backup  Waiting on start time</computeroutput>
 </screen>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/rebuild-index-examples.xml

New file
@@ -0,0 +1,43 @@
<?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 schedules a task to start immediately
  that rebuilds the <literal>cn</literal> (common name) index.
 </para>

 <screen>
$ <userinput>rebuild-index -p 4444 -h opendj.example.com -D "cn=Directory Manager" \
 -w password -b dc=example,dc=com -i cn -t 0</userinput>
<computeroutput>Rebuild Index task 20110607160349596 scheduled to start Jun 7, 2011 4:03:49 PM</computeroutput>
 </screen>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/restore-examples.xml

New file
@@ -0,0 +1,71 @@
<?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 schedules a restore as a task
  to begin immediately while OpenDJ directory server is online.
 </para>

 <screen>
$ restore -p 4444 -D "cn=Directory Manager" -w password
 -d /path/to/opendj/bak -I 20110613080032 -t 0
Restore task 20110613155052932 scheduled to start Jun 13, 2011 3:50:52 PM CEST
 </screen>

 <para>
  The following example restores data while OpenDJ is offline.
 </para>

 <screen>
$ <userinput>stop-ds</userinput>
<computeroutput>Stopping Server...
...</computeroutput>

$ <userinput>restore --backupDirectory /path/to/opendj/bak/userRoot \
 --listBackups</userinput>
<computeroutput>Backup ID:          20120928102414Z
Backup Date:        28/Sep/2012:12:24:17 +0200
Is Incremental:     false
Is Compressed:      false
Is Encrypted:       false
Has Unsigned Hash:  false
Has Signed Hash:    false
Dependent Upon:     none</computeroutput>

$ <userinput>restore --backupDirectory /path/to/opendj/bak/userRoot \
 --backupID 20120928102414Z</userinput>
<computeroutput>[28/Sep/2012:12:26:20 +0200] ... msg=Restored: 00000000.jdb (size 355179)</computeroutput>

$ <userinput>start-ds</userinput>
<computeroutput>[28/Sep/2012:12:27:29 +0200] ... The Directory Server has started successfully</computeroutput>
 </screen>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/setup-examples.xml

New file
@@ -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
  ! 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 command installs OpenDJ directory server,
  enabling StartTLS and importing 100 example entries without interaction.
 </para>

 <screen>
<userinput>$ /path/to/opendj/setup --cli -b dc=example,dc=com -d 100 \
 -D "cn=Directory Manager" -w password -h opendj.example.com -p 1389 \
 --generateSelfSignedCertificate --enableStartTLS -n</userinput>

<computeroutput>OpenDJ <replaceable>version</replaceable>
 Please wait while the setup program initializes...

See /var/.../opends-setup-484...561.log for a detailed log of this operation.

Configuring Directory Server ..... Done.
Configuring Certificates ..... Done.
Importing Automatically-Generated Data (100 Entries) ......... Done.
Starting Directory Server .......... Done.

To see basic server configuration status and configuration you can launch
 /path/to/opendj/bin/status</computeroutput>
 </screen>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/start-ds-examples.xml

New file
@@ -0,0 +1,41 @@
<?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 command starts the server without displaying information
  about the startup process.
 </para>

 <screen>
$ <userinput>start-ds -Q</userinput>
 </screen>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/status-examples.xml

New file
@@ -0,0 +1,76 @@
<?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>

 <screen>
$ <userinput>status -D "cn=Directory Manager" -w password</userinput>
<computeroutput>
          --- Server Status ---
Server Run Status:        Started
Open Connections:         1

          --- Server Details ---
Host Name:                localhost.localdomain
Administrative Users:     cn=Directory Manager
Installation Path:        /path/to/opendj
Version:                  OpenDJ <replaceable>version</replaceable>
Java Version:             <replaceable>version</replaceable>
Administration Connector: Port 4444 (LDAPS)

          --- Connection Handlers ---
Address:Port : Protocol    : State
-------------:-------------:---------
--           : LDIF        : Disabled
8989         : Replication : Enabled
0.0.0.0:161  : SNMP        : Disabled
0.0.0.0:636  : LDAPS       : Disabled
0.0.0.0:1389 : LDAP        : Enabled
0.0.0.0:1689 : JMX         : Disabled

          --- Data Sources ---
Base DN:                      dc=example,dc=com
Backend ID:                   userRoot
Entries:                      160
Replication:                  Enabled
Missing Changes:              0
Age of Oldest Missing Change: &lt;not available&gt;

Base DN:     dc=myCompany,dc=com
Backend ID:  myCompanyRoot
Entries:     3
Replication: Disabled

Base DN:     o=myOrg
Backend ID:  myOrgRoot
Entries:     3
Replication: Disabled</computeroutput>
 </screen>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/stop-ds-examples.xml

New file
@@ -0,0 +1,43 @@
<?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 restarts OpenDJ directory server.
 </para>

 <screen>
$ <userinput>stop-ds --restart</userinput>
<computeroutput>Stopping Server...

...The Directory Server has started successfully</computeroutput>
 </screen>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/uninstall-examples.xml

New file
@@ -0,0 +1,51 @@
<?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 command removes OpenDJ directory server without interaction.
 </para>

 <screen>
$ <userinput>/path/to/opendj/uninstall -a --cli -I admin -w password -n</userinput>

<computeroutput>Stopping Directory Server ..... Done.
Deleting Files under the Installation Path ..... Done.

The Uninstall Completed Successfully.
To complete the uninstallation, you must delete manually the following files
and directories:
/path/to/opendj/lib
See /var/.../opends-uninstall-3...0.log for a detailed log of this operation.</computeroutput>

$ <userinput>rm -rf /path/to/opendj</userinput>
 </screen>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/upgrade-exit-codes.xml

New file
@@ -0,0 +1,80 @@
<?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>Exit Codes</title>

 <variablelist>
  <varlistentry>
   <term>0</term>
   <listitem>
    <para>
     The command completed successfully.
    </para>
   </listitem>
  </varlistentry>

  <varlistentry>
   <term>2</term>
   <listitem>
    <para>
     The command was run in non-interactive mode, but could not complete
     because confirmation was required to run a long or critical task.
    </para>

    <para>
     See the error message or the log for details.
    </para>
   </listitem>
  </varlistentry>

  <varlistentry>
   <term>other</term>
   <listitem>
    <para>
     An error occurred.
    </para>
   </listitem>
  </varlistentry>
 </variablelist>

 <para>
  See the <citetitle>OpenDJ Installation Guide</citetitle>
  for an example upgrade process for OpenDJ directory server
  installed from the cross-platform (.zip) delivery.
 </para>

 <para>
  Native packages (.deb, .rpm) perform more of the upgrade process,
  stopping OpenDJ if it is running,
  overwriting older files with newer files,
  running this utility,
  and starting OpenDJ if it was running when you upgraded the package(s).
 </para>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/verify-index-examples.xml

New file
@@ -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 verifies the <literal>cn</literal> (common name) index
  for completeness and for errors.
 </para>

  <screen>
$ <userinput>verify-index -b dc=example,dc=com -i cn --clean --countErrors</userinput>
<computeroutput>[07/Jun/2011:16:06:50 +0200] category=BACKEND severity=INFORMATION
 msgID=9437595 msg=Local DB backend userRoot does not specify the number of
 lock tables: defaulting to 97
[07/Jun/2011:16:06:50 +0200] category=BACKEND severity=INFORMATION
 msgID=9437594 msg=Local DB backend userRoot does not specify the number of
 cleaner threads: defaulting to 24 threads
[07/Jun/2011:16:06:51 +0200] category=JEB severity=NOTICE msgID=8847461
 msg=Checked 1316 records and found 0 error(s) in 0 seconds
 (average rate 2506.7/sec)
[07/Jun/2011:16:06:51 +0200] category=JEB severity=INFORMATION
 msgID=8388710 msg=Number of records referencing more than one entry: 315
[07/Jun/2011:16:06:51 +0200] category=JEB severity=INFORMATION
 msgID=8388711 msg=Number of records that exceed the entry limit: 0
[07/Jun/2011:16:06:51 +0200] category=JEB severity=INFORMATION
 msgID=8388712 msg=Average number of entries referenced is 1.58/record
[07/Jun/2011:16:06:51 +0200] category=JEB severity=INFORMATION
 msgID=8388713 msg=Maximum number of entries referenced by any
 record is 32</computeroutput>
  </screen>
</refsect1>

 opendj-server-legacy/src/main/docbkx/man-pages/verify-index-exit-codes.xml

New file
@@ -0,0 +1,67 @@
<?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>Exit Codes</title>

 <variablelist>
  <varlistentry>
   <term>0</term>
   <listitem>
    <para>
     The command completed successfully.
    </para>
   </listitem>
  </varlistentry>

  <varlistentry>
   <term>1</term>
   <listitem>
    <para>
     The command was run in non-interactive mode, but could not complete
     because confirmation was required to run a long or critical task.
    </para>

    <para>
     See the error message or the log for details.
    </para>
   </listitem>
  </varlistentry>

  <varlistentry>
   <term>0-255</term>
   <listitem>
    <para>
     The number of errors in the index, as indicated
     for the <option>--countErrors</option> option.
    </para>
   </listitem>
  </varlistentry>
 </variablelist>
</refsect1>

 opendj-server-legacy/src/main/docbkx/reference/index.xml

@@ -87,40 +87,104 @@
   </para>
  </partintro>

   <xinclude:include href='man-backup.xml' />
   <xinclude:include href='man-base64.xml' />
   <xinclude:include href='man-control-panel.xml' />
   <xinclude:include href='man-create-rc-script.xml' />
   <xinclude:include href='man-dbtest.xml' />
   <xinclude:include href='man-dsconfig.xml' />
   <xinclude:include href='man-dsjavaproperties.xml' />
   <xinclude:include href='man-dsreplication.xml' />
   <xinclude:include href='man-encode-password.xml' />
   <xinclude:include href='man-export-ldif.xml' />
   <xinclude:include href='man-import-ldif.xml' />
   <xinclude:include href='man-ldapcompare.xml' />
   <xinclude:include href='man-ldapdelete.xml' />
   <xinclude:include href='man-ldapmodify.xml' />
   <xinclude:include href='man-ldappasswordmodify.xml' />
   <xinclude:include href='man-ldapsearch.xml' />
   <xinclude:include href='man-ldif-diff.xml' />
   <xinclude:include href='man-ldifmodify.xml' />
   <xinclude:include href='man-ldifsearch.xml' />
   <xinclude:include href='man-list-backends.xml' />
   <xinclude:include href='man-make-ldif.xml' />
   <xinclude:include href='man-make-ldif-template.xml' />
   <xinclude:include href='man-manage-account.xml' />
   <xinclude:include href='man-manage-tasks.xml' />
   <xinclude:include href='man-rebuild-index.xml' />
   <xinclude:include href='man-restore.xml' />
   <xinclude:include href='man-setup.xml' />
   <xinclude:include href='man-start-ds.xml' />
   <xinclude:include href='man-status.xml' />
   <xinclude:include href='man-stop-ds.xml' />
   <xinclude:include href='man-uninstall.xml' />
   <xinclude:include href='man-upgrade.xml' />
   <xinclude:include href='man-verify-index.xml' />
   <xinclude:include href='man-windows-service.xml' />
  <xinclude:include href='../man-pages/man-backup.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-base64.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-control-panel.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-create-rc-script.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-dbtest.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-dsconfig.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-dsjavaproperties.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-dsreplication.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-encode-password.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-export-ldif.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-import-ldif.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-ldapcompare.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-ldapdelete.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-ldapmodify.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-ldappasswordmodify.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-ldapsearch.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-ldif-diff.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-ldifmodify.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-ldifsearch.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-list-backends.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-make-ldif.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-make-ldif-template.xml' />
  <xinclude:include href='../man-pages/man-manage-account.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-manage-tasks.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-rebuild-index.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-restore.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-setup.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-start-ds.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-status.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-stop-ds.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-uninstall.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-upgrade.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-verify-index.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-windows-service.xml' />
 </reference>

 <xinclude:include href="../shared/glossary.xml" />

 opendj-server-legacy/src/main/docbkx/reference/man-backup.xml

File was deleted

 opendj-server-legacy/src/main/docbkx/reference/man-base64.xml

File was deleted

 opendj-server-legacy/src/main/docbkx/reference/man-control-panel.xml

File was deleted

 opendj-server-legacy/src/main/docbkx/reference/man-create-rc-script.xml

File was deleted

 opendj-server-legacy/src/main/docbkx/reference/man-dbtest.xml

File was deleted

 opendj-server-legacy/src/main/docbkx/reference/man-dsconfig.xml

File was deleted

 opendj-server-legacy/src/main/docbkx/reference/man-dsjavaproperties.xml

File was deleted

 opendj-server-legacy/src/main/docbkx/reference/man-dsreplication.xml

File was deleted

 opendj-server-legacy/src/main/docbkx/reference/man-encode-password.xml

File was deleted

 opendj-server-legacy/src/main/docbkx/reference/man-export-ldif.xml

File was deleted

 opendj-server-legacy/src/main/docbkx/reference/man-import-ldif.xml

File was deleted

 opendj-server-legacy/src/main/docbkx/reference/man-ldapcompare.xml

File was deleted

 opendj-server-legacy/src/main/docbkx/reference/man-ldapdelete.xml

File was deleted

 opendj-server-legacy/src/main/docbkx/reference/man-ldapmodify.xml

File was deleted

 opendj-server-legacy/src/main/docbkx/reference/man-ldappasswordmodify.xml

File was deleted

 opendj-server-legacy/src/main/docbkx/reference/man-ldapsearch.xml

File was deleted

 opendj-server-legacy/src/main/docbkx/reference/man-ldif-diff.xml

File was deleted

 opendj-server-legacy/src/main/docbkx/reference/man-ldifmodify.xml

File was deleted

 opendj-server-legacy/src/main/docbkx/reference/man-ldifsearch.xml

File was deleted

 opendj-server-legacy/src/main/docbkx/reference/man-list-backends.xml

File was deleted

 opendj-server-legacy/src/main/docbkx/reference/man-make-ldif-template.xml

File was deleted

 opendj-server-legacy/src/main/docbkx/reference/man-make-ldif.xml

File was deleted

 opendj-server-legacy/src/main/docbkx/reference/man-manage-account.xml

File was deleted

 opendj-server-legacy/src/main/docbkx/reference/man-manage-tasks.xml

File was deleted

 opendj-server-legacy/src/main/docbkx/reference/man-rebuild-index.xml

File was deleted

 opendj-server-legacy/src/main/docbkx/reference/man-restore.xml

File was deleted

 opendj-server-legacy/src/main/docbkx/reference/man-setup.xml

File was deleted

 opendj-server-legacy/src/main/docbkx/reference/man-start-ds.xml

File was deleted

 opendj-server-legacy/src/main/docbkx/reference/man-status.xml

File was deleted

 opendj-server-legacy/src/main/docbkx/reference/man-stop-ds.xml

File was deleted

 opendj-server-legacy/src/main/docbkx/reference/man-uninstall.xml

File was deleted

 opendj-server-legacy/src/main/docbkx/reference/man-upgrade.xml

File was deleted

 opendj-server-legacy/src/main/docbkx/reference/man-verify-index.xml

File was deleted

 pom.xml

@@ -163,6 +163,31 @@
  <build>
    <plugins>
      <plugin>
        <artifactId>maven-dependency-plugin</artifactId>
        <inherited>false</inherited>
        <executions>
          <execution>
            <id>unpack-sdk-man-pages</id>
            <phase>pre-site</phase>
            <goals>
              <goal>unpack</goal>
            </goals>
            <configuration>
              <artifactItems>
                <artifactItem>
                  <groupId>org.forgerock.opendj</groupId>
                  <artifactId>opendj-ldap-toolkit</artifactId>
                  <version>${project.version}</version>
                  <classifier>man-pages</classifier>
                  <outputDirectory>${project.build.directory}/docbkx-sources</outputDirectory>
                </artifactItem>
              </artifactItems>
            </configuration>
          </execution>
        </executions>
      </plugin>

      <plugin>
        <groupId>org.forgerock.commons</groupId>
        <artifactId>forgerock-doc-maven-plugin</artifactId>
        <version>${frDocPluginVersion}</version>

 src/main/docbkx/dev-guide/index.xml

@@ -78,28 +78,57 @@
  <title>Tools Reference</title>

  <partintro>
   <para>You can find the tools under the <filename>bin/</filename> or
   <filename>bat\</filename> folder where you installed OpenDJ LDAP SDK
   toolkit as described in the procedure explaining how <link
   <para>
    You can find the tools under
    the <filename>bin/</filename> or <filename>bat\</filename> folder
    where you installed OpenDJ LDAP SDK toolkit
    as described in the procedure explaining how
    <link
     xlink:show="new"
   xlink:href="dev-guide#install-latest-sdk"
   xlink:role="http://docbook.org/xlink/role/olink"><citetitle>To Install the
   Latest SDK &amp; Tools</citetitle></link>. For example,
   <filename>/path/to/opendj-ldap-toolkit-<?eval ${sdkDocTargetVersion}?>/bin</filename>.</para>
     xlink:role="http://docbook.org/xlink/role/olink"
    ><citetitle>To Install the Latest SDK &amp; Tools</citetitle></link>.
    For example, <filename>/path/to/opendj-ldap-toolkit-${sdkDocTargetVersion}/bin</filename>.
   </para>
  </partintro>

  <xinclude:include href='man-addrate.xml' />
  <xinclude:include href='man-authrate.xml' />
  <xinclude:include href='man-ldapcompare.xml' />
  <xinclude:include href='man-ldapmodify.xml' />
  <xinclude:include href='man-ldappasswordmodify.xml' />
  <xinclude:include href='man-ldapsearch.xml' />
  <xinclude:include href='man-ldifdiff.xml' />
  <xinclude:include href='man-ldifmodify.xml' />
  <xinclude:include href='man-ldifsearch.xml' />
  <xinclude:include href='man-makeldif.xml' />
  <xinclude:include href='man-makeldif-template.xml' />
  <xinclude:include href='man-modrate.xml' />
  <xinclude:include href='man-searchrate.xml' />
  <xinclude:include href='../man-pages/man-addrate.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-authrate.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-ldapcompare.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-ldapmodify.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-ldappasswordmodify.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-ldapsearch.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-ldifdiff.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-ldifmodify.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-ldifsearch.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-makeldif.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-makeldif-template.xml' />
  <xinclude:include href='../man-pages/man-modrate.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
  <xinclude:include href='../man-pages/man-searchrate.xml'>
   <xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
  </xinclude:include>
 </reference>

 <xinclude:include href="../shared/glossary.xml" />

 src/main/docbkx/dev-guide/man-addrate.xml

File was deleted

 src/main/docbkx/dev-guide/man-authrate.xml

File was deleted

 src/main/docbkx/dev-guide/man-ldapcompare.xml

File was deleted

 src/main/docbkx/dev-guide/man-ldapmodify.xml

File was deleted

 src/main/docbkx/dev-guide/man-ldappasswordmodify.xml

File was deleted

 src/main/docbkx/dev-guide/man-ldapsearch.xml

File was deleted

 src/main/docbkx/dev-guide/man-ldifdiff.xml

File was deleted

 src/main/docbkx/dev-guide/man-ldifmodify.xml

File was deleted

 src/main/docbkx/dev-guide/man-ldifsearch.xml

File was deleted

 src/main/docbkx/dev-guide/man-makeldif.xml

File was deleted

 src/main/docbkx/dev-guide/man-modrate.xml

File was deleted

 src/main/docbkx/dev-guide/man-searchrate.xml

File was deleted

 src/main/docbkx/man-pages/README.md

New file
@@ -0,0 +1,9 @@
Source files for the man pages are partially generated from tools sources,
partially hand-written.
See `GeneratedRefEntriesMojo` in `opendj-maven-plugin` for details.

The sources here are the hand-written pages and sections.

These sections are Xincluded into the generated sources at build time.
As a section might be Xincluded more than once in the same document,
none of the hand-written sections here has `xml:id` values.

 src/main/docbkx/man-pages/addrate-examples.xml

New file
@@ -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>

 src/main/docbkx/man-pages/attributes.xml

New file
@@ -0,0 +1,82 @@
<?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>Attributes</title>

 <para>
  The optional attribute list specifies the attributes to return
  in the entries found by the search.
  In addition to identifying attributes by name
  such as <literal>cn sn mail</literal> and so forth,
  you can use the following notations, too.
 </para>

 <variablelist>
  <varlistentry>
   <term><literal>*</literal></term>
   <listitem>
    <para>
     Return all user attributes
     such as <literal>cn</literal>, <literal>sn</literal>, and <literal>mail</literal>.
    </para>
   </listitem>
  </varlistentry>

  <varlistentry>
   <term><literal>+</literal></term>
   <listitem>
    <para>
     Return all operational attributes
     such as <literal>etag</literal> and <literal>pwdPolicySubentry</literal>.
    </para>
   </listitem>
  </varlistentry>

  <varlistentry>
   <term><literal>@<replaceable>objectclass</replaceable></literal></term>
   <listitem>
    <para>
     Return all attributes of the specified object class,
     where <replaceable>objectclass</replaceable> is one of the object classes
     on the entries returned by the search.
    </para>
   </listitem>
  </varlistentry>

  <varlistentry>
   <term><literal>1.1</literal></term>
   <listitem>
    <para>
     Return no attributes, only the DNs of matching entries.
    </para>
   </listitem>
  </varlistentry>
 </variablelist>
</refsect1>

 src/main/docbkx/man-pages/authrate-examples.xml

New file
@@ -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>

 src/main/docbkx/man-pages/exit-codes-0-1.xml

New file
@@ -0,0 +1,52 @@
<?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>Exit Codes</title>

 <variablelist>
  <varlistentry>
   <term>0</term>
   <listitem>
    <para>
     The command completed successfully.
    </para>
   </listitem>
  </varlistentry>

  <varlistentry>
   <term>1</term>
   <listitem>
    <para>
     An error occurred.
    </para>
   </listitem>
  </varlistentry>
 </variablelist>
</refsect1>

 src/main/docbkx/man-pages/exit-codes-0-5-6-other.xml

New file
@@ -0,0 +1,70 @@
<?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>Exit Codes</title>

 <variablelist>
  <varlistentry>
   <term>0</term>
   <listitem>
    <para>
     The command completed successfully.
    </para>
   </listitem>
  </varlistentry>

  <varlistentry>
   <term>5</term>
   <listitem>
    <para>
     The <option>-r</option> option was used, and the compare did not match.
    </para>
   </listitem>
  </varlistentry>

  <varlistentry>
   <term>6</term>
   <listitem>
    <para>
     The <option>-r</option> option was used, and the compare did match.
    </para>
   </listitem>
  </varlistentry>

  <varlistentry>
   <term>other</term>
   <listitem>
    <para>
     An error occurred.
    </para>
   </listitem>
  </varlistentry>
 </variablelist>
</refsect1>

 src/main/docbkx/man-pages/exit-codes-0-80-89.xml

New file
@@ -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
  ! 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>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>

 src/main/docbkx/man-pages/exit-codes-0-89.xml

New file
@@ -0,0 +1,52 @@
<?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>Exit Codes</title>

 <variablelist>
  <varlistentry>
   <term>0</term>
   <listitem>
    <para>
     The command completed successfully.
    </para>
   </listitem>
  </varlistentry>

  <varlistentry>
   <term>89</term>
   <listitem>
    <para>
     An error occurred while parsing the command-line arguments.
    </para>
   </listitem>
  </varlistentry>
 </variablelist>
</refsect1>

 src/main/docbkx/man-pages/exit-codes-0-gt0.xml

New file
@@ -0,0 +1,52 @@
<?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>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>

 src/main/docbkx/man-pages/exit-codes-0-ldap-89.xml

New file
@@ -0,0 +1,70 @@
<?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"
          xmlns:xlink="http://www.w3.org/1999/xlink">
 <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"
      xlink:show="new">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>

 src/main/docbkx/man-pages/files.xml

New file
@@ -0,0 +1,50 @@
<?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>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>

 src/main/docbkx/man-pages/filters.xml

New file
@@ -0,0 +1,39 @@
<?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>Filters</title>

 <para>
  The filter argument is a string representation of an LDAP search filter
  as in <literal>(cn=Babs Jensen)</literal>,
  <literal>(&amp;(objectClass=Person)(|(sn=Jensen)(cn=Babs J*)))</literal>,
  or <literal>(cn:caseExactMatch:=Fred Flintstone)</literal>.
 </para>
</refsect1>

 src/main/docbkx/man-pages/ldapcompare-examples.xml

New file
@@ -0,0 +1,60 @@
<?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 demonstrate comparing Babs Jensen's UID.
 </para>

 <para>
  The following example uses a matching UID value.
 </para>

 <screen>
$ <userinput>ldapcompare -p 1389 uid:bjensen uid=bjensen,ou=people,dc=example,dc=com</userinput>
<computeroutput>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</computeroutput>
 </screen>

 <para>
  The following example uses a UID value that does not match.
 </para>

 <screen>
$ <userinput>ldapcompare -p 1389 uid:beavis uid=bjensen,ou=people,dc=example,dc=com</userinput>
<computeroutput>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</computeroutput>
 </screen>
</refsect1>

 src/main/docbkx/man-pages/ldapmodify-examples.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/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 use of the command
  to add an entry to the directory.
 </para>

 <screen>
$ <userinput>cat newuser.ldif</userinput>
<computeroutput>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</computeroutput>

$ <userinput>ldapmodify -p 1389 -a -f newuser.ldif \
 -D uid=kvaughan,ou=people,dc=example,dc=com -w bribery</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.
 </para>

 <programlisting language="shell">
#!/bin/sh
#
# Add a new user with the ldapmodify utility.
#

usage(){
        echo "Usage: $0 uid firstname lastname"
        exit 1
}
[[ $# -lt 3 ]] &amp;&amp; usage

LDAPMODIFY=/path/to/opendj/bin/ldapmodify
HOST=opendj.example.com
PORT=1389
ADMIN=uid=kvaughan,ou=people,dc=example,dc=com
PWD=bribery

$LDAPMODIFY -h $HOST -p $PORT -D $ADMIN -w $PWD -a &lt;&lt;EOF
dn: uid=$1,ou=people,dc=example,dc=com
uid: $1
objectClass: top
objectClass: person
objectClass: organizationalPerson
objectClass: inetOrgPerson
cn: $2 $3
givenName: $2
sn: $3
mail: $1@example.com
EOF
 </programlisting>

 <para>
  The following example demonstrates adding a Description attribute
  to the new user's entry.
 </para>

 <screen>$ <userinput>cat newdesc.ldif</userinput>
<computeroutput>dn: uid=newuser,ou=People,dc=example,dc=com
changetype: modify
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>
<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.
 </para>

 <screen>
$ <userinput>cat moddesc.ldif</userinput>
<computeroutput>dn: uid=newuser,ou=People,dc=example,dc=com
changetype: modify
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>
<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.
 </para>

 <screen>$ <userinput>cat deluser.ldif</userinput>
<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>
<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>
</refsect1>

 src/main/docbkx/man-pages/ldappasswordmodify-examples.xml

New file
@@ -0,0 +1,46 @@
<?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 a user changing the password for an entry.
 </para>

 <screen>
$ <userinput>cat /tmp/currpwd.txt /tmp/newpwd.txt</userinput>
<computeroutput>bribery
secret12</computeroutput>

$ <userinput>ldappasswordmodify -p 1389 -C /tmp/currpwd.txt -N /tmp/newpwd.txt \
-A -D uid=kvaughan,ou=people,dc=example,dc=com -w bribery</userinput>
<computeroutput>The LDAP password modify operation was successful</computeroutput>
 </screen>
</refsect1>

 src/main/docbkx/man-pages/ldapsearch-examples.xml

New file
@@ -0,0 +1,112 @@
<?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 searches for entries
  with UID containing <literal>jensen</literal>,
  returning only DNs and uid values.
 </para>

 <screen>
$ <userinput>ldapsearch -p 1389 -b dc=example,dc=com "(uid=*jensen*)" uid</userinput>
<computeroutput>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)</computeroutput>
 </screen>

 <para>
  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.
 </para>

 <screen>
$ <userinput>ldapsearch -p 1389 -b dc=example,dc=com "(uid=bjensen)" @inetorgperson</userinput>
<computeroutput>dn: uid=bjensen,ou=People,dc=example,dc=com
givenName: Barbara
objectClass: person
objectClass: organizationalPerson
objectClass: inetOrgPerson
objectClass: posixAccount
objectClass: top
uid: bjensen
cn: Barbara Jensen
cn: Babs Jensen
telephoneNumber: +1 408 555 1862
sn: Jensen
roomNumber: 0209
mail: bjensen@example.com
l: Cupertino
ou: Product Development
ou: People
facsimileTelephoneNumber: +1 408 555 1992</computeroutput>
 </screen>

 <para>
  You can use <literal>+</literal> in the attribute list
  to return all operational attributes, as in the following example.
 </para>

 <screen>
$ <userinput>ldapsearch -p 1389 -b dc=example,dc=com "(uid=bjensen)" +</userinput>
<computeroutput>dn: uid=bjensen,ou=People,dc=example,dc=com
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
entryUUID: fc252fd9-b982-3ed6-b42a-c76d2546312c</computeroutput>
 </screen>
</refsect1>

 src/main/docbkx/man-pages/ldifdiff-examples.xml

New file
@@ -0,0 +1,77 @@
<?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 use of the command with two small LDIF files.
 </para>

 <screen>
$ <userinput>cat /path/to/newuser.ldif</userinput>
<computeroutput>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</computeroutput>

$ <userinput>cat /path/to/neweruser.ldif</userinput>
<computeroutput>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: secret12
description: A new description.</computeroutput>

$ <userinput>ldifdiff /path/to/newuser.ldif /path/to/neweruser.ldif</userinput>
<computeroutput>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.</computeroutput>
 </screen>
</refsect1>

 src/main/docbkx/man-pages/ldifmodify-examples.xml

New file
@@ -0,0 +1,79 @@
<?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 use of the command.
 </para>

 <screen>
$ cat <userinput>/path/to/newuser.ldif</userinput>
<computeroutput>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</computeroutput>

$ <userinput>cat /path/to/newdiff.ldif</userinput>
<computeroutput>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.</computeroutput>

$ <userinput>ldifmodify -o neweruser.ldif /path/to/newuser.ldif /path/to/newdiff.ldif</userinput>

$ <userinput>cat neweruser.ldif</userinput>
<computeroutput>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: secret12
description: A new description.</computeroutput>
 </screen>
</refsect1>

 src/main/docbkx/man-pages/ldifsearch-examples.xml

New file
@@ -0,0 +1,88 @@
<?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 use of the command.
 </para>

 <screen>
$ <userinput>ldifsearch -b dc=example,dc=com /path/to/Example.ldif uid=bjensen</userinput>
<computeroutput>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</computeroutput>
 </screen>

 <para>
  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>posixAccount</literal> object class.
 </para>

 <screen>
$ <userinput>ldifsearch --ldifFile /path/to/Example.ldif \
 --baseDN dc=example,dc=com "(uid=bjensen)" @posixaccount</userinput>
<computeroutput>dn: uid=bjensen,ou=People,dc=example,dc=com
objectClass: person
objectClass: organizationalPerson
objectClass: inetOrgPerson
objectClass: posixAccount
objectClass: top
uid: bjensen
userpassword: hifalutin
cn: Barbara Jensen
cn: Babs Jensen
homeDirectory: /home/bjensen
uidNumber: 1076
gidNumber: 1000</computeroutput>
 </screen>
</refsect1>

 src/main/docbkx/man-pages/makeldif-examples.xml

New file
@@ -0,0 +1,46 @@
<?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 uses a built-in template and data files
  to generate a base entry, an <literal>ou=People</literal> entry,
  and 2000 user entries, instead of the default specified in the template,
  which is 10000.
 </para>

 <screen>
$ <userinput>makeldif --outputLDIF test.ldif --constant numusers=2000 example.template</userinput>
<computeroutput>Processed 1000 entries
Processed 2000 entries
LDIF processing complete. 2002 entries written</computeroutput>
 </screen>
</refsect1>

 src/main/docbkx/man-pages/makeldif-see-also.xml

New file
@@ -0,0 +1,41 @@
<?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"
          xmlns:xlink="http://www.w3.org/1999/xlink">
 <title>See Also</title>

 <para>
  <link xlink:show="new"
        xlink:href="dev-guide#makeldif-template-5"
        xlink:role="http://docbook.org/xlink/role/olink"
   ><citerefentry><refentrytitle
   >makeldif.template</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>
 </para>
</refsect1>

 src/main/docbkx/man-pages/man-makeldif-template.xml

File was renamed from src/main/docbkx/dev-guide/man-makeldif-template.xml
@@ -20,7 +20,7 @@
  !
  ! CCPL HEADER END
  !
  !      Copyright 2012-2014 ForgeRock AS
  !      Copyright 2012-2015 ForgeRock AS.
  !
-->
<refentry xml:id='makeldif-template-5'
@@ -32,8 +32,8 @@
          xmlns:xlink='http://www.w3.org/1999/xlink'>
 <info>
  <copyright>
   <year>2012-2014</year>
   <holder>ForgeRock AS</holder>
   <year>2012-2015</year>
   <holder>ForgeRock AS.</holder>
  </copyright>
 </info>

@@ -616,11 +616,11 @@
  <title>See Also</title>

  <para>
   <link xlink:show="new"
   <link
    xlink:show="new"
         xlink:href="dev-guide#makeldif-1"
         xlink:role="http://docbook.org/xlink/role/olink"
           ><citerefentry><refentrytitle>makeldif</refentrytitle><manvolnum
           >1</manvolnum></citerefentry></link>,
    xlink:role="http://docbook.org/xlink/role/olink"><citerefentry><refentrytitle
    >makeldif</refentrytitle><manvolnum>1</manvolnum></citerefentry></link>,
   the OpenDJ directory server template file
   <filename>/path/to/opendj/config/MakeLDIF/example.template</filename>
  </para>

 src/main/docbkx/man-pages/modrate-examples.xml

New file
@@ -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>

 src/main/docbkx/man-pages/searchrate-examples.xml

New file
@@ -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>