From 8a81bad1a27eb157108f63c6cc5d313a13b17be0 Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Fri, 27 Mar 2015 14:14:51 +0000
Subject: [PATCH] CR-6483 OPENDJ-1786 Automate integration of generated content
---
src/main/docbkx/man-pages/ldappasswordmodify-examples.xml | 46
opendj-server-legacy/src/main/docbkx/man-pages/dsreplication-examples.xml | 86
src/main/docbkx/dev-guide/index.xml | 69
src/main/docbkx/man-pages/ldapsearch-examples.xml | 112 +
src/main/docbkx/man-pages/files.xml | 50
opendj-server-legacy/src/main/docbkx/man-pages/list-backends-examples.xml | 52
opendj-server-legacy/src/main/docbkx/man-pages/upgrade-exit-codes.xml | 80
src/main/docbkx/man-pages/exit-codes-0-gt0.xml | 52
src/main/docbkx/man-pages/ldapcompare-examples.xml | 60
opendj-server-legacy/src/main/docbkx/man-pages/dsconfig-examples.xml | 152 +
opendj-server-legacy/src/main/docbkx/man-pages/ldif-diff-examples.xml | 77
opendj-ldap-toolkit/src/main/resources/com/forgerock/opendj/ldap/tools/tools.properties | 12
opendj-server-legacy/src/main/docbkx/man-pages/dsjavaproperties-files.xml | 37
opendj-server-legacy/pom.xml | 294 ++
opendj-ldap-toolkit/pom.xml | 146 +
src/main/docbkx/man-pages/authrate-examples.xml | 59
opendj-server-legacy/src/main/docbkx/man-pages/manage-account-examples.xml | 66
src/main/docbkx/man-pages/exit-codes-0-1.xml | 52
src/main/docbkx/man-pages/exit-codes-0-89.xml | 52
opendj-server-legacy/src/main/docbkx/man-pages/files.xml | 50
opendj-server-legacy/src/main/docbkx/man-pages/base64-examples.xml | 53
src/main/docbkx/man-pages/searchrate-examples.xml | 55
opendj-server-legacy/src/main/docbkx/man-pages/setup-examples.xml | 56
src/main/docbkx/man-pages/exit-codes-0-80-89.xml | 61
src/main/docbkx/man-pages/exit-codes-0-ldap-89.xml | 70
src/main/docbkx/man-pages/exit-codes-0-5-6-other.xml | 70
opendj-server-legacy/src/main/docbkx/man-pages/README.md | 9
opendj-server-legacy/src/main/docbkx/man-pages/exit-codes-0-gt0.xml | 52
opendj-server-legacy/src/main/docbkx/man-pages/ldapdelete-examples.xml | 55
src/main/docbkx/man-pages/ldifdiff-examples.xml | 77
opendj-server-legacy/src/main/docbkx/man-pages/ldappasswordmodify-examples.xml | 46
opendj-server-legacy/src/main/docbkx/man-pages/ldapcompare-exit-codes.xml | 87
opendj-server-legacy/src/main/docbkx/man-pages/ldifmodify-examples.xml | 79
opendj-server-legacy/src/main/docbkx/man-pages/rebuild-index-examples.xml | 43
opendj-server-legacy/src/main/docbkx/man-pages/filters.xml | 39
opendj-server-legacy/src/main/docbkx/man-pages/exit-codes-0-ldap-89.xml | 70
opendj-server-legacy/src/main/docbkx/man-pages/export-ldif-examples.xml | 43
opendj-server-legacy/src/main/docbkx/man-pages/start-ds-examples.xml | 41
opendj-ldap-toolkit/src/main/java/com/forgerock/opendj/ldap/tools/DataSource.java | 2
opendj-server-legacy/src/main/docbkx/man-pages/ldifsearch-examples.xml | 88
opendj-server-legacy/src/main/docbkx/man-pages/create-rc-script-examples.xml | 43
opendj-server-legacy/src/main/docbkx/man-pages/ldapcompare-examples.xml | 60
src/main/docbkx/man-pages/README.md | 9
opendj-server-legacy/src/main/docbkx/man-pages/exit-codes-0-89.xml | 52
opendj-server-legacy/src/main/docbkx/man-pages/man-windows-service.xml | 69
opendj-server-legacy/src/main/docbkx/man-pages/restore-examples.xml | 71
pom.xml | 25
opendj-server-legacy/src/main/docbkx/man-pages/exit-codes-0-1.xml | 52
src/main/docbkx/man-pages/filters.xml | 39
opendj-server-legacy/src/main/docbkx/man-pages/uninstall-examples.xml | 51
opendj-server-legacy/src/main/docbkx/man-pages/import-ldif-examples.xml | 43
src/main/docbkx/man-pages/ldapmodify-examples.xml | 152 +
src/main/docbkx/man-pages/man-makeldif-template.xml | 16
src/main/docbkx/man-pages/modrate-examples.xml | 57
opendj-server-legacy/src/main/docbkx/man-pages/exit-codes-0-5-6-other.xml | 70
src/main/docbkx/man-pages/ldifmodify-examples.xml | 79
opendj-server-legacy/src/main/docbkx/man-pages/manage-tasks-examples.xml | 47
opendj-server-legacy/src/main/docbkx/man-pages/make-ldif-see-also.xml | 41
opendj-maven-plugin/src/main/java/org/forgerock/opendj/maven/GenerateRefEntriesMojo.java | 221 +
src/main/docbkx/man-pages/makeldif-examples.xml | 46
opendj-server-legacy/src/main/docbkx/man-pages/backup-examples.xml | 72
opendj-server-legacy/src/main/docbkx/man-pages/man-make-ldif-template.xml | 295 +-
opendj-server-legacy/src/main/docbkx/man-pages/stop-ds-examples.xml | 43
opendj-server-legacy/src/main/docbkx/man-pages/ldapsearch-examples.xml | 112 +
opendj-server-legacy/src/main/docbkx/man-pages/make-ldif-examples.xml | 45
src/main/docbkx/man-pages/ldifsearch-examples.xml | 88
opendj-server-legacy/src/main/docbkx/man-pages/status-examples.xml | 76
opendj-server-legacy/src/main/docbkx/reference/index.xml | 132
opendj-server-legacy/src/main/docbkx/man-pages/dsjavaproperties-examples.xml | 43
/dev/null | 410 ---
opendj-ldap-toolkit/src/main/assembly/man-pages.xml | 104 +
opendj-server-legacy/src/main/docbkx/man-pages/attributes.xml | 82
opendj-server-legacy/src/main/docbkx/man-pages/dbtest-examples.xml | 55
src/main/docbkx/man-pages/attributes.xml | 82
opendj-server-legacy/src/main/docbkx/man-pages/control-panel-examples.xml | 40
opendj-server-legacy/src/main/docbkx/man-pages/verify-index-exit-codes.xml | 67
opendj-server-legacy/src/main/docbkx/man-pages/encode-password-examples.xml | 64
src/main/docbkx/man-pages/makeldif-see-also.xml | 41
opendj-server-legacy/src/main/docbkx/man-pages/ldapmodify-examples.xml | 154 +
opendj-server-legacy/src/main/docbkx/man-pages/verify-index-examples.xml | 59
src/main/docbkx/man-pages/addrate-examples.xml | 122 +
81 files changed, 5,372 insertions(+), 757 deletions(-)
diff --git a/opendj-ldap-toolkit/pom.xml b/opendj-ldap-toolkit/pom.xml
index 133bad6..7d196b8 100644
--- a/opendj-ldap-toolkit/pom.xml
+++ b/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>
diff --git a/opendj-ldap-toolkit/src/main/assembly/man-pages.xml b/opendj-ldap-toolkit/src/main/assembly/man-pages.xml
new file mode 100644
index 0000000..41a2808
--- /dev/null
+++ b/opendj-ldap-toolkit/src/main/assembly/man-pages.xml
@@ -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>
diff --git a/opendj-ldap-toolkit/src/main/java/com/forgerock/opendj/ldap/tools/DataSource.java b/opendj-ldap-toolkit/src/main/java/com/forgerock/opendj/ldap/tools/DataSource.java
index d367c02..6930153 100644
--- a/opendj-ldap-toolkit/src/main/java/com/forgerock/opendj/ldap/tools/DataSource.java
+++ b/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. "
diff --git a/opendj-ldap-toolkit/src/main/resources/com/forgerock/opendj/ldap/tools/tools.properties b/opendj-ldap-toolkit/src/main/resources/com/forgerock/opendj/ldap/tools/tools.properties
index e61c276..aa5b295 100755
--- a/opendj-ldap-toolkit/src/main/resources/com/forgerock/opendj/ldap/tools/tools.properties
+++ b/opendj-ldap-toolkit/src/main/resources/com/forgerock/opendj/ldap/tools/tools.properties
@@ -581,10 +581,10 @@
in the <filename>/etc/sysctl.conf</filename> file. \
</para> \
\
- <programlisting language="ini"> \
- net.ipv4.tcp_fin_timeout = 30 \
- net.ipv4.tcp_tw_recycle = 1 \
- net.ipv4.tcp_tw_reuse = 1 \
+ <programlisting language="ini">\n \
+net.ipv4.tcp_fin_timeout = 30\n \
+net.ipv4.tcp_tw_recycle = 1\n \
+net.ipv4.tcp_tw_reuse = 1 \
</programlisting> \
\
<para> \
@@ -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: \
diff --git a/opendj-maven-plugin/src/main/java/org/forgerock/opendj/maven/GenerateRefEntriesMojo.java b/opendj-maven-plugin/src/main/java/org/forgerock/opendj/maven/GenerateRefEntriesMojo.java
index 1b5be78..fbd3c56 100644
--- a/opendj-maven-plugin/src/main/java/org/forgerock/opendj/maven/GenerateRefEntriesMojo.java
+++ b/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-<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) {
- final File manPage = new File(outputDir, "man-" + tool.getName() + ".xml");
- try {
- setSystemOut(refEntryFile(manPage.getPath()));
- } catch (FileNotFoundException e) {
- setSystemOut(out);
- failures.add(manPage.getPath());
- throw new MojoExecutionException("Failed to write " + manPage.getPath(), e);
+ /**
+ * Generate a RefEntry file to the output directory for a tool.
+ * The files name corresponds to the tool name: {@code man-<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 {
+ // 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();
+ }
+ }
+ }
}
diff --git a/opendj-server-legacy/pom.xml b/opendj-server-legacy/pom.xml
index 2581f37..bcbd16e 100644
--- a/opendj-server-legacy/pom.xml
+++ b/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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/README.md b/opendj-server-legacy/src/main/docbkx/man-pages/README.md
new file mode 100644
index 0000000..b14b463
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/README.md
@@ -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.
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/attributes.xml b/opendj-server-legacy/src/main/docbkx/man-pages/attributes.xml
new file mode 100644
index 0000000..8a55f5f
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/attributes.xml
@@ -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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/backup-examples.xml b/opendj-server-legacy/src/main/docbkx/man-pages/backup-examples.xml
new file mode 100644
index 0000000..2653a29
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/backup-examples.xml
@@ -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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/base64-examples.xml b/opendj-server-legacy/src/main/docbkx/man-pages/base64-examples.xml
new file mode 100644
index 0000000..0eae3c0
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/base64-examples.xml
@@ -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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/control-panel-examples.xml b/opendj-server-legacy/src/main/docbkx/man-pages/control-panel-examples.xml
new file mode 100644
index 0000000..ece480b
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/control-panel-examples.xml
@@ -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 &</userinput>
+ </screen>
+</refsect1>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/create-rc-script-examples.xml b/opendj-server-legacy/src/main/docbkx/man-pages/create-rc-script-examples.xml
new file mode 100644
index 0000000..b2833ed
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/create-rc-script-examples.xml
@@ -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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/dbtest-examples.xml b/opendj-server-legacy/src/main/docbkx/man-pages/dbtest-examples.xml
new file mode 100644
index 0000000..d099b7b
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/dbtest-examples.xml
@@ -0,0 +1,55 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ! CCPL HEADER START
+ !
+ ! This work is licensed under the Creative Commons
+ ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
+ ! To view a copy of this license, visit
+ ! http://creativecommons.org/licenses/by-nc-nd/3.0/
+ ! or send a letter to Creative Commons, 444 Castro Street,
+ ! Suite 900, Mountain View, California, 94041, USA.
+ !
+ ! You can also obtain a copy of the license at
+ ! trunk/opendj/legal-notices/CC-BY-NC-ND.txt.
+ ! See the License for the specific language governing permissions
+ ! and limitations under the License.
+ !
+ ! If applicable, add the following below this CCPL HEADER, with the fields
+ ! enclosed by brackets "[]" replaced with your own identifying information:
+ ! Portions Copyright [yyyy] [name of copyright owner]
+ !
+ ! CCPL HEADER END
+ !
+ ! Copyright 2015 ForgeRock AS.
+ !
+-->
+<refsect1 xmlns="http://docbook.org/ns/docbook"
+ version="5.0" xml:lang="en"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://docbook.org/ns/docbook
+ http://docbook.org/xml/5.0/xsd/docbook.xsd">
+ <title>Examples</title>
+
+ <para>
+ The following example 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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/dsconfig-examples.xml b/opendj-server-legacy/src/main/docbkx/man-pages/dsconfig-examples.xml
new file mode 100644
index 0000000..3716c01
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/dsconfig-examples.xml
@@ -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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/dsjavaproperties-examples.xml b/opendj-server-legacy/src/main/docbkx/man-pages/dsjavaproperties-examples.xml
new file mode 100644
index 0000000..d586e7a
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/dsjavaproperties-examples.xml
@@ -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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/dsjavaproperties-files.xml b/opendj-server-legacy/src/main/docbkx/man-pages/dsjavaproperties-files.xml
new file mode 100644
index 0000000..2b312ca
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/dsjavaproperties-files.xml
@@ -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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/dsreplication-examples.xml b/opendj-server-legacy/src/main/docbkx/man-pages/dsreplication-examples.xml
new file mode 100644
index 0000000..2e0e7bc
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/dsreplication-examples.xml
@@ -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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/encode-password-examples.xml b/opendj-server-legacy/src/main/docbkx/man-pages/encode-password-examples.xml
new file mode 100644
index 0000000..abb83fa
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/encode-password-examples.xml
@@ -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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/exit-codes-0-1.xml b/opendj-server-legacy/src/main/docbkx/man-pages/exit-codes-0-1.xml
new file mode 100644
index 0000000..1da3555
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/exit-codes-0-1.xml
@@ -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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/exit-codes-0-5-6-other.xml b/opendj-server-legacy/src/main/docbkx/man-pages/exit-codes-0-5-6-other.xml
new file mode 100644
index 0000000..9e4e9c9
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/exit-codes-0-5-6-other.xml
@@ -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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/exit-codes-0-89.xml b/opendj-server-legacy/src/main/docbkx/man-pages/exit-codes-0-89.xml
new file mode 100644
index 0000000..1134dd2
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/exit-codes-0-89.xml
@@ -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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/exit-codes-0-gt0.xml b/opendj-server-legacy/src/main/docbkx/man-pages/exit-codes-0-gt0.xml
new file mode 100644
index 0000000..e06d202
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/exit-codes-0-gt0.xml
@@ -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>> 0</term>
+ <listitem>
+ <para>
+ An error occurred.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+</refsect1>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/exit-codes-0-ldap-89.xml b/opendj-server-legacy/src/main/docbkx/man-pages/exit-codes-0-ldap-89.xml
new file mode 100644
index 0000000..f7e9cf1
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/exit-codes-0-ldap-89.xml
@@ -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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/export-ldif-examples.xml b/opendj-server-legacy/src/main/docbkx/man-pages/export-ldif-examples.xml
new file mode 100644
index 0000000..f4447bd
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/export-ldif-examples.xml
@@ -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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/files.xml b/opendj-server-legacy/src/main/docbkx/man-pages/files.xml
new file mode 100644
index 0000000..bc7f0cb
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/files.xml
@@ -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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/filters.xml b/opendj-server-legacy/src/main/docbkx/man-pages/filters.xml
new file mode 100644
index 0000000..e10bb37
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/filters.xml
@@ -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>(&(objectClass=Person)(|(sn=Jensen)(cn=Babs J*)))</literal>,
+ or <literal>(cn:caseExactMatch:=Fred Flintstone)</literal>.
+ </para>
+</refsect1>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/import-ldif-examples.xml b/opendj-server-legacy/src/main/docbkx/man-pages/import-ldif-examples.xml
new file mode 100644
index 0000000..9ae21e6
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/import-ldif-examples.xml
@@ -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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/ldapcompare-examples.xml b/opendj-server-legacy/src/main/docbkx/man-pages/ldapcompare-examples.xml
new file mode 100644
index 0000000..10cdb77
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/ldapcompare-examples.xml
@@ -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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/ldapcompare-exit-codes.xml b/opendj-server-legacy/src/main/docbkx/man-pages/ldapcompare-exit-codes.xml
new file mode 100644
index 0000000..fe02448
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/ldapcompare-exit-codes.xml
@@ -0,0 +1,87 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ! CCPL HEADER START
+ !
+ ! This work is licensed under the Creative Commons
+ ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
+ ! To view a copy of this license, visit
+ ! http://creativecommons.org/licenses/by-nc-nd/3.0/
+ ! or send a letter to Creative Commons, 444 Castro Street,
+ ! Suite 900, Mountain View, California, 94041, USA.
+ !
+ ! You can also obtain a copy of the license at
+ ! 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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/ldapdelete-examples.xml b/opendj-server-legacy/src/main/docbkx/man-pages/ldapdelete-examples.xml
new file mode 100644
index 0000000..53b05d6
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/ldapdelete-examples.xml
@@ -0,0 +1,55 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ! CCPL HEADER START
+ !
+ ! This work is licensed under the Creative Commons
+ ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
+ ! To view a copy of this license, visit
+ ! http://creativecommons.org/licenses/by-nc-nd/3.0/
+ ! or send a letter to Creative Commons, 444 Castro Street,
+ ! Suite 900, Mountain View, California, 94041, USA.
+ !
+ ! You can also obtain a copy of the license at
+ ! trunk/opendj/legal-notices/CC-BY-NC-ND.txt.
+ ! See the License for the specific language governing permissions
+ ! and limitations under the License.
+ !
+ ! If applicable, add the following below this CCPL HEADER, with the fields
+ ! enclosed by brackets "[]" replaced with your own identifying information:
+ ! Portions Copyright [yyyy] [name of copyright owner]
+ !
+ ! CCPL HEADER END
+ !
+ ! Copyright 2015 ForgeRock AS.
+ !
+-->
+<refsect1 xmlns="http://docbook.org/ns/docbook"
+ version="5.0" xml:lang="en"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://docbook.org/ns/docbook
+ http://docbook.org/xml/5.0/xsd/docbook.xsd">
+ <title>Examples</title>
+
+ <para>
+ The following 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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/ldapmodify-examples.xml b/opendj-server-legacy/src/main/docbkx/man-pages/ldapmodify-examples.xml
new file mode 100644
index 0000000..4239aed
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/ldapmodify-examples.xml
@@ -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 ]] && 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 <<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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/ldappasswordmodify-examples.xml b/opendj-server-legacy/src/main/docbkx/man-pages/ldappasswordmodify-examples.xml
new file mode 100644
index 0000000..ecced5c
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/ldappasswordmodify-examples.xml
@@ -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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/ldapsearch-examples.xml b/opendj-server-legacy/src/main/docbkx/man-pages/ldapsearch-examples.xml
new file mode 100644
index 0000000..06a4ba6
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/ldapsearch-examples.xml
@@ -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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/ldif-diff-examples.xml b/opendj-server-legacy/src/main/docbkx/man-pages/ldif-diff-examples.xml
new file mode 100644
index 0000000..881326f
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/ldif-diff-examples.xml
@@ -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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/ldifmodify-examples.xml b/opendj-server-legacy/src/main/docbkx/man-pages/ldifmodify-examples.xml
new file mode 100644
index 0000000..1313128
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/ldifmodify-examples.xml
@@ -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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/ldifsearch-examples.xml b/opendj-server-legacy/src/main/docbkx/man-pages/ldifsearch-examples.xml
new file mode 100644
index 0000000..328a443
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/ldifsearch-examples.xml
@@ -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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/list-backends-examples.xml b/opendj-server-legacy/src/main/docbkx/man-pages/list-backends-examples.xml
new file mode 100644
index 0000000..8139444
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/list-backends-examples.xml
@@ -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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/make-ldif-examples.xml b/opendj-server-legacy/src/main/docbkx/man-pages/make-ldif-examples.xml
new file mode 100644
index 0000000..4e7fba9
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/make-ldif-examples.xml
@@ -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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/make-ldif-see-also.xml b/opendj-server-legacy/src/main/docbkx/man-pages/make-ldif-see-also.xml
new file mode 100644
index 0000000..c659d6f
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/make-ldif-see-also.xml
@@ -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>
diff --git a/src/main/docbkx/dev-guide/man-makeldif-template.xml b/opendj-server-legacy/src/main/docbkx/man-pages/man-make-ldif-template.xml
similarity index 64%
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
index a4cb9ca..ff266b9 100644
--- a/src/main/docbkx/dev-guide/man-makeldif-template.xml
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/man-make-ldif-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,30 +133,26 @@
<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>
- <programlisting language="ldif"
- >description: Description for [org] under [suffix]</programlisting>
+ <programlisting language="ldif"
+ >description: Description for [org] under [suffix]</programlisting>
<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: <first>
-sn: <last></programlisting>
+ <programlisting language="ldif">givenName: <first>
+sn: <last></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><</literal>
- and <literal>></literal>,
+ The other kind of tag is delimited with
+ <literal><</literal> and <literal>></literal>,
as shown above in the example with
- <literal><first></literal> and <literal><last></literal>.
-
+ <literal><first></literal> and <literal><last></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>< [ {</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>> ] }</literal>).
</para>
<programlisting language="ldif"
- >scimMail: \{"emails": \[\{"value": "{mail}", "type": "work", "primary": true}]}
-xml: \<id>{uid}\</id></programlisting>
+ >scimMail: \{"emails": \[\{"value": "{mail}", "type": "work", "primary": true}]}
+xml: \<id>{uid}\</id></programlisting>
<para>
- The <command>makeldif</command> command supports the following tags.
+ OpenDJ supports the following tags.
</para>
<varlistentry>
- <term><DN></term>
+ <term><DN></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><DN:1></literal> gets replaced
- by <literal>uid=bjensen</literal>,
- and <literal><DN:-2></literal> gets replaced
- by <literal>dc=example,dc=com</literal>.
+ <literal>uid=bjensen,ou=People,dc=example,dc=com</literal>
+ <literal><DN:1></literal> gets replaced by <literal>uid=bjensen</literal>,
+ and <literal><DN:-2></literal> gets replaced by
+ <literal>dc=example,dc=com</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><File></term>
+ <term><File></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><file:/path/to/myDescriptions></literal>,
- or specify a path relative to the template file
- such as <literal><file:streets></literal>.
-
+ For the file argument, either you specify an absolute path to the file
+ such as <literal><file:/path/to/myDescriptions></literal>,
+ or you specify a path relative to the
+ <filename>/path/to/opendj/config/MakeLDIF/</filename> directory
+ such as <literal><file:streets></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><First></term>
+ <term><First></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><GUID></term>
+ <term><GUID></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><IfAbsent></term>
+ <term><IfAbsent></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><Presence></literal>
+ Use this tag when you have used <literal><Presence></literal>
to define another attribute that is not always present on generated entries.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><IfPresent></term>
+ <term><IfPresent></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><Presence></literal>
+ Use this tag when you have used <literal><Presence></literal>
to define another attribute that is sometimes present on generated entries.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><Last></term>
+ <term><Last></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><List></term>
+ <term><List></term>
<listitem>
<para>
- The List tag gets replaced by one of the values from the list of
- arguments you provide.
-
- For example, <literal><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><List:bronze:silver:gold></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><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><List:bronze;2:silver;1:gold;1></literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><ParentDN></term>
+ <term><ParentDN></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><ParentDN></literal> gets replaced by
+ <literal><ParentDN></literal> gets replaced by
<literal>ou=People,dc=example,dc=com</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><Presence></term>
+ <term><Presence></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: <Presence:50>A description</literal>
- generates <literal>description: A description</literal>
- on half the entries.
+ For example,
+ <literal>description: <Presence:50>A description</literal> generates
+ <literal>description: A description</literal> on half the entries.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><Random></term>
+ <term><Random></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><Random:<replaceable>subtype</replaceable>></literal>.
-
+ that is <literal><Random:<replaceable>subtype</replaceable>></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><RDN></term>
+ <term><RDN></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><Sequential></term>
+ <term><Sequential></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><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><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>.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><_DN></term>
+ <term><_DN></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><_ParentDN></term>
+ <term><_ParentDN></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"
- xlink:role="http://docbook.org/xlink/role/olink"
- ><citerefentry><refentrytitle>makeldif</refentrytitle><manvolnum
- >1</manvolnum></citerefentry></link>,
+ <link
+ xlink:show="new"
+ xlink:href="reference#make-ldif-1"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><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>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-windows-service.xml b/opendj-server-legacy/src/main/docbkx/man-pages/man-windows-service.xml
similarity index 70%
rename from opendj-server-legacy/src/main/docbkx/reference/man-windows-service.xml
rename to opendj-server-legacy/src/main/docbkx/man-pages/man-windows-service.xml
index 6241e09..f8ae702 100644
--- a/opendj-server-legacy/src/main/docbkx/reference/man-windows-service.xml
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/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>> 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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/manage-account-examples.xml b/opendj-server-legacy/src/main/docbkx/man-pages/manage-account-examples.xml
new file mode 100644
index 0000000..9f33021
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/manage-account-examples.xml
@@ -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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/manage-tasks-examples.xml b/opendj-server-legacy/src/main/docbkx/man-pages/manage-tasks-examples.xml
new file mode 100644
index 0000000..c1e34e1
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/manage-tasks-examples.xml
@@ -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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/rebuild-index-examples.xml b/opendj-server-legacy/src/main/docbkx/man-pages/rebuild-index-examples.xml
new file mode 100644
index 0000000..89c6379
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/rebuild-index-examples.xml
@@ -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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/restore-examples.xml b/opendj-server-legacy/src/main/docbkx/man-pages/restore-examples.xml
new file mode 100644
index 0000000..45a3cd5
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/restore-examples.xml
@@ -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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/setup-examples.xml b/opendj-server-legacy/src/main/docbkx/man-pages/setup-examples.xml
new file mode 100644
index 0000000..9651c3e
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/setup-examples.xml
@@ -0,0 +1,56 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ! CCPL HEADER START
+ !
+ ! This work is licensed under the Creative Commons
+ ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
+ ! To view a copy of this license, visit
+ ! http://creativecommons.org/licenses/by-nc-nd/3.0/
+ ! or send a letter to Creative Commons, 444 Castro Street,
+ ! Suite 900, Mountain View, California, 94041, USA.
+ !
+ ! You can also obtain a copy of the license at
+ ! 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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/start-ds-examples.xml b/opendj-server-legacy/src/main/docbkx/man-pages/start-ds-examples.xml
new file mode 100644
index 0000000..ac75d29
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/start-ds-examples.xml
@@ -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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/status-examples.xml b/opendj-server-legacy/src/main/docbkx/man-pages/status-examples.xml
new file mode 100644
index 0000000..dea2244
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/status-examples.xml
@@ -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: <not available>
+
+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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/stop-ds-examples.xml b/opendj-server-legacy/src/main/docbkx/man-pages/stop-ds-examples.xml
new file mode 100644
index 0000000..7c994c6
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/stop-ds-examples.xml
@@ -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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/uninstall-examples.xml b/opendj-server-legacy/src/main/docbkx/man-pages/uninstall-examples.xml
new file mode 100644
index 0000000..6f960e3
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/uninstall-examples.xml
@@ -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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/upgrade-exit-codes.xml b/opendj-server-legacy/src/main/docbkx/man-pages/upgrade-exit-codes.xml
new file mode 100644
index 0000000..5819e50
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/upgrade-exit-codes.xml
@@ -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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/verify-index-examples.xml b/opendj-server-legacy/src/main/docbkx/man-pages/verify-index-examples.xml
new file mode 100644
index 0000000..c866e24
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/verify-index-examples.xml
@@ -0,0 +1,59 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ! CCPL HEADER START
+ !
+ ! This work is licensed under the Creative Commons
+ ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
+ ! To view a copy of this license, visit
+ ! http://creativecommons.org/licenses/by-nc-nd/3.0/
+ ! or send a letter to Creative Commons, 444 Castro Street,
+ ! Suite 900, Mountain View, California, 94041, USA.
+ !
+ ! You can also obtain a copy of the license at
+ ! trunk/opendj/legal-notices/CC-BY-NC-ND.txt.
+ ! See the License for the specific language governing permissions
+ ! and limitations under the License.
+ !
+ ! If applicable, add the following below this CCPL HEADER, with the fields
+ ! enclosed by brackets "[]" replaced with your own identifying information:
+ ! Portions Copyright [yyyy] [name of copyright owner]
+ !
+ ! CCPL HEADER END
+ !
+ ! Copyright 2015 ForgeRock AS.
+ !
+-->
+<refsect1 xmlns="http://docbook.org/ns/docbook"
+ version="5.0" xml:lang="en"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://docbook.org/ns/docbook
+ http://docbook.org/xml/5.0/xsd/docbook.xsd">
+ <title>Examples</title>
+
+ <para>
+ The following example 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>
diff --git a/opendj-server-legacy/src/main/docbkx/man-pages/verify-index-exit-codes.xml b/opendj-server-legacy/src/main/docbkx/man-pages/verify-index-exit-codes.xml
new file mode 100644
index 0000000..ad55075
--- /dev/null
+++ b/opendj-server-legacy/src/main/docbkx/man-pages/verify-index-exit-codes.xml
@@ -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>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/index.xml b/opendj-server-legacy/src/main/docbkx/reference/index.xml
index 86e4357..12aba85 100644
--- a/opendj-server-legacy/src/main/docbkx/reference/index.xml
+++ b/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" />
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-backup.xml b/opendj-server-legacy/src/main/docbkx/reference/man-backup.xml
deleted file mode 100644
index 3fd37c9..0000000
--- a/opendj-server-legacy/src/main/docbkx/reference/man-backup.xml
+++ /dev/null
@@ -1,367 +0,0 @@
-<?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/opendj3/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 2011-2014 ForgeRock AS
- !
--->
-<refentry xml:id='backup-1'
- 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'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
- <refmeta>
- <refentrytitle>backup</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>backup</refname>
- <refpurpose>back up OpenDJ directory data</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>backup</command>
- <arg choice="req">options</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to back up one or more directory server
- backends.</para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>-a, --backUpAll</option></term>
- <listitem>
- <para>Back up all backends in the server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-A, --hash</option></term>
- <listitem>
- <para>Generate a hash of the backup contents</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-B, --incrementalBaseID {backupID}</option></term>
- <listitem>
- <para>Backup ID of the source archive for an incremental backup.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-c, --compress</option></term>
- <listitem>
- <para>Compress the backup content</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-d, --backupDirectory {backupDir}</option></term>
- <listitem>
- <para>Path to the target directory for the backup file(s)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-i, --incremental</option></term>
- <listitem>
- <para>Perform an incremental backup rather than a full backup</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-I, --backupID {backupID}</option></term>
- <listitem>
- <para>Use the provided identifier for the backup</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-n, --backendID {backendName}</option></term>
- <listitem>
- <para>Backend ID for the backend to archive</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-s, --signHash</option></term>
- <listitem>
- <para>Sign the hash of the backup contents</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-y, --encrypt</option></term>
- <listitem>
- <para>Encrypt the backup contents</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <refsect2>
- <title>Task Backend Connection Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--connectTimeout {timeout}</option></term>
- <listitem>
- <para>Maximum length of time (in milliseconds) that can be taken to
- establish a connection. Use '0' to specify no time out.</para>
- <para>Default value: 30000</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-D, --bindDN {bindDN}</option></term>
- <listitem>
- <para>DN to use to bind to the server</para>
- <para>Default value: cn=Directory Manager</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-h, --hostname {host}</option></term>
- <listitem>
- <para>Directory server hostname or IP address</para>
- <para>Default value: localhost.localdomain</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>
- <listitem>
- <para>Bind password file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-K, --keyStorePath {keyStorePath}</option></term>
- <listitem>
- <para>Certificate key store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-N, --certNickname {nickname}</option></term>
- <listitem>
- <para>Nickname of certificate for SSL client authentication</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-o, --saslOption {name=value}</option></term>
- <listitem>
- <para>SASL bind options</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-p, --port {port}</option></term>
- <listitem>
- <para>Directory server administration port number</para>
- <para>Default value: 4444</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-P, --trustStorePath {trustStorePath}</option></term>
- <listitem>
- <para>Certificate trust store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-T, --trustStorePassword {trustStorePassword}</option></term>
- <listitem>
- <para>Certificate trust store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
- <listitem>
- <para>Certificate key store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-U, --trustStorePasswordFile {path}</option></term>
- <listitem>
- <para>Certificate trust store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-w, --bindPassword {bindPassword}</option></term>
- <listitem>
- <para>Password to use to bind to the server</para>
- <para>Use <option>-w -</option> to have the command prompt for the
- password, rather than enter the password on the command line.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
- <listitem>
- <para>Certificate key store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-X, --trustAll</option></term>
- <listitem>
- <para>Trust all server SSL certificates</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>Task Scheduling Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--completionNotify {emailAddress}</option></term>
- <listitem>
- <para>Email address of a recipient to be notified when the task
- completes. This option may be specified more than once.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--dependency {taskID}</option></term>
- <listitem>
- <para>ID of a task upon which this task depends. A task will not start
- execution until all its dependencies have completed execution.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--errorNotify {emailAddress}</option></term>
- <listitem>
- <para>Email address of a recipient to be notified if an error occurs
- when this task executes. This option may be specified more than
- once.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--failedDependencyAction {action}</option></term>
- <listitem>
- <para>Action this task will take should one if its dependent tasks fail.
- The value must be one of PROCESS, CANCEL, DISABLE. If not specified
- defaults to CANCEL.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--recurringTask {schedulePattern}</option></term>
- <listitem>
- <para>Indicates the task is recurring and will be scheduled according
- to the value argument expressed in crontab(5) compatible time/date
- pattern.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t, --start {startTime}</option></term>
- <listitem>
- <para>Indicates the date/time at which this operation will start when
- scheduled as a server task expressed in YYYYMMDDhhmmssZ format for UTC
- time or YYYYMMDDhhmmss for local time. A value of '0' will cause the
- task to be scheduled for immediate execution. When this option is
- specified the operation will be scheduled to start at the specified
- time after which this utility will exit immediately.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>Utility Input/Output Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--noPropertiesFile</option></term>
- <listitem>
- <para>No properties file will be used to get default command line
- argument values</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--propertiesFilePath {propertiesFilePath}</option></term>
- <listitem>
- <para>Path to the file containing default property values used for
- command line arguments</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>General Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-V, --version</option></term>
- <listitem>
- <para>Display version information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- </refsect1>
- <refsect1>
- <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 while parsing the command-line arguments.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <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 Jun 13, 2011 2:38:01 PM CEST</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>...
-[28/Sep/2012:12:14:22 +0200] ... msg=The backup process completed successfully</computeroutput>
-
-$ <userinput>start-ds</userinput>
-<computeroutput>[28/Sep/2012:12:15:48 +0200] ... The Directory Server has started successfully</computeroutput>
- </screen>
- </refsect1>
-</refentry>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-base64.xml b/opendj-server-legacy/src/main/docbkx/reference/man-base64.xml
deleted file mode 100644
index 6312a19..0000000
--- a/opendj-server-legacy/src/main/docbkx/reference/man-base64.xml
+++ /dev/null
@@ -1,175 +0,0 @@
-<?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/opendj3/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 2011-2014 ForgeRock AS
- !
--->
-<refentry xml:id='base64-1'
- 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'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
- <refmeta>
- <refentrytitle>base64</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>base64</refname>
- <refpurpose>encode and decode base64 strings</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>base64 <replaceable>subcommand</replaceable></command>
- <arg choice="req">options</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to encode and decode information using base64.</para>
- </refsect1>
- <refsect1>
- <title>Subcommands</title>
- <para>The following subcommands are supported.</para>
- <variablelist>
- <varlistentry>
- <term><command>base64 decode</command></term>
- <listitem>
- <para>Decode base64-encoded information into raw data</para>
- <para>When no options are specified, this subcommand reads from standard
- input and writes to standard output.</para>
- <variablelist>
- <title>Decode Options</title>
- <varlistentry>
- <term><option>-d, --encodedData {data}</option></term>
- <listitem>
- <para>The base64-encoded data to be decoded</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f, --encodedDataFile {path}</option></term>
- <listitem>
- <para>The path to a file containing the base64-encoded data to be
- decoded</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-o, --toRawFile {path}</option></term>
- <listitem>
- <para>The path to a file to which the raw base64-decoded data should be
- written</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>base64 encode</command></term>
- <listitem>
- <para>Encode raw data using base64</para>
- <para>When no options are specified, this subcommand reads from standard
- input and writes to standard output.</para>
- <variablelist>
- <title>Decode Options</title>
- <varlistentry>
- <term><option>-d, --rawData {data}</option></term>
- <listitem>
- <para>The raw data to be base64 encoded</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f, --rawDataFile {path}</option></term>
- <listitem>
- <para>The path to a file containing the raw data to be base64
- encoded</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-o, --toEncodedFile {path}</option></term>
- <listitem>
- <para>The path to a file to which the base64-encoded data should be
- written</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <title>General Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-V, --version</option></term>
- <listitem>
- <para>Display version information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <title>Exit Codes</title>
- <variablelist>
- <varlistentry>
- <term>0</term>
- <listitem>
- <para>The command completed successfully.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>> 0</term>
- <listitem>
- <para>An error occurred.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <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>
-</refentry>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-control-panel.xml b/opendj-server-legacy/src/main/docbkx/reference/man-control-panel.xml
deleted file mode 100644
index 3cf4b1b..0000000
--- a/opendj-server-legacy/src/main/docbkx/reference/man-control-panel.xml
+++ /dev/null
@@ -1,160 +0,0 @@
-<?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/opendj3/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 2011-2014 ForgeRock AS
- !
--->
-<refentry xml:id='control-panel-1'
- 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'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
- <refmeta>
- <refentrytitle>control-panel</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>control-panel</refname>
- <refpurpose>start the OpenDJ graphical admin interface</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>control-panel</command>
- <arg choice="req">options</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to display the Control Panel window which
- displays basic server information and allows to do some basic administration
- tasks on the server.</para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>-r, --remote</option></term>
- <listitem>
- <para>Connect to a remote server</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <refsect2>
- <title>LDAP Connection Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--connectTimeout {timeout}</option></term>
- <listitem>
- <para>Maximum length of time (in milliseconds) that can be taken to
- establish a connection. Use '0' to specify no time out.</para>
- <para>Default value: 30000</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-D, --bindDN {bindDN}</option></term>
- <listitem>
- <para>DN to use to bind to the server</para>
- <para>Default value: cn=Directory Manager</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-h, --hostname {host}</option></term>
- <listitem>
- <para>Directory server hostname or IP address</para>
- <para>Default value: localhost.localdomain</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-j, --adminPasswordFile {bindPasswordFile}</option></term>
- <listitem>
- <para>Global administrator password file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-p, --port {port}</option></term>
- <listitem>
- <para>Directory server administration port number</para>
- <para>Default value: 4444</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-w, --adminPassword {bindPassword}</option></term>
- <listitem>
- <para>Password for the global administrator</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-X, --trustAll</option></term>
- <listitem>
- <para>Trust all server SSL certificates</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>General Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--version</option></term>
- <listitem>
- <para>Display version information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- </refsect1>
- <refsect1>
- <title>Exit Codes</title>
- <variablelist>
- <varlistentry>
- <term>0</term>
- <listitem>
- <para>The command completed successfully.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>> 0</term>
- <listitem>
- <para>An error occurred.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <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 &</userinput>
- </screen>
- </refsect1>
-</refentry>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-create-rc-script.xml b/opendj-server-legacy/src/main/docbkx/reference/man-create-rc-script.xml
deleted file mode 100644
index 89591a6..0000000
--- a/opendj-server-legacy/src/main/docbkx/reference/man-create-rc-script.xml
+++ /dev/null
@@ -1,132 +0,0 @@
-<?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/opendj3/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 2011-2014 ForgeRock AS
- !
--->
-<refentry xml:id='create-rc-script-1'
- 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'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
- <refmeta>
- <refentrytitle>create-rc-script</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>create-rc-script</refname>
- <refpurpose>script to manage OpenDJ as a service on UNIX</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>create-rc-script</command>
- <arg choice="req">options</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>Create an RC script that may be used to start, stop, and restart
- the directory server on UNIX-based systems.</para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>-f, --outputFile {path}</option></term>
- <listitem>
- <para>The path to the output file to create.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-j, --javaHome {path}</option></term>
- <listitem>
- <para>The path to the Java installation that should be used to run
- the server.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-J, --javaArgs {args}</option></term>
- <listitem>
- <para>A set of arguments that should be passed to the JVM when running
- the server.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-u, --userName {userName}</option></term>
- <listitem>
- <para>The name of the user account under which the server should
- run.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <refsect2>
- <title>General Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--version</option></term>
- <listitem>
- <para>Display version information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- </refsect1>
- <refsect1>
- <title>Exit Codes</title>
- <variablelist>
- <varlistentry>
- <term>0</term>
- <listitem>
- <para>The command completed successfully.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>> 0</term>
- <listitem>
- <para>An error occurred.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <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 mark</userinput>
-$ <userinput>sudo update-rc.d opendj</userinput>
- </screen>
-
- </refsect1>
-</refentry>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-dbtest.xml b/opendj-server-legacy/src/main/docbkx/reference/man-dbtest.xml
deleted file mode 100644
index 75d15f6..0000000
--- a/opendj-server-legacy/src/main/docbkx/reference/man-dbtest.xml
+++ /dev/null
@@ -1,275 +0,0 @@
-<?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/opendj3/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 2011-2015 ForgeRock AS.
- !
--->
-<refentry xml:id='dbtest-1'
- 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'>
- <info><copyright><year>2011-2015</year><holder>ForgeRock AS.</holder></copyright></info>
- <refmeta>
- <refentrytitle>dbtest</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>dbtest</refname>
- <refpurpose>gather <literal>local-db</literal> backend database debug info</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>dbtest <replaceable>subcommand</replaceable></command> <arg>options</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to debug a <literal>local-db</literal> backend database.</para>
- </refsect1>
- <refsect1>
- <title>Subcommands</title>
- <para>The following subcommands are supported.</para>
- <variablelist>
- <varlistentry>
- <term><command>dbtest dump-database-container</command></term>
- <listitem>
- <para>Dump records from a database container</para>
-
- <para>
- Depending on database size, this subcommand can generate lots of output.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>dbtest list-database-containers</command></term>
- <listitem>
- <para>List the database containers for an entry container</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>dbtest list-entry-containers</command></term>
- <listitem>
- <para>List the entry containers for a root container</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>dbtest list-index-status</command></term>
- <listitem>
- <para>List the status of indexes in an entry container</para>
-
- <para>
- This command can take a long time to complete,
- as it reads all indexes for all backends.
- </para>
-
- <para>
- When you list index status, the result is a table,
- followed by a "Total", which is the total number of indexes,
- followed by a list of indexes with "Undefined keys" to show
- the values for which the number of entries exceeded the index entry limit.
- The table has the following columns.
- </para>
-
- <variablelist>
- <varlistentry>
- <term>Index Name</term>
- <listitem>
- <para>
- Name of the index,
- which takes the form <replaceable>attr.type</replaceable>
- for attribute indexes,
- and vlv.<replaceable>name</replaceable> for VLV indexes.
- Some indexes are for OpenDJ directory server's internal use.
- </para>
-
- <para>
- Example: <literal>givenName.substring</literal>
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>Index Type</term>
- <listitem>
- <para>
- Type of the index,
- which is <literal>Index</literal> for attribute indexes,
- and <literal>VLVIndex</literal> for VLV indexes.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>JE Database Name</term>
- <listitem>
- <para>
- Name of the <literal>local-db</literal> database,
- which reflects how OpenDJ directory server
- organizes the data in the database.
- </para>
-
- <para>
- Example: <literal>dc_example_dc_com_givenName.substring</literal>
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>Index Valid</term>
- <listitem>
- <para>
- This is <literal>true</literal> for valid indexes.
- If this is <literal>false</literal>,
- the index might be degraded.
- Verify the index, and rebuild the index if necessary.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>Record Count</term>
- <listitem>
- <para>
- Number of indexed keys.
- Use the <command>dbtest dump-database-container</command> command
- to see how many entry IDs correspond to each key.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>Undefined</term>
- <listitem>
- <para>
- Number of keys for which there are too many values
- to maintain an index, based on the index entry limit.
- This is recorded as <literal>-</literal> for VLV indexes.
- </para>
-
- <para>
- In other words, with the default index entry limit of 4000,
- if every user in your large directory has a mail address
- ending in <literal>@example.com</literal>,
- and a substring index is maintained for <literal>mail</literal>,
- then OpenDJ directory server does not maintain indexes for
- keys corresponding to substrings in <literal>@example.com</literal>.
- </para>
-
- <para>
- As a result, an LDAP search with the filter
- <literal>"(mail=*@example.com)"</literal> becomes an unindexed search
- even though a substring index exists for the mail attribute.
- By default OpenDJ directory server does not allow unindexed searches
- except by privileged users.
- This is usually exactly the behavior you want
- in order to prevent client applications for example
- from sending searches that return every user in the directory.
- Clients should refine their search filters instead.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term>95%, 90%, 85%</term>
- <listitem>
- <para>
- Number of keys for which the number of values is approaching
- the index entry limit, having reached the specified percentage.
- This is a measure of how full the entry ID lists are.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>dbtest list-root-containers</command></term>
- <listitem>
- <para>List the root containers used by all <literal>local-db</literal> backends</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following global options are supported.</para>
- <para>For other options, see <command>dbtest
- <replaceable>subcommand</replaceable> --help</command>.</para>
- <variablelist>
- <varlistentry>
- <term><option>--version</option></term>
- <listitem>
- <para>Display version information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <title>Exit Codes</title>
- <variablelist>
- <varlistentry>
- <term>0</term>
- <listitem>
- <para>The command completed successfully.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>> 0</term>
- <listitem>
- <para>An error occurred.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <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>
-</refentry>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-dsconfig.xml b/opendj-server-legacy/src/main/docbkx/reference/man-dsconfig.xml
deleted file mode 100644
index 21756bf..0000000
--- a/opendj-server-legacy/src/main/docbkx/reference/man-dsconfig.xml
+++ /dev/null
@@ -1,5627 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- ! CCPL HEADER START
- !
- ! This work is licensed under the Creative Commons
- ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
- ! To view a copy of this license, visit
- ! http://creativecommons.org/licenses/by-nc-nd/3.0/
- ! or send a letter to Creative Commons, 444 Castro Street,
- ! Suite 900, Mountain View, California, 94041, USA.
- !
- ! You can also obtain a copy of the license at legal-notices/CC-BY-NC-ND.txt.
- ! See the License for the specific language governing permissions
- ! and limitations under the License.
- !
- ! If applicable, add the following below this CCPL HEADER, with the fields
- ! enclosed by brackets "[]" replaced with your own identifying information:
- ! Portions Copyright [yyyy] [name of copyright owner]
- !
- ! CCPL HEADER END
- !
- ! Copyright 2011-2015 ForgeRock AS.
- !
--->
-<refentry xml:id='dsconfig-1'
- 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'>
- <info><copyright><year>2011-2015</year><holder>ForgeRock AS.</holder></copyright></info>
- <refmeta>
- <refentrytitle>dsconfig</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>dsconfig</refname>
- <refpurpose>manage OpenDJ directory server configuration</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>dsconfig [<replaceable>subcommand</replaceable>]</command>
- <arg choice="opt">options</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility serves to configure a running directory server.</para>
-
- <para>The <command>dsconfig</command> command is the primary command-line tool
- for viewing and editing OpenDJ configuration. When started without arguments,
- <command>dsconfig</command> prompts you for administration connection
- information, including the host name, administration port number,
- administrator bind DN and administrator password. The
- <command>dsconfig</command> command then connects securely to the directory
- server over the administration port. Once connected it presents you with a
- menu-driven interface to the server configuration.</para>
-
- <para>When you pass connection information, subcommands, and additional
- options to <command>dsconfig</command>, the command runs in script mode and
- so is not interactive, though it can prompt you to ask whether to apply
- changes and whether to trust certificates (unless you use the
- <option>--no-prompt</option> and <option>--trustAll</option> options,
- respectively).</para>
-
- <para>You can prepare <command>dsconfig</command> batch scripts by running
- the tool with the <option>--commandFilePath</option> option in interactive
- mode, then reading from the batch file with the <option>--batchFile</option>
- option in script mode. Batch files can be useful when you have many
- <command>dsconfig</command> commands to run and want to avoid starting
- the JVM and setting up a new connection for each command.</para>
-
- <para>The <command>dsconfig</command> command categorizes directory server
- configuration into <firstterm>components</firstterm>, also called
- <firstterm>managed objects</firstterm>. Actual components often inherit from
- a parent component type. For example, one component is a Connection Handler.
- An LDAP Connection Handler is a type of Connection Handler. You configure the
- LDAP Connection Handler component to specify how OpenDJ directory server
- handles LDAP connections coming from client applications.</para>
-
- <para>Configuration components have <firstterm>properties</firstterm>.
- For example, the LDAP Connection Handler component has properties such as
- <literal>listen-port</literal> and <literal>allow-start-tls</literal>. You
- can set the component's <literal>listen-port</literal> property to
- <literal>389</literal> to use the default LDAP port number. You can set the
- component's <literal>allow-start-tls</literal> property to
- <literal>true</literal> to permit LDAP client applications to use StartTLS.
- Much of the configuration you do with <command>dsconfig</command> involves
- setting component properties. The <link xlink:show="new"
- xlink:href="${configRefBase}"
- ><citetitle>OpenDJ Configuration Reference</citetitle></link> covers all
- <command>dsconfig</command> component properties in detail, drawing on the
- documentation you also view when getting help through the
- <command>dsconfig</command> command.</para>
- </refsect1>
- <refsect1 xml:id="dsconfig-getting-help">
- <title>Getting Help</title>
-
- <para>The <command>dsconfig</command> command provides many subcommands.
- Use the following options to view help for subcommands.</para>
-
- <para>See <link linkend="dsconfig-subcommands-ref"><citetitle>dsconfig
- Subcommands</citetitle></link> for details of individual subcommands.</para>
-
- <variablelist>
- <varlistentry>
- <term><command>dsconfig --help-all</command></term>
- <listitem>
- <para>Display all subcommands</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>dsconfig --help-core-server</command></term>
- <listitem>
- <para>Display subcommands relating to core server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>dsconfig --help-database</command></term>
- <listitem>
- <para>Display subcommands relating to caching and back-ends</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>dsconfig --help-logging</command></term>
- <listitem>
- <para>Display subcommands relating to logging</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>dsconfig --help-replication</command></term>
- <listitem>
- <para>Display subcommands relating to replication</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>dsconfig --help-security</command></term>
- <listitem>
- <para>Display subcommands relating to authentication and authorization</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>dsconfig --help-user-management</command></term>
- <listitem>
- <para>Display subcommands relating to user management</para>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <para>For help with individual subcommands, either use <command>dsconfig
- <replaceable>subcommand</replaceable> --help</command>, or start
- <command>dsconfig</command> in interactive mode, without specifying a
- subcommand.</para>
-
- <para>To view component properties, use the <command>dsconfig
- list-properties</command> command.</para>
- </refsect1>
- <refsect1 xml:id="dsconfig-general-options">
- <title>Generally Applicable Options</title>
- <para>The following options are supported for all <command>dsconfig</command>
- subcommands.</para>
- <variablelist>
- <varlistentry>
- <term><option>--advanced</option></term>
- <listitem>
- <para>Allows the configuration of advanced components and properties</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <refsect2>
- <title>LDAP Connection Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--connectTimeout {timeout}</option></term>
- <listitem>
- <para>Maximum length of time (in milliseconds) that can be taken to
- establish a connection. Use '0' to specify no time out.</para>
- <para>Default value: 30000</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-h, --hostname {host}</option></term>
- <listitem>
- <para>Directory server hostname or IP address</para>
- <para>Default value: localhost.localdomain</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-I, --adminUID {adminUID}</option></term>
- <listitem>
- <para>User ID of the global administrator to use to bind to the server.
- For the <command>enable</command> subcommand, if no global administrator
- was defined previously for any servers, the global administrator will be
- created using the UID provided.</para>
- <para>Default value: admin</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-j, --adminPasswordFile {bindPasswordFile}</option></term>
- <listitem>
- <para>Global administrator password file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-K, --keyStorePath {keyStorePath}</option></term>
- <listitem>
- <para> Certificate key store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-N, --certNickname {nickname}</option></term>
- <listitem>
- <para>Nickname of certificate for SSL client authentication</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-o, --saslOption {name=value}</option></term>
- <listitem>
- <para>SASL bind options</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-p, --port {port}</option></term>
- <listitem>
- <para>Directory server administration port number</para>
- <para>Default value: 4444</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-P, --trustStorePath {trustStorePath}</option></term>
- <listitem>
- <para>Certificate trust store path</para>
- <para>Default value: /path/to/opendj/config/admin-truststore</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-T, --trustStorePassword {trustStorePassword}</option></term>
- <listitem>
- <para>Certificate trust store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
- <listitem>
- <para>Certificate key store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-U, --trustStorePasswordFile {path}</option></term>
- <listitem>
- <para>Certificate trust store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-w, --adminPassword {bindPassword}</option></term>
- <listitem>
- <para>Password for the global administrator</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
- <listitem>
- <para>Certificate key store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-X, --trustAll</option></term>
- <listitem>
- <para>Trust all server SSL certificates</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>Utility Input/Output Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--commandFilePath {path}</option></term>
- <listitem>
- <para>The full path to the file where the equivalent non-interactive
- commands will be written when this command is run in interactive
- mode.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--displayCommand</option></term>
- <listitem>
- <para>Display the equivalent non-interactive option on standard output
- when this command is run in interactive mode.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-F, --batchFilePath {batchFilePath}</option></term>
- <listitem>
- <para>Path to a batch file containing a set of dsconfig commands to be
- executed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-n, --no-prompt</option></term>
- <listitem>
- <para>Use non-interactive mode. If data in the command is missing, the
- user is not prompted and the command exits with an error.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--noPropertiesFile</option></term>
- <listitem>
- <para>No properties file will be used to get default command line
- argument values</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--propertiesFilePath {propertiesFilePath}</option></term>
- <listitem>
- <para>Path to the file containing default property values used for
- command line arguments</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-Q, --quiet</option></term>
- <listitem>
- <para>Do not write progress information to standard output</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-s, --script-friendly</option></term>
- <listitem>
- <para>Use script-friendly mode</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-v, --verbose</option></term>
- <listitem>
- <para>Use verbose mode</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>General Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--version</option></term>
- <listitem>
- <para>Display version information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- </refsect1>
- <refsect1 xml:id="dsconfig-subcommands-ref">
- <title>dsconfig Subcommands</title>
- <para>This section covers individual <command>dsconfig</command>
- subcommands.</para>
-
- <para>Subcommands let you create, list, and delete entire configuration
- components, and also let you get and set component properties. Subcommands
- therefore have names that reflect these five actions.</para>
- <itemizedlist>
- <listitem><para>create-<replaceable>component</replaceable></para></listitem>
- <listitem><para>list-<replaceable>component</replaceable>s</para></listitem>
- <listitem><para>delete-<replaceable>component</replaceable></para></listitem>
- <listitem><para>get-<replaceable>component</replaceable>-prop</para></listitem>
- <listitem><para>set-<replaceable>component</replaceable>-prop</para></listitem>
- </itemizedlist>
-
- <para>Here, <replaceable>component</replaceable> names correspond to the
- names of managed object types referred to as <link xlink:show="new"
- xlink:href="${configRefBase}ManagedObjectList.html"><citetitle
- >Components</citetitle></link> in the <citetitle>OpenDJ Configuration
- Reference</citetitle>, and that have no parent components. (In other words,
- only the names of components with no parents correspond to subcommands.)
- Subcommand <replaceable>component</replaceable> names are lower-case,
- hyphenated versions of the friendly names used in the <citetitle>OpenDJ
- Configuration Reference</citetitle>. When you act on an actual configuration
- component, you provide the name of the component as an option argument.</para>
-
- <itemizedlist>
- <para>For example, the Log Publisher component has these corresponding
- subcommands.</para>
- <listitem><para><command>create-log-publisher</command></para></listitem>
- <listitem><para><command>list-log-publishers</command></para></listitem>
- <listitem><para><command>delete-log-publisher</command></para></listitem>
- <listitem><para><command>get-log-publisher-prop</command></para></listitem>
- <listitem><para><command>set-log-publisher-prop</command></para></listitem>
- </itemizedlist>
-
- <para>When you create or delete Log Publisher components and when you get
- and set their configuration properties, you provide the name of the actual
- log publisher, which you can find by using the
- <command>list-log-publishers</command> subcommand.</para>
-
- <screen>
-$ <userinput>dsconfig \
- list-log-publishers \
- --hostname opendj.example.com \
- --port 4444 \
- --bindDN "cn=Directory Manager" \
- --bindPassword password \
- --trustAll</userinput>
-<computeroutput>
-Log Publisher : Type : enabled
-------------------------------:------------------------:--------
-File-Based Access Logger : file-based-access : true
-File-Based Audit Logger : file-based-audit : false
-File-Based Debug Logger : file-based-debug : false
-File-Based Error Logger : file-based-error : true
-File-Based HTTP Access Logger : file-based-http-access : false
-Replication Repair Logger : file-based-error : true</computeroutput>
-
-$ <userinput>dsconfig \
- get-log-publisher-prop \
- --publisher-name "File-Based Access Logger" \
- --property rotation-policy \
- --hostname opendj.example.com \
- --port 4444 \
- --bindDN "cn=Directory Manager" \
- --bindPassword password \
- --trustAll</userinput>
-<computeroutput>Property : Value(s)
-----------------:--------------------------------------------------------------
-rotation-policy : 24 Hours Time Limit Rotation Policy, Size Limit Rotation
- : Policy</computeroutput>
- </screen>
-
- <para>To find documentation for specific component properties, also see the
- <link xlink:show="new" xlink:href="${configRefBase}"><citetitle>OpenDJ
- Configuration Reference</citetitle></link>.</para>
-
- <para>Many subcommands let you set property values. Notice in the reference
- for the subcommands below that specific options are available for handling
- multi-valued properties. Whereas you can assign a single property value using
- the <option>--set</option> option, you assign multiple values to a
- multi-valued property using the <option>--add</option> option. You can reset
- the values of the multi-valued property using the <option>--reset</option>
- option.</para>
-
- <itemizedlist>
- <para>Some property values take a time duration. Durations are expressed
- as numbers followed by units. For example <literal>1 s</literal> means
- one second, and <literal>2 w</literal> means two weeks. Some durations
- have minimum granularity or maximum units, so you cannot necessary specify
- every duration in milliseconds or weeks for example. Some durations allow
- you to use a special value to mean unlimited. Units are specified as
- follows.</para>
- <listitem><para><literal>ms</literal>: milliseconds</para></listitem>
- <listitem><para><literal>s</literal>: seconds</para></listitem>
- <listitem><para><literal>m</literal>: minutes</para></listitem>
- <listitem><para><literal>h</literal>: hours</para></listitem>
- <listitem><para><literal>d</literal>: days</para></listitem>
- <listitem><para><literal>w</literal>: weeks</para></listitem>
- </itemizedlist>
-
- <!-- Pending https://bugster.forgerock.org/jira/browse/OPENDJ-386
- Automate generation of the following list of subcommands.
- Currently, there's a secret setting in dsconfig to produce the content.
- $ export OPENDJ_JAVA_ARGS="-Dorg.forgerock.opendj.gendoc=true"
- $ /path/to/opendj/bin/dsconfig -?
- -->
- <refsect2 xml:id="dsconfig-create-access-log-filtering-criteria">
- <title>dsconfig create-access-log-filtering-criteria</title>
- <para>Creates Access Log Filtering Criteria</para>
- <variablelist>
- <varlistentry>
- <term><option>--publisher-name {name}</option></term>
- <listitem>
- <para>The name of the Access Log Publisher</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--criteria-name {name}</option></term>
- <listitem>
- <para>The name of the new Access Log Filtering Criteria</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t | --type {type}</option></term>
- <listitem>
- <para>The type of Access Log Filtering Criteria which should be created (Default: generic). The value for TYPE can be one of: generic</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-create-account-status-notification-handler">
- <title>dsconfig create-account-status-notification-handler</title>
- <para>Creates Account Status Notification Handlers</para>
- <variablelist>
- <varlistentry>
- <term><option>--handler-name {name}</option></term>
- <listitem>
- <para>The name of the new Account Status Notification Handler</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t | --type {type}</option></term>
- <listitem>
- <para>The type of Account Status Notification Handler which should be created. The value for TYPE can be one of: custom | error-log | smtp</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-create-alert-handler">
- <title>dsconfig create-alert-handler</title>
- <para>Creates Alert Handlers</para>
- <variablelist>
- <varlistentry>
- <term><option>--handler-name {name}</option></term>
- <listitem>
- <para>The name of the new Alert Handler</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t | --type {type}</option></term>
- <listitem>
- <para>The type of Alert Handler which should be created. The value for TYPE can be one of: custom | jmx | smtp</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-create-attribute-syntax">
- <title>dsconfig create-attribute-syntax</title>
- <para>Creates Attribute Syntaxes</para>
- <variablelist>
- <varlistentry>
- <term><option>--syntax-name {name}</option></term>
- <listitem>
- <para>The name of the new Attribute Syntax</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t | --type {type}</option></term>
- <listitem>
- <para>The type of Attribute Syntax which should be created (Default: generic). The value for TYPE can be one of: attribute-type-description | certificate | country-string | directory-string | generic | jpeg | telephone-number</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-create-backend">
- <title>dsconfig create-backend</title>
- <para>Creates Backends</para>
- <variablelist>
- <varlistentry>
- <term><option>--backend-name {STRING}</option></term>
- <listitem>
- <para>The name of the new Backend which will also be used as the value of the "backend-id" property: Specifies a name to identify the associated backend.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t | --type {type}</option></term>
- <listitem>
- <para>The type of Backend which should be created. The value for TYPE can be one of: backup | config-file-handler | custom | ldif | local-db | memory | monitor | null | schema | task | trust-store</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-create-certificate-mapper">
- <title>dsconfig create-certificate-mapper</title>
- <para>Creates Certificate Mappers</para>
- <variablelist>
- <varlistentry>
- <term><option>--mapper-name {name}</option></term>
- <listitem>
- <para>The name of the new Certificate Mapper</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t | --type {type}</option></term>
- <listitem>
- <para>The type of Certificate Mapper which should be created. The value for TYPE can be one of: custom | fingerprint | subject-attribute-to-user-attribute | subject-dn-to-user-attribute | subject-equals-dn</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-create-connection-handler">
- <title>dsconfig create-connection-handler</title>
- <para>Creates Connection Handlers</para>
- <variablelist>
- <varlistentry>
- <term><option>--handler-name {name}</option></term>
- <listitem>
- <para>The name of the new Connection Handler</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t | --type {type}</option></term>
- <listitem>
- <para>The type of Connection Handler which should be created. The value for TYPE can be one of: custom | http | jmx | ldap | ldif | snmp</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-create-debug-target">
- <title>dsconfig create-debug-target</title>
- <para>Creates Debug Targets</para>
- <variablelist>
- <varlistentry>
- <term><option>--publisher-name {name}</option></term>
- <listitem>
- <para>The name of the Debug Log Publisher</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--target-name {STRING}</option></term>
- <listitem>
- <para>The name of the new Debug Target which will also be used as the value of the "debug-scope" property: Specifies the fully-qualified OpenDJ Java package, class, or method affected by the settings in this target definition. Use the number character (#) to separate the class name and the method name (that is, org.opends.server.core.DirectoryServer#startUp).</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t | --type {type}</option></term>
- <listitem>
- <para>The type of Debug Target which should be created (Default: generic). The value for TYPE can be one of: generic</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-create-entry-cache">
- <title>dsconfig create-entry-cache</title>
- <para>Creates Entry Caches</para>
- <variablelist>
- <varlistentry>
- <term><option>--cache-name {name}</option></term>
- <listitem>
- <para>The name of the new Entry Cache</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t | --type {type}</option></term>
- <listitem>
- <para>The type of Entry Cache which should be created. The value for TYPE can be one of: custom | fifo | file-system | soft-reference</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-create-extended-operation-handler">
- <title>dsconfig create-extended-operation-handler</title>
- <para>Creates Extended Operation Handlers</para>
- <variablelist>
- <varlistentry>
- <term><option>--handler-name {name}</option></term>
- <listitem>
- <para>The name of the new Extended Operation Handler</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t | --type {type}</option></term>
- <listitem>
- <para>The type of Extended Operation Handler which should be created. The value for TYPE can be one of: cancel | custom | get-connection-id | get-symmetric-key | password-modify | password-policy-state | start-tls | who-am-i</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-create-group-implementation">
- <title>dsconfig create-group-implementation</title>
- <para>Creates Group Implementations</para>
- <variablelist>
- <varlistentry>
- <term><option>--implementation-name {name}</option></term>
- <listitem>
- <para>The name of the new Group Implementation</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t | --type {type}</option></term>
- <listitem>
- <para>The type of Group Implementation which should be created. The value for TYPE can be one of: custom | dynamic | static | virtual-static</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-create-identity-mapper">
- <title>dsconfig create-identity-mapper</title>
- <para>Creates Identity Mappers</para>
- <variablelist>
- <varlistentry>
- <term><option>--mapper-name {name}</option></term>
- <listitem>
- <para>The name of the new Identity Mapper</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t | --type {type}</option></term>
- <listitem>
- <para>The type of Identity Mapper which should be created. The value for TYPE can be one of: custom | exact-match | regular-expression</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-create-key-manager-provider">
- <title>dsconfig create-key-manager-provider</title>
- <para>Creates Key Manager Providers</para>
- <variablelist>
- <varlistentry>
- <term><option>--provider-name {name}</option></term>
- <listitem>
- <para>The name of the new Key Manager Provider</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t | --type {type}</option></term>
- <listitem>
- <para>The type of Key Manager Provider which should be created. The value for TYPE can be one of: custom | file-based | pkcs11</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-create-local-db-index">
- <title>dsconfig create-local-db-index</title>
- <para>Creates Local DB Indexes</para>
- <variablelist>
- <varlistentry>
- <term><option>--backend-name {name}</option></term>
- <listitem>
- <para>The name of the Local DB Backend</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--index-name {OID}</option></term>
- <listitem>
- <para>The name of the new Local DB Index which will also be used as the value of the "attribute" property: Specifies the name of the attribute for which the index is to be maintained.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t | --type {type}</option></term>
- <listitem>
- <para>The type of Local DB Index which should be created (Default: generic). The value for TYPE can be one of: generic</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-create-local-db-vlv-index">
- <title>dsconfig create-local-db-vlv-index</title>
- <para>Creates Local DB VLV Indexes</para>
- <variablelist>
- <varlistentry>
- <term><option>--backend-name {name}</option></term>
- <listitem>
- <para>The name of the Local DB Backend</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--index-name {STRING}</option></term>
- <listitem>
- <para>The name of the new Local DB VLV Index which will also be used as the value of the "name" property: Specifies a unique name for this VLV index.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t | --type {type}</option></term>
- <listitem>
- <para>The type of Local DB VLV Index which should be created (Default: generic). The value for TYPE can be one of: generic</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-create-log-publisher">
- <title>dsconfig create-log-publisher</title>
- <para>Creates Log Publishers</para>
- <variablelist>
- <varlistentry>
- <term><option>--publisher-name {name}</option></term>
- <listitem>
- <para>The name of the new Log Publisher</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t | --type {type}</option></term>
- <listitem>
- <para>The type of Log Publisher which should be created. The value for TYPE can be one of: custom-access | custom-debug | custom-error | custom-http-access | file-based-access | file-based-audit | file-based-debug | file-based-error | file-based-http-access</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-create-log-retention-policy">
- <title>dsconfig create-log-retention-policy</title>
- <para>Creates Log Retention Policies</para>
- <variablelist>
- <varlistentry>
- <term><option>--policy-name {name}</option></term>
- <listitem>
- <para>The name of the new Log Retention Policy</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t | --type {type}</option></term>
- <listitem>
- <para>The type of Log Retention Policy which should be created. The value for TYPE can be one of: custom | file-count | free-disk-space | size-limit</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-create-log-rotation-policy">
- <title>dsconfig create-log-rotation-policy</title>
- <para>Creates Log Rotation Policies</para>
- <variablelist>
- <varlistentry>
- <term><option>--policy-name {name}</option></term>
- <listitem>
- <para>The name of the new Log Rotation Policy</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t | --type {type}</option></term>
- <listitem>
- <para>The type of Log Rotation Policy which should be created. The value for TYPE can be one of: custom | fixed-time | size-limit | time-limit</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-create-matching-rule">
- <title>dsconfig create-matching-rule</title>
- <para>Creates Matching Rules</para>
- <variablelist>
- <varlistentry>
- <term><option>--rule-name {name}</option></term>
- <listitem>
- <para>The name of the new Matching Rule</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t | --type {type}</option></term>
- <listitem>
- <para>The type of Matching Rule which should be created (Default: generic). The value for TYPE can be one of: collation | generic</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-create-monitor-provider">
- <title>dsconfig create-monitor-provider</title>
- <para>Creates Monitor Providers</para>
- <variablelist>
- <varlistentry>
- <term><option>--provider-name {name}</option></term>
- <listitem>
- <para>The name of the new Monitor Provider</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t | --type {type}</option></term>
- <listitem>
- <para>The type of Monitor Provider which should be created. The value for TYPE can be one of: client-connection | custom | entry-cache | memory-usage | stack-trace | system-info | version</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-create-password-generator">
- <title>dsconfig create-password-generator</title>
- <para>Creates Password Generators</para>
- <variablelist>
- <varlistentry>
- <term><option>--generator-name {name}</option></term>
- <listitem>
- <para>The name of the new Password Generator</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t | --type {type}</option></term>
- <listitem>
- <para>The type of Password Generator which should be created. The value for TYPE can be one of: custom | random</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-create-password-policy">
- <title>dsconfig create-password-policy</title>
- <para>Creates Authentication Policies</para>
- <variablelist>
- <varlistentry>
- <term><option>--policy-name {name}</option></term>
- <listitem>
- <para>The name of the new Authentication Policy</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t | --type {type}</option></term>
- <listitem>
- <para>The type of Authentication Policy which should be created. The value for TYPE can be one of: ldap-pass-through | password-policy</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-create-password-storage-scheme">
- <title>dsconfig create-password-storage-scheme</title>
- <para>Creates Password Storage Schemes</para>
- <variablelist>
- <varlistentry>
- <term><option>--scheme-name {name}</option></term>
- <listitem>
- <para>The name of the new Password Storage Scheme</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t | --type {type}</option></term>
- <listitem>
- <para>The type of Password Storage Scheme which should be created. The value for TYPE can be one of: aes | base64 | blowfish | clear | crypt | custom | md5 | pbkdf2 | pkcs5s2 | rc4 | salted-md5 | salted-sha1 | salted-sha256 | salted-sha384 | salted-sha512 | sha1 | triple-des</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-create-password-validator">
- <title>dsconfig create-password-validator</title>
- <para>Creates Password Validators</para>
- <variablelist>
- <varlistentry>
- <term><option>--validator-name {name}</option></term>
- <listitem>
- <para>The name of the new Password Validator</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t | --type {type}</option></term>
- <listitem>
- <para>The type of Password Validator which should be created. The value for TYPE can be one of: attribute-value | character-set | custom | dictionary | length-based | repeated-characters | similarity-based | unique-characters</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-create-plugin">
- <title>dsconfig create-plugin</title>
- <para>Creates Plugins</para>
- <variablelist>
- <varlistentry>
- <term><option>--plugin-name {name}</option></term>
- <listitem>
- <para>The name of the new Plugin</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t | --type {type}</option></term>
- <listitem>
- <para>The type of Plugin which should be created. The value for TYPE can be one of: attribute-cleanup | change-number-control | custom | entry-uuid | fractional-ldif-import | last-mod | ldap-attribute-description-list | password-policy-import | profiler | referential-integrity | samba-password | seven-bit-clean | unique-attribute</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-create-replication-domain">
- <title>dsconfig create-replication-domain</title>
- <para>Creates Replication Domains</para>
- <variablelist>
- <varlistentry>
- <term><option>--provider-name {name}</option></term>
- <listitem>
- <para>The name of the Replication Synchronization Provider</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--domain-name {name}</option></term>
- <listitem>
- <para>The name of the new Replication Domain</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t | --type {type}</option></term>
- <listitem>
- <para>The type of Replication Domain which should be created (Default: generic). The value for TYPE can be one of: generic</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-create-replication-server">
- <title>dsconfig create-replication-server</title>
- <para>Creates Replication Servers</para>
- <variablelist>
- <varlistentry>
- <term><option>--provider-name {name}</option></term>
- <listitem>
- <para>The name of the Replication Synchronization Provider</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t | --type {type}</option></term>
- <listitem>
- <para>The type of Replication Server which should be created (Default: generic). The value for TYPE can be one of: generic</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-create-sasl-mechanism-handler">
- <title>dsconfig create-sasl-mechanism-handler</title>
- <para>Creates SASL Mechanism Handlers</para>
- <variablelist>
- <varlistentry>
- <term><option>--handler-name {name}</option></term>
- <listitem>
- <para>The name of the new SASL Mechanism Handler</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t | --type {type}</option></term>
- <listitem>
- <para>The type of SASL Mechanism Handler which should be created. The value for TYPE can be one of: anonymous | cram-md5 | custom | digest-md5 | external | gssapi | plain</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-create-synchronization-provider">
- <title>dsconfig create-synchronization-provider</title>
- <para>Creates Synchronization Providers</para>
- <variablelist>
- <varlistentry>
- <term><option>--provider-name {name}</option></term>
- <listitem>
- <para>The name of the new Synchronization Provider</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t | --type {type}</option></term>
- <listitem>
- <para>The type of Synchronization Provider which should be created. The value for TYPE can be one of: custom | replication</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-create-trust-manager-provider">
- <title>dsconfig create-trust-manager-provider</title>
- <para>Creates Trust Manager Providers</para>
- <variablelist>
- <varlistentry>
- <term><option>--provider-name {name}</option></term>
- <listitem>
- <para>The name of the new Trust Manager Provider</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t | --type {type}</option></term>
- <listitem>
- <para>The type of Trust Manager Provider which should be created. The value for TYPE can be one of: blind | custom | file-based</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-create-virtual-attribute">
- <title>dsconfig create-virtual-attribute</title>
- <para>Creates Virtual Attributes</para>
- <variablelist>
- <varlistentry>
- <term><option>--name {name}</option></term>
- <listitem>
- <para>The name of the new Virtual Attribute</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t | --type {type}</option></term>
- <listitem>
- <para>The type of Virtual Attribute which should be created. The value for TYPE can be one of: collective-attribute-subentries | custom | entity-tag | entry-dn | entry-uuid | governing-structure-rule | has-subordinates | is-member-of | member | num-subordinates | password-expiration-time | password-policy-subentry | structural-object-class | subschema-subentry | user-defined</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-delete-access-log-filtering-criteria">
- <title>dsconfig delete-access-log-filtering-criteria</title>
- <para>Deletes Access Log Filtering Criteria</para>
- <variablelist>
- <varlistentry>
- <term><option>--publisher-name {name}</option></term>
- <listitem>
- <para>The name of the Access Log Publisher</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--criteria-name {name}</option></term>
- <listitem>
- <para>The name of the Access Log Filtering Criteria</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f | --force</option></term>
- <listitem>
- <para>Ignore non-existent Access Log Filtering Criteria</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-delete-account-status-notification-handler">
- <title>dsconfig delete-account-status-notification-handler</title>
- <para>Deletes Account Status Notification Handlers</para>
- <variablelist>
- <varlistentry>
- <term><option>--handler-name {name}</option></term>
- <listitem>
- <para>The name of the Account Status Notification Handler</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f | --force</option></term>
- <listitem>
- <para>Ignore non-existent Account Status Notification Handlers</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-delete-alert-handler">
- <title>dsconfig delete-alert-handler</title>
- <para>Deletes Alert Handlers</para>
- <variablelist>
- <varlistentry>
- <term><option>--handler-name {name}</option></term>
- <listitem>
- <para>The name of the Alert Handler</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f | --force</option></term>
- <listitem>
- <para>Ignore non-existent Alert Handlers</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-delete-attribute-syntax">
- <title>dsconfig delete-attribute-syntax</title>
- <para>Deletes Attribute Syntaxes</para>
- <variablelist>
- <varlistentry>
- <term><option>--syntax-name {name}</option></term>
- <listitem>
- <para>The name of the Attribute Syntax</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f | --force</option></term>
- <listitem>
- <para>Ignore non-existent Attribute Syntaxes</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-delete-backend">
- <title>dsconfig delete-backend</title>
- <para>Deletes Backends</para>
- <variablelist>
- <varlistentry>
- <term><option>--backend-name {name}</option></term>
- <listitem>
- <para>The name of the Backend</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f | --force</option></term>
- <listitem>
- <para>Ignore non-existent Backends</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-delete-certificate-mapper">
- <title>dsconfig delete-certificate-mapper</title>
- <para>Deletes Certificate Mappers</para>
- <variablelist>
- <varlistentry>
- <term><option>--mapper-name {name}</option></term>
- <listitem>
- <para>The name of the Certificate Mapper</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f | --force</option></term>
- <listitem>
- <para>Ignore non-existent Certificate Mappers</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-delete-connection-handler">
- <title>dsconfig delete-connection-handler</title>
- <para>Deletes Connection Handlers</para>
- <variablelist>
- <varlistentry>
- <term><option>--handler-name {name}</option></term>
- <listitem>
- <para>The name of the Connection Handler</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f | --force</option></term>
- <listitem>
- <para>Ignore non-existent Connection Handlers</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-delete-debug-target">
- <title>dsconfig delete-debug-target</title>
- <para>Deletes Debug Targets</para>
- <variablelist>
- <varlistentry>
- <term><option>--publisher-name {name}</option></term>
- <listitem>
- <para>The name of the Debug Log Publisher</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--target-name {name}</option></term>
- <listitem>
- <para>The name of the Debug Target</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f | --force</option></term>
- <listitem>
- <para>Ignore non-existent Debug Targets</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-delete-entry-cache">
- <title>dsconfig delete-entry-cache</title>
- <para>Deletes Entry Caches</para>
- <variablelist>
- <varlistentry>
- <term><option>--cache-name {name}</option></term>
- <listitem>
- <para>The name of the Entry Cache</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f | --force</option></term>
- <listitem>
- <para>Ignore non-existent Entry Caches</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-delete-extended-operation-handler">
- <title>dsconfig delete-extended-operation-handler</title>
- <para>Deletes Extended Operation Handlers</para>
- <variablelist>
- <varlistentry>
- <term><option>--handler-name {name}</option></term>
- <listitem>
- <para>The name of the Extended Operation Handler</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f | --force</option></term>
- <listitem>
- <para>Ignore non-existent Extended Operation Handlers</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-delete-group-implementation">
- <title>dsconfig delete-group-implementation</title>
- <para>Deletes Group Implementations</para>
- <variablelist>
- <varlistentry>
- <term><option>--implementation-name {name}</option></term>
- <listitem>
- <para>The name of the Group Implementation</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f | --force</option></term>
- <listitem>
- <para>Ignore non-existent Group Implementations</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-delete-identity-mapper">
- <title>dsconfig delete-identity-mapper</title>
- <para>Deletes Identity Mappers</para>
- <variablelist>
- <varlistentry>
- <term><option>--mapper-name {name}</option></term>
- <listitem>
- <para>The name of the Identity Mapper</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f | --force</option></term>
- <listitem>
- <para>Ignore non-existent Identity Mappers</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-delete-key-manager-provider">
- <title>dsconfig delete-key-manager-provider</title>
- <para>Deletes Key Manager Providers</para>
- <variablelist>
- <varlistentry>
- <term><option>--provider-name {name}</option></term>
- <listitem>
- <para>The name of the Key Manager Provider</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f | --force</option></term>
- <listitem>
- <para>Ignore non-existent Key Manager Providers</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-delete-local-db-index">
- <title>dsconfig delete-local-db-index</title>
- <para>Deletes Local DB Indexes</para>
- <variablelist>
- <varlistentry>
- <term><option>--backend-name {name}</option></term>
- <listitem>
- <para>The name of the Local DB Backend</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--index-name {name}</option></term>
- <listitem>
- <para>The name of the Local DB Index</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f | --force</option></term>
- <listitem>
- <para>Ignore non-existent Local DB Indexes</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-delete-local-db-vlv-index">
- <title>dsconfig delete-local-db-vlv-index</title>
- <para>Deletes Local DB VLV Indexes</para>
- <variablelist>
- <varlistentry>
- <term><option>--backend-name {name}</option></term>
- <listitem>
- <para>The name of the Local DB Backend</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--index-name {name}</option></term>
- <listitem>
- <para>The name of the Local DB VLV Index</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f | --force</option></term>
- <listitem>
- <para>Ignore non-existent Local DB VLV Indexes</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-delete-log-publisher">
- <title>dsconfig delete-log-publisher</title>
- <para>Deletes Log Publishers</para>
- <variablelist>
- <varlistentry>
- <term><option>--publisher-name {name}</option></term>
- <listitem>
- <para>The name of the Log Publisher</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f | --force</option></term>
- <listitem>
- <para>Ignore non-existent Log Publishers</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-delete-log-retention-policy">
- <title>dsconfig delete-log-retention-policy</title>
- <para>Deletes Log Retention Policies</para>
- <variablelist>
- <varlistentry>
- <term><option>--policy-name {name}</option></term>
- <listitem>
- <para>The name of the Log Retention Policy</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f | --force</option></term>
- <listitem>
- <para>Ignore non-existent Log Retention Policies</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-delete-log-rotation-policy">
- <title>dsconfig delete-log-rotation-policy</title>
- <para>Deletes Log Rotation Policies</para>
- <variablelist>
- <varlistentry>
- <term><option>--policy-name {name}</option></term>
- <listitem>
- <para>The name of the Log Rotation Policy</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f | --force</option></term>
- <listitem>
- <para>Ignore non-existent Log Rotation Policies</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-delete-matching-rule">
- <title>dsconfig delete-matching-rule</title>
- <para>Deletes Matching Rules</para>
- <variablelist>
- <varlistentry>
- <term><option>--rule-name {name}</option></term>
- <listitem>
- <para>The name of the Matching Rule</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f | --force</option></term>
- <listitem>
- <para>Ignore non-existent Matching Rules</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-delete-monitor-provider">
- <title>dsconfig delete-monitor-provider</title>
- <para>Deletes Monitor Providers</para>
- <variablelist>
- <varlistentry>
- <term><option>--provider-name {name}</option></term>
- <listitem>
- <para>The name of the Monitor Provider</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f | --force</option></term>
- <listitem>
- <para>Ignore non-existent Monitor Providers</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-delete-password-generator">
- <title>dsconfig delete-password-generator</title>
- <para>Deletes Password Generators</para>
- <variablelist>
- <varlistentry>
- <term><option>--generator-name {name}</option></term>
- <listitem>
- <para>The name of the Password Generator</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f | --force</option></term>
- <listitem>
- <para>Ignore non-existent Password Generators</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-delete-password-policy">
- <title>dsconfig delete-password-policy</title>
- <para>Deletes Authentication Policies</para>
- <variablelist>
- <varlistentry>
- <term><option>--policy-name {name}</option></term>
- <listitem>
- <para>The name of the Authentication Policy</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f | --force</option></term>
- <listitem>
- <para>Ignore non-existent Authentication Policies</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-delete-password-storage-scheme">
- <title>dsconfig delete-password-storage-scheme</title>
- <para>Deletes Password Storage Schemes</para>
- <variablelist>
- <varlistentry>
- <term><option>--scheme-name {name}</option></term>
- <listitem>
- <para>The name of the Password Storage Scheme</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f | --force</option></term>
- <listitem>
- <para>Ignore non-existent Password Storage Schemes</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-delete-password-validator">
- <title>dsconfig delete-password-validator</title>
- <para>Deletes Password Validators</para>
- <variablelist>
- <varlistentry>
- <term><option>--validator-name {name}</option></term>
- <listitem>
- <para>The name of the Password Validator</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f | --force</option></term>
- <listitem>
- <para>Ignore non-existent Password Validators</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-delete-plugin">
- <title>dsconfig delete-plugin</title>
- <para>Deletes Plugins</para>
- <variablelist>
- <varlistentry>
- <term><option>--plugin-name {name}</option></term>
- <listitem>
- <para>The name of the Plugin</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f | --force</option></term>
- <listitem>
- <para>Ignore non-existent Plugins</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-delete-replication-domain">
- <title>dsconfig delete-replication-domain</title>
- <para>Deletes Replication Domains</para>
- <variablelist>
- <varlistentry>
- <term><option>--provider-name {name}</option></term>
- <listitem>
- <para>The name of the Replication Synchronization Provider</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--domain-name {name}</option></term>
- <listitem>
- <para>The name of the Replication Domain</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f | --force</option></term>
- <listitem>
- <para>Ignore non-existent Replication Domains</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-delete-replication-server">
- <title>dsconfig delete-replication-server</title>
- <para>Deletes Replication Servers</para>
- <variablelist>
- <varlistentry>
- <term><option>--provider-name {name}</option></term>
- <listitem>
- <para>The name of the Replication Synchronization Provider</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f | --force</option></term>
- <listitem>
- <para>Ignore non-existent Replication Servers</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-delete-sasl-mechanism-handler">
- <title>dsconfig delete-sasl-mechanism-handler</title>
- <para>Deletes SASL Mechanism Handlers</para>
- <variablelist>
- <varlistentry>
- <term><option>--handler-name {name}</option></term>
- <listitem>
- <para>The name of the SASL Mechanism Handler</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f | --force</option></term>
- <listitem>
- <para>Ignore non-existent SASL Mechanism Handlers</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-delete-synchronization-provider">
- <title>dsconfig delete-synchronization-provider</title>
- <para>Deletes Synchronization Providers</para>
- <variablelist>
- <varlistentry>
- <term><option>--provider-name {name}</option></term>
- <listitem>
- <para>The name of the Synchronization Provider</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f | --force</option></term>
- <listitem>
- <para>Ignore non-existent Synchronization Providers</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-delete-trust-manager-provider">
- <title>dsconfig delete-trust-manager-provider</title>
- <para>Deletes Trust Manager Providers</para>
- <variablelist>
- <varlistentry>
- <term><option>--provider-name {name}</option></term>
- <listitem>
- <para>The name of the Trust Manager Provider</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f | --force</option></term>
- <listitem>
- <para>Ignore non-existent Trust Manager Providers</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-delete-virtual-attribute">
- <title>dsconfig delete-virtual-attribute</title>
- <para>Deletes Virtual Attributes</para>
- <variablelist>
- <varlistentry>
- <term><option>--name {name}</option></term>
- <listitem>
- <para>The name of the Virtual Attribute</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f | --force</option></term>
- <listitem>
- <para>Ignore non-existent Virtual Attributes</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-access-control-handler-prop">
- <title>dsconfig get-access-control-handler-prop</title>
- <para>Shows Access Control Handler properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-access-log-filtering-criteria-prop">
- <title>dsconfig get-access-log-filtering-criteria-prop</title>
- <para>Shows Access Log Filtering Criteria properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--publisher-name {name}</option></term>
- <listitem>
- <para>The name of the Access Log Publisher</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--criteria-name {name}</option></term>
- <listitem>
- <para>The name of the Access Log Filtering Criteria</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-account-status-notification-handler-prop">
- <title>dsconfig get-account-status-notification-handler-prop</title>
- <para>Shows Account Status Notification Handler properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--handler-name {name}</option></term>
- <listitem>
- <para>The name of the Account Status Notification Handler</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-administration-connector-prop">
- <title>dsconfig get-administration-connector-prop</title>
- <para>Shows Administration Connector properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-alert-handler-prop">
- <title>dsconfig get-alert-handler-prop</title>
- <para>Shows Alert Handler properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--handler-name {name}</option></term>
- <listitem>
- <para>The name of the Alert Handler</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-attribute-syntax-prop">
- <title>dsconfig get-attribute-syntax-prop</title>
- <para>Shows Attribute Syntax properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--syntax-name {name}</option></term>
- <listitem>
- <para>The name of the Attribute Syntax</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-backend-prop">
- <title>dsconfig get-backend-prop</title>
- <para>Shows Backend properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--backend-name {name}</option></term>
- <listitem>
- <para>The name of the Backend</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-certificate-mapper-prop">
- <title>dsconfig get-certificate-mapper-prop</title>
- <para>Shows Certificate Mapper properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--mapper-name {name}</option></term>
- <listitem>
- <para>The name of the Certificate Mapper</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-connection-handler-prop">
- <title>dsconfig get-connection-handler-prop</title>
- <para>Shows Connection Handler properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--handler-name {name}</option></term>
- <listitem>
- <para>The name of the Connection Handler</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-crypto-manager-prop">
- <title>dsconfig get-crypto-manager-prop</title>
- <para>Shows Crypto Manager properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-debug-target-prop">
- <title>dsconfig get-debug-target-prop</title>
- <para>Shows Debug Target properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--publisher-name {name}</option></term>
- <listitem>
- <para>The name of the Debug Log Publisher</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--target-name {name}</option></term>
- <listitem>
- <para>The name of the Debug Target</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-entry-cache-prop">
- <title>dsconfig get-entry-cache-prop</title>
- <para>Shows Entry Cache properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--cache-name {name}</option></term>
- <listitem>
- <para>The name of the Entry Cache</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-extended-operation-handler-prop">
- <title>dsconfig get-extended-operation-handler-prop</title>
- <para>Shows Extended Operation Handler properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--handler-name {name}</option></term>
- <listitem>
- <para>The name of the Extended Operation Handler</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-external-changelog-domain-prop">
- <title>dsconfig get-external-changelog-domain-prop</title>
- <para>Shows External Changelog Domain properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--provider-name {name}</option></term>
- <listitem>
- <para>The name of the Replication Synchronization Provider</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--domain-name {name}</option></term>
- <listitem>
- <para>The name of the Replication Domain</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-global-configuration-prop">
- <title>dsconfig get-global-configuration-prop</title>
- <para>Shows Global Configuration properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-group-implementation-prop">
- <title>dsconfig get-group-implementation-prop</title>
- <para>Shows Group Implementation properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--implementation-name {name}</option></term>
- <listitem>
- <para>The name of the Group Implementation</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-identity-mapper-prop">
- <title>dsconfig get-identity-mapper-prop</title>
- <para>Shows Identity Mapper properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--mapper-name {name}</option></term>
- <listitem>
- <para>The name of the Identity Mapper</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-key-manager-provider-prop">
- <title>dsconfig get-key-manager-provider-prop</title>
- <para>Shows Key Manager Provider properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--provider-name {name}</option></term>
- <listitem>
- <para>The name of the Key Manager Provider</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-local-db-index-prop">
- <title>dsconfig get-local-db-index-prop</title>
- <para>Shows Local DB Index properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--backend-name {name}</option></term>
- <listitem>
- <para>The name of the Local DB Backend</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--index-name {name}</option></term>
- <listitem>
- <para>The name of the Local DB Index</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-local-db-vlv-index-prop">
- <title>dsconfig get-local-db-vlv-index-prop</title>
- <para>Shows Local DB VLV Index properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--backend-name {name}</option></term>
- <listitem>
- <para>The name of the Local DB Backend</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--index-name {name}</option></term>
- <listitem>
- <para>The name of the Local DB VLV Index</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-log-publisher-prop">
- <title>dsconfig get-log-publisher-prop</title>
- <para>Shows Log Publisher properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--publisher-name {name}</option></term>
- <listitem>
- <para>The name of the Log Publisher</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-log-retention-policy-prop">
- <title>dsconfig get-log-retention-policy-prop</title>
- <para>Shows Log Retention Policy properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--policy-name {name}</option></term>
- <listitem>
- <para>The name of the Log Retention Policy</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-log-rotation-policy-prop">
- <title>dsconfig get-log-rotation-policy-prop</title>
- <para>Shows Log Rotation Policy properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--policy-name {name}</option></term>
- <listitem>
- <para>The name of the Log Rotation Policy</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-matching-rule-prop">
- <title>dsconfig get-matching-rule-prop</title>
- <para>Shows Matching Rule properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--rule-name {name}</option></term>
- <listitem>
- <para>The name of the Matching Rule</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-monitor-provider-prop">
- <title>dsconfig get-monitor-provider-prop</title>
- <para>Shows Monitor Provider properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--provider-name {name}</option></term>
- <listitem>
- <para>The name of the Monitor Provider</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-password-generator-prop">
- <title>dsconfig get-password-generator-prop</title>
- <para>Shows Password Generator properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--generator-name {name}</option></term>
- <listitem>
- <para>The name of the Password Generator</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-password-policy-prop">
- <title>dsconfig get-password-policy-prop</title>
- <para>Shows Authentication Policy properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--policy-name {name}</option></term>
- <listitem>
- <para>The name of the Authentication Policy</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-password-storage-scheme-prop">
- <title>dsconfig get-password-storage-scheme-prop</title>
- <para>Shows Password Storage Scheme properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--scheme-name {name}</option></term>
- <listitem>
- <para>The name of the Password Storage Scheme</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-password-validator-prop">
- <title>dsconfig get-password-validator-prop</title>
- <para>Shows Password Validator properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--validator-name {name}</option></term>
- <listitem>
- <para>The name of the Password Validator</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-plugin-prop">
- <title>dsconfig get-plugin-prop</title>
- <para>Shows Plugin properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--plugin-name {name}</option></term>
- <listitem>
- <para>The name of the Plugin</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-plugin-root-prop">
- <title>dsconfig get-plugin-root-prop</title>
- <para>Shows Plugin Root properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-replication-domain-prop">
- <title>dsconfig get-replication-domain-prop</title>
- <para>Shows Replication Domain properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--provider-name {name}</option></term>
- <listitem>
- <para>The name of the Replication Synchronization Provider</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--domain-name {name}</option></term>
- <listitem>
- <para>The name of the Replication Domain</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-replication-server-prop">
- <title>dsconfig get-replication-server-prop</title>
- <para>Shows Replication Server properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--provider-name {name}</option></term>
- <listitem>
- <para>The name of the Replication Synchronization Provider</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-root-dn-prop">
- <title>dsconfig get-root-dn-prop</title>
- <para>Shows Root DN properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-root-dse-backend-prop">
- <title>dsconfig get-root-dse-backend-prop</title>
- <para>Shows Root DSE Backend properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-sasl-mechanism-handler-prop">
- <title>dsconfig get-sasl-mechanism-handler-prop</title>
- <para>Shows SASL Mechanism Handler properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--handler-name {name}</option></term>
- <listitem>
- <para>The name of the SASL Mechanism Handler</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-synchronization-provider-prop">
- <title>dsconfig get-synchronization-provider-prop</title>
- <para>Shows Synchronization Provider properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--provider-name {name}</option></term>
- <listitem>
- <para>The name of the Synchronization Provider</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-trust-manager-provider-prop">
- <title>dsconfig get-trust-manager-provider-prop</title>
- <para>Shows Trust Manager Provider properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--provider-name {name}</option></term>
- <listitem>
- <para>The name of the Trust Manager Provider</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-virtual-attribute-prop">
- <title>dsconfig get-virtual-attribute-prop</title>
- <para>Shows Virtual Attribute properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--name {name}</option></term>
- <listitem>
- <para>The name of the Virtual Attribute</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-get-work-queue-prop">
- <title>dsconfig get-work-queue-prop</title>
- <para>Shows Work Queue properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E | --record</option></term>
- <listitem>
- <para>Modifies the display output to show one property value per line</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-list-access-log-filtering-criteria">
- <title>dsconfig list-access-log-filtering-criteria</title>
- <para>Lists existing Access Log Filtering Criteria</para>
- <variablelist>
- <varlistentry>
- <term><option>--publisher-name {name}</option></term>
- <listitem>
- <para>The name of the Access Log Publisher</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-list-account-status-notification-handlers">
- <title>dsconfig list-account-status-notification-handlers</title>
- <para>Lists existing Account Status Notification Handlers</para>
- <variablelist>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-list-alert-handlers">
- <title>dsconfig list-alert-handlers</title>
- <para>Lists existing Alert Handlers</para>
- <variablelist>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-list-attribute-syntaxes">
- <title>dsconfig list-attribute-syntaxes</title>
- <para>Lists existing Attribute Syntaxes</para>
- <variablelist>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-list-backends">
- <title>dsconfig list-backends</title>
- <para>Lists existing Backends</para>
- <variablelist>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-list-certificate-mappers">
- <title>dsconfig list-certificate-mappers</title>
- <para>Lists existing Certificate Mappers</para>
- <variablelist>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-list-connection-handlers">
- <title>dsconfig list-connection-handlers</title>
- <para>Lists existing Connection Handlers</para>
- <variablelist>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-list-debug-targets">
- <title>dsconfig list-debug-targets</title>
- <para>Lists existing Debug Targets</para>
- <variablelist>
- <varlistentry>
- <term><option>--publisher-name {name}</option></term>
- <listitem>
- <para>The name of the Debug Log Publisher</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-list-entry-caches">
- <title>dsconfig list-entry-caches</title>
- <para>Lists existing Entry Caches</para>
- <variablelist>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-list-extended-operation-handlers">
- <title>dsconfig list-extended-operation-handlers</title>
- <para>Lists existing Extended Operation Handlers</para>
- <variablelist>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-list-group-implementations">
- <title>dsconfig list-group-implementations</title>
- <para>Lists existing Group Implementations</para>
- <variablelist>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-list-identity-mappers">
- <title>dsconfig list-identity-mappers</title>
- <para>Lists existing Identity Mappers</para>
- <variablelist>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-list-key-manager-providers">
- <title>dsconfig list-key-manager-providers</title>
- <para>Lists existing Key Manager Providers</para>
- <variablelist>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-list-local-db-indexes">
- <title>dsconfig list-local-db-indexes</title>
- <para>Lists existing Local DB Indexes</para>
- <variablelist>
- <varlistentry>
- <term><option>--backend-name {name}</option></term>
- <listitem>
- <para>The name of the Local DB Backend</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-list-local-db-vlv-indexes">
- <title>dsconfig list-local-db-vlv-indexes</title>
- <para>Lists existing Local DB VLV Indexes</para>
- <variablelist>
- <varlistentry>
- <term><option>--backend-name {name}</option></term>
- <listitem>
- <para>The name of the Local DB Backend</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-list-log-publishers">
- <title>dsconfig list-log-publishers</title>
- <para>Lists existing Log Publishers</para>
- <variablelist>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-list-log-retention-policies">
- <title>dsconfig list-log-retention-policies</title>
- <para>Lists existing Log Retention Policies</para>
- <variablelist>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-list-log-rotation-policies">
- <title>dsconfig list-log-rotation-policies</title>
- <para>Lists existing Log Rotation Policies</para>
- <variablelist>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-list-matching-rules">
- <title>dsconfig list-matching-rules</title>
- <para>Lists existing Matching Rules</para>
- <variablelist>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-list-monitor-providers">
- <title>dsconfig list-monitor-providers</title>
- <para>Lists existing Monitor Providers</para>
- <variablelist>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-list-password-generators">
- <title>dsconfig list-password-generators</title>
- <para>Lists existing Password Generators</para>
- <variablelist>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-list-password-policies">
- <title>dsconfig list-password-policies</title>
- <para>Lists existing Password Policies</para>
- <variablelist>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-list-password-storage-schemes">
- <title>dsconfig list-password-storage-schemes</title>
- <para>Lists existing Password Storage Schemes</para>
- <variablelist>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-list-password-validators">
- <title>dsconfig list-password-validators</title>
- <para>Lists existing Password Validators</para>
- <variablelist>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-list-plugins">
- <title>dsconfig list-plugins</title>
- <para>Lists existing Plugins</para>
- <variablelist>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-list-properties">
- <title>dsconfig list-properties</title>
- <para>Describes managed objects and their properties</para>
- <variablelist>
- <varlistentry>
- <term><option>-c | --category {category}</option></term>
- <listitem>
- <para>The category of components whose properties should be described</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t | --type {type}</option></term>
- <listitem>
- <para>The type of components whose properties should be described. The value for TYPE must be one of the component types associated with the CATEGORY specified using the "--category" option</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--inherited</option></term>
- <listitem>
- <para>Modifies the display output to show the inherited properties of components</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-list-replication-domains">
- <title>dsconfig list-replication-domains</title>
- <para>Lists existing Replication Domains</para>
- <variablelist>
- <varlistentry>
- <term><option>--provider-name {name}</option></term>
- <listitem>
- <para>The name of the Replication Synchronization Provider</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-list-replication-server">
- <title>dsconfig list-replication-server</title>
- <para>Lists existing Replication Server</para>
- <variablelist>
- <varlistentry>
- <term><option>--provider-name {name}</option></term>
- <listitem>
- <para>The name of the Replication Synchronization Provider</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-list-sasl-mechanism-handlers">
- <title>dsconfig list-sasl-mechanism-handlers</title>
- <para>Lists existing SASL Mechanism Handlers</para>
- <variablelist>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-list-synchronization-providers">
- <title>dsconfig list-synchronization-providers</title>
- <para>Lists existing Synchronization Providers</para>
- <variablelist>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-list-trust-manager-providers">
- <title>dsconfig list-trust-manager-providers</title>
- <para>Lists existing Trust Manager Providers</para>
- <variablelist>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-list-virtual-attributes">
- <title>dsconfig list-virtual-attributes</title>
- <para>Lists existing Virtual Attributes</para>
- <variablelist>
- <varlistentry>
- <term><option>--property {property}</option></term>
- <listitem>
- <para>The name of a property to be displayed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z | --unit-size {unit}</option></term>
- <listitem>
- <para>Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m | --unit-time {unit}</option></term>
- <listitem>
- <para>Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks)</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-access-control-handler-prop">
- <title>dsconfig set-access-control-handler-prop</title>
- <para>Modifies Access Control Handler properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-access-log-filtering-criteria-prop">
- <title>dsconfig set-access-log-filtering-criteria-prop</title>
- <para>Modifies Access Log Filtering Criteria properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--publisher-name {name}</option></term>
- <listitem>
- <para>The name of the Access Log Publisher</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--criteria-name {name}</option></term>
- <listitem>
- <para>The name of the Access Log Filtering Criteria</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-account-status-notification-handler-prop">
- <title>dsconfig set-account-status-notification-handler-prop</title>
- <para>Modifies Account Status Notification Handler properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--handler-name {name}</option></term>
- <listitem>
- <para>The name of the Account Status Notification Handler</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-administration-connector-prop">
- <title>dsconfig set-administration-connector-prop</title>
- <para>Modifies Administration Connector properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-alert-handler-prop">
- <title>dsconfig set-alert-handler-prop</title>
- <para>Modifies Alert Handler properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--handler-name {name}</option></term>
- <listitem>
- <para>The name of the Alert Handler</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-attribute-syntax-prop">
- <title>dsconfig set-attribute-syntax-prop</title>
- <para>Modifies Attribute Syntax properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--syntax-name {name}</option></term>
- <listitem>
- <para>The name of the Attribute Syntax</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-backend-prop">
- <title>dsconfig set-backend-prop</title>
- <para>Modifies Backend properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--backend-name {name}</option></term>
- <listitem>
- <para>The name of the Backend</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-certificate-mapper-prop">
- <title>dsconfig set-certificate-mapper-prop</title>
- <para>Modifies Certificate Mapper properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--mapper-name {name}</option></term>
- <listitem>
- <para>The name of the Certificate Mapper</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-connection-handler-prop">
- <title>dsconfig set-connection-handler-prop</title>
- <para>Modifies Connection Handler properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--handler-name {name}</option></term>
- <listitem>
- <para>The name of the Connection Handler</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-crypto-manager-prop">
- <title>dsconfig set-crypto-manager-prop</title>
- <para>Modifies Crypto Manager properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-debug-target-prop">
- <title>dsconfig set-debug-target-prop</title>
- <para>Modifies Debug Target properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--publisher-name {name}</option></term>
- <listitem>
- <para>The name of the Debug Log Publisher</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--target-name {name}</option></term>
- <listitem>
- <para>The name of the Debug Target</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-entry-cache-prop">
- <title>dsconfig set-entry-cache-prop</title>
- <para>Modifies Entry Cache properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--cache-name {name}</option></term>
- <listitem>
- <para>The name of the Entry Cache</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-extended-operation-handler-prop">
- <title>dsconfig set-extended-operation-handler-prop</title>
- <para>Modifies Extended Operation Handler properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--handler-name {name}</option></term>
- <listitem>
- <para>The name of the Extended Operation Handler</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-external-changelog-domain-prop">
- <title>dsconfig set-external-changelog-domain-prop</title>
- <para>Modifies External Changelog Domain properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--provider-name {name}</option></term>
- <listitem>
- <para>The name of the Replication Synchronization Provider</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--domain-name {name}</option></term>
- <listitem>
- <para>The name of the Replication Domain</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-global-configuration-prop">
- <title>dsconfig set-global-configuration-prop</title>
- <para>Modifies Global Configuration properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-group-implementation-prop">
- <title>dsconfig set-group-implementation-prop</title>
- <para>Modifies Group Implementation properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--implementation-name {name}</option></term>
- <listitem>
- <para>The name of the Group Implementation</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-identity-mapper-prop">
- <title>dsconfig set-identity-mapper-prop</title>
- <para>Modifies Identity Mapper properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--mapper-name {name}</option></term>
- <listitem>
- <para>The name of the Identity Mapper</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-key-manager-provider-prop">
- <title>dsconfig set-key-manager-provider-prop</title>
- <para>Modifies Key Manager Provider properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--provider-name {name}</option></term>
- <listitem>
- <para>The name of the Key Manager Provider</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-local-db-index-prop">
- <title>dsconfig set-local-db-index-prop</title>
- <para>Modifies Local DB Index properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--backend-name {name}</option></term>
- <listitem>
- <para>The name of the Local DB Backend</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--index-name {name}</option></term>
- <listitem>
- <para>The name of the Local DB Index</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-local-db-vlv-index-prop">
- <title>dsconfig set-local-db-vlv-index-prop</title>
- <para>Modifies Local DB VLV Index properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--backend-name {name}</option></term>
- <listitem>
- <para>The name of the Local DB Backend</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--index-name {name}</option></term>
- <listitem>
- <para>The name of the Local DB VLV Index</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-log-publisher-prop">
- <title>dsconfig set-log-publisher-prop</title>
- <para>Modifies Log Publisher properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--publisher-name {name}</option></term>
- <listitem>
- <para>The name of the Log Publisher</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-log-retention-policy-prop">
- <title>dsconfig set-log-retention-policy-prop</title>
- <para>Modifies Log Retention Policy properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--policy-name {name}</option></term>
- <listitem>
- <para>The name of the Log Retention Policy</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-log-rotation-policy-prop">
- <title>dsconfig set-log-rotation-policy-prop</title>
- <para>Modifies Log Rotation Policy properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--policy-name {name}</option></term>
- <listitem>
- <para>The name of the Log Rotation Policy</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-matching-rule-prop">
- <title>dsconfig set-matching-rule-prop</title>
- <para>Modifies Matching Rule properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--rule-name {name}</option></term>
- <listitem>
- <para>The name of the Matching Rule</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-monitor-provider-prop">
- <title>dsconfig set-monitor-provider-prop</title>
- <para>Modifies Monitor Provider properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--provider-name {name}</option></term>
- <listitem>
- <para>The name of the Monitor Provider</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-password-generator-prop">
- <title>dsconfig set-password-generator-prop</title>
- <para>Modifies Password Generator properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--generator-name {name}</option></term>
- <listitem>
- <para>The name of the Password Generator</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-password-policy-prop">
- <title>dsconfig set-password-policy-prop</title>
- <para>Modifies Authentication Policy properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--policy-name {name}</option></term>
- <listitem>
- <para>The name of the Authentication Policy</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-password-storage-scheme-prop">
- <title>dsconfig set-password-storage-scheme-prop</title>
- <para>Modifies Password Storage Scheme properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--scheme-name {name}</option></term>
- <listitem>
- <para>The name of the Password Storage Scheme</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-password-validator-prop">
- <title>dsconfig set-password-validator-prop</title>
- <para>Modifies Password Validator properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--validator-name {name}</option></term>
- <listitem>
- <para>The name of the Password Validator</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-plugin-prop">
- <title>dsconfig set-plugin-prop</title>
- <para>Modifies Plugin properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--plugin-name {name}</option></term>
- <listitem>
- <para>The name of the Plugin</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-plugin-root-prop">
- <title>dsconfig set-plugin-root-prop</title>
- <para>Modifies Plugin Root properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-replication-domain-prop">
- <title>dsconfig set-replication-domain-prop</title>
- <para>Modifies Replication Domain properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--provider-name {name}</option></term>
- <listitem>
- <para>The name of the Replication Synchronization Provider</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--domain-name {name}</option></term>
- <listitem>
- <para>The name of the Replication Domain</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-replication-server-prop">
- <title>dsconfig set-replication-server-prop</title>
- <para>Modifies Replication Server properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--provider-name {name}</option></term>
- <listitem>
- <para>The name of the Replication Synchronization Provider</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-root-dn-prop">
- <title>dsconfig set-root-dn-prop</title>
- <para>Modifies Root DN properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-root-dse-backend-prop">
- <title>dsconfig set-root-dse-backend-prop</title>
- <para>Modifies Root DSE Backend properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-sasl-mechanism-handler-prop">
- <title>dsconfig set-sasl-mechanism-handler-prop</title>
- <para>Modifies SASL Mechanism Handler properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--handler-name {name}</option></term>
- <listitem>
- <para>The name of the SASL Mechanism Handler</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-synchronization-provider-prop">
- <title>dsconfig set-synchronization-provider-prop</title>
- <para>Modifies Synchronization Provider properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--provider-name {name}</option></term>
- <listitem>
- <para>The name of the Synchronization Provider</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-trust-manager-provider-prop">
- <title>dsconfig set-trust-manager-provider-prop</title>
- <para>Modifies Trust Manager Provider properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--provider-name {name}</option></term>
- <listitem>
- <para>The name of the Trust Manager Provider</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-virtual-attribute-prop">
- <title>dsconfig set-virtual-attribute-prop</title>
- <para>Modifies Virtual Attribute properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--name {name}</option></term>
- <listitem>
- <para>The name of the Virtual Attribute</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
-<refsect2 xml:id="dsconfig-set-work-queue-prop">
- <title>dsconfig set-work-queue-prop</title>
- <para>Modifies Work Queue properties</para>
- <variablelist>
- <varlistentry>
- <term><option>--set {PROP:VALUE}</option></term>
- <listitem>
- <para>Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--reset {property}</option></term>
- <listitem>
- <para>Resets a property back to its default values where PROP is the name of the property to be reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--add {PROP:VALUE}</option></term>
- <listitem>
- <para>Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--remove {PROP:VALUE}</option></term>
- <listitem>
- <para>Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed</para>
- </listitem>
- </varlistentry>
- </variablelist>
-</refsect2>
- </refsect1>
- <refsect1>
- <title>Exit Codes</title>
- <variablelist>
- <varlistentry>
- <term>0</term>
- <listitem>
- <para>The command completed successfully.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>> 0</term>
- <listitem>
- <para>An error occurred.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <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 examples 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>
-</refentry>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-dsjavaproperties.xml b/opendj-server-legacy/src/main/docbkx/reference/man-dsjavaproperties.xml
deleted file mode 100644
index b8b7645..0000000
--- a/opendj-server-legacy/src/main/docbkx/reference/man-dsjavaproperties.xml
+++ /dev/null
@@ -1,116 +0,0 @@
-<?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/opendj3/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 2011-2014 ForgeRock AS
- !
--->
-<refentry xml:id='dsjavaproperties-1'
- 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'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
- <refmeta>
- <refentrytitle>dsjavaproperties</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>dsjavaproperties</refname>
- <refpurpose>apply OpenDJ Java home and JVM settings</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>dsjavaproperties</command>
- <arg choice="opt">options</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to change the Java arguments and Java home
- that are used by other server commands.</para>
- <para>Before launching the command, edit the properties file located in
- <filename>/path/to/opendj/config/java.properties</filename> to specify the
- Java arguments and Java home. When you have edited the properties file, run
- this command for the changes to be taken into account.</para>
- <para>Changes apply to the current server installation. No modifications
- are made to your environment variables.</para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>-Q, --quiet</option></term>
- <listitem>
- <para>Run the tool in quiet mode. Quiet mode will not output progress
- information to standard output.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-V, --version</option></term>
- <listitem>
- <para>Display version information.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <title>Files</title>
- <para>This command depends on the content of the
- <filename>config/java.properties</filename> file.</para>
- </refsect1>
- <refsect1>
- <title>Exit Codes</title>
- <variablelist>
- <varlistentry>
- <term>0</term>
- <listitem>
- <para>The command completed successfully.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>> 0</term>
- <listitem>
- <para>An error occurred.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
-
- <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>
-</refentry>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-dsreplication.xml b/opendj-server-legacy/src/main/docbkx/reference/man-dsreplication.xml
deleted file mode 100644
index 6b6acff..0000000
--- a/opendj-server-legacy/src/main/docbkx/reference/man-dsreplication.xml
+++ /dev/null
@@ -1,1066 +0,0 @@
-<?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/opendj3/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 2011-2014 ForgeRock AS
- !
--->
-<refentry xml:id='dsreplication-1'
- 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'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
- <refmeta>
- <refentrytitle>dsreplication</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>dsreplication</refname>
- <refpurpose>manage OpenDJ directory data replication</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>dsreplication</command>
- <command><replaceable>subcommand</replaceable></command>
- <arg>options</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to configure replication between servers so
- that the data of the servers is synchronized. For replication to work you
- must first enable replication using the <command>enable</command> subcommand
- and then initialize the contents of one of the servers with the contents of
- the other using the <command>initialize</command> subcommand.</para>
- </refsect1>
- <refsect1>
- <title>Global Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>--advanced</option></term>
- <listitem>
- <para>Access advanced settings when running this command in interactive
- mode.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-b, --baseDN {baseDN}</option></term>
- <listitem>
- <para>Base DN of the data to be replicated, initialized or for which you
- want to disable replication. Multiple base DNs can be provided by using
- this option multiple times.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <refsect2>
- <title>LDAP Connection Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--connectTimeout {timeout}</option></term>
- <listitem>
- <para>Maximum length of time (in milliseconds) that can be taken to
- establish a connection. Use '0' to specify no time out.</para>
- <para>Default value: 30000</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-h, --hostname {host}</option></term>
- <listitem>
- <para>Directory server hostname or IP address</para>
- <para>Default value: localhost.localdomain</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-I, --adminUID {adminUID}</option></term>
- <listitem>
- <para>User ID of the global administrator to use to bind to the server.
- For the <command>enable</command> subcommand, if no global administrator
- was defined previously for any servers, the global administrator will be
- created using the UID provided.</para>
- <para>Default value: admin</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-j, --adminPasswordFile {bindPasswordFile}</option></term>
- <listitem>
- <para>Global administrator password file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-K, --keyStorePath {keyStorePath}</option></term>
- <listitem>
- <para> Certificate key store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-N, --certNickname {nickname}</option></term>
- <listitem>
- <para>Nickname of certificate for SSL client authentication</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-o, --saslOption {name=value}</option></term>
- <listitem>
- <para>SASL bind options</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-p, --port {port}</option></term>
- <listitem>
- <para>Directory server administration port number</para>
- <para>Default value: 4444</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-P, --trustStorePath {trustStorePath}</option></term>
- <listitem>
- <para>Certificate trust store path</para>
- <para>Default value: /path/to/opendj/config/admin-truststore</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-T, --trustStorePassword {trustStorePassword}</option></term>
- <listitem>
- <para>Certificate trust store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
- <listitem>
- <para>Certificate key store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-U, --trustStorePasswordFile {path}</option></term>
- <listitem>
- <para>Certificate trust store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-w, --adminPassword {bindPassword}</option></term>
- <listitem>
- <para>Password for the global administrator</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
- <listitem>
- <para>Certificate key store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-X, --trustAll</option></term>
- <listitem>
- <para>Trust all server SSL certificates</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>Utility Input/Output Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--commandFilePath {path}</option></term>
- <listitem>
- <para>The full path to the file where the equivalent non-interactive
- commands will be written when this command is run in interactive
- mode.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--displayCommand</option></term>
- <listitem>
- <para>Display the equivalent non-interactive option on standard output
- when this command is run in interactive mode.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-n, --no-prompt</option></term>
- <listitem>
- <para>Use non-interactive mode. If data in the command is missing, the
- user is not prompted and the command exits with an error.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--noPropertiesFile</option></term>
- <listitem>
- <para>No properties file will be used to get default command line
- argument values</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--propertiesFilePath {propertiesFilePath}</option></term>
- <listitem>
- <para>Path to the file containing default property values used for
- command line arguments</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-Q, --quiet</option></term>
- <listitem>
- <para>Do not write progress information to standard output</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>General Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--version</option></term>
- <listitem>
- <para>Display version information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- </refsect1>
- <refsect1>
- <title>Exit Codes</title>
- <variablelist>
- <varlistentry>
- <term>0</term>
- <listitem>
- <para>The command completed successfully.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>> 0</term>
- <listitem>
- <para>An error occurred.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <title>Subcommands</title>
- <para>The following subcommands are supported.</para>
- <variablelist>
- <varlistentry>
- <term><command>disable</command></term>
- <listitem>
- <para>Disable replication on the specified server for the provided base
- DN and removes references in the other servers with which it is
- replicating data.</para>
-
- <variablelist>
- <title>Subcommand Options</title>
-
- <para>
- In addition to global options, these subcommand options are supported.
- </para>
-
- <varlistentry>
- <term><option>-a, --disableAll</option></term>
- <listitem>
- <para>
- Disable the replication configuration on the specified server. The
- contents of the server are no longer replicated and the replication server
- (changelog and replication port) is disabled if it is configured.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-D, --bindDN {bindDN}</option></term>
- <listitem>
- <para>
- DN to use to bind to the server where we want to disable replication. This
- option must be used when no Global Administrator has been defined on the
- server or if the user does not want to remove references in the other
- replicated servers. The password provided for the Global Administrator
- will be used when specifying this option.
- </para>
-
- <para>
- Default value: cn=Directory Manager
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--disableReplicationServer</option></term>
- <listitem>
- <para>
- Disable the replication server. The replication port and change log are
- disabled on the specified server.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-h, --hostname {host}</option></term>
- <listitem>
- <para>
- Directory server hostname or IP address
- </para>
-
- <para>
- Default value: <replaceable>configured-hostname</replaceable>
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-p, --port {port}</option></term>
- <listitem>
- <para>
- Directory server administration port number
- </para>
-
- <para>
- Default value: <replaceable>configured-admin-port</replaceable>
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>enable</command></term>
- <listitem>
- <para>Update the configuration of the servers to replicate the data
- under the specified base DN. If one of the specified servers is already
- replicating the data under the base DN with other servers, executing this
- subcommand will update the configuration of all the servers. Thus it is
- sufficient to execute the command line once for each server added to the
- replication topology.</para>
-
- <variablelist>
- <title>Subcommand Options</title>
-
- <para>
- In addition to global options, these subcommand options are supported.
- </para>
-
-
- <varlistentry>
- <term><option>-h, --host1 {host}</option></term>
- <listitem>
- <para>
- Fully qualified host name or IP address of the first server whose contents
- will be replicated.
- </para>
-
- <para>
- Default value: <replaceable>configured-hostname</replaceable>
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-p, --port1 {port}</option></term>
- <listitem>
- <para>
- Directory server administration port number of the first server whose
- contents will be replicated.
- </para>
-
- <para>
- Default value: <replaceable>configured-admin-port</replaceable>
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-D, --bindDN1 {bindDN}</option></term>
- <listitem>
- <para>
- DN to use to bind to the first server whose contents will be replicated.
- If not specified the global administrator will be used to bind.
- </para>
-
- <para>
- Default value: cn=Directory Manager
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--bindPassword1 {bindPassword}</option></term>
- <listitem>
- <para>
- Password to use to bind to the first server whose contents will be
- replicated. If no bind DN was specified for the first server the password
- of the global administrator will be used to bind.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--bindPasswordFile1 {bindPasswordFile}</option></term>
- <listitem>
- <para>
- File containing the password to use to bind to the first server whose
- contents will be replicated. If no bind DN was specified for the first
- server the password of the global administrator will be used to bind.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-r, --replicationPort1 {port}</option></term>
- <listitem>
- <para>
- Port that will be used by the replication mechanism in the first server to
- communicate with the other servers. You have to specify this option only
- if replication was not previously configured in the first server.
- </para>
-
- <para>
- Default value: 8989
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--secureReplication1</option></term>
- <listitem>
- <para>
- Specifies whether or not the communication through the replication port of
- the first server is encrypted or not. This option will only be taken into
- account the first time replication is configured on the first server.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--noReplicationServer1</option></term>
- <listitem>
- <para>
- Do not configure a replication port or change log on the first server. The
- first server will contain replicated data but will not contain a change log
- of modifications made to the replicated data. Note that each replicated
- topology must contain at least two servers with a change log to avoid a
- single point of failure.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--onlyReplicationServer1</option></term>
- <listitem>
- <para>
- Configure only a change log and replication port on the first server. The
- first server will not contain replicated data, but will contain a change
- log of the modifications made to the replicated data on other servers.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-O, --host2 {host}</option></term>
- <listitem>
- <para>
- Fully qualified host name or IP address of the second server whose contents
- will be replicated.
- </para>
-
- <para>
- Default value: <replaceable>configured-hostname</replaceable>
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--port2 {port}</option></term>
- <listitem>
- <para>
- Directory server administration port number of the second server whose
- contents will be replicated.
- </para>
-
- <para>
- Default value: <replaceable>configured-admin-port</replaceable>
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--bindDN2 {bindDN}</option></term>
- <listitem>
- <para>
- DN to use to bind to the second server whose contents will be replicated.
- If not specified the global administrator will be used to bind.
- </para>
-
- <para>
- Default value: cn=Directory Manager
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--bindPassword2 {bindPassword}</option></term>
- <listitem>
- <para>
- Password to use to bind to the second server whose contents will be
- replicated. If no bind DN was specified for the second server the password
- of the global administrator will be used to bind.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-F, --bindPasswordFile2 {bindPasswordFile}</option></term>
- <listitem>
- <para>
- File containing the password to use to bind to the second server whose
- contents will be replicated. If no bind DN was specified for the second
- server the password of the global administrator will be used to bind.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-R, --replicationPort2 {port}</option></term>
- <listitem>
- <para>
- Port that will be used by the replication mechanism in the second server to
- communicate with the other servers. You have to specify this option only
- if replication was not previously configured in the second server.
- </para>
-
- <para>
- Default value: 8989
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--secureReplication2</option></term>
- <listitem>
- <para>
- Specifies whether or not the communication through the replication port of
- the second server is encrypted or not. This option will only be taken into
- account the first time replication is configured on the second server.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--noReplicationServer2</option></term>
- <listitem>
- <para>
- Do not configure a replication port or change log on the second server. The
- second server will contain replicated data but will not contain a change
- log of modifications made to the replicated data. Note that each replicated
- topology must contain at least two servers with a change log to avoid a
- single point of failure.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--onlyReplicationServer2</option></term>
- <listitem>
- <para>
- Configure only a change log and replication port on the second server. The
- second server will not contain replicated data, but will contain a change
- log of the modifications made to the replicated data on other servers.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-S, --skipPortCheck</option></term>
- <listitem>
- <para>
- Skip the check to determine whether the specified replication ports are
- usable.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--noSchemaReplication</option></term>
- <listitem>
- <para>
- Do not replicate the schema between the servers.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--useSecondServerAsSchemaSource</option></term>
- <listitem>
- <para>
- Use the second server to initialize the schema of the first server. If
- this option nor option --noSchemaReplication are specified the schema of
- the first server will be used to initialize the schema of the second server.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>initialize</command></term>
- <listitem>
- <para>Initialize the contents of the data under the specified base DN
- on the destination server with the contents on the source server. This
- operation is required after enabling replication in order replication to
- work. <command>initialize-all</command> can also be used for this
- purpose.</para>
-
- <variablelist>
- <title>Subcommand Options</title>
-
- <para>
- In addition to global options, these subcommand options are supported.
- </para>
-
- <varlistentry>
- <term><option>-h, --hostSource {host}</option></term>
- <listitem>
- <para>
- Fully qualified host name or IP address of the source server whose contents
- will be used to initialize the destination server.
- </para>
-
- <para>
- Default value: <replaceable>configured-hostname</replaceable>
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-p, --portSource {port}</option></term>
- <listitem>
- <para>
- Directory server administration port number of the source server whose
- contents will be used to initialize the destination server.
- </para>
-
- <para>
- Default value: <replaceable>configured-admin-port</replaceable>
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-O, --hostDestination {host}</option></term>
- <listitem>
- <para>
- Fully qualified host name or IP address of the destination server whose
- contents will be initialized.
- </para>
-
- <para>
- Default value: <replaceable>configured-hostname</replaceable>
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--portDestination {port}</option></term>
- <listitem>
- <para>
- Directory server administration port number of the destination server whose
- contents will be initialized.
- </para>
-
- <para>
- Default value: <replaceable>configured-admin-port</replaceable>
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>initialize-all</command></term>
- <listitem>
- <para>Initialize the contents of the data under the specified base DN
- on all the servers whose contents are being replicated with the contents
- on the specified server. This operation is required after enabling
- replication for replication to work. Run <command>initialize</command>
- for each server to achieve the same effect.</para>
-
- <variablelist>
- <title>Subcommand Options</title>
-
- <para>
- In addition to global options, these subcommand options are supported.
- </para>
-
- <varlistentry>
- <term><option>-h, --hostname {host}</option></term>
- <listitem>
- <para>
- Directory server hostname or IP address
- </para>
-
- <para>
- Default value: <replaceable>configured-hostname</replaceable>
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-p, --port {port}</option></term>
- <listitem>
- <para>
- Directory server administration port number
- </para>
-
- <para>
- Default value: <replaceable>configured-admin-port</replaceable>
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>post-external-initialization</command></term>
- <listitem>
- <para>This subcommand must be called after initializing the contents of
- all the replicated servers using the <command>import-ldif</command>
- command, or by copying the database. You must specify the list of base DNs
- that have been initialized, and you must provide the credentials of any
- of the servers that are being replicated. See
- <command>pre-external-initialization --help</command> for more
- information.</para>
-
- <variablelist>
- <title>Subcommand Options</title>
-
- <para>
- In addition to global options, these subcommand options are supported.
- </para>
-
- <varlistentry>
- <term><option>-h, --hostname {host}</option></term>
- <listitem>
- <para>
- Directory server hostname or IP address
- </para>
-
- <para>
- Default value: <replaceable>configured-hostname</replaceable>
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-p, --port {port}</option></term>
- <listitem>
- <para>
- Directory server administration port number
- </para>
-
- <para>
- Default value: <replaceable>configured-admin-port</replaceable>
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>pre-external-initialization</command></term>
- <listitem>
- <para>This subcommand must be called before initializing the contents
- of all the replicated servers using the <command>import-ldif</command>
- command, or by copying the database. You must specify the list of base DNs
- that have been initialized, and you must provide the credentials of any
- of the servers that are being replicated. After calling this subcommand,
- initialize the contents of all the servers in the topology, either by
- using the same LDIF file or by copying the database to each of the
- servers, then call the <command>post-external-initialization</command>
- subcommand.</para>
-
- <variablelist>
- <title>Subcommand Options</title>
-
- <para>
- In addition to global options, these subcommand options are supported.
- </para>
-
- <varlistentry>
- <term><option>-h, --hostname {host}</option></term>
- <listitem>
- <para>
- Directory server hostname or IP address
- </para>
-
- <para>
- Default value: <replaceable>configured-hostname</replaceable>
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-p, --port {port}</option></term>
- <listitem>
- <para>
- Directory server administration port number
- </para>
-
- <para>
- Default value: <replaceable>configured-admin-port</replaceable>
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>purge-historical</command></term>
- <listitem>
- <para>Launch a purge processing of the historical information stored
- in the user entries by replication. Since this processing may take a
- while, you must specify a maximum duration.</para>
-
- <variablelist>
- <title>Subcommand Options</title>
-
- <para>
- In addition to global options, these subcommand options are supported.
- </para>
-
- <varlistentry>
- <term><option>-h, --hostname {host}</option></term>
- <listitem>
- <para>
- Directory server hostname or IP address
- </para>
-
- <para>
- Default value: <replaceable>configured-hostname</replaceable>
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-p, --port {port}</option></term>
- <listitem>
- <para>
- Directory server administration port number
- </para>
-
- <para>
- Default value: <replaceable>configured-admin-port</replaceable>
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--maximumDuration {maximum duration}</option></term>
- <listitem>
- <para>
- This argument specifies the maximum duration the purge processing must last
- expressed in seconds.
- </para>
-
- <para>
- Default value: 3600
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-t, --start {startTime}</option></term>
- <listitem>
- <para>
- Indicates the date/time at which this operation will start when scheduled
- as a server task expressed in YYYYMMDDhhmmssZ format for UTC time or
- YYYYMMDDhhmmss for local time. A value of '0' will cause the task to be
- scheduled for immediate execution. When this option is specified the
- operation will be scheduled to start at the specified time after which this
- utility will exit immediately.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--recurringTask {schedulePattern}</option></term>
- <listitem>
- <para>
- Indicates the task is recurring and will be scheduled according to the
- value argument expressed in crontab(5) compatible time/date pattern
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--completionNotify {emailAddress}</option></term>
- <listitem>
- <para>
- Email address of a recipient to be notified when the task completes. This
- option may be specified more than once.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--errorNotify {emailAddress}</option></term>
- <listitem>
- <para>
- Email address of a recipient to be notified if an error occurs when this
- task executes. This option may be specified more than once.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--dependency {taskID}</option></term>
- <listitem>
- <para>
- ID of a task upon which this task depends. A task will not start execution
- until all its dependencies have completed execution.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--failedDependencyAction {action}</option></term>
- <listitem>
- <para>
- Action this task will take should one if its dependent tasks fail. The
- value must be one of PROCESS,CANCEL,DISABLE. If not specified defaults to
- CANCEL.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>status</command></term>
- <listitem>
- <para>Display a list with the basic replication configuration of the
- base DNs of the servers defined in the registration information. If
- no base DNs are specified as parameter, information for all base DNs
- is displayed.</para>
-
- <variablelist>
- <title>Subcommand Options</title>
-
- <para>
- In addition to global options, these subcommand options are supported.
- </para>
-
- <varlistentry>
- <term><option>-h, --hostname {host}</option></term>
- <listitem>
- <para>
- Directory server hostname or IP address
- </para>
-
- <para>
- Default value: <replaceable>configured-hostname</replaceable>
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-p, --port {port}</option></term>
- <listitem>
- <para>
- Directory server administration port number
- </para>
-
- <para>
- Default value: <replaceable>configured-admin-port</replaceable>
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-s, --script-friendly</option></term>
- <listitem>
- <para>
- Use script-friendly mode.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <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>
-</refentry>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-encode-password.xml b/opendj-server-legacy/src/main/docbkx/reference/man-encode-password.xml
deleted file mode 100644
index 5912a85..0000000
--- a/opendj-server-legacy/src/main/docbkx/reference/man-encode-password.xml
+++ /dev/null
@@ -1,193 +0,0 @@
-<?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/opendj3/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 2011-2014 ForgeRock AS
- !
--->
-<refentry xml:id='encode-password-1'
- 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'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
- <refmeta>
- <refentrytitle>encode-password</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>encode-password</refname>
- <refpurpose>encode a password with an OpenDJ storage scheme</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>encode-password</command>
- <arg choice="req">options</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to encode user passwords with a specified
- storage scheme, or to determine whether a given clear-text value matches a
- provided encoded password.</para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following global options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>-a, --authPasswordSyntax</option></term>
- <listitem>
- <para>Use the authentication password syntax rather than the user
- password syntax.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-c, --clearPassword {clearPW}</option></term>
- <listitem>
- <para>Clear-text password to encode or to compare against an encoded
- password.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-e, --encodedPassword {encodedPW}</option></term>
- <listitem>
- <para>Encoded password to compare against the clear-text password.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E, --encodedPasswordFile {file}</option></term>
- <listitem>
- <para>Encoded password file.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f, --clearPasswordFile {file}</option></term>
- <listitem>
- <para>Clear-text password file.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-i, --interactivePassword</option></term>
- <listitem>
- <para>The password to encode or to compare against an encoded password is
- interactively asked to the user.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-l, --listSchemes</option></term>
- <listitem>
- <para>List available password storage schemes.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-r, --useCompareResultCode</option></term>
- <listitem>
- <para>Use the LDAP compare result as an exit code for the password
- comparison.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-s, --storageScheme {scheme}</option></term>
- <listitem>
- <para>Scheme to use for the encoded password.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-V, --version</option></term>
- <listitem>
- <para>Display version information.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <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>
- <refsect1>
- <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>
-</refentry>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-export-ldif.xml b/opendj-server-legacy/src/main/docbkx/reference/man-export-ldif.xml
deleted file mode 100644
index ec2f6da..0000000
--- a/opendj-server-legacy/src/main/docbkx/reference/man-export-ldif.xml
+++ /dev/null
@@ -1,352 +0,0 @@
-<?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/opendj3/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 2011-2014 ForgeRock AS
- !
--->
-<refentry xml:id='export-ldif-1'
- 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'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
- <refmeta>
- <refentrytitle>export-ldif</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>export-ldif</refname>
- <refpurpose>export OpenDJ directory data in LDIF</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>export-ldif</command>
- <arg choice="req">options</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to export data from a directory server backend
- in LDIF form.</para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>-a, --appendToLDIF</option></term>
- <listitem>
- <para>Append an existing LDIF file rather than overwriting it.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-b, --includeBranch {branchDN}</option></term>
- <listitem>
- <para>Base DN of a branch to include in the LDIF export.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-B, --excludeBranch {branchDN}</option></term>
- <listitem>
- <para>Base DN of a branch to exclude from the LDIF export.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-c, --compress</option></term>
- <listitem>
- <para>Compress the LDIF data as it is exported.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-e, --excludeAttribute {attribute}</option></term>
- <listitem>
- <para>Attribute to exclude from the LDIF export.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E, --excludeFilter {filter}</option></term>
- <listitem>
- <para>Filter to identify entries to exclude from the LDIF export.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-i, --includeAttribute {attribute}</option></term>
- <listitem>
- <para>Attribute to include in the LDIF export.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-I, --includeFilter {filter}</option></term>
- <listitem>
- <para>Filter to identify entries to include in the LDIF export.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-l, --ldifFile {ldifFile}</option></term>
- <listitem>
- <para>Path to the LDIF file to be written.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-n, --backendID {backendName}</option></term>
- <listitem>
- <para>Backend ID for the backend to export.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-O, --excludeOperational</option></term>
- <listitem>
- <para>Exclude operational attributes from the LDIF export.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--wrapColumn {wrapColumn}</option></term>
- <listitem>
- <para>Column at which to wrap long lines (0 for no wrapping).</para>
- <para>Default value: 0</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <refsect2>
- <title>Task Backend Connection Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--connectTimeout {timeout}</option></term>
- <listitem>
- <para>Maximum length of time (in milliseconds) that can be taken to
- establish a connection. Use '0' to specify no time out.</para>
- <para>Default value: 30000</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-D, --bindDN {bindDN}</option></term>
- <listitem>
- <para>DN to use to bind to the server</para>
- <para>Default value: cn=Directory Manager</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-h, --hostname {host}</option></term>
- <listitem>
- <para>Directory server hostname or IP address</para>
- <para>Default value: localhost.localdomain</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>
- <listitem>
- <para>Bind password file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-K, --keyStorePath {keyStorePath}</option></term>
- <listitem>
- <para>Certificate key store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-N, --certNickname {nickname}</option></term>
- <listitem>
- <para>Nickname of certificate for SSL client authentication</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-o, --saslOption {name=value}</option></term>
- <listitem>
- <para>SASL bind options</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-p, --port {port}</option></term>
- <listitem>
- <para>Directory server administration port number</para>
- <para>Default value: 4444</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-P, --trustStorePath {trustStorePath}</option></term>
- <listitem>
- <para>Certificate trust store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-T, --trustStorePassword {trustStorePassword}</option></term>
- <listitem>
- <para>Certificate trust store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
- <listitem>
- <para>Certificate key store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-U, --trustStorePasswordFile {path}</option></term>
- <listitem>
- <para>Certificate trust store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-w, --bindPassword {bindPassword}</option></term>
- <listitem>
- <para>Password to use to bind to the server</para>
- <para>Use <option>-w -</option> to have the command prompt for the
- password, rather than enter the password on the command line.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
- <listitem>
- <para>Certificate key store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-X, --trustAll</option></term>
- <listitem>
- <para>Trust all server SSL certificates</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>Task Scheduling Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--completionNotify {emailAddress}</option></term>
- <listitem>
- <para>Email address of a recipient to be notified when the task
- completes. This option may be specified more than once.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--dependency {taskID}</option></term>
- <listitem>
- <para>ID of a task upon which this task depends. A task will not start
- execution until all its dependencies have completed execution.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--errorNotify {emailAddress}</option></term>
- <listitem>
- <para>Email address of a recipient to be notified if an error occurs
- when this task executes. This option may be specified more than
- once.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--failedDependencyAction {action}</option></term>
- <listitem>
- <para>Action this task will take should one if its dependent tasks fail.
- The value must be one of PROCESS, CANCEL, DISABLE. If not specified
- defaults to CANCEL.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--recurringTask {schedulePattern}</option></term>
- <listitem>
- <para>Indicates the task is recurring and will be scheduled according
- to the value argument expressed in crontab(5) compatible time/date
- pattern.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t, --start {startTime}</option></term>
- <listitem>
- <para>Indicates the date/time at which this operation will start when
- scheduled as a server task expressed in YYYYMMDDhhmmssZ format for UTC
- time or YYYYMMDDhhmmss for local time. A value of '0' will cause the
- task to be scheduled for immediate execution. When this option is
- specified the operation will be scheduled to start at the specified
- time after which this utility will exit immediately.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>Utility Input/Output Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--noPropertiesFile</option></term>
- <listitem>
- <para>No properties file will be used to get default command line
- argument values</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--propertiesFilePath {propertiesFilePath}</option></term>
- <listitem>
- <para>Path to the file containing default property values used for
- command line arguments</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>General Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-V, --version</option></term>
- <listitem>
- <para>Display version information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- </refsect1>
- <refsect1>
- <title>Exit Codes</title>
- <variablelist>
- <varlistentry>
- <term>0</term>
- <listitem>
- <para>The command completed successfully.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>> 0</term>
- <listitem>
- <para>An error occurred.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <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>[21/Jun/2011:13:40:49 +0200] category=BACKEND severity=INFORMATION ...
-...Exported 160 entries and skipped 0 in 0 seconds (average rate 1428.6/sec)</computeroutput>
- </screen>
- </refsect1>
-</refentry>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-import-ldif.xml b/opendj-server-legacy/src/main/docbkx/reference/man-import-ldif.xml
deleted file mode 100644
index 24eefe6..0000000
--- a/opendj-server-legacy/src/main/docbkx/reference/man-import-ldif.xml
+++ /dev/null
@@ -1,420 +0,0 @@
-<?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/opendj3/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 2011-2014 ForgeRock AS
- !
--->
-<refentry xml:id='import-ldif-1'
- 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'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
- <refmeta>
- <refentrytitle>import-ldif</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>import-ldif</refname>
- <refpurpose>import OpenDJ directory data from LDIF</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>import-ldif</command>
- <arg choice="req">options</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to import LDIF data into a directory server
- backend.</para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>-a, --append</option></term>
- <listitem>
- <para>Append to an existing database rather than overwriting it.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-A, --templateFile {templateFile}</option></term>
- <listitem>
- <para>Path to a MakeLDIF template to use to generate the import
- data.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-b, --includeBranch {branchDN}</option></term>
- <listitem>
- <para>Base DN of a branch to include in the LDIF import.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-B, --excludeBranch {branchDN}</option></term>
- <listitem>
- <para>Base DN of a branch to exclude from the LDIF import.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-c, --isCompressed</option></term>
- <listitem>
- <para>LDIF file is compressed.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--countRejects</option></term>
- <listitem>
- <para>Count the number of entries rejected by the server and return that
- value as the exit code (values > 255 will be reduced to 255 due to exit
- code restrictions).</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-e, --excludeAttribute {attribute}</option></term>
- <listitem>
- <para>Attribute to exclude from the LDIF import.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E, --excludeFilter {filter}</option></term>
- <listitem>
- <para>Filter to identify entries to exclude from the LDIF import.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-F, --clearBackend</option></term>
- <listitem>
- <para>Remove all entries for all base DNs in the backend before
- importing.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-i, --includeAttribute {attribute}</option></term>
- <listitem>
- <para>Attribute to include in the LDIF import.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-I, --includeFilter {filter}</option></term>
- <listitem>
- <para>Filter to identify entries to include in the LDIF import.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-l, --ldifFile {ldifFile}</option></term>
- <listitem>
- <para>Path to the LDIF file to be imported.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-n, --backendID {backendName}</option></term>
- <listitem>
- <para>Backend ID for the backend to import.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-O, --overwrite</option></term>
- <listitem>
- <para>Overwrite an existing rejects and/or skip file rather than appending
- to it.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-r, --replaceExisting</option></term>
- <listitem>
- <para>Replace existing entries when appending to the database.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-R, --rejectFile {rejectFile}</option></term>
- <listitem>
- <para>Write rejected entries to the specified file.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-s, --randomSeed {seed}</option></term>
- <listitem>
- <para>Seed for the MakeLDIF random number generator.</para>
- <para>Default value: 0</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-S, --skipSchemaValidation</option></term>
- <listitem>
- <para>Skip schema validation during the LDIF import.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--skipDNValidation</option></term>
- <listitem>
- <para>Perform DN validation during later part of LDIF import.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--skipFile {skipFile}</option></term>
- <listitem>
- <para>Write skipped entries to the specified file.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--threadCount {count}</option></term>
- <listitem>
- <para>Number of threads used to read LDIF file during import. Default
- value (0) equals: 2 x (number of CPUs).</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--tmpdirectory {directory}</option></term>
- <listitem>
- <para>Path to temporary directory for index scratch files during LDIF
- import.</para>
- <para>Default value: <filename>import-tmp</filename></para>
- </listitem>
- </varlistentry>
- </variablelist>
- <refsect2>
- <title>Task Backend Connection Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--connectTimeout {timeout}</option></term>
- <listitem>
- <para>Maximum length of time (in milliseconds) that can be taken to
- establish a connection. Use '0' to specify no time out.</para>
- <para>Default value: 30000</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-D, --bindDN {bindDN}</option></term>
- <listitem>
- <para>DN to use to bind to the server</para>
- <para>Default value: cn=Directory Manager</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-h, --hostname {host}</option></term>
- <listitem>
- <para>Directory server hostname or IP address</para>
- <para>Default value: localhost.localdomain</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>
- <listitem>
- <para>Bind password file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-K, --keyStorePath {keyStorePath}</option></term>
- <listitem>
- <para>Certificate key store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-N, --certNickname {nickname}</option></term>
- <listitem>
- <para>Nickname of certificate for SSL client authentication</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-o, --saslOption {name=value}</option></term>
- <listitem>
- <para>SASL bind options</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-p, --port {port}</option></term>
- <listitem>
- <para>Directory server administration port number</para>
- <para>Default value: 4444</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-P, --trustStorePath {trustStorePath}</option></term>
- <listitem>
- <para>Certificate trust store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-T, --trustStorePassword {trustStorePassword}</option></term>
- <listitem>
- <para>Certificate trust store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
- <listitem>
- <para>Certificate key store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-U, --trustStorePasswordFile {path}</option></term>
- <listitem>
- <para>Certificate trust store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-w, --bindPassword {bindPassword}</option></term>
- <listitem>
- <para>Password to use to bind to the server</para>
- <para>Use <option>-w -</option> to have the command prompt for the
- password, rather than enter the password on the command line.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
- <listitem>
- <para>Certificate key store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-X, --trustAll</option></term>
- <listitem>
- <para>Trust all server SSL certificates</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>Task Scheduling Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--completionNotify {emailAddress}</option></term>
- <listitem>
- <para>Email address of a recipient to be notified when the task
- completes. This option may be specified more than once.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--dependency {taskID}</option></term>
- <listitem>
- <para>ID of a task upon which this task depends. A task will not start
- execution until all its dependencies have completed execution.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--errorNotify {emailAddress}</option></term>
- <listitem>
- <para>Email address of a recipient to be notified if an error occurs
- when this task executes. This option may be specified more than
- once.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--failedDependencyAction {action}</option></term>
- <listitem>
- <para>Action this task will take should one if its dependent tasks fail.
- The value must be one of PROCESS, CANCEL, DISABLE. If not specified
- defaults to CANCEL.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--recurringTask {schedulePattern}</option></term>
- <listitem>
- <para>Indicates the task is recurring and will be scheduled according
- to the value argument expressed in crontab(5) compatible time/date
- pattern.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t, --start {startTime}</option></term>
- <listitem>
- <para>Indicates the date/time at which this operation will start when
- scheduled as a server task expressed in YYYYMMDDhhmmssZ format for UTC
- time or YYYYMMDDhhmmss for local time. A value of '0' will cause the
- task to be scheduled for immediate execution. When this option is
- specified the operation will be scheduled to start at the specified
- time after which this utility will exit immediately.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>Utility Input/Output Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--noPropertiesFile</option></term>
- <listitem>
- <para>No properties file will be used to get default command line
- argument values</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--propertiesFilePath {propertiesFilePath}</option></term>
- <listitem>
- <para>Path to the file containing default property values used for
- command line arguments</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>General Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-V, --version</option></term>
- <listitem>
- <para>Display version information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- </refsect1>
- <refsect1>
- <title>Exit Codes</title>
- <variablelist>
- <varlistentry>
- <term>0</term>
- <listitem>
- <para>The command completed successfully.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>> 0</term>
- <listitem>
- <para>An error occurred.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para>The following example imports the content of the LDIF 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>[21/Jun/2011:13:38:03 +0200] category=RUNTIME_INFORMATION severity=NOTICE...
-... msg=Import LDIF environment close took 0 seconds</computeroutput>
- </screen>
- </refsect1>
-</refentry>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-ldapcompare.xml b/opendj-server-legacy/src/main/docbkx/reference/man-ldapcompare.xml
deleted file mode 100644
index 4f9d073..0000000
--- a/opendj-server-legacy/src/main/docbkx/reference/man-ldapcompare.xml
+++ /dev/null
@@ -1,356 +0,0 @@
-<?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/opendj3/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 2011-2014 ForgeRock AS
- !
--->
-<refentry xml:id='ldapcompare-1'
- 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'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
- <refmeta>
- <refentrytitle>ldapcompare</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>ldapcompare</refname>
- <refpurpose>perform LDAP compare operations</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>ldapcompare</command>
- <arg choice="req">options</arg>
- <group><arg>attribute</arg><arg>:</arg><arg>value</arg></group>
- <arg choice="opt" rep="repeat">DN</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to perform LDAP compare operations in the
- directory.</para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>--assertionFilter {filter}</option></term>
- <listitem>
- <para>Use the LDAP assertion control with the provided filter</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-c, --continueOnError</option></term>
- <listitem>
- <para>Continue processing even if there are errors</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f, --filename {file}</option></term>
- <listitem>
- <para>LDIF file containing one DN per line of entries to compare</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-J, --control {controloid[:criticality[:value|::b64value|:<filePath]]}</option></term>
- <listitem>
- <para>Use a request control with the provided information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m, --useCompareResultCode</option></term>
- <listitem>
- <para>Use the LDAP compare result as an exit code for the LDAP compare operations.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-n, --dry-run</option></term>
- <listitem>
- <para>Show what would be done but do not perform any operation</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <refsect2>
- <title>LDAP Connection Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--connectTimeout {timeout}</option></term>
- <listitem>
- <para>Maximum length of time (in milliseconds) that can be taken to
- establish a connection. Use '0' to specify no time out.</para>
- <para>Default value: 30000</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-D, --bindDN {bindDN}</option></term>
- <listitem>
- <para>DN to use to bind to the server</para>
- <para>Default value: cn=Directory Manager</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-h, --hostname {host}</option></term>
- <listitem>
- <para>Directory server hostname or IP address</para>
- <para>Default value: localhost.localdomain</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>
- <listitem>
- <para>Bind password file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-K, --keyStorePath {keyStorePath}</option></term>
- <listitem>
- <para> Certificate key store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-N, --certNickname {nickname}</option></term>
- <listitem>
- <para>Nickname of certificate for SSL client authentication</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-o, --saslOption {name=value}</option></term>
- <listitem>
- <para>SASL bind options</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-p, --port {port}</option></term>
- <listitem>
- <para>Directory server port number</para>
- <para>Default value: 389</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-P, --trustStorePath {trustStorePath}</option></term>
- <listitem>
- <para>Certificate trust store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-q, --useStartTLS</option></term>
- <listitem>
- <para>Use StartTLS to secure communication with the server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-r, --useSASLExternal</option></term>
- <listitem>
- <para>Use the SASL EXTERNAL authentication mechanism</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--trustStorePassword {trustStorePassword}</option></term>
- <listitem>
- <para>Certificate trust store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
- <listitem>
- <para>Certificate key store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-U, --trustStorePasswordFile {path}</option></term>
- <listitem>
- <para>Certificate trust store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-V, --ldapVersion {version}</option></term>
- <listitem>
- <para>LDAP protocol version number</para>
- <para>Default value: 3</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-w, --bindPassword {bindPassword}</option></term>
- <listitem>
- <para>Password to use to bind to the server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
- <listitem>
- <para>Certificate key store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-X, --trustAll</option></term>
- <listitem>
- <para>Trust all server SSL certificates</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-Z, --useSSL</option></term>
- <listitem>
- <para>Use SSL for secure communication with the server</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>Utility Input/Output Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-i, --encoding {encoding}</option></term>
- <listitem>
- <para>Use the specified character set for command-line input</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--noPropertiesFile</option></term>
- <listitem>
- <para>No properties file will be used to get default command line
- argument values</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--propertiesFilePath {propertiesFilePath}</option></term>
- <listitem>
- <para>Path to the file containing default property values used for
- command line arguments</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-s, --script-friendly</option></term>
- <listitem>
- <para>Use script-friendly mode</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-v, --verbose</option></term>
- <listitem>
- <para>Use verbose mode</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>General Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--version</option></term>
- <listitem>
- <para>Display version information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- </refsect1>
- <refsect1>
- <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 -m 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 -m 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: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>
- <refsect1>
- <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>
- <refsect1>
- <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>
-</refentry>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-ldapdelete.xml b/opendj-server-legacy/src/main/docbkx/reference/man-ldapdelete.xml
deleted file mode 100644
index 8b79ca3..0000000
--- a/opendj-server-legacy/src/main/docbkx/reference/man-ldapdelete.xml
+++ /dev/null
@@ -1,338 +0,0 @@
-<?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/opendj3/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 2011-2014 ForgeRock AS
- !
--->
-<refentry xml:id='ldapdelete-1'
- 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'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
- <refmeta>
- <refentrytitle>ldapdelete</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>ldapdelete</refname>
- <refpurpose>perform LDAP delete operations</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>ldapdelete</command>
- <arg choice="req">options</arg>
- <arg><replaceable>DN</replaceable></arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to perform LDAP delete operations in the
- directory.</para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>--assertionFilter {filter}</option></term>
- <listitem>
- <para>Use the LDAP assertion control with the provided filter</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-c, --continueOnError</option></term>
- <listitem>
- <para>Continue processing even if there are errors</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f, --filename {file}</option></term>
- <listitem>
- <para>LDIF file containing the changes to apply</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-J, --control {controloid[:criticality[:value|::b64value|:<filePath]]}</option></term>
- <listitem>
- <para>Use a request control with the provided information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-n, --dry-run</option></term>
- <listitem>
- <para>Show what would be done but do not perform any operation</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-x, --deleteSubtree</option></term>
- <listitem>
- <para>Delete the specified entry and all entries below it</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-Y, --proxyAs {authzID}</option></term>
- <listitem>
- <para>Use the proxied authorization control with the given authorization
- ID</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <refsect2>
- <title>LDAP Connection Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-D, --bindDN {bindDN}</option></term>
- <listitem>
- <para>DN to use to bind to the server</para>
- <para>Default value: cn=Directory Manager</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E, --reportAuthzID</option></term>
- <listitem>
- <para>Use the authorization identity control</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-h, --hostname {host}</option></term>
- <listitem>
- <para>Directory server hostname or IP address</para>
- <para>Default value: localhost.localdomain</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>
- <listitem>
- <para>Bind password file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-K, --keyStorePath {keyStorePath}</option></term>
- <listitem>
- <para> Certificate key store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-N, --certNickname {nickname}</option></term>
- <listitem>
- <para>Nickname of certificate for SSL client authentication</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-o, --saslOption {name=value}</option></term>
- <listitem>
- <para>SASL bind options</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-p, --port {port}</option></term>
- <listitem>
- <para>Directory server port number</para>
- <para>Default value: 389</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-P, --trustStorePath {trustStorePath}</option></term>
- <listitem>
- <para>Certificate trust store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-q, --useStartTLS</option></term>
- <listitem>
- <para>Use StartTLS to secure communication with the server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-T, --trustStorePassword {trustStorePassword}</option></term>
- <listitem>
- <para>Certificate trust store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
- <listitem>
- <para>Certificate key store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-U, --trustStorePasswordFile {path}</option></term>
- <listitem>
- <para>Certificate trust store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--usePasswordPolicyControl</option></term>
- <listitem>
- <para>Use the password policy request control</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-V, --ldapVersion {version}</option></term>
- <listitem>
- <para>LDAP protocol version number</para>
- <para>Default value: 3</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-w, --bindPassword {bindPassword}</option></term>
- <listitem>
- <para>Password to use to bind to the server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
- <listitem>
- <para>Certificate key store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-X, --trustAll</option></term>
- <listitem>
- <para>Trust all server SSL certificates</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-Z, --useSSL</option></term>
- <listitem>
- <para>Use SSL for secure communication with the server</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>Utility Input/Output Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-i, --encoding {encoding}</option></term>
- <listitem>
- <para>Use the specified character set for command-line input</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--noPropertiesFile</option></term>
- <listitem>
- <para>No properties file will be used to get default command line
- argument values</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--propertiesFilePath {propertiesFilePath}</option></term>
- <listitem>
- <para>Path to the file containing default property values used for
- command line arguments</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-v, --verbose</option></term>
- <listitem>
- <para>Use verbose mode</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>General Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--version</option></term>
- <listitem>
- <para>Display version information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- </refsect1>
- <refsect1>
- <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">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>
- <refsect1>
- <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>
- <refsect1>
- <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 ou=Groups entry and all entries
- underneath ou=Groups.</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>
-</refentry>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-ldapmodify.xml b/opendj-server-legacy/src/main/docbkx/reference/man-ldapmodify.xml
deleted file mode 100644
index ee6259d..0000000
--- a/opendj-server-legacy/src/main/docbkx/reference/man-ldapmodify.xml
+++ /dev/null
@@ -1,455 +0,0 @@
-<?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/opendj3/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 2011-2015 ForgeRock AS.
- !
--->
-<refentry xml:id='ldapmodify-1'
- 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'>
- <info><copyright><year>2011-2015</year><holder>ForgeRock AS.</holder></copyright></info>
- <refmeta>
- <refentrytitle>ldapmodify</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>ldapmodify</refname>
- <refpurpose>perform LDAP modify, add, delete, mod DN operations</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>ldapmodify</command>
- <arg choice="req">options</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to perform LDAP modify, add, delete, and
- modify DN operations in the directory.</para>
- <para>When not using a file to specify modifications, end your input with
- EOF (Ctrl+D on UNIX, Ctrl+Z on Windows).</para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>-a, --defaultAdd</option></term>
- <listitem>
- <para>Treat records with no changetype as add operations</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--assertionFilter {filter}</option></term>
- <listitem>
- <para>Use the LDAP assertion control with the provided filter</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-c, --continueOnError</option></term>
- <listitem>
- <para>Continue processing even if there are errors</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f, --filename {file}</option></term>
- <listitem>
- <para>LDIF file containing the changes to apply</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-J, --control {controloid[:criticality[:value|::b64value|:<filePath]]}</option></term>
- <listitem>
- <para>Use a request control with the provided information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-n, --dry-run</option></term>
- <listitem>
- <para>Show what would be done but do not perform any operation</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--postReadAttributes {attrList}</option></term>
- <listitem>
- <para>Use the LDAP ReadEntry post-read control</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--preReadAttributes {attrList}</option></term>
- <listitem>
- <para>Use the LDAP ReadEntry pre-read control</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-Y, --proxyAs {authzID}</option></term>
- <listitem>
- <para>Use the proxied authorization control with the given authorization
- ID</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <refsect2>
- <title>LDAP Connection Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--connectTimeout {timeout}</option></term>
- <listitem>
- <para>Maximum length of time (in milliseconds) that can be taken to
- establish a connection. Use '0' to specify no time out.</para>
- <para>Default value: 30000</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-D, --bindDN {bindDN}</option></term>
- <listitem>
- <para>DN to use to bind to the server</para>
- <para>Default value: cn=Directory Manager</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E, --reportAuthzID</option></term>
- <listitem>
- <para>Use the authorization identity control</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-h, --hostname {host}</option></term>
- <listitem>
- <para>Directory server hostname or IP address</para>
- <para>Default value: localhost.localdomain</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>
- <listitem>
- <para>Bind password file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-K, --keyStorePath {keyStorePath}</option></term>
- <listitem>
- <para> Certificate key store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-N, --certNickname {nickname}</option></term>
- <listitem>
- <para>Nickname of certificate for SSL client authentication</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-o, --saslOption {name=value}</option></term>
- <listitem>
- <para>SASL bind options</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-p, --port {port}</option></term>
- <listitem>
- <para>Directory server port number</para>
- <para>Default value: 389</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-P, --trustStorePath {trustStorePath}</option></term>
- <listitem>
- <para>Certificate trust store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-q, --useStartTLS</option></term>
- <listitem>
- <para>Use StartTLS to secure communication with the server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-r, --useSASLExternal</option></term>
- <listitem>
- <para>Use the SASL EXTERNAL authentication mechanism</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--trustStorePassword {trustStorePassword}</option></term>
- <listitem>
- <para>Certificate trust store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
- <listitem>
- <para>Certificate key store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-U, --trustStorePasswordFile {path}</option></term>
- <listitem>
- <para>Certificate trust store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-V, --ldapVersion {version}</option></term>
- <listitem>
- <para>LDAP protocol version number</para>
- <para>Default value: 3</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-w, --bindPassword {bindPassword}</option></term>
- <listitem>
- <para>Password to use to bind to the server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
- <listitem>
- <para>Certificate key store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-X, --trustAll</option></term>
- <listitem>
- <para>Trust all server SSL certificates</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-Z, --useSSL</option></term>
- <listitem>
- <para>Use SSL for secure communication with the server</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>Utility Input/Output Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-i, --encoding {encoding}</option></term>
- <listitem>
- <para>Use the specified character set for command-line input</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--noPropertiesFile</option></term>
- <listitem>
- <para>No properties file will be used to get default command line
- argument values</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--propertiesFilePath {propertiesFilePath}</option></term>
- <listitem>
- <para>Path to the file containing default property values used for
- command line arguments</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-v, --verbose</option></term>
- <listitem>
- <para>Use verbose mode</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>General Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--version</option></term>
- <listitem>
- <para>Display version information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- </refsect1>
- <refsect1>
- <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">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>
- <refsect1>
- <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>
- <refsect1>
- <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 ]] && 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 <<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>
-</refentry>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-ldappasswordmodify.xml b/opendj-server-legacy/src/main/docbkx/reference/man-ldappasswordmodify.xml
deleted file mode 100644
index 7a21734..0000000
--- a/opendj-server-legacy/src/main/docbkx/reference/man-ldappasswordmodify.xml
+++ /dev/null
@@ -1,324 +0,0 @@
-<?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/opendj3/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 2011-2014 ForgeRock AS
- !
--->
-<refentry xml:id='ldappasswordmodify-1'
- 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'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
- <refmeta>
- <refentrytitle>ldappasswordmodify</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>ldappasswordmodify</refname>
- <refpurpose>perform LDAP password modifications</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>ldappasswordmodify</command>
- <arg choice="req">options</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to perform LDAP password modify operations in
- the directory.</para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>-a, --authzID {authzID}</option></term>
- <listitem>
- <para>Authorization ID for the user entry whose password should be changed</para>
- <para>The authorization ID is a string having either the prefix
- <literal>dn:</literal> followed by the user's distinguished name, or
- the prefix <literal>u:</literal> followed by a user identifier that
- depends on the identity mapping used to match the user identifier to
- an entry in the directory. Examples include
- <literal>dn:uid=bjensen,ou=People,dc=example,dc=com</literal>, and, if
- we assume that <literal>bjensen</literal> is mapped to Barbara Jensen's
- entry, <literal>u:bjensen</literal>.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-A, --provideDNForAuthzID</option></term>
- <listitem>
- <para>Use the bind DN as the authorization ID for the password modify
- operation</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-c, --currentPassword {currentPassword}</option></term>
- <listitem>
- <para>Current password for the target user</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-C, --currentPasswordFile {file}</option></term>
- <listitem>
- <para>Path to a file containing the current password for the target user</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-J, --control {controloid[:criticality[:value|::b64value|:<filePath]]}</option></term>
- <listitem>
- <para>Use a request control with the provided information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-n, --newPassword {newPassword}</option></term>
- <listitem>
- <para>New password to provide for the target user</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-N, --newPasswordFile {file}</option></term>
- <listitem>
- <para>Path to a file containing the new password to provide for the
- target user</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <refsect2>
- <title>LDAP Connection Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--certNickname {nickname}</option></term>
- <listitem>
- <para>Nickname of certificate for SSL client authentication</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--connectTimeout {timeout}</option></term>
- <listitem>
- <para>Maximum length of time (in milliseconds) that can be taken to
- establish a connection. Use '0' to specify no time out.</para>
- <para>Default: 30000</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-D, --bindDN {bindDN}</option></term>
- <listitem>
- <para>DN to use to bind to the server</para>
- <para>Default value: cn=Directory Manager</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-h, --hostname {host}</option></term>
- <listitem>
- <para>Directory server hostname or IP address</para>
- <para>Default value: localhost.localdomain</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>
- <listitem>
- <para>Bind password file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-K, --keyStorePath {keyStorePath}</option></term>
- <listitem>
- <para> Certificate key store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-p, --port {port}</option></term>
- <listitem>
- <para>Directory server port number</para>
- <para>Default value: 389</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-P, --trustStorePath {trustStorePath}</option></term>
- <listitem>
- <para>Certificate trust store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-q, --useStartTLS</option></term>
- <listitem>
- <para>Use StartTLS to secure communication with the server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--trustStorePassword {trustStorePassword}</option></term>
- <listitem>
- <para>Certificate trust store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
- <listitem>
- <para>Certificate key store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-U, --trustStorePasswordFile {path}</option></term>
- <listitem>
- <para>Certificate trust store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-w, --bindPassword {bindPassword}</option></term>
- <listitem>
- <para>Password to use to bind to the server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
- <listitem>
- <para>Certificate key store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-X, --trustAll</option></term>
- <listitem>
- <para>Trust all server SSL certificates</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-Z, --useSSL</option></term>
- <listitem>
- <para>Use SSL for secure communication with the server</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>Utility Input/Output Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--noPropertiesFile</option></term>
- <listitem>
- <para>No properties file will be used to get default command line
- argument values</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--propertiesFilePath {propertiesFilePath}</option></term>
- <listitem>
- <para>Path to the file containing default property values used for
- command line arguments</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-V, --version</option></term>
- <listitem>
- <para>Display directory server version information</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>General Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--version</option></term>
- <listitem>
- <para>Display version information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- </refsect1>
- <refsect1>
- <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">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>
- <refsect1>
- <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>
- <refsect1>
- <title>Examples</title>
- <para>The following example demonstrates a user changing the password
- for her 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>
-</refentry>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-ldapsearch.xml b/opendj-server-legacy/src/main/docbkx/reference/man-ldapsearch.xml
deleted file mode 100644
index 4f282ea..0000000
--- a/opendj-server-legacy/src/main/docbkx/reference/man-ldapsearch.xml
+++ /dev/null
@@ -1,763 +0,0 @@
-<?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/opendj3/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 2011-2015 ForgeRock AS.
- !
--->
-<refentry xml:id='ldapsearch-1'
- 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'>
- <info><copyright><year>2011-2015</year><holder>ForgeRock AS.</holder></copyright></info>
- <refmeta>
- <refentrytitle>ldapsearch</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>ldapsearch</refname>
- <refpurpose>perform LDAP search operations</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>ldapsearch</command>
- <arg choice="req">options</arg>
- <arg choice="opt">filter</arg>
- <arg choice="opt" rep="repeat">attributes</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to perform LDAP search operations in the
- directory.</para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>-a, --dereferencePolicy {dereferencePolicy}</option></term>
- <listitem>
- <para>Alias dereference policy ('never', 'always', 'search', or 'find')</para>
- <para>Default value: never</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-A, --typesOnly</option></term>
- <listitem>
- <para>Only retrieve attribute names but not their values</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--assertionFilter {filter}</option></term>
- <listitem>
- <para>Use the LDAP assertion control with the provided filter</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-b, --baseDN {baseDN}</option></term>
- <listitem>
- <para>Base DN format string</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-c, --continueOnError</option></term>
- <listitem>
- <para>Continue processing even if there are errors</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-C, --persistentSearch ps[:changetype[:changesonly[:entrychgcontrols]]]</option></term>
- <listitem>
- <para>Use the persistent search control</para>
-
- <para>
- A persistent search allows the client to continue receiving new results
- whenever changes are made to data that is in the scope of the search,
- thus using the search as a form of change notification.
- </para>
-
- <variablelist>
- <para>
- The optional <literal>changetype</literal> setting defines
- the kinds of updates that result in notification.
- By default the <literal>changetype</literal> is not set.
- </para>
-
- <varlistentry>
- <term><literal>add</literal></term>
- <listitem>
- <para>
- Send notifications for LDAP add operations.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>del</literal></term>
- <term><literal>delete</literal></term>
- <listitem>
- <para>
- Send notifications for LDAP delete operations.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>mod</literal></term>
- <term><literal>modify</literal></term>
- <listitem>
- <para>
- Send notifications for LDAP modify operations.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>moddn</literal></term>
- <term><literal>modrdn</literal></term>
- <term><literal>modifydn</literal></term>
- <listitem>
- <para>
- Send notifications for LDAP modify DN (rename and move) operations.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>all</literal></term>
- <term><literal>any</literal></term>
- <listitem>
- <para>
- Send notifications for all LDAP update operations.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <variablelist>
- <para>
- The optional <literal>changesonly</literal> setting defines
- whether the server returns existing entries as well as changes.
- </para>
-
- <varlistentry>
- <term><literal>true</literal></term>
- <listitem>
- <para>
- Do not return existing entries,
- but instead only notifications about changes.
- </para>
-
- <para>
- This is the default setting.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>false</literal></term>
- <listitem>
- <para>
- Also return existing entries.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <variablelist>
- <para>
- The optional <literal>entrychgcontrols</literal> setting defines
- whether the server returns an Entry Change Notification control
- with each entry notification.
- The Entry Change Notification control provides additional information
- about the change that caused the entry to be returned by the search.
- In particular, it indicates the change type,
- the change number if available,
- and the previous DN if the change type was a modify DN operation.
- </para>
-
- <varlistentry>
- <term><literal>true</literal></term>
- <listitem>
- <para>
- Do request the Entry Change Notification control.
- </para>
-
- <para>
- This is the default setting.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>false</literal></term>
- <listitem>
- <para>
- Do not request the Entry Change Notification control.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--countEntries</option></term>
- <listitem>
- <para>Count the number of entries returned by the server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-e, --getEffectiveRightsAttribute {attribute}</option></term>
- <listitem>
- <para>Specifies geteffectiverights control specific attribute list</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f, --filename {file}</option></term>
- <listitem>
- <para>LDIF file containing the changes to apply</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-g, --getEffectiveRightsAuthzid {authzID}</option></term>
- <listitem>
- <para>Use geteffectiverights control with the provided authzid</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-G, --virtualListView {before:after:index:count | before:after:value}</option></term>
- <listitem>
- <para>Use the virtual list view control to retrieve the specified results page</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-J, --control {controloid[:criticality[:value|::b64value|:<filePath]]}</option></term>
- <listitem>
- <para>Use a request control with the provided information</para>
-
- <para>
- For some <replaceable>controloid</replaceable> values,
- you can replace object identifiers with user-friendly strings.
-
- The strings are listed here in lower case, but the case is not important.
- You can use camelCase if you prefer, for example.
- </para>
-
- <variablelist>
- <varlistentry>
- <term><literal>accountusable</literal></term>
- <term><literal>accountusability</literal></term>
- <listitem>
- <para>Account Usability Control, Object Identifier: 1.3.6.1.4.1.42.2.27.9.5.8</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>authzid</literal></term>
- <term><literal>authorizationidentity</literal></term>
- <listitem>
- <para>Authorization Identity Request Control, Object Identifier: 2.16.840.1.113730.3.4.16</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>effectiverights</literal></term>
- <term><literal>geteffectiverights</literal></term>
- <listitem>
- <para>Get Effective Rights Request Control, Object Identifier: 1.3.6.1.4.1.42.2.27.9.5.2</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>managedsait</literal></term>
- <listitem>
- <para>Manage DSAIT Request Control, Object Identifier: 2.16.840.1.113730.3.4.2</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>noop</literal></term>
- <term><literal>no-op</literal></term>
- <listitem>
- <para>No-Op Control, Object Identifier: 1.3.6.1.4.1.4203.1.10.2</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>pwpolicy</literal></term>
- <term><literal>passwordpolicy</literal></term>
- <listitem>
- <para>Password Policy Control, Object Identifier: 1.3.6.1.4.1.42.2.27.8.5.1</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>realattrsonly</literal></term>
- <term><literal>realattributesonly</literal></term>
- <listitem>
- <para>Real Attributes Only Request Control, Object Identifier: 2.16.840.1.113730.3.4.17</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>subtreedelete</literal></term>
- <term><literal>treedelete</literal></term>
- <listitem>
- <para>Subtree Delete Request Control, Object Identifier: 1.2.840.113556.1.4.805</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>virtualattrsonly</literal></term>
- <term><literal>virtualattributesonly</literal></term>
- <listitem>
- <para>Virtual Attributes Only Request Control, Object Identifier: 2.16.840.1.113730.3.4.19</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-l, --timeLimit {timeLimit}</option></term>
- <listitem>
- <para>Maximum length of time in seconds to allow for the search</para>
- <para>Default value: 0</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--matchedValuesFilter {filter}</option></term>
- <listitem>
- <para>Use the LDAP matched values control with the provided filter</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-n, --dry-run</option></term>
- <listitem>
- <para>Show what would be done but do not perform any operation</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-s, --searchScope {searchScope}</option></term>
- <listitem>
- <para>Search scope ('base', 'one', 'sub', or 'subordinate')</para>
- <para>Default value: sub</para>
- <para><literal>subordinate</literal> is an LDAP extension that might
- not work with all LDAP servers.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-S, --sortOrder {sortOrder}</option></term>
- <listitem>
- <para>Sort the results using the provided sort order</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--simplePageSize {numEntries}</option></term>
- <listitem>
- <para>Use the simple paged results control with the given page size</para>
- <para>Default value: 1000</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--subEntries</option></term>
- <listitem>
- <para>Use subentries control to specify that subentries are visible and
- normal entries are not</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-Y, --proxyAs {authzID}</option></term>
- <listitem>
- <para>Use the proxied authorization control with the given authorization
- ID</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z, --sizeLimit {sizeLimit}</option></term>
- <listitem>
- <para>Maximum number of entries to return from the search</para>
- <para>Default value: 0</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <refsect2>
- <title>LDAP Connection Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--connectTimeout {timeout}</option></term>
- <listitem>
- <para>Maximum length of time (in milliseconds) that can be taken to
- establish a connection. Use '0' to specify no time out.</para>
- <para>Default value: 30000</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-D, --bindDN {bindDN}</option></term>
- <listitem>
- <para>DN to use to bind to the server</para>
- <para>Default value: cn=Directory Manager</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E, --reportAuthzID</option></term>
- <listitem>
- <para>Use the authorization identity control</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-h, --hostname {host}</option></term>
- <listitem>
- <para>Directory server hostname or IP address</para>
- <para>Default value: localhost.localdomain</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>
- <listitem>
- <para>Bind password file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-K, --keyStorePath {keyStorePath}</option></term>
- <listitem>
- <para> Certificate key store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-N, --certNickname {nickname}</option></term>
- <listitem>
- <para>Nickname of certificate for SSL client authentication</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-o, --saslOption {name=value}</option></term>
- <listitem>
- <para>SASL bind options</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-p, --port {port}</option></term>
- <listitem>
- <para>Directory server port number</para>
- <para>Default value: 389</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-P, --trustStorePath {trustStorePath}</option></term>
- <listitem>
- <para>Certificate trust store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-q, --useStartTLS</option></term>
- <listitem>
- <para>Use StartTLS to secure communication with the server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-r, --useSASLExternal</option></term>
- <listitem>
- <para>Use the SASL EXTERNAL authentication mechanism</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--trustStorePassword {trustStorePassword}</option></term>
- <listitem>
- <para>Certificate trust store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
- <listitem>
- <para>Certificate key store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-U, --trustStorePasswordFile {path}</option></term>
- <listitem>
- <para>Certificate trust store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--usePasswordPolicyControl</option></term>
- <listitem>
- <para>Use the password policy request control</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-V, --ldapVersion {version}</option></term>
- <listitem>
- <para>LDAP protocol version number</para>
- <para>Default value: 3</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-w, --bindPassword {bindPassword}</option></term>
- <listitem>
- <para>Password to use to bind to the server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
- <listitem>
- <para>Certificate key store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-X, --trustAll</option></term>
- <listitem>
- <para>Trust all server SSL certificates</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-Z, --useSSL</option></term>
- <listitem>
- <para>Use SSL for secure communication with the server</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>Utility Input/Output Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-i, --encoding {encoding}</option></term>
- <listitem>
- <para>Use the specified character set for command-line input</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--noPropertiesFile</option></term>
- <listitem>
- <para>No properties file will be used to get default command line
- argument values</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--propertiesFilePath {propertiesFilePath}</option></term>
- <listitem>
- <para>Path to the file containing default property values used for
- command line arguments</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-T, --dontWrap</option></term>
- <listitem><para>Do not wrap long lines</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-v, --verbose</option></term>
- <listitem>
- <para>Use verbose mode</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>General Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--version</option></term>
- <listitem>
- <para>Display version information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- </refsect1>
- <refsect1>
- <title>Filter</title>
- <para>The filter argument is a string representation of an LDAP search filter
- as in <literal>(cn=Babs Jensen)</literal>, <literal
- >(&(objectClass=Person)(|(sn=Jensen)(cn=Babs J*)))</literal>, or
- <literal>(cn:caseExactMatch:=Fred Flintstone)</literal>.</para>
- </refsect1>
- <refsect1>
- <title>Attribute</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>
- <refsect1>
- <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">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>
- <refsect1>
- <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>
- <refsect1>
- <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>
-</refentry>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-ldif-diff.xml b/opendj-server-legacy/src/main/docbkx/reference/man-ldif-diff.xml
deleted file mode 100644
index 55a4b4e..0000000
--- a/opendj-server-legacy/src/main/docbkx/reference/man-ldif-diff.xml
+++ /dev/null
@@ -1,208 +0,0 @@
-<?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/opendj3/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 2011-2014 ForgeRock AS
- !
--->
-<refentry xml:id='ldif-diff-1'
- 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'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
- <refmeta>
- <refentrytitle>ldif-diff</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>ldif-diff</refname>
- <refpurpose>compare small LDIF files</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>ldif-diff</command>
- <arg choice="req">options</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to compare two LDIF files and report the
- differences in LDIF format.</para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>-a, --ignoreAttrs {file}</option></term>
- <listitem>
- <para>File containing a list of attributes to ignore when computing the
- difference.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--checkSchema</option></term>
- <listitem>
- <para>Takes into account the syntax of the attributes as defined in the
- schema to make the value comparison. The provided LDIF files must conform
- to the server schema.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-e, --ignoreEntries {file}</option></term>
- <listitem>
- <para>File containing a list of entries (DN) to ignore when computing the
- difference.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-o, --outputLDIF {file}</option></term>
- <listitem>
- <para>File to which the output should be written.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-O, --overwriteExisting</option></term>
- <listitem>
- <para>Any existing output file should be overwritten rather than appending
- to it.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-r, --useCompareResultCode</option></term>
- <listitem>
- <para>Use the LDAP compare result as an exit code for reporting
- differences between the two LDIF files.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-s, --sourceLDIF {file}</option></term>
- <listitem>
- <para>LDIF file to use as the source data.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-S, --singleValueChanges</option></term>
- <listitem>
- <para>Each attribute-level change should be written as a separate
- modification per attribute value rather than one modification per
- entry.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t, --targetLDIF {file}</option></term>
- <listitem>
- <para>LDIF file to use as the target data.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-V, --version</option></term>
- <listitem>
- <para>Display version information.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <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 -r option was used, and no differences are reported.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>6</term>
- <listitem>
- <para>The-r option was used, and differences are reported.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>other</term>
- <listitem>
- <para>An error occurred.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <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>
-</refentry>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-ldifmodify.xml b/opendj-server-legacy/src/main/docbkx/reference/man-ldifmodify.xml
deleted file mode 100644
index e83b0d7..0000000
--- a/opendj-server-legacy/src/main/docbkx/reference/man-ldifmodify.xml
+++ /dev/null
@@ -1,154 +0,0 @@
-<?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/opendj3/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 2011-2014 ForgeRock AS
- !
--->
-<refentry xml:id='ldifmodify-1'
- 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'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
- <refmeta>
- <refentrytitle>ldifmodify</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>ldifmodify</refname>
- <refpurpose>apply LDIF changes to LDIF</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>ldifmodify</command>
- <arg choice="req">options</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to apply a set of modify, add, and delete
- operations against data in an LDIF file.</para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>-m, --changesLDIF {ldifFile}</option></term>
- <listitem>
- <para>LDIF file containing the changes to apply.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-s, --sourceLDIF {ldifFile}</option></term>
- <listitem>
- <para>LDIF file containing the data to be updated.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t, --targetLDIF {ldifFile}</option></term>
- <listitem>
- <para>File to which the updated data should be written.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-V, --version</option></term>
- <listitem>
- <para>Display version information.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <title>Exit Codes</title>
- <variablelist>
- <varlistentry>
- <term>0</term>
- <listitem>
- <para>The command completed successfully.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>> 0</term>
- <listitem>
- <para>An error occurred.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <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>
-</refentry>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-ldifsearch.xml b/opendj-server-legacy/src/main/docbkx/reference/man-ldifsearch.xml
deleted file mode 100644
index 23509cc..0000000
--- a/opendj-server-legacy/src/main/docbkx/reference/man-ldifsearch.xml
+++ /dev/null
@@ -1,258 +0,0 @@
-<?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/opendj3/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 2011-2014 ForgeRock AS
- !
--->
-<refentry xml:id='ldifsearch-1'
- 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'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
- <refmeta>
- <refentrytitle>ldifsearch</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>ldifsearch</refname>
- <refpurpose>search LDIF with LDAP filters</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>ldifsearch</command>
- <arg choice="req">options</arg>
- <arg choice="opt">filter</arg>
- <arg choice="opt" rep="repeat">attribute</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to perform search operations against data in
- an LDIF file.</para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>-b, --baseDN {baseDN}</option></term>
- <listitem>
- <para>The base DN for the search. Multiple base DNs may be specified by
- providing the option multiple times. If no base DN is provided, then the
- root DSE will be used.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f, --filterFile {filterFile}</option></term>
- <listitem>
- <para>The path to the file containing the search filter(s) to use. If
- this is not provided, then the filter must be provided on the command line
- after all configuration options.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-l, --ldifFile {ldifFile}</option></term>
- <listitem>
- <para>LDIF file containing the data to search. Multiple files may be
- specified by providing the option multiple times. If no files are provided,
- the data will be read from standard input.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-o, --outputFile {outputFile}</option></term>
- <listitem>
- <para>The path to the output file to which the matching entries should be
- written. If this is not provided, then the data will be written to
- standard output.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-O, --overwriteExisting</option></term>
- <listitem>
- <para>Any existing output file should be overwritten rather than appending
- to it.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-s, --searchScope {scope}</option></term>
- <listitem>
- <para>The scope for the search. It must be one of 'base', 'one', 'sub',
- or 'subordinate'. If it is not provided, then 'sub' will be used.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t, --timeLimit {timeLimit}</option></term>
- <listitem>
- <para>Maximum length of time (in seconds) to spend processing.</para>
- <para>Default value: 0</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-T, --dontWrap</option></term>
- <listitem>
- <para>Long lines should not be wrapped.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-V, --version</option></term>
- <listitem>
- <para>Display version information.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z, --sizeLimit {sizeLimit}</option></term>
- <listitem>
- <para>Maximum number of matching entries to return.</para>
- <para>Default value: 0</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <title>Filter</title>
- <para>The filter argument is a string representation of an LDAP search filter
- as in <literal>(cn=Babs Jensen)</literal>, <literal
- >(&(objectClass=Person)(|(sn=Jensen)(cn=Babs J*)))</literal>, or
- <literal>(cn:caseExactMatch:=Fred Flintstone)</literal>.</para>
- </refsect1>
- <refsect1>
- <title>Attribute</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>
- <refsect1>
- <title>Exit Codes</title>
- <variablelist>
- <varlistentry>
- <term>0</term>
- <listitem>
- <para>The command completed successfully.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>> 0</term>
- <listitem>
- <para>An error occurred.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
- <para>The following example demonstrates use of the command.</para>
-
- <screen>
-$ <userinput>ldifsearch -l /path/to/Example.ldif -b dc=example,dc=com 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>
-</refentry>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-list-backends.xml b/opendj-server-legacy/src/main/docbkx/reference/man-list-backends.xml
deleted file mode 100644
index 0fa41b1..0000000
--- a/opendj-server-legacy/src/main/docbkx/reference/man-list-backends.xml
+++ /dev/null
@@ -1,119 +0,0 @@
-<?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/opendj3/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 2011-2014 ForgeRock AS
- !
--->
-<refentry xml:id='list-backends-1'
- 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'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
- <refmeta>
- <refentrytitle>list-backends</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>list-backends</refname>
- <refpurpose>list OpenDJ backends and base DNs</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>list-backends</command>
- <arg choice="opt">options</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to list the backends and base DNs configured
- in the Directory Server.</para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>-b, --baseDN {baseDN}</option></term>
- <listitem>
- <para>Base DN for which to list the backend ID.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-n, --backendID {backendName}</option></term>
- <listitem>
- <para>Backend ID of the backend for which to list the base DNs.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-V, --version</option></term>
- <listitem>
- <para>Display version information.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <title>Exit Codes</title>
- <variablelist>
- <varlistentry>
- <term>0</term>
- <listitem>
- <para>The command completed successfully.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>> 0</term>
- <listitem>
- <para>An error occurred.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <title>Examples</title>
-
- <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>
-</refentry>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-make-ldif-template.xml b/opendj-server-legacy/src/main/docbkx/reference/man-make-ldif-template.xml
deleted file mode 100644
index 33b7536..0000000
--- a/opendj-server-legacy/src/main/docbkx/reference/man-make-ldif-template.xml
+++ /dev/null
@@ -1,456 +0,0 @@
-<?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/opendj3/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 2012-2015 ForgeRock AS.
- !
--->
-<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'
- xsi:schemaLocation='http://docbook.org/ns/docbook
- http://docbook.org/xml/5.0/xsd/docbook.xsd'
- xmlns:xlink='http://www.w3.org/1999/xlink'>
- <info><copyright><year>2012-2015</year><holder>ForgeRock AS.</holder></copyright></info>
- <refmeta>
- <refentrytitle>make-ldif.template</refentrytitle><manvolnum>5</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>make-ldif.template</refname>
- <refpurpose>template file for the make-ldif command</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <synopsis># Comment lines start with #.
-#
-# Notice that this synopsis includes blank lines after entries.
-# 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]
-#
-define <replaceable>constant-name</replaceable>=<replaceable>value</replaceable>
-...
-
-# Define branches by suffix DN, such as the following:
-#
-# dc=example,dc=com
-# ou=People,dc=example,dc=com
-# ou=Groups,dc=example,dc=com
-#
-# make-ldif generates the necessary object class definitions and RDNs.
-#
-# A branch can have subordinateTemplates that define templates to use for
-# 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>
-[subordinateTemplate: <replaceable>template-name</replaceable>:<replaceable>number</replaceable>
-...]
-[<replaceable>attribute</replaceable>: <replaceable>attr-value</replaceable>
-...]
-
-...
-
-# Define entries using templates.
-#
-# A template can extend another template.
-# A template defines the RDN attribute(s) used for generated entries.
-# A template can have a subordinateTemplate that defines a template to use for
-# the generated entries.
-#
-# A template then defines attributes. See the Description below for more
-# information on specifying attribute values.
-#
-template: <replaceable>template-name</replaceable>
-[extends: <replaceable>template-name</replaceable>]
-rdnAttr: <replaceable>attribute</replaceable>[+<replaceable>attribute</replaceable> ...]
-[subordinateTemplate: <replaceable>template-name</replaceable>:<replaceable>number</replaceable>]
-[<replaceable>attribute</replaceable>: <replaceable>attr-value</replaceable>
-...]
-
-...
-</synopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
-
- <para>Template files specify how to build LDIF. They allow you to define
- variables, insert random values from other files, and generally build
- arbitrarily large LDIF files for testing purposes. You pass template files
- to the <command>make-ldif</command> command when generating LDIF.</para>
-
- <para>The Synopsis above shows the layout 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>
-
- <variablelist>
- <title>Specifying Attribute Values</title>
-
- <para>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>
-
- <programlisting language="ldif"
- >description: Description for [org] under [suffix]</programlisting>
-
- <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. Such tags are delimited with braces, <literal>{ }</literal>.
- For example, if your template includes definitions for first name and last
- name attributes:</para>
-
- <programlisting language="ldif">givenName: <first>
-sn: <last></programlisting>
-
- <para>Then you can define a mail attribute that uses the values of both
- attributes, and an initials attribute that takes the first character
- of each.</para>
-
- <programlisting language="ldif">mail: {givenName}.{sn}@[myDomain]
-initials: {givenName:1}{sn:1}</programlisting>
-
- <para>The other kind of tag is delimited with <literal><</literal>
- and <literal>></literal>, as shown above in the example with
- <literal><first></literal> and <literal><last></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>
-
- <para>Use backslashes to escape literal start tag characters (<literal
- >< [ {</literal>) as shown in the following example, and to escape literal
- end tag characters within tags (<literal>> ] }</literal>).</para>
-
- <programlisting language="ldif"
- >scimMail: \{"emails": \[\{"value": "{mail}", "type": "work", "primary": true}]}
-xml: \<id>{uid}\</id></programlisting>
-
- <para>OpenDJ supports the following tags.</para>
-
- <varlistentry>
- <term><DN></term>
- <listitem>
- <para>The DN tag gets replaced by the distinguished name of the current
- entry. 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>
- <literal><DN:1></literal> gets replaced by
- <literal>uid=bjensen</literal>, and <literal><DN:-2></literal> gets
- replaced by <literal>dc=example,dc=com</literal>.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><File></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, and an
- optional second argument, either <literal>random</literal> or
- <literal>sequential</literal>. For the file argument, either you specify
- an absolute path to the file such as
- <literal><file:/path/to/myDescriptions></literal>, or you specify
- a path relative to the
- <filename>/path/to/opendj/config/MakeLDIF/</filename> directory such as
- <literal><file:streets></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><First></term>
- <listitem>
- <para>The first name tag gets replaced by a random line from
- <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.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><GUID></term>
- <listitem>
- <para>The GUID tag gets replaced by a 128-bit, type 4 (random) universally
- unique identifier, such as
- <literal>f47ac10b-58cc-4372-a567-0e02b2c3d479</literal>.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><IfAbsent></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><Presence></literal> to define another attribute that is
- not always present on generated entries.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><IfPresent></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><Presence></literal> to define another attribute that is
- sometimes present on generated entries.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><Last></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.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><List></term>
- <listitem>
- <para>The List tag gets replaced by one of the values from the list of
- arguments you provide. For example,
- <literal><List:bronze:silver:gold></literal> gets replaced with
- <literal>bronze</literal>, <literal>silver</literal>, or
- <literal>gold</literal>.</para>
- <para>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><List:bronze;2:silver;1:gold;1></literal>.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><ParentDN></term>
- <listitem>
- <para>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><ParentDN></literal> gets replaced by
- <literal>ou=People,dc=example,dc=com</literal>.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><Presence></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: <Presence:50>A description</literal> generates
- <literal>description: A description</literal> on half the entries.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><Random></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><Random:<replaceable
- >subtype</replaceable>></literal>.</para>
-
- <itemizedlist>
- <listitem>
- <para><literal>alpha:<replaceable>length</replaceable></literal></para>
- </listitem>
- <listitem>
- <para><literal>alpha:<replaceable>minlength</replaceable>:<replaceable
- >maxlength</replaceable></literal></para>
- </listitem>
- <listitem>
- <para><literal>numeric:<replaceable>length</replaceable></literal></para>
- </listitem>
- <listitem>
- <para><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>,
- where <replaceable>format</replaceable> is a
- <literal>java.text.DecimalFormat</literal> pattern</para>
- </listitem>
- <listitem>
- <para><literal>alphanumeric:<replaceable>length</replaceable></literal></para>
- </listitem>
- <listitem>
- <para><literal>alphanumeric:<replaceable>minlength</replaceable>:<replaceable
- >maxlength</replaceable></literal></para>
- </listitem>
- <listitem>
- <para><literal>chars:<replaceable>characters</replaceable>:<replaceable
- >length</replaceable></literal></para>
- </listitem>
- <listitem>
- <para><literal>chars:<replaceable>characters</replaceable>:<replaceable
- >minlength</replaceable>:<replaceable>maxlength</replaceable></literal></para>
- </listitem>
- <listitem>
- <para><literal>hex:<replaceable>length</replaceable></literal></para>
- </listitem>
- <listitem>
- <para><literal>hex:<replaceable>minlength</replaceable>:<replaceable
- >maxlength</replaceable></literal></para>
- </listitem>
- <listitem>
- <para><literal>base64:<replaceable>length</replaceable></literal></para>
- </listitem>
- <listitem>
- <para><literal>base64:<replaceable>minlength</replaceable>:<replaceable
- >maxlength</replaceable></literal></para>
- </listitem>
- <listitem>
- <para><literal>month</literal></para>
- </listitem>
- <listitem>
- <para><literal>month:<replaceable>maxlength</replaceable></literal></para>
- </listitem>
- <listitem>
- <para><literal>telephone</literal>, a telephone number starting with
- the country code <literal>+1</literal></para>
- </listitem>
- </itemizedlist>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><RDN></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 subcomponents of the RDN
- to generate.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><Sequential></term>
- <listitem>
- <para>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><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>.</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><_DN></term>
- <listitem>
- <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><_ParentDN></term>
- <listitem>
- <para>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.</para>
-
- <programlisting language="plain"><![CDATA[define suffix=dc=example,dc=com
-define maildomain=example.com
-define numusers=50
-define numorgs=10
-
-branch: [suffix]
-
-branch: ou=People,[suffix]
-subordinateTemplate: orgunit:[numorgs]
-description: This is the People container
-telephoneNumber: +33 00010002
-
-template: orgunit
-subordinateTemplate: person:[numusers]
-rdnAttr: ou
-ou: Org-<sequential:0>
-objectClass: top
-objectClass: organizationalUnit
-description: This is the {ou} organizational unit
-
-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>
- </refsect1>
- <refsect1>
- <title>See Also</title>
- <para><link xlink:href="reference#make-ldif-1"
- xlink:role="http://docbook.org/xlink/role/olink"><citerefentry><refentrytitle
- >make-ldif</refentrytitle><manvolnum>1</manvolnum></citerefentry></link
- >, <filename>/path/to/opendj/config/MakeLDIF/example.template</filename></para>
- </refsect1>
-</refentry>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-make-ldif.xml b/opendj-server-legacy/src/main/docbkx/reference/man-make-ldif.xml
deleted file mode 100644
index 0e3e6ab..0000000
--- a/opendj-server-legacy/src/main/docbkx/reference/man-make-ldif.xml
+++ /dev/null
@@ -1,129 +0,0 @@
-<?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/opendj3/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 2011-2015 ForgeRock AS.
- !
--->
-<refentry xml:id='make-ldif-1'
- 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'>
- <info><copyright><year>2011-2015</year><holder>ForgeRock AS.</holder></copyright></info>
- <refmeta>
- <refentrytitle>make-ldif</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>make-ldif</refname>
- <refpurpose>generate test LDIF</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>make-ldif</command>
- <arg choice="req">options</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to generate LDIF data based on a definition
- in a template file.</para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>-o, --ldifFile {file}</option></term>
- <listitem>
- <para>The path to the LDIF file to be written.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-s, --randomSeed {seed}</option></term>
- <listitem>
- <para>The seed to use to initialize the random number generator.</para>
- <para>Default value: 0</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t, --templateFile {file}</option></term>
- <listitem>
- <para>The path to the template file with information about the LDIF data
- to generate.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-V, --version</option></term>
- <listitem>
- <para>Display version information.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <title>Exit Codes</title>
- <variablelist>
- <varlistentry>
- <term>0</term>
- <listitem>
- <para>The command completed successfully.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>> 0</term>
- <listitem>
- <para>An error occurred.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <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>
- <refsect1>
- <title>See Also</title>
- <para><link xlink:href="reference#make-ldif-template-5"
- xlink:role="http://docbook.org/xlink/role/olink"><citerefentry><refentrytitle
- >make-ldif.template</refentrytitle><manvolnum>5</manvolnum
- ></citerefentry></link></para>
- </refsect1>
-</refentry>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-manage-account.xml b/opendj-server-legacy/src/main/docbkx/reference/man-manage-account.xml
deleted file mode 100644
index 51eb093..0000000
--- a/opendj-server-legacy/src/main/docbkx/reference/man-manage-account.xml
+++ /dev/null
@@ -1,382 +0,0 @@
-<?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/opendj3/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 2011-2014 ForgeRock AS
- !
--->
-<refentry xml:id='manage-account-1'
- 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'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
- <refmeta>
- <refentrytitle>manage-account</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>manage-account</refname>
- <refpurpose>manage state of directory server accounts</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>manage-account</command>
- <command><replaceable>subcommand</replaceable></command>
- <arg choice="req">options</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to retrieve and manipulate the values of
- password policy state variables.</para>
- </refsect1>
- <refsect1>
- <title>Subcommands</title>
- <para>The following subcommands are supported.</para>
- <variablelist>
- <varlistentry>
- <term><command>manage-account clear-account-is-disabled</command></term>
- <listitem>
- <para>Clear account disabled state information from the user account</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>manage-account get-account-expiration-time</command></term>
- <listitem>
- <para>Display when the user account will expire</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>manage-account get-account-is-disabled</command></term>
- <listitem>
- <para>Display information about whether the user account has been
- administratively disabled</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>manage-account get-all</command></term>
- <listitem>
- <para>Display all password policy state information for the user</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>manage-account get-authentication-failure-times</command></term>
- <listitem>
- <para>Display the authentication failure times for the user</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>manage-account get-grace-login-use-times</command></term>
- <listitem>
- <para>Display the grace login use times for the user</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>manage-account get-last-login-time</command></term>
- <listitem>
- <para>Display the time that the user last authenticated to the server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>manage-account get-password-changed-by-required-time</command></term>
- <listitem>
- <para>Display the required password change time with which the user last
- complied</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>manage-account get-password-changed-time</command></term>
- <listitem>
- <para>Display the time that the user's password was last changed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>manage-account get-password-expiration-warned-time</command></term>
- <listitem>
- <para>Display the time that the user first received an expiration warning
- notice</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>manage-account get-password-history</command></term>
- <listitem>
- <para>Display password history state values for the user</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>manage-account get-password-is-reset</command></term>
- <listitem>
- <para>Display information about whether the user will be required to
- change his or her password on the next successful authentication</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>manage-account get-password-policy-dn</command></term>
- <listitem>
- <para>Display the DN of the password policy for the user</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>manage-account get-remaining-authentication-failure-count</command></term>
- <listitem>
- <para>Display the number of remaining authentication failures until the
- user's account is locked</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>manage-account get-remaining-grace-login-count</command></term>
- <listitem>
- <para>Display the number of grace logins remaining for the user</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>manage-account get-seconds-until-account-expiration</command></term>
- <listitem>
- <para>Display the length of time in seconds until the user account
- expires</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>manage-account get-seconds-until-authentication-failure-unlock</command></term>
- <listitem>
- <para>Display the length of time in seconds until the authentication
- failure lockout expires</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>manage-account get-seconds-until-idle-lockout</command></term>
- <listitem>
- <para>Display the length of time in seconds until user's account is locked
- because it has remained idle for too long</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>manage-account get-seconds-until-password-expiration</command></term>
- <listitem>
- <para>Display length of time in seconds until the user's password expires</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>manage-account get-seconds-until-password-expiration-warning</command></term>
- <listitem>
- <para>Display the length of time in seconds until the user should start
- receiving password expiration warning notices</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>manage-account get-seconds-until-password-reset-lockout</command></term>
- <listitem>
- <para>Display the length of time in seconds until user's account is locked
- because the user failed to change the password in a timely manner after an
- administrative reset</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>manage-account get-seconds-until-required-change-time</command></term>
- <listitem>
- <para>Display the length of time in seconds that the user has remaining to
- change his or her password before the account becomes locked due to the
- required change time</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>manage-account set-account-is-disabled</command></term>
- <listitem>
- <para>Specify whether the user account has been administratively disabled</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <title>Global Options</title>
- <para>The following global options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>-b, --targetDN {targetDN}</option></term>
- <listitem>
- <para>The DN of the user entry for which to get and set password policy
- state information</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <refsect2>
- <title>LDAP Connection Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-D, --bindDN {bindDN}</option></term>
- <listitem>
- <para>DN to use to bind to the server</para>
- <para>Default value: cn=Directory Manager</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-h, --hostname {host}</option></term>
- <listitem>
- <para>Directory server hostname or IP address</para>
- <para>Default value: localhost.localdomain</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>
- <listitem>
- <para>Bind password file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-K, --keyStorePath {keyStorePath}</option></term>
- <listitem>
- <para>Certificate key store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-N, --certNickname {nickname}</option></term>
- <listitem>
- <para>Nickname of certificate for SSL client authentication</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-o, --saslOption {name=value}</option></term>
- <listitem>
- <para>SASL bind options</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-p, --port {port}</option></term>
- <listitem>
- <para>Directory server administration port number</para>
- <para>Default value: 4444</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-P, --trustStorePath {trustStorePath}</option></term>
- <listitem>
- <para>Certificate trust store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-T, --trustStorePassword {trustStorePassword}</option></term>
- <listitem>
- <para>Certificate trust store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
- <listitem>
- <para>Certificate key store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-U, --trustStorePasswordFile {path}</option></term>
- <listitem>
- <para>Certificate trust store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-w, --bindPassword {bindPassword}</option></term>
- <listitem>
- <para>Password to use to bind to the server</para>
- <para>Use <option>-w -</option> to have the command prompt for the
- password, rather than enter the password on the command line.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
- <listitem>
- <para>Certificate key store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-X, --trustAll</option></term>
- <listitem>
- <para>Trust all server SSL certificates</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>General Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-V, --version</option></term>
- <listitem>
- <para>Display version information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- </refsect1>
- <refsect1>
- <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>
- <refsect1>
- <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>
-</refentry>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-manage-tasks.xml b/opendj-server-legacy/src/main/docbkx/reference/man-manage-tasks.xml
deleted file mode 100644
index 963bf91..0000000
--- a/opendj-server-legacy/src/main/docbkx/reference/man-manage-tasks.xml
+++ /dev/null
@@ -1,254 +0,0 @@
-<?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/opendj3/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 2011-2014 ForgeRock AS
- !
--->
-<refentry xml:id='manage-tasks-1'
- 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'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
- <refmeta>
- <refentrytitle>manage-tasks</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>manage-tasks</refname>
- <refpurpose>manage OpenDJ server administration tasks</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>manage-tasks</command>
- <arg choice="req">options</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to obtain a list of tasks scheduled to run
- within the directory server as well as information about individual
- tasks.</para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>-c, --cancel {taskID}</option></term>
- <listitem>
- <para>ID of a particular task to cancel</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-i, --info {taskID}</option></term>
- <listitem>
- <para>ID of a particular task about which this tool will display
- information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-s, --summary</option></term>
- <listitem>
- <para>Print a summary of tasks</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <refsect2>
- <title>LDAP Connection Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--connectTimeout {timeout}</option></term>
- <listitem>
- <para>Maximum length of time (in milliseconds) that can be taken to
- establish a connection. Use '0' to specify no time out.</para>
- <para>Default value: 30000</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-D, --bindDN {bindDN}</option></term>
- <listitem>
- <para>DN to use to bind to the server</para>
- <para>Default value: cn=Directory Manager</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-h, --hostname {host}</option></term>
- <listitem>
- <para>Directory server hostname or IP address</para>
- <para>Default value: localhost.localdomain</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>
- <listitem>
- <para>Bind password file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-K, --keyStorePath {keyStorePath}</option></term>
- <listitem>
- <para>Certificate key store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-N, --certNickname {nickname}</option></term>
- <listitem>
- <para>Nickname of certificate for SSL client authentication</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-o, --saslOption {name=value}</option></term>
- <listitem>
- <para>SASL bind options</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-p, --port {port}</option></term>
- <listitem>
- <para>Directory server administration port number</para>
- <para>Default value: 4444</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-P, --trustStorePath {trustStorePath}</option></term>
- <listitem>
- <para>Certificate trust store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-T, --trustStorePassword {trustStorePassword}</option></term>
- <listitem>
- <para>Certificate trust store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
- <listitem>
- <para>Certificate key store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-U, --trustStorePasswordFile {path}</option></term>
- <listitem>
- <para>Certificate trust store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-w, --bindPassword {bindPassword}</option></term>
- <listitem>
- <para>Password to use to bind to the server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
- <listitem>
- <para>Certificate key store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-X, --trustAll</option></term>
- <listitem>
- <para>Trust all server SSL certificates</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>Utility Input/Output Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-n, --no-prompt</option></term>
- <listitem>
- <para>Use non-interactive mode. If data in the command is missing, the
- user is not prompted and the tool will fail</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--noPropertiesFile</option></term>
- <listitem>
- <para>No properties file will be used to get default command line
- argument values</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--propertiesFilePath {propertiesFilePath}</option></term>
- <listitem>
- <para>Path to the file containing default property values used for
- command line arguments</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>General Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-V, --version</option></term>
- <listitem>
- <para>Display version information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- </refsect1>
- <refsect1>
- <title>Exit Codes</title>
- <variablelist>
- <varlistentry>
- <term>0</term>
- <listitem>
- <para>The command completed successfully.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>> 0</term>
- <listitem>
- <para>An error occurred.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <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>
-</refentry>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-rebuild-index.xml b/opendj-server-legacy/src/main/docbkx/reference/man-rebuild-index.xml
deleted file mode 100644
index e8de653..0000000
--- a/opendj-server-legacy/src/main/docbkx/reference/man-rebuild-index.xml
+++ /dev/null
@@ -1,331 +0,0 @@
-<?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/opendj3/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 2011-2015 ForgeRock AS.
- !
--->
-<refentry xml:id='rebuild-index-1'
- 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'>
- <info><copyright><year>2011-2015</year><holder>ForgeRock AS.</holder></copyright></info>
- <refmeta>
- <refentrytitle>rebuild-index</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>rebuild-index</refname>
- <refpurpose>rebuild index after configuration change</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>rebuild-index</command>
- <arg choice="req">options</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>
- This utility can be used to rebuild index data within an indexed backend database.
- </para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>-b, --baseDN {baseDN}</option></term>
- <listitem>
- <para>Base DN of a backend supporting indexing. Rebuild is performed on
- indexes within the scope of the given base DN.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--clearDegradedState</option></term>
- <listitem>
- <para>Indicates that indexes do not need rebuilding because they are known
- to be empty and forcefully marks them as valid. <emphasis>This is an
- advanced option which must only be used in cases where a degraded index is
- known to be empty and does not therefore need rebuilding.</emphasis> This
- situation typically arises when an index is created for an attribute which
- has just been added to the schema.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-i, --index {index}</option></term>
- <listitem>
- <para>Names of index(es) to rebuild. For an attribute index this is
- simply an attribute name. At least one index must be specified for
- rebuild. Cannot be used with the <option>--rebuildAll</option>
- or <option>--rebuildDegraded</option> options.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--rebuildAll</option></term>
- <listitem>
- <para>Rebuild all indexes, including any DN2ID, DN2URI, VLV and
- extensible indexes. Cannot be used with the <option>--index</option>
- or <option>--rebuildDegraded</option> options.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--rebuildDegraded</option></term>
- <listitem>
- <para>Rebuild all degraded indexes, including any DN2ID, DN2URI, VLV and
- extensible indexes. Cannot be used with the <option>--index</option>
- or <option>--rebuildAll</option> options.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--tmpdirectory {directory}</option></term>
- <listitem>
- <para>Path to temporary directory for index scratch files during index
- rebuilding.</para>
- <para>Default value: import-tmp</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <refsect2>
- <title>Task Backend Connection Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--connectTimeout {timeout}</option></term>
- <listitem>
- <para>Maximum length of time (in milliseconds) that can be taken to
- establish a connection. Use '0' to specify no time out.</para>
- <para>Default value: 30000</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-D, --bindDN {bindDN}</option></term>
- <listitem>
- <para>DN to use to bind to the server</para>
- <para>Default value: cn=Directory Manager</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-h, --hostname {host}</option></term>
- <listitem>
- <para>Directory server hostname or IP address</para>
- <para>Default value: localhost.localdomain</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>
- <listitem>
- <para>Bind password file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-K, --keyStorePath {keyStorePath}</option></term>
- <listitem>
- <para> Certificate key store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-N, --certNickname {nickname}</option></term>
- <listitem>
- <para>Nickname of certificate for SSL client authentication</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-o, --saslOption {name=value}</option></term>
- <listitem>
- <para>SASL bind options</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-p, --port {port}</option></term>
- <listitem>
- <para>Directory server administration port number</para>
- <para>Default value: 4444</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-P, --trustStorePath {trustStorePath}</option></term>
- <listitem>
- <para>Certificate trust store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-T, --trustStorePassword {trustStorePassword}</option></term>
- <listitem>
- <para>Certificate trust store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
- <listitem>
- <para>Certificate key store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-U, --trustStorePasswordFile {path}</option></term>
- <listitem>
- <para>Certificate trust store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-w, --bindPassword {bindPassword}</option></term>
- <listitem>
- <para>Password to use to bind to the server</para>
- <para>Use <option>-w -</option> to have the command prompt for the
- password, rather than enter the password on the command line.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
- <listitem>
- <para>Certificate key store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-X, --trustAll</option></term>
- <listitem>
- <para>Trust all server SSL certificates</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>Task Scheduling Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--completionNotify {emailAddress}</option></term>
- <listitem>
- <para>Email address of a recipient to be notified when the task
- completes. This option may be specified more than once.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--dependency {taskID}</option></term>
- <listitem>
- <para>ID of a task upon which this task depends. A task will not start
- execution until all its dependencies have completed execution.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--errorNotify {emailAddress}</option></term>
- <listitem>
- <para>Email address of a recipient to be notified if an error occurs
- when this task executes. This option may be specified more than
- once.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--failedDependencyAction {action}</option></term>
- <listitem>
- <para>Action this task will take should one if its dependent tasks fail.
- The value must be one of PROCESS, CANCEL, DISABLE. If not specified
- defaults to CANCEL.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--recurringTask {schedulePattern}</option></term>
- <listitem>
- <para>Indicates the task is recurring and will be scheduled according
- to the value argument expressed in crontab(5) compatible time/date
- pattern.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t, --start {startTime}</option></term>
- <listitem>
- <para>Indicates the date/time at which this operation will start when
- scheduled as a server task expressed in YYYYMMDDhhmmssZ format for UTC
- time or YYYYMMDDhhmmss for local time. A value of '0' will cause the
- task to be scheduled for immediate execution. When this option is
- specified the operation will be scheduled to start at the specified
- time after which this utility will exit immediately.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>Utility Input/Output Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--noPropertiesFile</option></term>
- <listitem>
- <para>No properties file will be used to get default command line
- argument values</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--propertiesFilePath {propertiesFilePath}</option></term>
- <listitem>
- <para>Path to the file containing default property values used for
- command line arguments</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>General Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-V, --version</option></term>
- <listitem>
- <para>Display version information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- </refsect1>
- <refsect1>
- <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 while parsing the command-line arguments.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <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>
-</refentry>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-restore.xml b/opendj-server-legacy/src/main/docbkx/reference/man-restore.xml
deleted file mode 100644
index 354c776..0000000
--- a/opendj-server-legacy/src/main/docbkx/reference/man-restore.xml
+++ /dev/null
@@ -1,329 +0,0 @@
-<?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/opendj3/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 2011-2014 ForgeRock AS
- !
--->
-<refentry xml:id='restore-1'
- 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'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
- <refmeta>
- <refentrytitle>restore</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>restore</refname>
- <refpurpose>restore OpenDJ directory data backups</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>restore</command>
- <arg choice="req">options</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to restore a backup of a directory server
- backend.</para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>-d, --backupDirectory {backupDir}</option></term>
- <listitem>
- <para>Path to the target directory for the backup file(s)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-I, --backupID {backupID}</option></term>
- <listitem>
- <para>Use the provided identifier for the backup</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-l, --listBackups</option></term>
- <listitem>
- <para>List available backups in the backup directory</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-n, --dry-run</option></term>
- <listitem>
- <para>Verify the contents of the backup but do not restore it</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <refsect2>
- <title>Task Backend Connection Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--connectTimeout {timeout}</option></term>
- <listitem>
- <para>Maximum length of time (in milliseconds) that can be taken to
- establish a connection. Use '0' to specify no time out.</para>
- <para>Default value: 30000</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-D, --bindDN {bindDN}</option></term>
- <listitem>
- <para>DN to use to bind to the server</para>
- <para>Default value: cn=Directory Manager</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-h, --hostname {host}</option></term>
- <listitem>
- <para>Directory server hostname or IP address</para>
- <para>Default value: localhost.localdomain</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>
- <listitem>
- <para>Bind password file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-K, --keyStorePath {keyStorePath}</option></term>
- <listitem>
- <para>Certificate key store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-N, --certNickname {nickname}</option></term>
- <listitem>
- <para>Nickname of certificate for SSL client authentication</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-o, --saslOption {name=value}</option></term>
- <listitem>
- <para>SASL bind options</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-p, --port {port}</option></term>
- <listitem>
- <para>Directory server administration port number</para>
- <para>Default value: 4444</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-P, --trustStorePath {trustStorePath}</option></term>
- <listitem>
- <para>Certificate trust store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-T, --trustStorePassword {trustStorePassword}</option></term>
- <listitem>
- <para>Certificate trust store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
- <listitem>
- <para>Certificate key store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-U, --trustStorePasswordFile {path}</option></term>
- <listitem>
- <para>Certificate trust store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-w, --bindPassword {bindPassword}</option></term>
- <listitem>
- <para>Password to use to bind to the server</para>
- <para>Use <option>-w -</option> to have the command prompt for the
- password, rather than enter the password on the command line.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
- <listitem>
- <para>Certificate key store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-X, --trustAll</option></term>
- <listitem>
- <para>Trust all server SSL certificates</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>Task Scheduling Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--completionNotify {emailAddress}</option></term>
- <listitem>
- <para>Email address of a recipient to be notified when the task
- completes. This option may be specified more than once.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--dependency {taskID}</option></term>
- <listitem>
- <para>ID of a task upon which this task depends. A task will not start
- execution until all its dependencies have completed execution.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--errorNotify {emailAddress}</option></term>
- <listitem>
- <para>Email address of a recipient to be notified if an error occurs
- when this task executes. This option may be specified more than
- once.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--failedDependencyAction {action}</option></term>
- <listitem>
- <para>Action this task will take should one if its dependent tasks fail.
- The value must be one of PROCESS, CANCEL, DISABLE. If not specified
- defaults to CANCEL.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--recurringTask {schedulePattern}</option></term>
- <listitem>
- <para>Indicates the task is recurring and will be scheduled according
- to the value argument expressed in crontab(5) compatible time/date
- pattern.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t, --start {startTime}</option></term>
- <listitem>
- <para>Indicates the date/time at which this operation will start when
- scheduled as a server task expressed in YYYYMMDDhhmmssZ format for UTC
- time or YYYYMMDDhhmmss for local time. A value of '0' will cause the
- task to be scheduled for immediate execution. When this option is
- specified the operation will be scheduled to start at the specified
- time after which this utility will exit immediately.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>Utility Input/Output Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--noPropertiesFile</option></term>
- <listitem>
- <para>No properties file will be used to get default command line
- argument values</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--propertiesFilePath {propertiesFilePath}</option></term>
- <listitem>
- <para>Path to the file containing default property values used for
- command line arguments</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>General Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-V, --version</option></term>
- <listitem>
- <para>Display version information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- </refsect1>
- <refsect1>
- <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 while parsing the command-line arguments.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <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>
-</refentry>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-setup.xml b/opendj-server-legacy/src/main/docbkx/reference/man-setup.xml
deleted file mode 100644
index 20b6013..0000000
--- a/opendj-server-legacy/src/main/docbkx/reference/man-setup.xml
+++ /dev/null
@@ -1,347 +0,0 @@
-<?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/opendj3/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 2011-2014 ForgeRock AS
- !
--->
-<refentry xml:id='setup-1'
- 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'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
- <refmeta>
- <refentrytitle>setup</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>setup</refname>
- <refpurpose>install OpenDJ directory server</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>setup</command>
- <arg choice="opt">options</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to setup the directory server.</para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>-a, --addBaseEntry</option></term>
- <listitem>
- <para>Indicates whether to create the base entry in the directory server
- database</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--adminConnectorPort {port}</option></term>
- <listitem>
- <para>Port on which the Administration Connector should listen for
- communication</para>
- <para>Default value: 4444</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-b, --baseDN {baseDN}</option></term>
- <listitem>
- <para>Base DN for user information in the directory server. Multiple base
- DNs may be provided by using this option multiple times</para>
- <para>Default value: dc=example,dc=com</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-d, --sampleData {numEntries}</option></term>
- <listitem>
- <para>Specifies that the database should be populated with the specified
- number of sample entries</para>
- <para>Default value: 0</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-D, --rootUserDN {rootUserDN}</option></term>
- <listitem>
- <para>DN for the initial root user for the directory server</para>
- <para>Default value: cn=Directory Manager</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--generateSelfSignedCertificate</option></term>
- <listitem>
- <para>Generate a self-signed certificate that the server should use when
- accepting SSL-based connections or performing StartTLS negotiation</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-h, --hostname {host}</option></term>
- <listitem>
- <para>The fully-qualified directory server host name that will be used
- when generating self-signed certificates for LDAP SSL/StartTLS, the
- administration connector, and replication</para>
- <para>Default value: localhost.localdomain</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-i, --cli</option></term>
- <listitem>
- <para>Use the command line install. If not specified the graphical
- interface will be launched. The rest of the options (excluding help and
- version) will only be taken into account if this option is specified</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-j, --rootUserPasswordFile {rootUserPasswordFile}</option></term>
- <listitem>
- <para>Path to a file containing the password for the initial root user for
- the directory server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-l, --ldifFile {ldifFile}</option></term>
- <listitem>
- <para>Path to an LDIF file containing data that should be added to the
- directory server database. Multiple LDIF files may be provided by using
- this option multiple times</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-N, --certNickname {nickname}</option></term>
- <listitem>
- <para>Nickname of the certificate that the server should use when
- accepting SSL-based connections or performing StartTLS negotiation</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-O, --doNotStart</option></term>
- <listitem>
- <para>Do not start the server when the configuration is completed</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-p, --ldapPort {port}</option></term>
- <listitem>
- <para>Port on which the Directory Server should listen for LDAP
- communication</para>
- <para>Default value: 389</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-q, --enableStartTLS</option></term>
- <listitem>
- <para>Enable StartTLS to allow secure communication with the server using
- the LDAP port</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-R, --rejectFile {rejectFile}</option></term>
- <listitem>
- <para>Write rejected entries to the specified file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-S, --skipPortCheck</option></term>
- <listitem>
- <para>Skip the check to determine whether the specified ports are
- usable</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--skipFile {skipFile}</option></term>
- <listitem>
- <para>Write skipped entries to the specified file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
- <listitem>
- <para>Certificate key store PIN file. A PIN is required when you specify
- to use an existing certificate (JKS, JCEKS, PKCS#12 or PKCS#11) as server
- certificate</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--useJavaKeystore {keyStorePath}</option></term>
- <listitem>
- <para>Path of a Java Key Store (JKS) containing a certificate to be used
- as the server certificate</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--useJCEKS {keyStorePath}</option></term>
- <listitem>
- <para>Path of a JCEKS containing a certificate to be used as the server
- certificate</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--usePkcs11Keystore</option></term>
- <listitem>
- <para>Use a certificate in a PKCS#11 token that the server should use when
- accepting SSL-based connections or performing StartTLS negotiation</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--usePkcs12keyStore {keyStorePath}</option></term>
- <listitem>
- <para>Path of a PKCS#12 key store containing the certificate that the
- server should use when accepting SSL-based connections or performing
- StartTLS negotiation</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-w, --rootUserPassword {rootUserPassword}</option></term>
- <listitem>
- <para>Password for the initial root user for the Directory Server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
- <listitem>
- <para>Certificate key store PIN. A PIN is required when you specify
- to use an existing certificate (JKS, JCEKS, PKCS#12 or PKCS#11) as server
- certificate</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-x, --jmxPort {jmxPort}</option></term>
- <listitem>
- <para>Port on which the Directory Server should listen for JMX
- communication</para>
- <para>Default value: 1689</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-Z, --ldapsPort {port}</option></term>
- <listitem>
- <para>Port on which the Directory Server should listen for LDAPS
- communication. The LDAPS port will be configured and SSL will be enabled
- only if this argument is explicitly specified</para>
- <para>Default value: 636</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <refsect2>
- <title>Utility Input/Output Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-n, --no-prompt</option></term>
- <listitem>
- <para>Use non-interactive mode. If data in the command is missing, the
- user is not prompted and the tool will fail</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--noPropertiesFile</option></term>
- <listitem>
- <para>No properties file will be used to get default command line
- argument values</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--propertiesFilePath {propertiesFilePath}</option></term>
- <listitem>
- <para>Path to the file containing default property values used for
- command line arguments</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-Q, --quiet</option></term>
- <listitem>
- <para>Run setup in quiet mode. Quiet mode will not output progress
- information to standard output</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-v, --verbose</option></term>
- <listitem>
- <para>Use verbose mode</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>General Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-V, --version</option></term>
- <listitem>
- <para>Display version information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- </refsect1>
- <refsect1>
- <title>Exit Codes</title>
- <variablelist>
- <varlistentry>
- <term>0</term>
- <listitem>
- <para>The command completed successfully.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>> 0</term>
- <listitem>
- <para>An error occurred.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <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 <?eval ${docTargetVersion}?>
-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>
-</refentry>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-start-ds.xml b/opendj-server-legacy/src/main/docbkx/reference/man-start-ds.xml
deleted file mode 100644
index 9f7c100..0000000
--- a/opendj-server-legacy/src/main/docbkx/reference/man-start-ds.xml
+++ /dev/null
@@ -1,137 +0,0 @@
-<?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/opendj3/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 2011-2014 ForgeRock AS
- !
--->
-<refentry xml:id='start-ds-1'
- 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'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
- <refmeta>
- <refentrytitle>start-ds</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>start-ds</refname>
- <refpurpose>start OpenDJ directory server</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>start-ds</command>
- <arg choice="opt">options</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to start the directory server, as well as to
- obtain the server version and other forms of general server
- information.</para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>-L, --useLastKnownGoodConfig</option></term>
- <listitem>
- <para>Attempt to start using the configuration that was in place at the
- last successful startup (if it is available) rather than using the current
- active configuration.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-N, --nodetach</option></term>
- <listitem>
- <para>Do not detach from the terminal and continue running in the
- foreground. This option cannot be used with the -t, --timeout
- option.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-Q, --quiet</option></term>
- <listitem>
- <para>Use quiet mode.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-s, --systemInfo</option></term>
- <listitem>
- <para>Display general system information.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t, --timeout {seconds}</option></term>
- <listitem>
- <para>Maximum time (in seconds) to wait before the command returns (the
- server continues the startup process, regardless). A value of '0'
- indicates an infinite timeout, which means that the command returns only
- when the server startup is completed. The default value is 60 seconds.
- This option cannot be used with the -N, --nodetach option.</para>
- <para>Default value: 200</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-V, --version</option></term>
- <listitem>
- <para>Display version information.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <title>Exit Codes</title>
- <variablelist>
- <varlistentry>
- <term>0</term>
- <listitem>
- <para>The command completed successfully.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>> 0</term>
- <listitem>
- <para>An error occurred.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <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>
-</refentry>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-status.xml b/opendj-server-legacy/src/main/docbkx/reference/man-status.xml
deleted file mode 100644
index 3e84575..0000000
--- a/opendj-server-legacy/src/main/docbkx/reference/man-status.xml
+++ /dev/null
@@ -1,256 +0,0 @@
-<?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/opendj3/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 2011-2014 ForgeRock AS
- !
--->
-<refentry xml:id='status-1'
- 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'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
- <refmeta>
- <refentrytitle>status</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>status</refname>
- <refpurpose>display basic OpenDJ server information</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>status</command>
- <arg choice="opt">options</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to display basic server information.</para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <refsect2>
- <title>LDAP Connection Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--connectTimeout {timeout}</option></term>
- <listitem>
- <para>Maximum length of time (in milliseconds) that can be taken to
- establish a connection. Use '0' to specify no time out.</para>
- <para>Default value: 30000</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-D, --bindDN {bindDN}</option></term>
- <listitem>
- <para>DN to use to bind to the server</para>
- <para>Default value: cn=Directory Manager</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>
- <listitem>
- <para>Bind password file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-K, --keyStorePath {keyStorePath}</option></term>
- <listitem>
- <para>Certificate key store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-N, --certNickname {nickname}</option></term>
- <listitem>
- <para>Nickname of certificate for SSL client authentication</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-o, --saslOption {name=value}</option></term>
- <listitem>
- <para>SASL bind options</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-P, --trustStorePath {trustStorePath}</option></term>
- <listitem>
- <para>Certificate trust store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-T, --trustStorePassword {trustStorePassword}</option></term>
- <listitem>
- <para>Certificate trust store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
- <listitem>
- <para>Certificate key store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-U, --trustStorePasswordFile {path}</option></term>
- <listitem>
- <para>Certificate trust store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-w, --bindPassword {bindPassword}</option></term>
- <listitem>
- <para>Password to use to bind to the server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
- <listitem>
- <para>Certificate key store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-X, --trustAll</option></term>
- <listitem>
- <para>Trust all server SSL certificates</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>Utility Input/Output Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-n, --no-prompt</option></term>
- <listitem>
- <para>Use non-interactive mode. If data in the command is missing, the
- user is not prompted and the tool will fail</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--noPropertiesFile</option></term>
- <listitem>
- <para>No properties file will be used to get default command line
- argument values</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-r, --refresh {period}</option></term>
- <listitem>
- <para>When this argument is specified, the status command will display
- its contents periodically. Used to specify the period (in seconds)
- between two status displays</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-s, --script-friendly</option></term>
- <listitem>
- <para>Use script-friendly mode</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>General Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-V, --version</option></term>
- <listitem>
- <para>Display version information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- </refsect1>
- <refsect1>
- <title>Exit Codes</title>
- <variablelist>
- <varlistentry>
- <term>0</term>
- <listitem>
- <para>The command completed successfully.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>> 0</term>
- <listitem>
- <para>An error occurred.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <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 <?eval ${docTargetVersion}?>
-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: <not available>
-
-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>
-</refentry>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-stop-ds.xml b/opendj-server-legacy/src/main/docbkx/reference/man-stop-ds.xml
deleted file mode 100644
index 449c254..0000000
--- a/opendj-server-legacy/src/main/docbkx/reference/man-stop-ds.xml
+++ /dev/null
@@ -1,257 +0,0 @@
-<?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/opendj3/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 2011-2014 ForgeRock AS
- !
--->
-<refentry xml:id='stop-ds-1'
- 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'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
- <refmeta>
- <refentrytitle>stop-ds</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>stop-ds</refname>
- <refpurpose>stop OpenDJ directory server</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>stop-ds</command>
- <arg choice="opt">options</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to request that the directory server stop
- running or perform a restart.</para>
- <para>When run without connection options, <command>stop-ds</command>
- sends a signal to the OpenDJ process to stop the server. When run with
- connection options, the <command>stop-ds</command> connects to the OpenDJ
- administration port and creates a shutdown task to stop the server.</para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>-r, --stopReason {stopReason}</option></term>
- <listitem>
- <para>Reason the server is being stopped or restarted.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-R, --restart</option></term>
- <listitem>
- <para>Attempt to automatically restart the server once it has
- stopped.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t, --stopTime {stopTime}</option></term>
- <listitem>
- <para>Indicates the date/time at which the shutdown operation will begin
- as a server task expressed in format YYYYMMDDhhmmssZ for UTC time or
- YYYYMMDDhhmmss for local time. A value of '0' will cause the shutdown to
- be scheduled for immediate execution. When this option is specified the
- operation will be scheduled to start at the specified time after which this
- utility will exit immediately.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-Y, --proxyAs {authzID}</option></term>
- <listitem>
- <para>Use the proxied authorization control with the given authorization
- ID.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <refsect2>
- <title>LDAP Connection Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-D, --bindDN {bindDN}</option></term>
- <listitem>
- <para>DN to use to bind to the server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-h, --hostname {host}</option></term>
- <listitem>
- <para>Directory server hostname or IP address</para>
- <para>Default value: 127.0.0.1</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>
- <listitem>
- <para>Bind password file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-K, --keyStorePath {keyStorePath}</option></term>
- <listitem>
- <para>Certificate key store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-N, --certNickname {nickname}</option></term>
- <listitem>
- <para>Nickname of certificate for SSL client authentication</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-o, --saslOption {name=value}</option></term>
- <listitem>
- <para>SASL bind options</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-p, --port {port}</option></term>
- <listitem>
- <para>Directory server administration port number</para>
- <para>Default value: 4444</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-P, --trustStorePath {trustStorePath}</option></term>
- <listitem>
- <para>Certificate trust store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-T, --trustStorePassword {trustStorePassword}</option></term>
- <listitem>
- <para>Certificate trust store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
- <listitem>
- <para>Certificate key store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-U, --trustStorePasswordFile {path}</option></term>
- <listitem>
- <para>Certificate trust store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-w, --bindPassword {bindPassword}</option></term>
- <listitem>
- <para>Password to use to bind to the server</para>
- <para>Use <option>-w -</option> to have the command prompt for the
- password, rather than enter the password on the command line.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
- <listitem>
- <para>Certificate key store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-X, --trustAll</option></term>
- <listitem>
- <para>Trust all server SSL certificates</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>Utility Input/Output Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--noPropertiesFile</option></term>
- <listitem>
- <para>No properties file will be used to get default command line
- argument values</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--propertiesFilePath {propertiesFilePath}</option></term>
- <listitem>
- <para>Path to the file containing default property values used for
- command line arguments</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-Q, --quiet</option></term>
- <listitem>
- <para>Use quiet mode</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>General Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-V, --version</option></term>
- <listitem>
- <para>Display version information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- </refsect1>
- <refsect1>
- <title>Exit Codes</title>
- <variablelist>
- <varlistentry>
- <term>0</term>
- <listitem>
- <para>The command completed successfully.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>> 0</term>
- <listitem>
- <para>An error occurred.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <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>
-</refentry>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-uninstall.xml b/opendj-server-legacy/src/main/docbkx/reference/man-uninstall.xml
deleted file mode 100644
index b119c72..0000000
--- a/opendj-server-legacy/src/main/docbkx/reference/man-uninstall.xml
+++ /dev/null
@@ -1,306 +0,0 @@
-<?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/opendj3/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 2011-2014 ForgeRock AS
- !
--->
-<refentry xml:id='uninstall-1'
- 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'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
- <refmeta>
- <refentrytitle>uninstall</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>uninstall</refname>
- <refpurpose>remove OpenDJ directory server software</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>uninstall</command>
- <arg choice="opt">options</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to uninstall the directory server.</para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>-a, --remove-all</option></term>
- <listitem>
- <para>Remove all components of the server (this option is not compatible
- with the rest of remove options)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-b, --backup-files</option></term>
- <listitem>
- <para>Remove backup files</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-c, --configuration-files</option></term>
- <listitem>
- <para>Remove configuration files</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-d, --databases</option></term>
- <listitem>
- <para>Remove database contents</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-e, --ldif-files</option></term>
- <listitem>
- <para>Remove LDIF files</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f, --forceOnError</option></term>
- <listitem>
- <para>Specifies whether the uninstall should continue if there is an error
- updating references to this server in remote server instances or not. This
- option can only be used with the --no-prompt option.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-i, --cli</option></term>
- <listitem>
- <para>Specifies to use the command line install. If not specified the
- graphical interface will be launched. The rest of the options (excluding
- help and version) will only be taken into account if this option is
- specified</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-l, --server-libraries</option></term>
- <listitem>
- <para>Remove Server Libraries and Administrative Tools</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-L, --log-files</option></term>
- <listitem>
- <para>Remove log files</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <refsect2>
- <title>LDAP Connection Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--connectTimeout {timeout}</option></term>
- <listitem>
- <para>Maximum length of time (in milliseconds) that can be taken to
- establish a connection. Use '0' to specify no time out.</para>
- <para>Default value: 30000</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-h, --referencedHostName {host}</option></term>
- <listitem>
- <para>The name of this host (or IP address) as it is referenced in remote
- servers for replication</para>
- <para>Default value: localhost.localdomain</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-I, --adminUID {adminUID}</option></term>
- <listitem>
- <para>User ID of the Global Administrator to use to bind to the
- server.</para>
- <para>Default value: admin</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>
- <listitem>
- <para>Bind password file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-K, --keyStorePath {keyStorePath}</option></term>
- <listitem>
- <para>Certificate key store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-N, --certNickname {nickname}</option></term>
- <listitem>
- <para>Nickname of certificate for SSL client authentication</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-o, --saslOption {name=value}</option></term>
- <listitem>
- <para>SASL bind options</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-P, --trustStorePath {trustStorePath}</option></term>
- <listitem>
- <para>Certificate trust store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-T, --trustStorePassword {trustStorePassword}</option></term>
- <listitem>
- <para>Certificate trust store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
- <listitem>
- <para>Certificate key store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-U, --trustStorePasswordFile {path}</option></term>
- <listitem>
- <para>Certificate trust store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-w, --bindPassword {bindPassword}</option></term>
- <listitem>
- <para>Password to use to bind to the server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
- <listitem>
- <para>Certificate key store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-X, --trustAll</option></term>
- <listitem>
- <para>Trust all server SSL certificates</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>Utility Input/Output Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-n, --no-prompt</option></term>
- <listitem>
- <para>Use non-interactive mode. If data in the command is missing, the
- user is not prompted and the tool will fail</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--noPropertiesFile</option></term>
- <listitem>
- <para>No properties file will be used to get default command line
- argument values</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--propertiesFilePath {propertiesFilePath}</option></term>
- <listitem>
- <para>Path to the file containing default property values used for
- command line arguments</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-Q, --quiet</option></term>
- <listitem>
- <para>Run setup in quiet mode. Quiet mode will not output progress
- information to standard output</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-v, --verbose</option></term>
- <listitem>
- <para>Use verbose mode</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>General Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-V, --version</option></term>
- <listitem>
- <para>Display version information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- </refsect1>
- <refsect1>
- <title>Exit Codes</title>
- <variablelist>
- <varlistentry>
- <term>0</term>
- <listitem>
- <para>The command completed successfully.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>> 0</term>
- <listitem>
- <para>An error occurred.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <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>
-</refentry>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-upgrade.xml b/opendj-server-legacy/src/main/docbkx/reference/man-upgrade.xml
deleted file mode 100644
index 53d5c2c..0000000
--- a/opendj-server-legacy/src/main/docbkx/reference/man-upgrade.xml
+++ /dev/null
@@ -1,212 +0,0 @@
-<?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/opendj3/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 2011-2014 ForgeRock AS
- !
--->
-<refentry xml:id='upgrade-1'
- 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'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
- <refmeta>
- <refentrytitle>upgrade</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>upgrade</refname>
- <refpurpose>upgrade OpenDJ configuration & application data</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>upgrade</command>
- <arg choice="req">options</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
-
- <para>This utility upgrades OpenDJ configuration (schema, directory server
- configuration, and other configuration files) and application data (primarily
- directory data) so that it is compatible with the binary files and scripts
- that are installed.</para>
-
- <para>The <command>upgrade</command> command thus performs only part of the
- upgrade process, which includes the following phases for a single
- server.</para>
-
- <orderedlist>
- <listitem>
- <para>Get and unpack a newer version of OpenDJ directory server
- software.</para>
- </listitem>
- <listitem>
- <para>Stop the current OpenDJ directory server.</para>
- </listitem>
- <listitem>
- <para>Overwrite existing binary and script files with those of the
- newer version, and then run this utility, the <command>upgrade</command>
- command, before restarting OpenDJ.</para>
- </listitem>
- <listitem>
- <para>Start the upgraded OpenDJ directory server.</para>
- </listitem>
- </orderedlist>
-
- <important>
- <para>The <command>upgrade</command> command <emphasis>does not back up
- OpenDJ before you upgrade, nor does it restore OpenDJ if the
- <command>upgrade</command> command fails</emphasis>. In order to revert a
- failed upgrade, make sure you back up OpenDJ directory server before you
- overwrite existing binary and script files.</para>
- </important>
-
- <para>By default, the <command>upgrade</command> command requests
- confirmation before making important configuration changes. You can use
- the <option>--no-prompt</option> option to run the command
- non-interactively.</para>
-
- <para>When using the <option>--no-prompt</option> option, if the
- <command>upgrade</command> command cannot complete because it requires
- confirmation for a potentially very long or critical task, then it exits
- with an error and a message about how to finish making the changes. You can
- add the <option>--force</option> option to force a non-interactive upgrade
- to continue in this case, also performing long running and critical
- tasks.</para>
-
- <para>After upgrading, see the resulting <filename>upgrade.log</filename>
- file for a full list of operations performed.</para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>--acceptLicense</option></term>
- <listitem>
- <para>Automatically accepts the product license if there is one in the
- delivery.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--force</option></term>
- <listitem>
- <para>Forces a non-interactive upgrade to continue even if it requires
- user interaction. In particular, long running or critical upgrade tasks,
- such as re-indexing, which require user confirmation will be skipped. This
- option may only be used with the <option>--no-prompt</option> option.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--ignoreErrors</option></term>
- <listitem>
- <para>Ignores any errors which occur during the upgrade. This option
- should be used with caution and may be useful in automated deployments
- where potential errors are known in advance and resolved after the upgrade
- has completed.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <refsect2>
- <title>Utility Input/Output Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-n, --no-prompt</option></term>
- <listitem>
- <para>Use non-interactive mode. Prompt for any required information
- rather than fail.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-Q, --quiet</option></term>
- <listitem>
- <para>Use quiet mode.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-v, --verbose</option></term>
- <listitem>
- <para>Use verbose mode.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>General Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-V, --version</option></term>
- <listitem>
- <para>Display version information.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- </refsect1>
- <refsect1>
- <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>Installation Guide</citetitle> for an example
- upgrade process for OpenDJ directory server installed from the cross-platform
- (.zip) delivery, <link xlink:show="new"
- xlink:href="install-guide#upgrade-zip-example"
- xlink:role="http://docbook.org/xlink/role/olink"><citetitle>Upgrading From
- OpenDJ 2.4.5</citetitle></link>.</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>
-</refentry>
diff --git a/opendj-server-legacy/src/main/docbkx/reference/man-verify-index.xml b/opendj-server-legacy/src/main/docbkx/reference/man-verify-index.xml
deleted file mode 100644
index 7c7d670..0000000
--- a/opendj-server-legacy/src/main/docbkx/reference/man-verify-index.xml
+++ /dev/null
@@ -1,163 +0,0 @@
-<?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/opendj3/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 2011-2015 ForgeRock AS.
- !
--->
-<refentry xml:id='verify-index-1'
- 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'>
- <info><copyright><year>2011-2015</year><holder>ForgeRock AS.</holder></copyright></info>
- <refmeta>
- <refentrytitle>verify-index</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>verify-index</refname>
- <refpurpose>check index for consistency or errors</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>verify-index</command>
- <arg choice="req">options</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>
- This utility can be used to ensure that index data is consistent
- within an indexed backend database.
- </para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>-b, --baseDN {baseDN}</option></term>
- <listitem>
- <para>Base DN of a backend supporting indexing. Verification is
- performed on indexes within the scope of the given base DN.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-c, --clean</option></term>
- <listitem>
- <para>Specifies that a single index should be verified to ensure it is
- clean. An index is clean if each index value references only entries
- containing that value. Only one index at a time may be verified in this
- way.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--countErrors</option></term>
- <listitem>
- <para>Count the number of errors found during the verification and return
- that value as the exit code (values > 255 will be reduced to 255 due to
- exit code restrictions).</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-i, --index {index}</option></term>
- <listitem>
- <para>Name of an index to be verified. For an attribute index this is
- simply an attribute name. Multiple indexes may be verified for
- completeness, or all indexes if no indexes are specified. An index is
- complete if each index value references all entries containing that
- value.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <refsect2>
- <title>General Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-V, --version</option></term>
- <listitem>
- <para>Display version information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- </refsect1>
- <refsect1>
- <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 while parsing the command-line arguments.</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>
- <refsect1>
- <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>
-</refentry>
diff --git a/pom.xml b/pom.xml
index 3d36d01..96a42b4 100644
--- a/pom.xml
+++ b/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>
diff --git a/src/main/docbkx/dev-guide/index.xml b/src/main/docbkx/dev-guide/index.xml
index 60e1bb2..44e7c83 100644
--- a/src/main/docbkx/dev-guide/index.xml
+++ b/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
- xlink:href="dev-guide#install-latest-sdk"
- xlink:role="http://docbook.org/xlink/role/olink"><citetitle>To Install the
- Latest SDK & Tools</citetitle></link>. For example,
- <filename>/path/to/opendj-ldap-toolkit-<?eval ${sdkDocTargetVersion}?>/bin</filename>.</para>
+ <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 & 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" />
diff --git a/src/main/docbkx/dev-guide/man-addrate.xml b/src/main/docbkx/dev-guide/man-addrate.xml
deleted file mode 100644
index 0e0820b..0000000
--- a/src/main/docbkx/dev-guide/man-addrate.xml
+++ /dev/null
@@ -1,676 +0,0 @@
-<?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/opendj3/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 2014-2015 ForgeRock AS.
- !
--->
-<refentry xml:id='addrate-1'
- 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'
- xmlns:xinclude='http://www.w3.org/2001/XInclude'>
- <info>
- <copyright>
- <year>2014-2015</year>
- <holder>ForgeRock AS.</holder>
- </copyright>
- </info>
-
- <refmeta>
- <refentrytitle>addrate</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version">${docTargetVersion}</refmiscinfo>
- </refmeta>
-
- <refnamediv>
- <refname>addrate</refname>
- <refpurpose>measure add & delete throughput and response time</refpurpose>
- </refnamediv>
-
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>addrate</command>
- <arg choice="req">options</arg>
- <arg choice="req">template-file-path</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
-
- <refsect1>
- <title>Description</title>
- <para>
- This utility can be used to measure add and optionally delete
- throughput and response time of a directory server using user-defined entries.
- </para>
-
- <para>
- The <replaceable>template-file-path</replaceable> argument
- identifies a template file that has the same form as a template file
- for the <command>makeldif</command> command.
- For details, see
- <link
- xlink:show="new"
- xlink:href="dev-guide#makeldif-template-5"
- xlink:role="http://docbook.org/xlink/role/olink"
- >makeldif.template</link>.
- </para>
-
- <xinclude:include href="../shared/informalexample-net-tweaks.xml" />
- </refsect1>
-
- <refsect1>
- <title>Options</title>
-
- <para>
- The following options are supported.
- </para>
-
- <variablelist>
- <varlistentry>
- <term><option>-a, --deleteAgeThreshold {seconds}</option></term>
- <listitem>
- <para>
- Specifies the age at which added entries will become candidates for deletion
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-A, --asynchronous</option></term>
- <listitem>
- <para>
- Use asynchronous mode and do not wait for results before sending the next request
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-B, --warmUpDuration {warmUpDuration}</option></term>
- <listitem>
- <para>
- Warm up duration in seconds
- </para>
-
- <para>
- Default value: 0
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-c, --numConnections {numConnections}</option></term>
- <listitem>
- <para>
- Number of connections
- </para>
-
- <para>
- Default value: 1
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-C, --deleteMode {fifo | random | off}</option></term>
- <listitem>
- <para>
- The algorithm used for selecting entries to be deleted which must be one of "fifo", "random", or "off".
- </para>
-
- <para>
- Default value: FIFO
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-d, --maxDuration {maxDuration}</option></term>
- <listitem>
- <para>
- Maximum duration in seconds, 0 for unlimited
- </para>
-
- <para>
- Default value: 0
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-e, --percentile {percentile}</option></term>
- <listitem>
- <para>
- Calculate max response time for a percentile of operations
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-f, --keepConnectionsOpen</option></term>
- <listitem>
- <para>
- Keep connections open
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-F, --noRebind</option></term>
- <listitem>
- <para>
- Keep connections open and do not rebind
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-g, --constant {name=value}</option></term>
- <listitem>
- <para>
- A constant that overrides the value set in the template file
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-i, --statInterval {statInterval}</option></term>
- <listitem>
- <para>
- Display results each specified number of seconds
- </para>
-
- <para>
- Default value: 5
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-m, --maxIterations {maxIterations}</option></term>
- <listitem>
- <para>
- Max iterations, 0 for unlimited
- </para>
-
- <para>
- Default value: 0
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-M, --targetThroughput {targetThroughput}</option></term>
- <listitem>
- <para>
- Target average throughput to achieve
- </para>
-
- <para>
- Default value: 0
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-n, --noPurge</option></term>
- <listitem>
- <para>
- Disable the purge phase when the tool stops.
- </para>
-
- <para>
- By default, when you interrupt the tool
- it deletes the remaining entries that it added before returning.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-r, --resourcePath {path}</option></term>
- <listitem>
- <para>
- Path to look for template resources (e.g. data files)
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-R, --randomSeed {seed}</option></term>
- <listitem>
- <para>
- The seed to use for initializing the random number generator
- </para>
-
- <para>
- Default value: 0
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-s, --deleteSizeThreshold {count}</option></term>
- <listitem>
- <para>
- Specifies the number of entries to be added before deletion begins
- </para>
-
- <para>
- Default value: 10000
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-S, --scriptFriendly</option></term>
- <listitem>
- <para>
- Use script-friendly mode
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-t, --numThreads {numThreads}</option></term>
- <listitem>
- <para>
- Number of worker threads per connection
- </para>
-
- <para>
- Default value: 1
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <refsect2>
- <title>LDAP Connection Options</title>
-
- <variablelist>
- <varlistentry>
- <term><option>-D, --bindDN {bindDN}</option></term>
- <listitem>
- <para>
- DN to use to bind to the server
- </para>
-
- <para>
- If you do not specify a bind DN,
- then the operations are performed as an anonymous user.
- In many directories anonymous users have no right to add or delete entries.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-E, --reportAuthzID</option></term>
- <listitem>
- <para>
- Use the authorization identity control
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-h, --hostname {host}</option></term>
- <listitem>
- <para>
- Directory server hostname or IP address
- </para>
-
- <para>
- Default value: localhost.localdomain
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>
- <listitem>
- <para>
- Bind password file
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-K, --keyStorePath {keyStorePath}</option></term>
- <listitem>
- <para>
- Certificate key store path
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-N, --certNickname {nickname}</option></term>
- <listitem>
- <para>
- Nickname of the certificate that the server should use
- when accepting SSL-based connections or performing StartTLS negotiation
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-o, --saslOption {name=value}</option></term>
- <listitem>
- <para>
- SASL bind options
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-p, --port {port}</option></term>
- <listitem>
- <para>
- Directory server port number
- </para>
-
- <para>
- Default value: 389
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-P, --trustStorePath {trustStorePath}</option></term>
- <listitem>
- <para>
- Certificate trust store path
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-q, --useStartTLS</option></term>
- <listitem>
- <para>
- Use StartTLS to secure communication with the server
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-T, --trustStorePassword {trustStorePassword}</option></term>
- <listitem>
- <para>
- Certificate trust store PIN
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
- <listitem>
- <para>
- Certificate key store PIN file.
- A PIN is required when you specify to use an existing certificate
- as server certificate
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-U, --trustStorePasswordFile {path}</option></term>
- <listitem>
- <para>
- Certificate trust store PIN file
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--usePasswordPolicyControl</option></term>
- <listitem>
- <para>
- Use the password policy request control
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-w, --bindPassword {bindPassword}</option></term>
- <listitem>
- <para>
- Password to use to bind to the server
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
- <listitem>
- <para>
- Certificate key store PIN
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-X, --trustAll</option></term>
- <listitem>
- <para>
- Trust all server SSL certificates
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-Z, --useSSL</option></term>
- <listitem>
- <para>
- Use SSL for secure communication with the server
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
-
- <refsect2>
- <title>Utility Input/Output Options</title>
-
- <variablelist>
- <varlistentry>
- <term><option>--noPropertiesFile</option></term>
- <listitem>
- <para>
- No properties file will be used to get default command line argument values
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>--propertiesFilePath {propertiesFilePath}</option></term>
- <listitem>
- <para>
- Path to the file containing default property values used for command line arguments
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-v, --verbose</option></term>
- <listitem>
- <para>
- Use verbose mode
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
-
- <refsect2>
- <title>General Options</title>
-
- <variablelist>
- <varlistentry>
- <term><option>-V, --version</option></term>
- <listitem>
- <para>
- Display version information
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>
- Display usage information
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- </refsect1>
-
- <refsect1>
- <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>
-
- <refsect1>
- <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>
-</refentry>
diff --git a/src/main/docbkx/dev-guide/man-authrate.xml b/src/main/docbkx/dev-guide/man-authrate.xml
deleted file mode 100644
index 5a2b125..0000000
--- a/src/main/docbkx/dev-guide/man-authrate.xml
+++ /dev/null
@@ -1,405 +0,0 @@
-<?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/opendj3/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 2011-2014 ForgeRock AS
- !
--->
-<refentry xml:id='authrate-1'
- 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:xinclude='http://www.w3.org/2001/XInclude'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
- <refmeta>
- <refentrytitle>authrate</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>authrate</refname>
- <refpurpose>measure bind throughput and response time</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>authrate</command>
- <arg choice="req">options</arg>
- <arg choice="opt">filter format string</arg>
- <arg choice="opt" rep="repeat">attributes</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to measure bind throughput and response time
- of a directory service using user-defined bind or search-then-bind
- operations.</para>
- <para>Format strings may be used in the bind DN option as well as the authid
- and authzid SASL bind options. A search operation may be used to retrieve the
- bind DN by specifying the base DN and a filter. The retrieved entry DN will
- be appended as the last argument in the argument list when evaluating format
- strings.</para>
-
- <xinclude:include href="../shared/informalexample-net-tweaks.xml" />
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>-a, --dereferencePolicy {dereferencePolicy}</option></term>
- <listitem>
- <para>Alias dereference policy ('never', 'always', 'search', or 'find')</para>
- <para>Default value: never</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-b, --baseDN {baseDN}</option></term>
- <listitem>
- <para>Base DN format string</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-B, --warmUpDuration {warmUpDuration}</option></term>
- <listitem>
- <para>
- Warm up duration in seconds
- </para>
-
- <para>
- Default value: 0
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-c, --numConnections {numConnections}</option></term>
- <listitem>
- <para>Number of connections</para>
- <para>Default value: 1</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-d, --maxDuration {maxDuration}</option></term>
- <listitem>
- <para>
- Maximum duration in seconds, 0 for unlimited
- </para>
-
- <para>
- Default value: 0
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-e, --percentile {percentile}</option></term>
- <listitem>
- <para>Calculate max response time for a percentile of operations</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f, --keepConnectionsOpen</option></term>
- <listitem>
- <para>Keep connections open</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-g, --argument {generator function or static string}</option></term>
- <listitem>
- <para>Argument used to evaluate the Java style format strings in program
- parameters (Base DN, Search Filter). The set of all arguments provided
- form the the argument list in order. Besides static string arguments, they
- can be generated per iteration with the following functions:</para>
- <variablelist>
- <varlistentry>
- <term>"inc({filename})"</term>
- <listitem><para>Consecutive, incremental line from file</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>"inc({min},{max})"</term>
- <listitem><para>Consecutive, incremental number</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>"rand({filename})"</term>
- <listitem><para>Random line from file</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>"rand({min},{max})"</term>
- <listitem><para>Random number</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>"randstr({length},<replaceable>charSet</replaceable>)"</term>
- <listitem><para>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. If no charSet is specified,
- the default charSet of [A-Z][a-z][0-9] will be used.</para></listitem>
- </varlistentry>
- </variablelist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-i, --statInterval {statInterval}</option></term>
- <listitem>
- <para>Display results each specified number of seconds</para>
- <para>Default value: 5</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-I, --invalidPassword {invalidPassword}</option></term>
- <listitem>
- <para>Percent of bind operations with simulated invalid password</para>
- <para>Default value: 0</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m, --maxIterations {maxIterations}</option></term>
- <listitem>
- <para>Max iterations, 0 for unlimited</para>
- <para>Default value: 0</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-M, --targetThroughput {targetThroughput}</option></term>
- <listitem>
- <para>Target average throughput to achieve</para>
- <para>Default value: 0</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-s, --searchScope {searchScope}</option></term>
- <listitem>
- <para>Search scope ('base', 'one', 'sub', or 'subordinate')</para>
- <para>Default value: sub</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-S, --scriptFriendly</option></term>
- <listitem>
- <para>Use script-friendly mode</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <refsect2>
- <title>LDAP Connection Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-D, --bindDN {bindDN}</option></term>
- <listitem>
- <para>DN to use to bind to the server</para>
- <para>Default value: cn=Directory Manager</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E, --reportAuthzID</option></term>
- <listitem>
- <para>Use the authorization identity control</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-h, --hostname {host}</option></term>
- <listitem>
- <para>Directory server hostname or IP address</para>
- <para>Default value: localhost.localdomain</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>
- <listitem>
- <para>Bind password file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-K, --keyStorePath {keyStorePath}</option></term>
- <listitem>
- <para> Certificate key store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-N, --certNickname {nickname}</option></term>
- <listitem>
- <para>Nickname of certificate for SSL client authentication</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-o, --saslOption {name=value}</option></term>
- <listitem>
- <para>SASL bind options</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-p, --port {port}</option></term>
- <listitem>
- <para>Directory server port number</para>
- <para>Default value: 389</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-P, --trustStorePath {trustStorePath}</option></term>
- <listitem>
- <para>Certificate trust store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-q, --useStartTLS</option></term>
- <listitem>
- <para>Use StartTLS to secure communication with the server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-T, --trustStorePassword {trustStorePassword}</option></term>
- <listitem>
- <para>Certificate trust store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
- <listitem>
- <para>Certificate key store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-U, --trustStorePasswordFile {path}</option></term>
- <listitem>
- <para>Certificate trust store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--usePasswordPolicyControl</option></term>
- <listitem>
- <para>Use the password policy request control</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-w, --bindPassword {bindPassword}</option></term>
- <listitem>
- <para>Password to use to bind to the server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
- <listitem>
- <para>Certificate key store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-X, --trustAll</option></term>
- <listitem>
- <para>Trust all server SSL certificates</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-Z, --useSSL</option></term>
- <listitem>
- <para>Use SSL for secure communication with the server</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>Utility Input/Output Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--noPropertiesFile</option></term>
- <listitem>
- <para>No properties file will be used to get default command line
- argument values</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--propertiesFilePath {propertiesFilePath}</option></term>
- <listitem>
- <para>Path to the file containing default property values used for
- command line arguments</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-v, --verbose</option></term>
- <listitem>
- <para>Use verbose mode</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>General Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-V, --version</option></term>
- <listitem>
- <para>Display version information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- </refsect1>
- <refsect1>
- <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>
- <refsect1>
- <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, and all user password values have been set to
- <literal>password</literal> for this example.</para>
- </refsect1>
-</refentry>
diff --git a/src/main/docbkx/dev-guide/man-ldapcompare.xml b/src/main/docbkx/dev-guide/man-ldapcompare.xml
deleted file mode 100644
index 1c2ecc3..0000000
--- a/src/main/docbkx/dev-guide/man-ldapcompare.xml
+++ /dev/null
@@ -1,335 +0,0 @@
-<?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/opendj3/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 2011-2014 ForgeRock AS
- !
--->
-<refentry xml:id='ldapcompare-1'
- 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'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
- <refmeta>
- <refentrytitle>ldapcompare</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>ldapcompare</refname>
- <refpurpose>perform LDAP compare operations</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>ldapcompare</command>
- <arg choice="req">options</arg>
- <group><arg>attribute</arg><arg>:</arg><arg>value</arg></group>
- <arg choice="opt" rep="repeat">DN</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to perform LDAP compare operations in the
- directory.</para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>--assertionFilter {filter}</option></term>
- <listitem>
- <para>Use the LDAP assertion control with the provided filter</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-c, --continueOnError</option></term>
- <listitem>
- <para>Continue processing even if there are errors</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f, --filename {file}</option></term>
- <listitem>
- <para>LDIF file containing one DN per line of entries to compare</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-J, --control {controloid[:criticality[:value|::b64value|:<filePath]]}</option></term>
- <listitem>
- <para>Use a request control with the provided information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-n, --dry-run</option></term>
- <listitem>
- <para>Show what would be done but do not perform any operation</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-Y, --proxyAs {authzID}</option></term>
- <listitem>
- <para>Use the proxied authorization control with the given authorization
- ID</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <refsect2>
- <title>LDAP Connection Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-D, --bindDN {bindDN}</option></term>
- <listitem>
- <para>DN to use to bind to the server</para>
- <para>Default value: cn=Directory Manager</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E, --reportAuthzID</option></term>
- <listitem>
- <para>Use the authorization identity control</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-h, --hostname {host}</option></term>
- <listitem>
- <para>Directory server hostname or IP address</para>
- <para>Default value: localhost.localdomain</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>
- <listitem>
- <para>Bind password file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-K, --keyStorePath {keyStorePath}</option></term>
- <listitem>
- <para> Certificate key store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-N, --certNickname {nickname}</option></term>
- <listitem>
- <para>Nickname of certificate for SSL client authentication</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-o, --saslOption {name=value}</option></term>
- <listitem>
- <para>SASL bind options</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-p, --port {port}</option></term>
- <listitem>
- <para>Directory server port number</para>
- <para>Default value: 389</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-P, --trustStorePath {trustStorePath}</option></term>
- <listitem>
- <para>Certificate trust store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-q, --useStartTLS</option></term>
- <listitem>
- <para>Use StartTLS to secure communication with the server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-T, --trustStorePassword {trustStorePassword}</option></term>
- <listitem>
- <para>Certificate trust store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
- <listitem>
- <para>Certificate key store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-U, --trustStorePasswordFile {path}</option></term>
- <listitem>
- <para>Certificate trust store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--usePasswordPolicyControl</option></term>
- <listitem>
- <para>Use the password policy request control</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-V, --ldapVersion {version}</option></term>
- <listitem>
- <para>LDAP protocol version number</para>
- <para>Default value: 3</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-w, --bindPassword {bindPassword}</option></term>
- <listitem>
- <para>Password to use to bind to the server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
- <listitem>
- <para>Certificate key store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-X, --trustAll</option></term>
- <listitem>
- <para>Trust all server SSL certificates</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-Z, --useSSL</option></term>
- <listitem>
- <para>Use SSL for secure communication with the server</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>Utility Input/Output Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-i, --encoding {encoding}</option></term>
- <listitem>
- <para>Use the specified character set for command-line input</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--noPropertiesFile</option></term>
- <listitem>
- <para>No properties file will be used to get default command line
- argument values</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--propertiesFilePath {propertiesFilePath}</option></term>
- <listitem>
- <para>Path to the file containing default property values used for
- command line arguments</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-v, --verbose</option></term>
- <listitem>
- <para>Use verbose mode</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>General Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--version</option></term>
- <listitem>
- <para>Display version information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- </refsect1>
- <refsect1>
- <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">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>
- <refsect1>
- <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>
- <refsect1>
- <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>
-</refentry>
diff --git a/src/main/docbkx/dev-guide/man-ldapmodify.xml b/src/main/docbkx/dev-guide/man-ldapmodify.xml
deleted file mode 100644
index 1567f99..0000000
--- a/src/main/docbkx/dev-guide/man-ldapmodify.xml
+++ /dev/null
@@ -1,446 +0,0 @@
-<?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/opendj3/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 2011-2015 ForgeRock AS.
- !
--->
-<refentry xml:id='ldapmodify-1'
- 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'>
- <info><copyright><year>2011-2015</year><holder>ForgeRock AS.</holder></copyright></info>
- <refmeta>
- <refentrytitle>ldapmodify</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>ldapmodify</refname>
- <refpurpose>perform LDAP modify, add, delete, mod DN operations</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>ldapmodify</command>
- <arg choice="req">options</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to perform LDAP modify, add, delete, and
- modify DN operations in the directory.</para>
- <para>When not using a file to specify modifications, end your input with
- EOF (Ctrl+D on UNIX, Ctrl+Z on Windows).</para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>-a, --defaultAdd</option></term>
- <listitem>
- <para>Treat records with no changetype as add operations</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--assertionFilter {filter}</option></term>
- <listitem>
- <para>Use the LDAP assertion control with the provided filter</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-c, --continueOnError</option></term>
- <listitem>
- <para>Continue processing even if there are errors</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f, --filename {file}</option></term>
- <listitem>
- <para>LDIF file containing the changes to apply</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-J, --control {controloid[:criticality[:value|::b64value|:<filePath]]}</option></term>
- <listitem>
- <para>Use a request control with the provided information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-n, --dry-run</option></term>
- <listitem>
- <para>Show what would be done but do not perform any operation</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--postReadAttributes {attrList}</option></term>
- <listitem>
- <para>Use the LDAP ReadEntry post-read control</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--preReadAttributes {attrList}</option></term>
- <listitem>
- <para>Use the LDAP ReadEntry pre-read control</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-Y, --proxyAs {authzID}</option></term>
- <listitem>
- <para>Use the proxied authorization control with the given authorization
- ID</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <refsect2>
- <title>LDAP Connection Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-D, --bindDN {bindDN}</option></term>
- <listitem>
- <para>DN to use to bind to the server</para>
- <para>Default value: cn=Directory Manager</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E, --reportAuthzID</option></term>
- <listitem>
- <para>Use the authorization identity control</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-h, --hostname {host}</option></term>
- <listitem>
- <para>Directory server hostname or IP address</para>
- <para>Default value: localhost.localdomain</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>
- <listitem>
- <para>Bind password file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-K, --keyStorePath {keyStorePath}</option></term>
- <listitem>
- <para> Certificate key store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-N, --certNickname {nickname}</option></term>
- <listitem>
- <para>Nickname of certificate for SSL client authentication</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-o, --saslOption {name=value}</option></term>
- <listitem>
- <para>SASL bind options</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-p, --port {port}</option></term>
- <listitem>
- <para>Directory server port number</para>
- <para>Default value: 389</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-P, --trustStorePath {trustStorePath}</option></term>
- <listitem>
- <para>Certificate trust store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-q, --useStartTLS</option></term>
- <listitem>
- <para>Use StartTLS to secure communication with the server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-T, --trustStorePassword {trustStorePassword}</option></term>
- <listitem>
- <para>Certificate trust store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
- <listitem>
- <para>Certificate key store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-U, --trustStorePasswordFile {path}</option></term>
- <listitem>
- <para>Certificate trust store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--usePasswordPolicyControl</option></term>
- <listitem>
- <para>Use the password policy request control</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-V, --ldapVersion {version}</option></term>
- <listitem>
- <para>LDAP protocol version number</para>
- <para>Default value: 3</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-w, --bindPassword {bindPassword}</option></term>
- <listitem>
- <para>Password to use to bind to the server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
- <listitem>
- <para>Certificate key store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-X, --trustAll</option></term>
- <listitem>
- <para>Trust all server SSL certificates</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-Z, --useSSL</option></term>
- <listitem>
- <para>Use SSL for secure communication with the server</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>Utility Input/Output Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-i, --encoding {encoding}</option></term>
- <listitem>
- <para>Use the specified character set for command-line input</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--noPropertiesFile</option></term>
- <listitem>
- <para>No properties file will be used to get default command line
- argument values</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--propertiesFilePath {propertiesFilePath}</option></term>
- <listitem>
- <para>Path to the file containing default property values used for
- command line arguments</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-v, --verbose</option></term>
- <listitem>
- <para>Use verbose mode</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>General Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--version</option></term>
- <listitem>
- <para>Display version information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- </refsect1>
- <refsect1>
- <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">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>
- <refsect1>
- <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>
- <refsect1>
- <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 ]] && 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 <<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>
-</refentry>
diff --git a/src/main/docbkx/dev-guide/man-ldappasswordmodify.xml b/src/main/docbkx/dev-guide/man-ldappasswordmodify.xml
deleted file mode 100644
index a2e1b55..0000000
--- a/src/main/docbkx/dev-guide/man-ldappasswordmodify.xml
+++ /dev/null
@@ -1,342 +0,0 @@
-<?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/opendj3/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 2011-2014 ForgeRock AS
- !
--->
-<refentry xml:id='ldappasswordmodify-1'
- 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'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
- <refmeta>
- <refentrytitle>ldappasswordmodify</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>ldappasswordmodify</refname>
- <refpurpose>perform LDAP password modifications</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>ldappasswordmodify</command>
- <arg choice="req">options</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to perform LDAP password modify operations in
- the directory.</para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>-a, --authzID {authzID}</option></term>
- <listitem>
- <para>Authorization ID for the user entry whose password should be changed</para>
- <para>The authorization ID is a string having either the prefix
- <literal>dn:</literal> followed by the user's distinguished name, or
- the prefix <literal>u:</literal> followed by a user identifier that
- depends on the identity mapping used to match the user identifier to
- an entry in the directory. Examples include
- <literal>dn:uid=bjensen,ou=People,dc=example,dc=com</literal>, and, if
- we assume that <literal>bjensen</literal> is mapped to Barbara Jensen's
- entry, <literal>u:bjensen</literal>.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-A, --provideDNForAuthzID</option></term>
- <listitem>
- <para>Use the bind DN as the authorization ID for the password modify
- operation</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-c, --currentPassword {currentPassword}</option></term>
- <listitem>
- <para>Current password for the target user</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-C, --currentPasswordFile {file}</option></term>
- <listitem>
- <para>Path to a file containing the current password for the target user</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-F, --newPasswordFile {file}</option></term>
- <listitem>
- <para>Path to a file containing the new password to provide for the
- target user</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-J, --control {controloid[:criticality[:value|::b64value|:<filePath]]}</option></term>
- <listitem>
- <para>Use a request control with the provided information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-n, --newPassword {newPassword}</option></term>
- <listitem>
- <para>New password to provide for the target user</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <refsect2>
- <title>LDAP Connection Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-D, --bindDN {bindDN}</option></term>
- <listitem>
- <para>DN to use to bind to the server</para>
- <para>Default value: cn=Directory Manager</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E, --reportAuthzID</option></term>
- <listitem>
- <para>Use the authorization identity control</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-h, --hostname {host}</option></term>
- <listitem>
- <para>Directory server hostname or IP address</para>
- <para>Default value: localhost.localdomain</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>
- <listitem>
- <para>Bind password file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-K, --keyStorePath {keyStorePath}</option></term>
- <listitem>
- <para> Certificate key store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-N, --certNickname {nickname}</option></term>
- <listitem>
- <para>Nickname of certificate for SSL client authentication</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-o, --saslOption {name=value}</option></term>
- <listitem>
- <para>SASL bind options</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-p, --port {port}</option></term>
- <listitem>
- <para>Directory server port number</para>
- <para>Default value: 389</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-P, --trustStorePath {trustStorePath}</option></term>
- <listitem>
- <para>Certificate trust store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-q, --useStartTLS</option></term>
- <listitem>
- <para>Use StartTLS to secure communication with the server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-T, --trustStorePassword {trustStorePassword}</option></term>
- <listitem>
- <para>Certificate trust store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
- <listitem>
- <para>Certificate key store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-U, --trustStorePasswordFile {path}</option></term>
- <listitem>
- <para>Certificate trust store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--usePasswordPolicyControl</option></term>
- <listitem>
- <para>Use the password policy request control</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-V, --ldapVersion {version}</option></term>
- <listitem>
- <para>LDAP protocol version number</para>
- <para>Default value: 3</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-w, --bindPassword {bindPassword}</option></term>
- <listitem>
- <para>Password to use to bind to the server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
- <listitem>
- <para>Certificate key store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-X, --trustAll</option></term>
- <listitem>
- <para>Trust all server SSL certificates</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-Z, --useSSL</option></term>
- <listitem>
- <para>Use SSL for secure communication with the server</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>Utility Input/Output Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--noPropertiesFile</option></term>
- <listitem>
- <para>No properties file will be used to get default command line
- argument values</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--propertiesFilePath {propertiesFilePath}</option></term>
- <listitem>
- <para>Path to the file containing default property values used for
- command line arguments</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-v, --verbose</option></term>
- <listitem>
- <para>Use verbose mode</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>General Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--version</option></term>
- <listitem>
- <para>Display version information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- </refsect1>
- <refsect1>
- <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">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>
- <refsect1>
- <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>
- <refsect1>
- <title>Examples</title>
- <para>The following example demonstrates a user changing the password
- for her 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>
-</refentry>
diff --git a/src/main/docbkx/dev-guide/man-ldapsearch.xml b/src/main/docbkx/dev-guide/man-ldapsearch.xml
deleted file mode 100644
index 1684de1..0000000
--- a/src/main/docbkx/dev-guide/man-ldapsearch.xml
+++ /dev/null
@@ -1,743 +0,0 @@
-<?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/opendj3/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 2011-2015 ForgeRock AS.
- !
--->
-<refentry xml:id='ldapsearch-1'
- 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'>
- <info><copyright><year>2011-2015</year><holder>ForgeRock AS.</holder></copyright></info>
- <refmeta>
- <refentrytitle>ldapsearch</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>ldapsearch</refname>
- <refpurpose>perform LDAP search operations</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>ldapsearch</command>
- <arg choice="req">options</arg>
- <arg choice="opt">filter</arg>
- <arg choice="opt" rep="repeat">attributes</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to perform LDAP search operations in the
- directory.</para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>-a, --dereferencePolicy {dereferencePolicy}</option></term>
- <listitem>
- <para>Alias dereference policy ('never', 'always', 'search', or 'find')</para>
- <para>Default value: never</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-A, --typesOnly</option></term>
- <listitem>
- <para>Only retrieve attribute names but not their values</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--assertionFilter {filter}</option></term>
- <listitem>
- <para>Use the LDAP assertion control with the provided filter</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-b, --baseDN {baseDN}</option></term>
- <listitem>
- <para>Base DN format string</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-c, --continueOnError</option></term>
- <listitem>
- <para>Continue processing even if there are errors</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-C, --persistentSearch ps[:changetype[:changesonly[:entrychgcontrols]]]</option></term>
- <listitem>
- <para>Use the persistent search control</para>
-
- <para>
- A persistent search allows the client to continue receiving new results
- whenever changes are made to data that is in the scope of the search,
- thus using the search as a form of change notification.
- </para>
-
- <variablelist>
- <para>
- The optional <literal>changetype</literal> setting defines
- the kinds of updates that result in notification.
- By default the <literal>changetype</literal> is not set.
- </para>
-
- <varlistentry>
- <term><literal>add</literal></term>
- <listitem>
- <para>
- Send notifications for LDAP add operations.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>del</literal></term>
- <term><literal>delete</literal></term>
- <listitem>
- <para>
- Send notifications for LDAP delete operations.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>mod</literal></term>
- <term><literal>modify</literal></term>
- <listitem>
- <para>
- Send notifications for LDAP modify operations.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>moddn</literal></term>
- <term><literal>modrdn</literal></term>
- <term><literal>modifydn</literal></term>
- <listitem>
- <para>
- Send notifications for LDAP modify DN (rename and move) operations.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>all</literal></term>
- <term><literal>any</literal></term>
- <listitem>
- <para>
- Send notifications for all LDAP update operations.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <variablelist>
- <para>
- The optional <literal>changesonly</literal> setting defines
- whether the server returns existing entries as well as changes.
- </para>
-
- <varlistentry>
- <term><literal>true</literal></term>
- <listitem>
- <para>
- Do not return existing entries,
- but instead only notifications about changes.
- </para>
-
- <para>
- This is the default setting.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>false</literal></term>
- <listitem>
- <para>
- Also return existing entries.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
-
- <variablelist>
- <para>
- The optional <literal>entrychgcontrols</literal> setting defines
- whether the server returns an Entry Change Notification control
- with each entry notification.
- The Entry Change Notification control provides additional information
- about the change that caused the entry to be returned by the search.
- In particular, it indicates the change type,
- the change number if available,
- and the previous DN if the change type was a modify DN operation.
- </para>
-
- <varlistentry>
- <term><literal>true</literal></term>
- <listitem>
- <para>
- Do request the Entry Change Notification control.
- </para>
-
- <para>
- This is the default setting.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>false</literal></term>
- <listitem>
- <para>
- Do not request the Entry Change Notification control.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--countEntries</option></term>
- <listitem>
- <para>Count the number of entries returned by the server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-e, --getEffectiveRightsAttribute {attribute}</option></term>
- <listitem>
- <para>Specifies geteffectiverights control specific attribute list</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f, --filename {file}</option></term>
- <listitem>
- <para>LDIF file containing the changes to apply</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-g, --getEffectiveRightsAuthzid {authzID}</option></term>
- <listitem>
- <para>Use geteffectiverights control with the provided authzid</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-G, --virtualListView {before:after:index:count | before:after:value}</option></term>
- <listitem>
- <para>Use the virtual list view control to retrieve the specified results page</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-J, --control {controloid[:criticality[:value|::b64value|:<filePath]]}</option></term>
- <listitem>
- <para>Use a request control with the provided information</para>
-
- <para>
- For some <replaceable>controloid</replaceable> values,
- you can replace object identifiers with user-friendly strings.
-
- The strings are listed here in lower case, but the case is not important.
- You can use camelCase if you prefer, for example.
- </para>
-
- <variablelist>
- <varlistentry>
- <term><literal>accountusable</literal></term>
- <term><literal>accountusability</literal></term>
- <listitem>
- <para>Account Usability Control, Object Identifier: 1.3.6.1.4.1.42.2.27.9.5.8</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>authzid</literal></term>
- <term><literal>authorizationidentity</literal></term>
- <listitem>
- <para>Authorization Identity Request Control, Object Identifier: 2.16.840.1.113730.3.4.16</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>effectiverights</literal></term>
- <term><literal>geteffectiverights</literal></term>
- <listitem>
- <para>Get Effective Rights Request Control, Object Identifier: 1.3.6.1.4.1.42.2.27.9.5.2</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>managedsait</literal></term>
- <listitem>
- <para>Manage DSAIT Request Control, Object Identifier: 2.16.840.1.113730.3.4.2</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>noop</literal></term>
- <term><literal>no-op</literal></term>
- <listitem>
- <para>No-Op Control, Object Identifier: 1.3.6.1.4.1.4203.1.10.2</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>pwpolicy</literal></term>
- <term><literal>passwordpolicy</literal></term>
- <listitem>
- <para>Password Policy Control, Object Identifier: 1.3.6.1.4.1.42.2.27.8.5.1</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>realattrsonly</literal></term>
- <term><literal>realattributesonly</literal></term>
- <listitem>
- <para>Real Attributes Only Request Control, Object Identifier: 2.16.840.1.113730.3.4.17</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>subtreedelete</literal></term>
- <term><literal>treedelete</literal></term>
- <listitem>
- <para>Subtree Delete Request Control, Object Identifier: 1.2.840.113556.1.4.805</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><literal>virtualattrsonly</literal></term>
- <term><literal>virtualattributesonly</literal></term>
- <listitem>
- <para>Virtual Attributes Only Request Control, Object Identifier: 2.16.840.1.113730.3.4.19</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-l, --timeLimit {timeLimit}</option></term>
- <listitem>
- <para>Maximum length of time in seconds to allow for the search</para>
- <para>Default value: 0</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--matchedValuesFilter {filter}</option></term>
- <listitem>
- <para>Use the LDAP matched values control with the provided filter</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-n, --dry-run</option></term>
- <listitem>
- <para>Show what would be done but do not perform any operation</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-s, --searchScope {searchScope}</option></term>
- <listitem>
- <para>Search scope ('base', 'one', 'sub', or 'subordinate')</para>
- <para>Default value: sub</para>
- <para><literal>subordinate</literal> is an LDAP extension that might
- not work with all LDAP servers.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-S, --sortOrder {sortOrder}</option></term>
- <listitem>
- <para>Sort the results using the provided sort order</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--simplePageSize {numEntries}</option></term>
- <listitem>
- <para>Use the simple paged results control with the given page size</para>
- <para>Default value: 1000</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-Y, --proxyAs {authzID}</option></term>
- <listitem>
- <para>Use the proxied authorization control with the given authorization
- ID</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z, --sizeLimit {sizeLimit}</option></term>
- <listitem>
- <para>Maximum number of entries to return from the search</para>
- <para>Default value: 0</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <refsect2>
- <title>LDAP Connection Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-D, --bindDN {bindDN}</option></term>
- <listitem>
- <para>DN to use to bind to the server</para>
- <para>Default value: cn=Directory Manager</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E, --reportAuthzID</option></term>
- <listitem>
- <para>Use the authorization identity control</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-h, --hostname {host}</option></term>
- <listitem>
- <para>Directory server hostname or IP address</para>
- <para>Default value: localhost.localdomain</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>
- <listitem>
- <para>Bind password file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-K, --keyStorePath {keyStorePath}</option></term>
- <listitem>
- <para> Certificate key store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-N, --certNickname {nickname}</option></term>
- <listitem>
- <para>Nickname of certificate for SSL client authentication</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-o, --saslOption {name=value}</option></term>
- <listitem>
- <para>SASL bind options</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-p, --port {port}</option></term>
- <listitem>
- <para>Directory server port number</para>
- <para>Default value: 389</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-P, --trustStorePath {trustStorePath}</option></term>
- <listitem>
- <para>Certificate trust store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-q, --useStartTLS</option></term>
- <listitem>
- <para>Use StartTLS to secure communication with the server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-T, --trustStorePassword {trustStorePassword}</option></term>
- <listitem>
- <para>Certificate trust store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
- <listitem>
- <para>Certificate key store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-U, --trustStorePasswordFile {path}</option></term>
- <listitem>
- <para>Certificate trust store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--usePasswordPolicyControl</option></term>
- <listitem>
- <para>Use the password policy request control</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-V, --ldapVersion {version}</option></term>
- <listitem>
- <para>LDAP protocol version number</para>
- <para>Default value: 3</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-w, --bindPassword {bindPassword}</option></term>
- <listitem>
- <para>Password to use to bind to the server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
- <listitem>
- <para>Certificate key store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-X, --trustAll</option></term>
- <listitem>
- <para>Trust all server SSL certificates</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-Z, --useSSL</option></term>
- <listitem>
- <para>Use SSL for secure communication with the server</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>Utility Input/Output Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-i, --encoding {encoding}</option></term>
- <listitem>
- <para>Use the specified character set for command-line input</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--noPropertiesFile</option></term>
- <listitem>
- <para>No properties file will be used to get default command line
- argument values</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--propertiesFilePath {propertiesFilePath}</option></term>
- <listitem>
- <para>Path to the file containing default property values used for
- command line arguments</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t, --dontWrap</option></term>
- <listitem><para>Do not wrap long lines</para></listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-v, --verbose</option></term>
- <listitem>
- <para>Use verbose mode</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>General Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--version</option></term>
- <listitem>
- <para>Display version information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- </refsect1>
- <refsect1>
- <title>Filter</title>
- <para>The filter argument is a string representation of an LDAP search filter
- as in <literal>(cn=Babs Jensen)</literal>, <literal
- >(&(objectClass=Person)(|(sn=Jensen)(cn=Babs J*)))</literal>, or
- <literal>(cn:caseExactMatch:=Fred Flintstone)</literal>.</para>
- </refsect1>
- <refsect1>
- <title>Attribute</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>
- <refsect1>
- <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">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>
- <refsect1>
- <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>
- <refsect1>
- <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>
-</refentry>
diff --git a/src/main/docbkx/dev-guide/man-ldifdiff.xml b/src/main/docbkx/dev-guide/man-ldifdiff.xml
deleted file mode 100644
index c089a67..0000000
--- a/src/main/docbkx/dev-guide/man-ldifdiff.xml
+++ /dev/null
@@ -1,166 +0,0 @@
-<?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/opendj3/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 2011-2014 ForgeRock AS
- !
--->
-<refentry xml:id='ldifdiff-1'
- 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'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
- <refmeta>
- <refentrytitle>ldifdiff</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>ldifdiff</refname>
- <refpurpose>compare small LDIF files</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>ldifdiff</command>
- <arg choice="opt">options</arg>
- <arg choice="plain"><replaceable>source</replaceable>.ldif</arg>
- <arg choice="plain"><replaceable>target</replaceable>.ldif</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to compare two LDIF files and report the
- differences in LDIF format.</para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>-a, --ignoreAttrs {file}</option></term>
- <listitem>
- <para>File containing a list of attributes to ignore when computing the
- difference.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--checkSchema</option></term>
- <listitem>
- <para>Takes into account the syntax of the attributes as defined in the
- schema to make the value comparison. The provided LDIF files must conform
- to the server schema.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-e, --ignoreEntries {file}</option></term>
- <listitem>
- <para>File containing a list of entries (DN) to ignore when computing the
- difference.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-S, --singleValueChanges</option></term>
- <listitem>
- <para>Each attribute-level change should be written as a separate
- modification per attribute value rather than one modification per
- entry.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-V, --version</option></term>
- <listitem>
- <para>Display version information.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <title>Exit Codes</title>
- <variablelist>
- <varlistentry>
- <term>0</term>
- <listitem>
- <para>The command completed successfully.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>> 0</term>
- <listitem>
- <para>An error occurred.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <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>
-</refentry>
diff --git a/src/main/docbkx/dev-guide/man-ldifmodify.xml b/src/main/docbkx/dev-guide/man-ldifmodify.xml
deleted file mode 100644
index 21aaf13..0000000
--- a/src/main/docbkx/dev-guide/man-ldifmodify.xml
+++ /dev/null
@@ -1,150 +0,0 @@
-<?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/opendj3/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 2011-2014 ForgeRock AS
- !
--->
-<refentry xml:id='ldifmodify-1'
- 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'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
- <refmeta>
- <refentrytitle>ldifmodify</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>ldifmodify</refname>
- <refpurpose>apply LDIF changes to LDIF</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>ldifmodify</command>
- <arg choice="req">options</arg>
- <arg choice="plain">source</arg>
- <arg choice="opt">changes</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to apply a set of modify, add, and delete
- operations against data in an LDIF file.</para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>-c, --continueOnError</option></term>
- <listitem>
- <para>Continue processing even if there are errors</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-o, --outputLDIF {file}</option></term>
- <listitem>
- <para>Write updated entries to {file} instead of stdout</para>
- <para>Default value: stdout</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-V, --version</option></term>
- <listitem>
- <para>Display version information.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <title>Exit Codes</title>
- <variablelist>
- <varlistentry>
- <term>0</term>
- <listitem>
- <para>The command completed successfully.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>> 0</term>
- <listitem>
- <para>An error occurred.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <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>
-</refentry>
diff --git a/src/main/docbkx/dev-guide/man-ldifsearch.xml b/src/main/docbkx/dev-guide/man-ldifsearch.xml
deleted file mode 100644
index eaae30a..0000000
--- a/src/main/docbkx/dev-guide/man-ldifsearch.xml
+++ /dev/null
@@ -1,239 +0,0 @@
-<?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/opendj3/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 2011-2014 ForgeRock AS
- !
--->
-<refentry xml:id='ldifsearch-1'
- 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'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
- <refmeta>
- <refentrytitle>ldifsearch</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>ldifsearch</refname>
- <refpurpose>search LDIF with LDAP filters</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>ldifsearch</command>
- <arg choice="req">options</arg>
- <arg choice="plain">source</arg>
- <arg choice="opt">filter</arg>
- <arg choice="opt" rep="repeat">attribute</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to perform search operations against data in
- an LDIF file.</para>
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>-A, --typesOnly</option></term>
- <listitem>
- <para>Only retrieve attribute names but not their values</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-b, --baseDN {baseDN}</option></term>
- <listitem>
- <para>Search base DN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f, --filterFile {filterFile}</option></term>
- <listitem>
- <para>File containing a list of search filter strings</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-l, --timeLimit {timeLimit}</option></term>
- <listitem>
- <para>Maximum length of time in seconds to allow for the search</para>
- <para>Default value: 0</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-o, --outputFile {File}</option></term>
- <listitem>
- <para>Write search results to {file} instead of stdout</para>
- <para>Default: stdout</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-s, --searchScope {scope}</option></term>
- <listitem>
- <para>Search scope ('base', 'one', 'sub', or 'subordinate')</para>
- <para>Default value: sub</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-V, --version</option></term>
- <listitem>
- <para>Display version information.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-z, --sizeLimit {sizeLimit}</option></term>
- <listitem>
- <para>Maximum number of matching entries to return from the search</para>
- <para>Default value: 0</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <title>Filter</title>
- <para>The filter argument is a string representation of an LDAP search filter
- as in <literal>(cn=Babs Jensen)</literal>, <literal
- >(&(objectClass=Person)(|(sn=Jensen)(cn=Babs J*)))</literal>, or
- <literal>(cn:caseExactMatch:=Fred Flintstone)</literal>.</para>
- </refsect1>
- <refsect1>
- <title>Attribute</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>
- <refsect1>
- <title>Exit Codes</title>
- <variablelist>
- <varlistentry>
- <term>0</term>
- <listitem>
- <para>The command completed successfully.</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term>> 0</term>
- <listitem>
- <para>An error occurred.</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
- <refsect1>
- <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>
-</refentry>
diff --git a/src/main/docbkx/dev-guide/man-makeldif.xml b/src/main/docbkx/dev-guide/man-makeldif.xml
deleted file mode 100644
index 553bd0a..0000000
--- a/src/main/docbkx/dev-guide/man-makeldif.xml
+++ /dev/null
@@ -1,314 +0,0 @@
-<?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/opendj3/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 2013-2014 ForgeRock AS
- !
--->
-<refentry xml:id='makeldif-1'
- 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'>
- <info>
- <copyright>
- <year>2013-2014</year>
- <holder>ForgeRock AS</holder>
- </copyright>
- </info>
-
- <refmeta>
- <refentrytitle>makeldif</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version">${docTargetVersion}</refmiscinfo>
- </refmeta>
-
- <refnamediv>
- <refname>makeldif</refname>
- <refpurpose>generate test LDIF</refpurpose>
- </refnamediv>
-
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>makeldif</command>
- <arg choice="req">options</arg>
- <arg choice="plain">template-file-path</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
-
- <refsect1>
- <title>Description</title>
- <para>
- This utility can be used to generate LDIF data
- based on a definition in a template file,
- specified by <replaceable>template-file-path</replaceable>.
- </para>
-
- <para>
- The <replaceable>template-file-path</replaceable> can be
- one of the following:
- </para>
-
- <itemizedlist>
- <listitem>
- <para>
- A full path to the template file such as
- <filename>/path/to/opendj/config/MakeLDIF/example.template</filename>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- A relative path to the template file such as
- <filename>../../my-test-data.template</filename>.
- </para>
- </listitem>
-
- <listitem>
- <para>
- A file name that specifies one of the template files
- that are built into the OpenDJ LDAP Toolkit,
- such as <filename>example.template</filename>,
- or <filename>people_and_groups.template</filename>.
- </para>
- </listitem>
- </itemizedlist>
-
- <para>
- The OpenDJ LDAP Toolkit includes these built-in template and data files:
- </para>
-
- <variablelist>
- <varlistentry>
- <term><filename>cities</filename></term>
- <listitem>
- <para>
- List of more than 200 cities.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><filename>example.template</filename></term>
- <listitem>
- <para>
- Template to generate a base entry and users
- in a branch <literal>ou=people,[suffix]</literal>,
- where the default setting for suffix is
- <literal>suffix=dc=example,dc=com</literal>.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><filename>first.names</filename></term>
- <listitem>
- <para>
- List of more than 8000 first names.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><filename>last.names</filename></term>
- <listitem>
- <para>
- List of more than 13000 last names.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><filename>people_and_groups.template</filename></term>
- <listitem>
- <para>
- Template to generate a base entry, users, and groups.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><filename>states</filename></term>
- <listitem>
- <para>
- List of US states by their two-character codes.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><filename>streets</filename></term>
- <listitem>
- <para>
- List of more than 70 street names.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
-
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
-
- <variablelist>
- <varlistentry>
- <term><option>-c, --constant {name=value}</option></term>
- <listitem>
- <para>
- A constant that overrides the value set in the template file.
- </para>
-
- <para>
- Repeat this argument as necessary.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-o, --outputLDIF {file}</option></term>
- <listitem>
- <para>
- The path to the LDIF file to be written.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-r, --resourcePath {path}</option></term>
- <listitem>
- <para>
- Path to look for resources (such as data files).
- </para>
-
- <para>
- The <command>makeldif</command> command looks for resources
- in the following locations in this order:
- </para>
-
- <orderedlist>
- <listitem>
- <para>
- The current directory where the command is run.
- </para>
- </listitem>
-
- <listitem>
- <para>
- The resource path directory.
- </para>
- </listitem>
-
- <listitem>
- <para>
- The built-in files.
- </para>
- </listitem>
- </orderedlist>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-s, --randomSeed {seed}</option></term>
- <listitem>
- <para>
- The seed to use to initialize the random number generator.
- </para>
-
- <para>
- Default value: 0
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-V, --version</option></term>
- <listitem>
- <para>
- Display version information.
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>
- Display usage information.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect1>
-
- <refsect1>
- <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>
-
- <refsect1>
- <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>
-
- <refsect1>
- <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>
-</refentry>
diff --git a/src/main/docbkx/dev-guide/man-modrate.xml b/src/main/docbkx/dev-guide/man-modrate.xml
deleted file mode 100644
index 054ca25..0000000
--- a/src/main/docbkx/dev-guide/man-modrate.xml
+++ /dev/null
@@ -1,401 +0,0 @@
-<?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/opendj3/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 2011-2014 ForgeRock AS
- !
--->
-<refentry xml:id='modrate-1'
- 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:xinclude='http://www.w3.org/2001/XInclude'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
- <refmeta>
- <refentrytitle>modrate</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>modrate</refname>
- <refpurpose>measure modification throughput and response time</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>modrate</command>
- <arg choice="req">options</arg>
- <group choice="opt" rep="repeat">
- <arg>attribute</arg>
- <arg>:</arg>
- <arg>value format string</arg>
- </group>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to measure modify throughput and response time
- of a directory service using user-defined modifications.</para>
-
- <xinclude:include href="../shared/informalexample-net-tweaks.xml" />
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>-A, --asynchronous</option></term>
- <listitem>
- <para>Use asynchronous mode and don't wait for results before sending the
- next request</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-b, --baseDN {baseDN}</option></term>
- <listitem>
- <para>Base DN format string</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-B, --warmUpDuration {warmUpDuration}</option></term>
- <listitem>
- <para>
- Warm up duration in seconds
- </para>
-
- <para>
- Default value: 0
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-c, --numConnections {numConnections}</option></term>
- <listitem>
- <para>Number of connections</para>
- <para>Default value: 1</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-d, --maxDuration {maxDuration}</option></term>
- <listitem>
- <para>
- Maximum duration in seconds, 0 for unlimited
- </para>
-
- <para>
- Default value: 0
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-e, --percentile {percentile}</option></term>
- <listitem>
- <para>Calculate max response time for a percentile of operations</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f, --keepConnectionsOpen</option></term>
- <listitem>
- <para>Keep connections open</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-F, --noRebind</option></term>
- <listitem>
- <para>Keep connections open and do not rebind</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-g, --argument {generator function or static string}</option></term>
- <listitem>
- <para>Argument used to evaluate the Java style format strings in program
- parameters (Base DN, Search Filter). The set of all arguments provided
- form the the argument list in order. Besides static string arguments, they
- can be generated per iteration with the following functions:</para>
- <variablelist>
- <varlistentry>
- <term>"inc({filename})"</term>
- <listitem><para>Consecutive, incremental line from file</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>"inc({min},{max})"</term>
- <listitem><para>Consecutive, incremental number</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>"rand({filename})"</term>
- <listitem><para>Random line from file</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>"rand({min},{max})"</term>
- <listitem><para>Random number</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>"randstr({length},<replaceable>charSet</replaceable>)"</term>
- <listitem><para>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. If no charSet is specified,
- the default charSet of [A-Z][a-z][0-9] will be used.</para></listitem>
- </varlistentry>
- </variablelist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-i, --statInterval {statInterval}</option></term>
- <listitem>
- <para>Display results each specified number of seconds</para>
- <para>Default value: 5</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m, --maxIterations {maxIterations}</option></term>
- <listitem>
- <para>Max iterations, 0 for unlimited</para>
- <para>Default value: 0</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-M, --targetThroughput {targetThroughput}</option></term>
- <listitem>
- <para>Target average throughput to achieve</para>
- <para>Default value: 0</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-S, --scriptFriendly</option></term>
- <listitem>
- <para>Use script-friendly mode</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t, --numConcurrentTasks {numConcurrentTasks}</option></term>
- <listitem>
- <para>Number of concurrent tasks per connection</para>
- <para>Default value: 1</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <refsect2>
- <title>LDAP Connection Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-D, --bindDN {bindDN}</option></term>
- <listitem>
- <para>DN to use to bind to the server</para>
- <para>Default value: cn=Directory Manager</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E, --reportAuthzID</option></term>
- <listitem>
- <para>Use the authorization identity control</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-h, --hostname {host}</option></term>
- <listitem>
- <para>Directory server hostname or IP address</para>
- <para>Default value: localhost.localdomain</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>
- <listitem>
- <para>Bind password file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-K, --keyStorePath {keyStorePath}</option></term>
- <listitem>
- <para> Certificate key store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-N, --certNickname {nickname}</option></term>
- <listitem>
- <para>Nickname of certificate for SSL client authentication</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-o, --saslOption {name=value}</option></term>
- <listitem>
- <para>SASL bind options</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-p, --port {port}</option></term>
- <listitem>
- <para>Directory server port number</para>
- <para>Default value: 389</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-P, --trustStorePath {trustStorePath}</option></term>
- <listitem>
- <para>Certificate trust store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-q, --useStartTLS</option></term>
- <listitem>
- <para>Use StartTLS to secure communication with the server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-T, --trustStorePassword {trustStorePassword}</option></term>
- <listitem>
- <para>Certificate trust store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
- <listitem>
- <para>Certificate key store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-U, --trustStorePasswordFile {path}</option></term>
- <listitem>
- <para>Certificate trust store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--usePasswordPolicyControl</option></term>
- <listitem>
- <para>Use the password policy request control</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-w, --bindPassword {bindPassword}</option></term>
- <listitem>
- <para>Password to use to bind to the server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
- <listitem>
- <para>Certificate key store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-X, --trustAll</option></term>
- <listitem>
- <para>Trust all server SSL certificates</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-Z, --useSSL</option></term>
- <listitem>
- <para>Use SSL for secure communication with the server</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>Utility Input/Output Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--noPropertiesFile</option></term>
- <listitem>
- <para>No properties file will be used to get default command line
- argument values</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--propertiesFilePath {propertiesFilePath}</option></term>
- <listitem>
- <para>Path to the file containing default property values used for
- command line arguments</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-v, --verbose</option></term>
- <listitem>
- <para>Use verbose mode</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>General Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-V, --version</option></term>
- <listitem>
- <para>Display version information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- </refsect1>
- <refsect1>
- <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>
- <refsect1>
- <title>Examples</title>
- <para>The following example demonstrates testing directory performance by
- using the modrate 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>
-</refentry>
diff --git a/src/main/docbkx/dev-guide/man-searchrate.xml b/src/main/docbkx/dev-guide/man-searchrate.xml
deleted file mode 100644
index c688862..0000000
--- a/src/main/docbkx/dev-guide/man-searchrate.xml
+++ /dev/null
@@ -1,410 +0,0 @@
-<?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/opendj3/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 2011-2014 ForgeRock AS
- !
--->
-<refentry xml:id='searchrate-1'
- 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:xinclude='http://www.w3.org/2001/XInclude'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
- <refmeta>
- <refentrytitle>searchrate</refentrytitle><manvolnum>1</manvolnum>
- <refmiscinfo class="software">OpenDJ</refmiscinfo>
- <refmiscinfo class="version"><?eval ${docTargetVersion}?></refmiscinfo>
- </refmeta>
- <refnamediv>
- <refname>searchrate</refname>
- <refpurpose>measure search throughput and response time</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <cmdsynopsis>
- <command>searchrate</command>
- <arg choice="req">options</arg>
- <arg choice="opt">filter format string</arg>
- <arg choice="opt" rep="repeat">attributes</arg>
- </cmdsynopsis>
- </refsynopsisdiv>
- <refsect1>
- <title>Description</title>
- <para>This utility can be used to measure search throughput and response time
- of a directory service using user-defined searches.</para>
-
- <xinclude:include href="../shared/informalexample-net-tweaks.xml" />
- </refsect1>
- <refsect1>
- <title>Options</title>
- <para>The following options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>-a, --dereferencePolicy {dereferencePolicy}</option></term>
- <listitem>
- <para>Alias dereference policy ('never', 'always', 'search', or 'find')</para>
- <para>Default value: never</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-A, --asynchronous</option></term>
- <listitem>
- <para>Use asynchronous mode and do not wait for results before sending the
- next request</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-b, --baseDN {baseDN}</option></term>
- <listitem>
- <para>Base DN format string</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-B, --warmUpDuration {warmUpDuration}</option></term>
- <listitem>
- <para>
- Warm up duration in seconds
- </para>
-
- <para>
- Default value: 0
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-c, --numConnections {numConnections}</option></term>
- <listitem>
- <para>Number of connections</para>
- <para>Default value: 1</para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-d, --maxDuration {maxDuration}</option></term>
- <listitem>
- <para>
- Maximum duration in seconds, 0 for unlimited
- </para>
-
- <para>
- Default value: 0
- </para>
- </listitem>
- </varlistentry>
-
- <varlistentry>
- <term><option>-e, --percentile {percentile}</option></term>
- <listitem>
- <para>Calculate max response time for a percentile of operations</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-f, --keepConnectionsOpen</option></term>
- <listitem>
- <para>Keep connections open</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-F, --noRebind</option></term>
- <listitem>
- <para>Keep connections open and do not rebind</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-g, --argument {generator function or static string}</option></term>
- <listitem>
- <para>Argument used to evaluate the Java style format strings in program
- parameters (Base DN, Search Filter). The set of all arguments provided
- form the the argument list in order. Besides static string arguments, they
- can be generated per iteration with the following functions:</para>
- <variablelist>
- <varlistentry>
- <term>"inc({filename})"</term>
- <listitem><para>Consecutive, incremental line from file</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>"inc({min},{max})"</term>
- <listitem><para>Consecutive, incremental number</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>"rand({filename})"</term>
- <listitem><para>Random line from file</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>"rand({min},{max})"</term>
- <listitem><para>Random number</para></listitem>
- </varlistentry>
- <varlistentry>
- <term>"randstr({length},<replaceable>charSet</replaceable>)"</term>
- <listitem><para>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. If no charSet is specified,
- the default charSet of [A-Z][a-z][0-9] will be used.</para></listitem>
- </varlistentry>
- </variablelist>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-i, --statInterval {statInterval}</option></term>
- <listitem>
- <para>Display results each specified number of seconds</para>
- <para>Default value: 5</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-m, --maxIterations {maxIterations}</option></term>
- <listitem>
- <para>Max iterations, 0 for unlimited</para>
- <para>Default value: 0</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-M, --targetThroughput {targetThroughput}</option></term>
- <listitem>
- <para>Target average throughput to achieve</para>
- <para>Default value: 0</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-s, --searchScope {searchScope}</option></term>
- <listitem>
- <para>Search scope ('base', 'one', 'sub', or 'subordinate')</para>
- <para>Default value: sub</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-S, --scriptFriendly</option></term>
- <listitem>
- <para>Use script-friendly mode</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-t, --numConcurrentTasks {numConcurrentTasks}</option></term>
- <listitem>
- <para>Number of concurrent tasks per connection</para>
- <para>Default value: 1</para>
- </listitem>
- </varlistentry>
- </variablelist>
- <refsect2>
- <title>LDAP Connection Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-D, --bindDN {bindDN}</option></term>
- <listitem>
- <para>DN to use to bind to the server</para>
- <para>Default value: cn=Directory Manager</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-E, --reportAuthzID</option></term>
- <listitem>
- <para>Use the authorization identity control</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-h, --hostname {host}</option></term>
- <listitem>
- <para>Directory server hostname or IP address</para>
- <para>Default value: localhost.localdomain</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-j, --bindPasswordFile {bindPasswordFile}</option></term>
- <listitem>
- <para>Bind password file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-K, --keyStorePath {keyStorePath}</option></term>
- <listitem>
- <para> Certificate key store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-N, --certNickname {nickname}</option></term>
- <listitem>
- <para>Nickname of certificate for SSL client authentication</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-o, --saslOption {name=value}</option></term>
- <listitem>
- <para>SASL bind options</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-p, --port {port}</option></term>
- <listitem>
- <para>Directory server port number</para>
- <para>Default value: 389</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-P, --trustStorePath {trustStorePath}</option></term>
- <listitem>
- <para>Certificate trust store path</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-q, --useStartTLS</option></term>
- <listitem>
- <para>Use StartTLS to secure communication with the server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-T, --trustStorePassword {trustStorePassword}</option></term>
- <listitem>
- <para>Certificate trust store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
- <listitem>
- <para>Certificate key store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-U, --trustStorePasswordFile {path}</option></term>
- <listitem>
- <para>Certificate trust store PIN file</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--usePasswordPolicyControl</option></term>
- <listitem>
- <para>Use the password policy request control</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-w, --bindPassword {bindPassword}</option></term>
- <listitem>
- <para>Password to use to bind to the server</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
- <listitem>
- <para>Certificate key store PIN</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-X, --trustAll</option></term>
- <listitem>
- <para>Trust all server SSL certificates</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-Z, --useSSL</option></term>
- <listitem>
- <para>Use SSL for secure communication with the server</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>Utility Input/Output Options</title>
- <variablelist>
- <varlistentry>
- <term><option>--noPropertiesFile</option></term>
- <listitem>
- <para>No properties file will be used to get default command line
- argument values</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--propertiesFilePath {propertiesFilePath}</option></term>
- <listitem>
- <para>Path to the file containing default property values used for
- command line arguments</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-v, --verbose</option></term>
- <listitem>
- <para>Use verbose mode</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- <refsect2>
- <title>General Options</title>
- <variablelist>
- <varlistentry>
- <term><option>-V, --version</option></term>
- <listitem>
- <para>Display version information</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>-?, -H, --help</option></term>
- <listitem>
- <para>Display usage information</para>
- </listitem>
- </varlistentry>
- </variablelist>
- </refsect2>
- </refsect1>
- <refsect1>
- <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>
- <refsect1>
- <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>
-</refentry>
diff --git a/src/main/docbkx/man-pages/README.md b/src/main/docbkx/man-pages/README.md
new file mode 100644
index 0000000..b14b463
--- /dev/null
+++ b/src/main/docbkx/man-pages/README.md
@@ -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.
diff --git a/src/main/docbkx/man-pages/addrate-examples.xml b/src/main/docbkx/man-pages/addrate-examples.xml
new file mode 100644
index 0000000..ac3f825
--- /dev/null
+++ b/src/main/docbkx/man-pages/addrate-examples.xml
@@ -0,0 +1,122 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ! CCPL HEADER START
+ !
+ ! This work is licensed under the Creative Commons
+ ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
+ ! To view a copy of this license, visit
+ ! http://creativecommons.org/licenses/by-nc-nd/3.0/
+ ! or send a letter to Creative Commons, 444 Castro Street,
+ ! Suite 900, Mountain View, California, 94041, USA.
+ !
+ ! You can also obtain a copy of the license at
+ ! trunk/opendj/legal-notices/CC-BY-NC-ND.txt.
+ ! See the License for the specific language governing permissions
+ ! and limitations under the License.
+ !
+ ! If applicable, add the following below this CCPL HEADER, with the fields
+ ! enclosed by brackets "[]" replaced with your own identifying information:
+ ! Portions Copyright [yyyy] [name of copyright owner]
+ !
+ ! CCPL HEADER END
+ !
+ ! Copyright 2015 ForgeRock AS.
+ !
+-->
+<refsect1 xmlns="http://docbook.org/ns/docbook"
+ version="5.0" xml:lang="en"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://docbook.org/ns/docbook
+ http://docbook.org/xml/5.0/xsd/docbook.xsd">
+ <title>Examples</title>
+
+ <para>
+ The following examples use this template file,
+ <filename>addrate.template</filename>.
+ </para>
+
+ <programlisting language="ldif">
+<![CDATA[
+define suffix=dc=example,dc=com
+define maildomain=example.com
+
+branch: [suffix]
+
+branch: ou=People,[suffix]
+subordinateTemplate: person
+
+template: person
+rdnAttr: uid
+objectClass: top
+objectClass: person
+objectClass: organizationalPerson
+objectClass: inetOrgPerson
+givenName: <first>
+sn: <last>
+cn: {givenName} {sn}
+initials: {givenName:1}<random:chars:ABCDEFGHIJKLMNOPQRSTUVWXYZ:1>{sn:1}
+employeeNumber: <sequential:0>
+uid: user.{employeeNumber}
+mail: {uid}@[maildomain]
+userPassword: password
+telephoneNumber: <random:telephone>
+homePhone: <random:telephone>
+pager: <random:telephone>
+mobile: <random:telephone>
+street: <random:numeric:5> <file:streets> Street
+l: <file:cities>
+st: <file:states>
+postalCode: <random:numeric:5>
+postalAddress: {cn}${street}${l}, {st} {postalCode}
+description: This is the description for {cn}.
+
+]]>
+ </programlisting>
+
+ <para>
+ The following example adds entries, and then randomly deletes them
+ when more than 10,000 entries have been added.
+ </para>
+
+ <screen>
+$ <userinput>addrate -p 1389 -D "cn=Directory Manager" -w password \
+-f -c 10 -C random -s 10000 addrate.template</userinput>
+<computeroutput>
+-----------------------------------------------------------------------
+ Throughput Response Time
+ (ops/second) (milliseconds)
+recent average recent average 99.9% 99.99% 99.999% err/sec Add%
+-----------------------------------------------------------------------
+466.7 467.2 20.738 20.738 187.00 201.00 201.00 0.0 100.00
+588.9 528.1 17.015 18.661 166.00 201.00 201.00 0.0 100.00
+1584.9 880.3 6.076 11.109 150.00 196.00 201.00 0.0 79.87
+1577.8 1054.5 6.138 9.252 132.00 192.00 201.00 0.0 50.00
+1853.0 1214.4 5.188 8.010 124.00 187.00 201.00 0.0 49.99
+^CPurge phase...
+2482.7 1426.2 3.790 6.783 114.00 187.00 201.00 0.0 9.77</computeroutput>
+ </screen>
+
+ <para>
+ The following example also adds entries, and then deletes them
+ in the order they were added after they are 10 seconds old.
+ </para>
+
+ <screen>
+$ <userinput>addrate -p 1389 -D "cn=Directory Manager" -w password \
+-f -c 10 -C fifo -a 10 addrate.template</userinput>
+<computeroutput>
+-----------------------------------------------------------------------
+ Throughput Response Time
+ (ops/second) (milliseconds)
+recent average recent average 99.9% 99.99% 99.999% err/sec Add%
+-----------------------------------------------------------------------
+2065.6 2068.1 4.646 4.646 30.00 51.00 58.00 0.0 100.00
+1479.7 1773.3 6.567 5.449 46.00 59.00 67.00 0.0 99.23
+1443.4 1663.3 6.730 5.820 56.00 112.00 120.00 0.0 50.01
+1462.6 1613.0 6.635 6.005 56.00 102.00 120.00 0.0 50.08
+1452.2 1580.8 6.678 6.129 62.00 110.00 120.00 0.0 49.97
+^CPurge phase...
+1344.5 1541.4 7.170 6.280 69.00 176.00 1900.00 0.0 17.30
+1703.3 1564.6 5.449 6.151 68.00 176.00 3000.00 0.0 0.00</computeroutput>
+ </screen>
+</refsect1>
diff --git a/src/main/docbkx/man-pages/attributes.xml b/src/main/docbkx/man-pages/attributes.xml
new file mode 100644
index 0000000..8a55f5f
--- /dev/null
+++ b/src/main/docbkx/man-pages/attributes.xml
@@ -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>
diff --git a/src/main/docbkx/man-pages/authrate-examples.xml b/src/main/docbkx/man-pages/authrate-examples.xml
new file mode 100644
index 0000000..d74cc39
--- /dev/null
+++ b/src/main/docbkx/man-pages/authrate-examples.xml
@@ -0,0 +1,59 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ! CCPL HEADER START
+ !
+ ! This work is licensed under the Creative Commons
+ ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
+ ! To view a copy of this license, visit
+ ! http://creativecommons.org/licenses/by-nc-nd/3.0/
+ ! or send a letter to Creative Commons, 444 Castro Street,
+ ! Suite 900, Mountain View, California, 94041, USA.
+ !
+ ! You can also obtain a copy of the license at
+ ! trunk/opendj/legal-notices/CC-BY-NC-ND.txt.
+ ! See the License for the specific language governing permissions
+ ! and limitations under the License.
+ !
+ ! If applicable, add the following below this CCPL HEADER, with the fields
+ ! enclosed by brackets "[]" replaced with your own identifying information:
+ ! Portions Copyright [yyyy] [name of copyright owner]
+ !
+ ! CCPL HEADER END
+ !
+ ! Copyright 2015 ForgeRock AS.
+ !
+-->
+<refsect1 xmlns="http://docbook.org/ns/docbook"
+ version="5.0" xml:lang="en"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://docbook.org/ns/docbook
+ http://docbook.org/xml/5.0/xsd/docbook.xsd">
+ <title>Examples</title>
+
+ <para>
+ The following example demonstrates measuring simple bind performance.
+ </para>
+
+ <screen>
+$ <userinput>authrate -p 1389 -g "rand(names.txt)" \
+ -D "uid=%s,ou=people,dc=example,dc=com" -w password -c 10 -f</userinput>
+<computeroutput>-----------------------------------------------------------------
+ Throughput Response Time
+ (ops/second) (milliseconds)
+recent average recent average 99.9% 99.99% 99.999% err/sec
+-----------------------------------------------------------------
+9796.9 9816.6 1.029 1.029 12.413 161.451 161.835 0.0
+14201.1 12028.1 0.704 0.835 9.508 161.456 167.573 0.0
+14450.0 12835.9 0.692 0.782 8.989 161.835 174.518 0.0
+12934.3 12860.6 0.773 0.779 9.253 161.339 174.426 0.0
+14154.5 13121.0 0.706 0.764 9.025 161.451 177.101 0.0
+^C</computeroutput>
+ </screen>
+
+ <para>
+ The <filename>names.txt</filename> contains
+ all the user IDs for the sample suffix.
+ All user password values have been set to <literal>password</literal>
+ for this example.
+ </para>
+</refsect1>
diff --git a/src/main/docbkx/man-pages/exit-codes-0-1.xml b/src/main/docbkx/man-pages/exit-codes-0-1.xml
new file mode 100644
index 0000000..1da3555
--- /dev/null
+++ b/src/main/docbkx/man-pages/exit-codes-0-1.xml
@@ -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>
diff --git a/src/main/docbkx/man-pages/exit-codes-0-5-6-other.xml b/src/main/docbkx/man-pages/exit-codes-0-5-6-other.xml
new file mode 100644
index 0000000..9e4e9c9
--- /dev/null
+++ b/src/main/docbkx/man-pages/exit-codes-0-5-6-other.xml
@@ -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>
diff --git a/src/main/docbkx/man-pages/exit-codes-0-80-89.xml b/src/main/docbkx/man-pages/exit-codes-0-80-89.xml
new file mode 100644
index 0000000..be64d51
--- /dev/null
+++ b/src/main/docbkx/man-pages/exit-codes-0-80-89.xml
@@ -0,0 +1,61 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ! CCPL HEADER START
+ !
+ ! This work is licensed under the Creative Commons
+ ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
+ ! To view a copy of this license, visit
+ ! http://creativecommons.org/licenses/by-nc-nd/3.0/
+ ! or send a letter to Creative Commons, 444 Castro Street,
+ ! Suite 900, Mountain View, California, 94041, USA.
+ !
+ ! You can also obtain a copy of the license at
+ ! 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>
diff --git a/src/main/docbkx/man-pages/exit-codes-0-89.xml b/src/main/docbkx/man-pages/exit-codes-0-89.xml
new file mode 100644
index 0000000..1134dd2
--- /dev/null
+++ b/src/main/docbkx/man-pages/exit-codes-0-89.xml
@@ -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>
diff --git a/src/main/docbkx/man-pages/exit-codes-0-gt0.xml b/src/main/docbkx/man-pages/exit-codes-0-gt0.xml
new file mode 100644
index 0000000..e06d202
--- /dev/null
+++ b/src/main/docbkx/man-pages/exit-codes-0-gt0.xml
@@ -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>> 0</term>
+ <listitem>
+ <para>
+ An error occurred.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+</refsect1>
diff --git a/src/main/docbkx/man-pages/exit-codes-0-ldap-89.xml b/src/main/docbkx/man-pages/exit-codes-0-ldap-89.xml
new file mode 100644
index 0000000..f7e9cf1
--- /dev/null
+++ b/src/main/docbkx/man-pages/exit-codes-0-ldap-89.xml
@@ -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>
diff --git a/src/main/docbkx/man-pages/files.xml b/src/main/docbkx/man-pages/files.xml
new file mode 100644
index 0000000..bc7f0cb
--- /dev/null
+++ b/src/main/docbkx/man-pages/files.xml
@@ -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>
diff --git a/src/main/docbkx/man-pages/filters.xml b/src/main/docbkx/man-pages/filters.xml
new file mode 100644
index 0000000..e10bb37
--- /dev/null
+++ b/src/main/docbkx/man-pages/filters.xml
@@ -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>(&(objectClass=Person)(|(sn=Jensen)(cn=Babs J*)))</literal>,
+ or <literal>(cn:caseExactMatch:=Fred Flintstone)</literal>.
+ </para>
+</refsect1>
diff --git a/src/main/docbkx/man-pages/ldapcompare-examples.xml b/src/main/docbkx/man-pages/ldapcompare-examples.xml
new file mode 100644
index 0000000..10cdb77
--- /dev/null
+++ b/src/main/docbkx/man-pages/ldapcompare-examples.xml
@@ -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>
diff --git a/src/main/docbkx/man-pages/ldapmodify-examples.xml b/src/main/docbkx/man-pages/ldapmodify-examples.xml
new file mode 100644
index 0000000..f0bad79
--- /dev/null
+++ b/src/main/docbkx/man-pages/ldapmodify-examples.xml
@@ -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 ]] && 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 <<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>
diff --git a/src/main/docbkx/man-pages/ldappasswordmodify-examples.xml b/src/main/docbkx/man-pages/ldappasswordmodify-examples.xml
new file mode 100644
index 0000000..967e303
--- /dev/null
+++ b/src/main/docbkx/man-pages/ldappasswordmodify-examples.xml
@@ -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>
diff --git a/src/main/docbkx/man-pages/ldapsearch-examples.xml b/src/main/docbkx/man-pages/ldapsearch-examples.xml
new file mode 100644
index 0000000..06a4ba6
--- /dev/null
+++ b/src/main/docbkx/man-pages/ldapsearch-examples.xml
@@ -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>
diff --git a/src/main/docbkx/man-pages/ldifdiff-examples.xml b/src/main/docbkx/man-pages/ldifdiff-examples.xml
new file mode 100644
index 0000000..113f598
--- /dev/null
+++ b/src/main/docbkx/man-pages/ldifdiff-examples.xml
@@ -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>
diff --git a/src/main/docbkx/man-pages/ldifmodify-examples.xml b/src/main/docbkx/man-pages/ldifmodify-examples.xml
new file mode 100644
index 0000000..cd35ca4
--- /dev/null
+++ b/src/main/docbkx/man-pages/ldifmodify-examples.xml
@@ -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>
diff --git a/src/main/docbkx/man-pages/ldifsearch-examples.xml b/src/main/docbkx/man-pages/ldifsearch-examples.xml
new file mode 100644
index 0000000..328a443
--- /dev/null
+++ b/src/main/docbkx/man-pages/ldifsearch-examples.xml
@@ -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>
diff --git a/src/main/docbkx/man-pages/makeldif-examples.xml b/src/main/docbkx/man-pages/makeldif-examples.xml
new file mode 100644
index 0000000..86cf69f
--- /dev/null
+++ b/src/main/docbkx/man-pages/makeldif-examples.xml
@@ -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>
diff --git a/src/main/docbkx/man-pages/makeldif-see-also.xml b/src/main/docbkx/man-pages/makeldif-see-also.xml
new file mode 100644
index 0000000..606de0e
--- /dev/null
+++ b/src/main/docbkx/man-pages/makeldif-see-also.xml
@@ -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>
diff --git a/src/main/docbkx/dev-guide/man-makeldif-template.xml b/src/main/docbkx/man-pages/man-makeldif-template.xml
similarity index 97%
rename from src/main/docbkx/dev-guide/man-makeldif-template.xml
rename to src/main/docbkx/man-pages/man-makeldif-template.xml
index a4cb9ca..5c79c27 100644
--- a/src/main/docbkx/dev-guide/man-makeldif-template.xml
+++ b/src/main/docbkx/man-pages/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"
- xlink:href="dev-guide#makeldif-1"
- xlink:role="http://docbook.org/xlink/role/olink"
- ><citerefentry><refentrytitle>makeldif</refentrytitle><manvolnum
- >1</manvolnum></citerefentry></link>,
+ <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>,
the OpenDJ directory server template file
<filename>/path/to/opendj/config/MakeLDIF/example.template</filename>
</para>
diff --git a/src/main/docbkx/man-pages/modrate-examples.xml b/src/main/docbkx/man-pages/modrate-examples.xml
new file mode 100644
index 0000000..b4eb753
--- /dev/null
+++ b/src/main/docbkx/man-pages/modrate-examples.xml
@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ! CCPL HEADER START
+ !
+ ! This work is licensed under the Creative Commons
+ ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
+ ! To view a copy of this license, visit
+ ! http://creativecommons.org/licenses/by-nc-nd/3.0/
+ ! or send a letter to Creative Commons, 444 Castro Street,
+ ! Suite 900, Mountain View, California, 94041, USA.
+ !
+ ! You can also obtain a copy of the license at
+ ! trunk/opendj/legal-notices/CC-BY-NC-ND.txt.
+ ! See the License for the specific language governing permissions
+ ! and limitations under the License.
+ !
+ ! If applicable, add the following below this CCPL HEADER, with the fields
+ ! enclosed by brackets "[]" replaced with your own identifying information:
+ ! Portions Copyright [yyyy] [name of copyright owner]
+ !
+ ! CCPL HEADER END
+ !
+ ! Copyright 2015 ForgeRock AS.
+ !
+-->
+<refsect1 xmlns="http://docbook.org/ns/docbook"
+ version="5.0" xml:lang="en"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://docbook.org/ns/docbook
+ http://docbook.org/xml/5.0/xsd/docbook.xsd">
+ <title>Examples</title>
+
+ <para>
+ The following example demonstrates testing directory performance
+ by using the <command>modrate</command> command
+ to write random 16-character description values to all entries in a sample file.
+ </para>
+
+ <screen>
+$ <userinput>grep ^uid: /path/to/Example.ldif | sed -e "s/uid: //" > names.txt</userinput>
+$ <userinput>modrate -p 1389 -D "cn=Directory Manager" -w password -A -F -c 4 -t 4 \
+ -b "uid=%s,ou=people,dc=example,dc=com" -g "rand(names.txt)" \
+ -g "randstr(16)" 'description:%2$s'</userinput>
+<computeroutput>--------------------------------------------------------------------------
+ Throughput Response Time
+ (ops/second) (milliseconds)
+recent average recent average 99.9% 99.99% 99.999% err/sec req/res
+--------------------------------------------------------------------------
+1085.9 1088.5 993.849 993.849 2135.220 2510.361 2510.361 0.0 2.3
+2086.7 1648.8 1963.980 1683.038 3015.025 3078.628 3215.050 0.0 1.0
+3097.3 2092.6 1332.930 1524.278 2940.131 3024.811 3215.050 0.0 1.0
+3848.3 2501.4 1045.000 1352.583 2902.235 3015.863 3215.050 0.0 1.0
+3641.2 2717.4 1106.157 1290.003 2901.379 3015.597 3215.050 0.0 1.0
+3759.4 2883.0 1065.732 1243.534 2900.400 3015.501 3215.050 0.0 1.0
+^C</computeroutput>
+ </screen>
+</refsect1>
diff --git a/src/main/docbkx/man-pages/searchrate-examples.xml b/src/main/docbkx/man-pages/searchrate-examples.xml
new file mode 100644
index 0000000..34d540f
--- /dev/null
+++ b/src/main/docbkx/man-pages/searchrate-examples.xml
@@ -0,0 +1,55 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ! CCPL HEADER START
+ !
+ ! This work is licensed under the Creative Commons
+ ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
+ ! To view a copy of this license, visit
+ ! http://creativecommons.org/licenses/by-nc-nd/3.0/
+ ! or send a letter to Creative Commons, 444 Castro Street,
+ ! Suite 900, Mountain View, California, 94041, USA.
+ !
+ ! You can also obtain a copy of the license at
+ ! trunk/opendj/legal-notices/CC-BY-NC-ND.txt.
+ ! See the License for the specific language governing permissions
+ ! and limitations under the License.
+ !
+ ! If applicable, add the following below this CCPL HEADER, with the fields
+ ! enclosed by brackets "[]" replaced with your own identifying information:
+ ! Portions Copyright [yyyy] [name of copyright owner]
+ !
+ ! CCPL HEADER END
+ !
+ ! Copyright 2015 ForgeRock AS.
+ !
+-->
+<refsect1 xmlns="http://docbook.org/ns/docbook"
+ version="5.0" xml:lang="en"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://docbook.org/ns/docbook
+ http://docbook.org/xml/5.0/xsd/docbook.xsd">
+ <title>Examples</title>
+
+ <para>
+ The following example demonstrates measuring search performance.
+ </para>
+
+ <screen>
+$ <userinput>grep ^uid: /path/to/Example.ldif | sed -e "s/uid: //" > names.txt</userinput>
+$ <userinput>searchrate -p 1389 -b dc=example,dc=com -A -F -c 4 -t 4 \
+ -g "rand(names.txt)" "(uid=%s)"</userinput>
+<computeroutput>-------------------------------------------------------------------------------
+ Throughput Response Time
+ (ops/second) (milliseconds)
+recent average recent average 99.9% 99.99% 99.999% err/sec Entries/Srch
+-------------------------------------------------------------------------------
+1475.9 1475.9 0.423 0.423 6.938 126.236 126.236 0.0 1.0
+2596.5 2038.4 0.254 0.315 6.866 12.980 126.236 0.0 1.0
+3210.7 2428.2 0.205 0.267 5.733 11.710 126.236 0.0 1.0
+3080.5 2591.0 0.215 0.252 5.733 10.541 126.236 0.0 1.0
+3236.9 2720.1 0.203 0.240 5.258 10.514 126.236 0.0 1.0
+3181.1 2796.8 0.207 0.234 5.258 10.384 126.236 0.0 1.0
+3202.5 2854.8 0.206 0.229 4.825 10.384 126.236 0.0 1.0
+^C</computeroutput>
+ </screen>
+</refsect1>
--
Gitblit v1.10.0