Fix OpenDJ-222: Remove more references to OpenDS. Also update/adds the man-...

Ludovic Poitou

20.57.2011 db1f00b67632d5a638f0b30129d547db9338059b

Fix OpenDJ-222: Remove more references to OpenDS.
Also update/adds the man-pages for tools.

 opends/resource/DynamicConstants.java.stubs

@@ -23,6 +23,7 @@
 *
 *
 *      Copyright 2006-2009 Sun Microsystems, Inc.
 *      Portions Copyright 2011 ForgeRock AS
 */
package org.opends.server.util;

@@ -296,7 +297,7 @@
        catch (Exception ex) {}
        try{
         RELEASE_VERSION_STRING = VERSION_NUMBER_STRING
                 + " (OpenDS version = "
                 + " (OpenDJ version = "
                 + OPENDS_NUMBER_STRING + ")" ;
        }
        catch (Exception ex) {}

 opends/resource/README

@@ -4,7 +4,7 @@
OpenDJ is a downstream build of the OpenDS project, with a different name
to avoid trademark issues.
Complete documentation for this product may be found online
at https://OpenDS.dev.java.net/.
at http://opendj.forgerock.org/docs.html.

To configure the server, run the setup script on UNIX-based platforms, or the
setup.bat batch file on Windows.  To start the server, run bin/start-ds on

 opends/resource/bin/stop-ds

@@ -62,7 +62,7 @@

# check for presence of lib/_svc-opendj.sh file
# If present, we should be on Solaris/OpenSolaris and use SMF to start
# OpenDJ. 
# OpenDJ.
# Check --exec. If not present, start OpenDJ from SMF
if test -f "${INSTALL_ROOT}/lib/_svc-opendj.sh"
then
@@ -176,7 +176,7 @@
    fi
  else
    echo "ERROR:  Unable to find the server.pid file to determine the process"
    echo "        ID of the OpenDS process to terminate."
    echo "        ID of the OpenDJ process to terminate."
    exit 1
  fi
fi
@@ -190,7 +190,7 @@
    rm "${INSTANCE_ROOT}/logs/server.pid"
  fi
fi
  

# Now if the user wants to restart the server, try to restart it if the server
# is stopped.
if test ${MUST_START_USING_SYSTEM_CALL} -eq 0

 opends/resource/dsml/webapp/web.xml

@@ -5,13 +5,13 @@
         version="2.4">

  <context-param>
    <description>The hostname or IP address of the OpenDS server; e.g., localhost</description>
    <description>The hostname or IP address of the OpenDJ server; e.g., localhost</description>
    <param-name>ldap.host</param-name>
    <param-value>localhost</param-value>
  </context-param>

  <context-param>
    <description>The port number of the OpenDS server; e.g., 389</description>
    <description>The port number of the OpenDJ server; e.g., 389</description>
    <param-name>ldap.port</param-name>
    <param-value>389</param-value>
  </context-param>

 opends/resource/install.html

@@ -30,15 +30,15 @@
<br>

<h2>How To Install OpenDJ</h2>
<p>If you are reading this page, you have already downloaded and unzipped 
<p>If you are reading this page, you have already downloaded and unzipped
an OpenDJ build.
<p>You can install OpenDJ in two modes:
<ul>
  <li><b>Graphical User Interface (GUI) mode</b>. The GUI mode uses
QuickSetup, a Java-based graphical tool that enables you to install and configure an 
QuickSetup, a Java-based graphical tool that enables you to install and configure an
OpenDJ directory server, load it with data and get it running in very little time.
  </li>
  <li><b>Interactive Command-line mode</b>. The interactive command-line utility 
  <li><b>Interactive Command-line mode</b>. The interactive command-line utility
  prompts you for required information before the installation and configuration begin.
  </li>
</ul>
@@ -48,16 +48,16 @@
It is recommended that your system have at least 100MB of disk space and
256MB of free memory to run OpenDJ for evaluation purposes. Note that
you can configure OpenDJ in such a way that it requires substantially
less, or more, disk space. For more information, see the 
<a href="https://www.opends.org/wiki/page/OpenDSSystemRequirements">OpenDS System Requirements</a>.
less, or more, disk space. For more information, see the
<a href="http://opendj.forgerock.org/doc/install-guide/OpenDJ-Install-Guide/chap-before-you-install.html">OpenDJ System Requirements</a>.

<h3>To Install OpenDJ in GUI mode</h3>
You can run QuickSetup remotely via Java Web Start, or locally from within the 
You can run QuickSetup remotely via Java Web Start, or locally from within the
build that you have downloaded and unzipped.
<p>If you run QuickSetup remotely, it automatically downloads and
unzips the latest weekly build, and handles server configuration. 
unzips the latest weekly build, and handles server configuration.

<a class="external" href="http://www.forgerock.org/downloads/opendj/2.4.0/install/QuickSetup.jnlp">Launch QuickSetup via Java Web Start</a><img class="outlink" src="Install_files/out.png" alt="">.
<a class="external" href="http://www.forgerock.org/downloads/opendj/2.4.4/install/QuickSetup.jnlp">Launch QuickSetup via Java Web Start</a><img class="outlink" src="Install_files/out.png" alt="">.
</p>
<p>To run QuickSetup locally:
</p>
@@ -68,9 +68,9 @@
(Windows)     setup.bat
  </span>
  </li>
  <li>On Mac systems, double-click on the QuickSetup.app application to launch 
  <li>On Mac systems, double-click on the QuickSetup.app application to launch
      QuickSetup directly from the Finder.<br><br>
  </li> 
  </li>
  <li>Answer the questions in the installation wizard.
  </li>
</ol>
@@ -90,12 +90,12 @@

<h3>See Also</h3>
<ul>
  <li><a href="https://www.opends.org/wiki/page/InstallingTheOpenDSDirectoryServer">Installing the OpenDS Directory Server</a>
  <li><a href="http://opendj.forgerock.org/doc/install-guide/OpenDJ-Install-Guide.html">Installing the OpenDJ directory server</a>
  <br>
  <li> <a href="https://www.opends.org/wiki/page/OverviewOfTheQuickSetupTool">Overview of the QuickSetup Tool</a>
  <li> <a href="http://opendj.forgerock.org/doc/install-guide/OpenDJ-Install-Guide/chap-install-gui.html">Installing OpenDJ with the QuickSetup Wizard</a>
  <br>
  </li>
  <li> <a href="https://www.opends.org/wiki/page/Setup">setup</a>
  <li> <a href="http://opendj.forgerock.org/doc/install-guide/OpenDJ-Install-Guide/chap-install-cli.html">Installing OpenDJ from the Command Line</a>
  </li>
</ul>
</body>

 opends/resource/install.txt

@@ -5,34 +5,34 @@

You can install OpenDJ in two modes:

 * Graphical User Interface (GUI) mode. The GUI mode uses QuickSetup, a Java-based graphical tool 
 * Graphical User Interface (GUI) mode. The GUI mode uses QuickSetup, a Java-based graphical tool
   that enables you to install and configure an OpenDJ directory server, load it with data and get
   it running in very little time.
 * Interactive Command-line mode. The interactive command-line utility prompts you for required 
 * Interactive Command-line mode. The interactive command-line utility prompts you for required
   information before the installation and configuration begin.

Before You Install
------------------
A Java SE 6.0 (version 1.6.0_10) or higher runtime environment must be installed. It is 
recommended that your system have at least 100MB of disk space and 256MB of free memory to run 
A Java SE 6.0 (version 1.6.0_10) or higher runtime environment must be installed. It is
recommended that your system have at least 100MB of disk space and 256MB of free memory to run
OpenDJ for evaluation purposes. Note that you can configure OpenDJ in such a way that it requires
substantially less, or more, disk space. For more information, see the OpenDS System Requirements
at https://www.opends.org/wiki/page/OpenDSSystemRequirements.
substantially less, or more, disk space. For more information, see the OpenDJ System Requirements
at http://opendj.forgerock.org/doc/install-guide/OpenDJ-Install-Guide/chap-before-you-install.html.

To Install OpenDJ in GUI mode
-----------------------------
You can run QuickSetup remotely via Java Web Start, or locally from within the build that you 
You can run QuickSetup remotely via Java Web Start, or locally from within the build that you
have downloaded and unzipped.

If you run QuickSetup remotely, it automatically downloads and unzips the latest weekly build, 
and handles server configuration. To launch QuickSetup via Java Web Start, point your 
browser to http://www.forgerock.org/downloads/opendj/2.4.0/install/QuickSetup.jnlp.
If you run QuickSetup remotely, it automatically downloads and unzips the latest weekly build,
and handles server configuration. To launch QuickSetup via Java Web Start, point your
browser to http://www.forgerock.org/downloads/opendj/2.4.4/install/QuickSetup.jnlp.

To run QuickSetup locally:

  1. From the top level of your installation directory, type the following command: 
  1. From the top level of your installation directory, type the following command:
     (Unix, Linux) setup (Windows) setup.bat
  2. On Mac systems, double-click on the QuickSetup.app application to launch QuickSetup 
  2. On Mac systems, double-click on the QuickSetup.app application to launch QuickSetup
     directly from the Finder.
  3. Answer the questions in the installation wizard.

@@ -44,8 +44,10 @@

See Also
--------
 * Installing the OpenDS Directory Server 
   (https://www.opends.org/wiki/page/InstallingTheOpenDSDirectoryServer)
 * Overview of the QuickSetup Tool (https://www.opends.org/wiki/page/OverviewOfTheQuickSetupTool)
 * setup (https://www.opends.org/wiki/page/Setup)
 * Installing the OpenDJ directory server
  (http://opendj.forgerock.org/doc/install-guide/OpenDJ-Install-Guide.html)
 * Installing OpenDJ with the QuickSetup Wizard
  (http://opendj.forgerock.org/doc/install-guide/OpenDJ-Install-Guide/chap-install-gui.html)
 * Installing OpenDJ from the Command Line
  (http://opendj.forgerock.org/doc/install-guide/OpenDJ-Install-Guide/chap-install-cli.html)


 opends/resource/man/man1/backup.1

New file
@@ -0,0 +1,302 @@
'\" t
.\"     Title: backup
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "BACKUP" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
backup \- back up OpenDJ directory data
.SH "SYNOPSIS"
.HP \w'\fBbackup\fR\ 'u
\fBbackup\fR {options}
.SH "DESCRIPTION"
.PP
This utility can be used to back up one or more directory server backends\&.
.SH "OPTIONS"
.PP
The following options are supported\&.
.PP
\fB\-a, \-\-backUpAll\fR
.RS 4
Back up all backends in the server
.RE
.PP
\fB\-A, \-\-hash\fR
.RS 4
Generate a hash of the backup contents
.RE
.PP
\fB\-B, \-\-incrementalBaseID {backupID}\fR
.RS 4
Backup ID of the source archive for an incremental backup\&.
.RE
.PP
\fB\-c, \-\-compress\fR
.RS 4
Compress the backup content
.RE
.PP
\fB\-d, \-\-backupDirectory {backupDir}\fR
.RS 4
Path to the target directory for the backup file(s)
.RE
.PP
\fB\-i, \-\-incremental\fR
.RS 4
Perform an incremental backup rather than a full backup
.RE
.PP
\fB\-I, \-\-backupID {backupID}\fR
.RS 4
Use the provided identifier for the backup
.RE
.PP
\fB\-n, \-\-backendID {backendName}\fR
.RS 4
Backend ID for the backend to archive
.RE
.PP
\fB\-s, \-\-signHash\fR
.RS 4
Sign the hash of the backup contents
.RE
.PP
\fB\-y, \-\-encrypt\fR
.RS 4
Encrypt the backup contents
.RE
.SS "Task Backend Connection Options"
.PP
\fB\-\-connectTimeout {timeout}\fR
.RS 4
Maximum length of time (in milliseconds) that can be taken to establish a connection\&. Use \*(Aq0\*(Aq to specify no time out\&.
.sp
Default value: 30000
.RE
.PP
\fB\-D, \-\-bindDN {bindDN}\fR
.RS 4
DN to use to bind to the server
.sp
Default value: cn=Directory Manager
.RE
.PP
\fB\-h, \-\-hostname {host}\fR
.RS 4
Directory server hostname or IP address
.sp
Default value: localhost\&.localdomain
.RE
.PP
\fB\-j, \-\-bindPasswordFile {bindPasswordFile}\fR
.RS 4
Bind password file
.RE
.PP
\fB\-K, \-\-keyStorePath {keyStorePath}\fR
.RS 4
Certificate key store path
.RE
.PP
\fB\-N, \-\-certNickname {nickname}\fR
.RS 4
Nickname of certificate for SSL client authentication
.RE
.PP
\fB\-o, \-\-saslOption {name=value}\fR
.RS 4
SASL bind options
.RE
.PP
\fB\-p, \-\-port {port}\fR
.RS 4
Directory server administration port number
.sp
Default value: 4444
.RE
.PP
\fB\-P, \-\-trustStorePath {trustStorePath}\fR
.RS 4
Certificate trust store path
.RE
.PP
\fB\-T, \-\-trustStorePassword {trustStorePassword}\fR
.RS 4
Certificate trust store PIN
.RE
.PP
\fB\-u, \-\-keyStorePasswordFile {keyStorePasswordFile}\fR
.RS 4
Certificate key store PIN file
.RE
.PP
\fB\-U, \-\-trustStorePasswordFile {path}\fR
.RS 4
Certificate trust store PIN file
.RE
.PP
\fB\-w, \-\-bindPassword {bindPassword}\fR
.RS 4
Password to use to bind to the server
.RE
.PP
\fB\-W, \-\-keyStorePassword {keyStorePassword}\fR
.RS 4
Certificate key store PIN
.RE
.PP
\fB\-X, \-\-trustAll\fR
.RS 4
Trust all server SSL certificates
.RE
.SS "Task Scheduling Options"
.PP
\fB\-\-completionNotify {emailAddress}\fR
.RS 4
Email address of a recipient to be notified when the task completes\&. This option may be specified more than once\&.
.RE
.PP
\fB\-\-dependency {taskID}\fR
.RS 4
ID of a task upon which this task depends\&. A task will not start execution until all its dependencies have completed execution\&.
.RE
.PP
\fB\-\-errorNotify {emailAddress}\fR
.RS 4
Email address of a recipient to be notified if an error occurs when this task executes\&. This option may be specified more than once\&.
.RE
.PP
\fB\-\-failedDependencyAction {action}\fR
.RS 4
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\&.
.RE
.PP
\fB\-\-recurringTask {schedulePattern}\fR
.RS 4
Indicates the task is recurring and will be scheduled according to the value argument expressed in crontab(5) compatible time/date pattern\&.
.RE
.PP
\fB\-t, \-\-start {startTime}\fR
.RS 4
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 \*(Aq0\*(Aq 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\&.
.RE
.SS "Utility Input/Output Options"
.PP
\fB\-\-noPropertiesFile\fR
.RS 4
No properties file will be used to get default command line argument values
.RE
.PP
\fB\-\-propertiesFilePath {propertiesFilePath}\fR
.RS 4
Path to the file containing default property values used for command line arguments
.RE
.SS "General Options"
.PP
\fB\-V, \-\-version\fR
.RS 4
Display version information
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information
.RE
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
1
.RS 4
An error occurred while parsing the command\-line arguments\&.
.RE
.SH "EXAMPLES"
.PP
The following example backs up all user data on the server\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ backup \-p 5444 \-D "cn=Directory Manager" \-w password
 \-a \-d /path/to/OpenDJ/bak \-t 0
Backup task 20110613143801866 scheduled to start Jun 13, 2011 2:38:01 PM CEST
.fi
.if n \{\
.RE
.\}
.PP
The following example schedules back up of all user data every night at 2 AM, and notifies diradmin@example\&.com when finished, or on error\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ backup \-p 5444 \-D "cn=Directory Manager" \-w password \-a
 \-d /path/to/OpenDJ/bak \-\-recurringTask "00 02 * * *"
 \-\-completionNotify diradmin@example\&.com \-\-errorNotify diradmin@example\&.com
Recurring Backup task BackupTask\-988d6adf\-4d65\-44bf\-8546\-6ea74a2480b0
scheduled successfully
.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp

 opends/resource/man/man1/base64.1

New file
@@ -0,0 +1,130 @@
'\" t
.\"     Title: base64
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "BASE64" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
base64 \- encode and decode base64 strings
.SH "SYNOPSIS"
.HP \w'\fBbase64\fR\fB\fIsubcommand\fR\fR\ 'u
\fBbase64\fR\fB\fIsubcommand\fR\fR {options}
.SH "DESCRIPTION"
.PP
This utility can be used to encode and decode information using base64\&.
.SH "SUBCOMMANDS"
.PP
The following subcommands are supported\&.
.PP
\fBbase64 decode\fR
.RS 4
Decode base64\-encoded information into raw data
.RE
.PP
\fBbase64 encode\fR
.RS 4
Encode raw data using base64
.RE
.SH "GENERAL OPTIONS"
.PP
\fB\-V, \-\-version\fR
.RS 4
Display version information
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information
.RE
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
> 0
.RS 4
An error occurred\&.
.RE
.SH "EXAMPLES"
.PP
The following command shows the changes from the external change log in human\-readable format\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ base64 decode \-d YWRkOiBkZXNjcmlwdGlvbgpkZXNjcmlwdGlvbjogQSB0aGlyZCBjaGFuZ2UK
LQpyZXBsYWNlOiBtb2RpZmllcnNOYW1lCm1vZGlmaWVyc05hbWU6IGNuPURpcmVjdG9yeSBNYW5hZ2V
yLGNuPVJvb3QgRE5zLGNuPWNvbmZpZwotCnJlcGxhY2U6IG1vZGlmeVRpbWVzdGFtcAptb2RpZnlUaW
1lc3RhbXA6IDIwMTEwNjEzMDcxMjEwWgotCg==
add: description
description: A third change
\-
replace: modifiersName
modifiersName: cn=Directory Manager,cn=Root DNs,cn=config
\-
replace: modifyTimestamp
modifyTimestamp: 20110613071210Z
\-
.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp

 opends/resource/man/man1/configure.1

@@ -1,9 +1,34 @@
'\" te
.\" Copyright (c) 2008, Sun Microsystems Inc. All
.\" Rights Reserved.
.TH configure 1 "December 2008" "1.1" "User Commands"
'\" t
.\"     Title: setup
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "configure" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH NAME
configure \- sets the instance location of an OpenDS package installation
configure \- sets the instance location of an OpenDJ package installation
.SH SYNOPSIS
.LP
.nf
@@ -13,7 +38,7 @@
.SH DESCRIPTION
.sp
.LP
The \fBconfigure\fR command configures an OpenDS package installation. The command registers the directory server as an SMF service,  specifies where the directory server instance will be located, and specifies  the user and group names of the instance owner.
The \fBconfigure\fR command configures an OpenDJ package installation. The command registers the directory server as an SMF service,  specifies where the directory server instance will be located, and specifies  the user and group names of the instance owner.
.sp
.LP
This command is available in the OpenSolaris\u\s-2TM\s+2\d package installation only.
@@ -31,7 +56,7 @@
\fB\fB-?\fR, \fB-H\fR, \fB--help\fR\fR
.ad
.RS 25n
.rt  
.rt
Displays usage information.
.RE

@@ -42,7 +67,7 @@
\fB\fB--groupName\fR \fIgroupName\fR\fR
.ad
.RS 25n
.rt  
.rt
The group name of the instance owner. If no group name is specified, the primary group of the \fIuserName\fR is used.
.RE

@@ -53,8 +78,8 @@
\fB\fB--instancePath\fR \fIpath\fR\fR
.ad
.RS 25n
.rt  
The path where the instance will be located. If no path is specified, the default \fB/var/opends\fR is used.
.rt
The path where the instance will be located. If no path is specified, the default \fB/var/opendj\fR is used.
.RE

.sp
@@ -64,7 +89,7 @@
\fB\fB--userName\fR \fIuserName\fR\fR
.ad
.RS 25n
.rt  
.rt
The user name of the instance owner. If no user name is specified, the default \fBldap\fR is used.
.RE

@@ -75,7 +100,7 @@
\fB\fB-V\fR, \fB--version\fR\fR
.ad
.RS 25n
.rt  
.rt
Displays directory server version information.
.RE

@@ -89,7 +114,7 @@
.sp
.in +2
.nf
$ /usr/opends/configure --instancePath /var/opends --userName myUser \
$ /usr/opendj/configure --instancePath /var/opendj --userName myUser \
  --groupName myGroup
.fi
.in -2
@@ -97,8 +122,6 @@

.sp
.LP
For more information, see "Running OpenDS as a Non-Root User" at http://docs.opends.org/1.2/page/RunningTheServerAsANonRootUser

.SH ATTRIBUTES
.sp
.LP
@@ -108,8 +131,8 @@
.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
cw(2.75i) |cw(2.75i)
lw(2.75i) |lw(2.75i)
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_

 opends/resource/man/man1/control-panel.1

@@ -1,67 +1,157 @@
'\" te
.\" Copyright (c) 2008, Sun Microsystems Inc. All
.\" Rights Reserved.
.TH control-panel 1 "December 2008" "1.1" "User Commands"
.SH NAME
control-panel \- launches a graphical user interface
that displays server status information and enables you to perform basic directory
server administration
.SH SYNOPSIS
.LP
'\" t
.\"     Title: control-panel
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "CONTROL\-PANEL" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
control-panel \- start the OpenDJ graphical admin interface
.SH "SYNOPSIS"
.HP \w'\fBcontrol\-panel\fR\ 'u
\fBcontrol\-panel\fR {options}
.SH "DESCRIPTION"
.PP
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\&.
.SH "OPTIONS"
.PP
The following options are supported\&.
.PP
\fB\-r, \-\-remote\fR
.RS 4
Connect to a remote server
.RE
.SS "LDAP Connection Options"
.PP
\fB\-\-connectTimeout {timeout}\fR
.RS 4
Maximum length of time (in milliseconds) that can be taken to establish a connection\&. Use \*(Aq0\*(Aq to specify no time out\&.
.sp
Default value: 30000
.RE
.PP
\fB\-D, \-\-bindDN {bindDN}\fR
.RS 4
DN to use to bind to the server
.sp
Default value: cn=Directory Manager
.RE
.PP
\fB\-h, \-\-hostname {host}\fR
.RS 4
Directory server hostname or IP address
.sp
Default value: localhost\&.localdomain
.RE
.PP
\fB\-j, \-\-adminPasswordFile {bindPasswordFile}\fR
.RS 4
Global administrator password file
.RE
.PP
\fB\-p, \-\-port {port}\fR
.RS 4
Directory server administration port number
.sp
Default value: 4444
.RE
.PP
\fB\-w, \-\-adminPassword {bindPassword}\fR
.RS 4
Password for the global administrator
.RE
.PP
\fB\-X, \-\-trustAll\fR
.RS 4
Trust all server SSL certificates
.RE
.SS "General Options"
.PP
\fB\-\-version\fR
.RS 4
Display version information
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information
.RE
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
> 0
.RS 4
An error occurred\&.
.RE
.SH "EXAMPLES"
.PP
The following example starts the Control Panel on a remote host\&.
.sp
.if n \{\
.RS 4
.\}
.nf
\fBcontrol-panel\fR \fIoptions\fR
$ control\-panel \-r \-h opendj\&.example\&.com \-p 4444 &
.fi

.SH DESCRIPTION
.sp
.LP
The \fBcontrol-panel\fR command launches a graphical user
interface that displays server status information and enables you to perform
basic directory server administration. The control panel enables you to perform
certain data management tasks such as managing entries, importing and exporting
data, and backing up and restoring data. The control panel also enables you
to manage directory schema and indexes, and to set server runtime options.
.SH OPTIONS
.sp
.LP
The following options are supported:
.sp
.ne 2
.mk
.na
\fB\fB-V\fR, \fB--version\fR\fR
.ad
.RS 18n
.rt  
Display Directory Server version information.
.if n \{\
.RE

.sp
.ne 2
.mk
.na
\fB\fB-?\fR, \fB-H\fR, \fB--help\fR\fR
.ad
.RS 18n
.rt  
Displays usage information.
.\}
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE

.SH ATTRIBUTES
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.LP
See \fBattributes\fR(5) for
descriptions of the following attributes:
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityUncommitted
.TE


 opends/resource/man/man1/create-rc-script.1

New file
@@ -0,0 +1,129 @@
'\" t
.\"     Title: create-rc-script
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "CREATE\-RC\-SCRIPT" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
create-rc-script \- script to manage OpenDJ as a service on UNIX
.SH "SYNOPSIS"
.HP \w'\fBcreate\-rc\-script\fR\ 'u
\fBcreate\-rc\-script\fR {options}
.SH "DESCRIPTION"
.PP
Create an RC script that may be used to start, stop, and restart the directory server on UNIX\-based systems\&.
.SH "OPTIONS"
.PP
The following options are supported\&.
.PP
\fB\-f, \-\-outputFile {path}\fR
.RS 4
The path to the output file to create\&.
.RE
.PP
\fB\-j, \-\-javaHome {path}\fR
.RS 4
The path to the Java installation that should be used to run the server\&.
.RE
.PP
\fB\-J, \-\-javaArgs {args}\fR
.RS 4
A set of arguments that should be passed to the JVM when running the server\&.
.RE
.PP
\fB\-u, \-\-userName {userName}\fR
.RS 4
The name of the user account under which the server should run\&.
.RE
.SS "General Options"
.PP
\fB\-\-version\fR
.RS 4
Display version information
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information
.RE
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
> 0
.RS 4
An error occurred\&.
.RE
.SH "EXAMPLES"
.PP
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\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ sudo create\-rc\-script \-f /etc/init\&.d/opendj \-u mark
$ sudo update\-rc\&.d opendj
.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp

 opends/resource/man/man1/dbtest.1

New file
@@ -0,0 +1,153 @@
'\" t
.\"     Title: dbtest
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "DBTEST" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
dbtest \- gather OpenDJ JE database debugging information
.SH "SYNOPSIS"
.HP \w'\fBdbtest\fR\fBsubcommand\fR\ 'u
\fBdbtest\fR\fBsubcommand\fR [options]
.SH "DESCRIPTION"
.PP
This utility can be used to debug the JE database\&.
.SH "SUBCOMMANDS"
.PP
The following subcommands are supported\&.
.PP
\fBdbtest dump\-database\-container\fR
.RS 4
Dump records from a database container
.RE
.PP
\fBdbtest list\-database\-containers\fR
.RS 4
List the database containers for an entry container
.RE
.PP
\fBdbtest list\-entry\-containers\fR
.RS 4
List the entry containers for a root container
.RE
.PP
\fBdbtest list\-index\-status\fR
.RS 4
List the status of indexes in an entry container
.RE
.PP
\fBdbtest list\-root\-containers\fR
.RS 4
List the root containers used by all JE backends
.RE
.SH "OPTIONS"
.PP
The following global options are supported\&.
.PP
For other options, see
\fBdbtest \fR\fB\fIsubcommand\fR\fR\fB \-\-help\fR\&.
.PP
\fB\-\-version\fR
.RS 4
Display version information
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information
.RE
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
> 0
.RS 4
An error occurred\&.
.RE
.SH "EXAMPLES"
.PP
The following example displays debugging information about the equality index for
sudoUser\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ dbtest dump\-database\-container \-n userRoot \-b dc=example,dc=com
 \-d sudoUser\&.equality
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
.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp

 opends/resource/man/man1/dsconfig.1

@@ -1,48 +1,526 @@
'\" te
.\" Copyright (c) 2008, Sun Microsystems Inc. All
.\" Rights Reserved.
.TH dsconfig 1 "December 2008" "1.1" "User Commands"
.SH NAME
dsconfig \- configures a directory server instance
.SH SYNOPSIS
.LP
'\" t
.\"     Title: dsconfig
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "DSCONFIG" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
dsconfig \- manage OpenDJ directory server configuration
.SH "SYNOPSIS"
.HP \w'\fBdsconfig\ [\fR\fB\fIsubcommand\fR\fR\fB]\fR\ 'u
\fBdsconfig [\fR\fB\fIsubcommand\fR\fR\fB]\fR [options]
.SH "DESCRIPTION"
.PP
This utility serves to configure a running directory server\&.
.PP
The
\fBdsconfig\fR
command is the primary command\-line tool for viewing and editing OpenDJ configuration\&. When started without arguments,
\fBdsconfig\fR
prompts you for administration connection information, including the host name, administration port number, administrator bind DN and administrator password\&. The
\fBdsconfig\fR
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\&.
.PP
When you pass connection information, subcommands, and additional options to
\fBdsconfig\fR, 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
\fB\-\-no\-prompt\fR
and
\fB\-\-trustAll\fR
options, respectively)\&.
.PP
You can prepare
\fBdsconfig\fR
batch scripts by running the tool with the
\fB\-\-commandFilePath\fR
option in interactive mode, then reading from the batch file with the
\fB\-\-batchFile\fR
option in script mode\&. Batch files can be useful when you have many
\fBdsconfig\fR
commands to run and want to avoid starting the JVM and setting up a new connection for each command\&.
.PP
The
\fBdsconfig\fR
command categorizes directory server configuration into
components, also called
managed objects\&. 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\&.
.PP
Configuration components have
properties\&. For example, the LDAP Connection Handler component has properties such as
listen\-port
and
allow\-start\-tls\&. You can set the component\*(Aqs
listen\-port
property to
389
to use the default LDAP port number\&. You can set the component\*(Aqs
allow\-start\-tls
property to
true
to permit LDAP client applications to use StartTLS\&. Much of the configuration you do with
\fBdsconfig\fR
involves setting component properties\&. The
OpenDJ Configuration Reference
covers all
\fBdsconfig\fR
component properties in detail, drawing on the documentation you also view when getting help through the
\fBdsconfig\fR
command\&.
.SH "GETTING HELP"
.PP
The
\fBdsconfig\fR
command provides many subcommands\&. Use the following options to view help for subcommands\&.
.PP
See
dsconfig Subcommands
for details of individual subcommands\&.
.PP
\fBdsconfig \-\-help\-all\fR
.RS 4
Display all subcommands
.RE
.PP
\fBdsconfig \-\-help\-core\-server\fR
.RS 4
Display subcommands relating to core server
.RE
.PP
\fBdsconfig \-\-help\-database\fR
.RS 4
Display subcommands relating to caching and back\-ends
.RE
.PP
\fBdsconfig \-\-help\-logging\fR
.RS 4
Display subcommands relating to logging
.RE
.PP
\fBdsconfig \-\-help\-replication\fR
.RS 4
Display subcommands relating to replication
.RE
.PP
\fBdsconfig \-\-help\-security\fR
.RS 4
Display subcommands relating to authentication and authorization
.RE
.PP
\fBdsconfig \-\-help\-user\-management\fR
.RS 4
Display subcommands relating to user management
.RE
.PP
For help with individual subcommands, either use
\fBdsconfig \fR\fB\fIsubcommand\fR\fR\fB \-\-help\fR, or start
\fBdsconfig\fR
in interactive mode, without specifying a subcommand\&.
.PP
To view component properties, use the
\fBdsconfig list\-properties\fR
command\&.
.SH "GENERALLY APPLICABLE OPTIONS"
.PP
The following options are supported for all
\fBdsconfig\fR
subcommands\&.
.PP
\fB\-\-advanced\fR
.RS 4
Allows the configuration of advanced components and properties
.RE
.SS "LDAP Connection Options"
.PP
\fB\-\-connectTimeout {timeout}\fR
.RS 4
Maximum length of time (in milliseconds) that can be taken to establish a connection\&. Use \*(Aq0\*(Aq to specify no time out\&.
.sp
Default value: 30000
.RE
.PP
\fB\-h, \-\-hostname {host}\fR
.RS 4
Directory server hostname or IP address
.sp
Default value: localhost\&.localdomain
.RE
.PP
\fB\-I, \-\-adminUID {adminUID}\fR
.RS 4
User ID of the global administrator to use to bind to the server\&. For the
\fBenable\fR
subcommand, if no global administrator was defined previously for any servers, the global administrator will be created using the UID provided\&.
.sp
Default value: admin
.RE
.PP
\fB\-j, \-\-adminPasswordFile {bindPasswordFile}\fR
.RS 4
Global administrator password file
.RE
.PP
\fB\-K, \-\-keyStorePath {keyStorePath}\fR
.RS 4
Certificate key store path
.RE
.PP
\fB\-N, \-\-certNickname {nickname}\fR
.RS 4
Nickname of certificate for SSL client authentication
.RE
.PP
\fB\-o, \-\-saslOption {name=value}\fR
.RS 4
SASL bind options
.RE
.PP
\fB\-p, \-\-port {port}\fR
.RS 4
Directory server administration port number
.sp
Default value: 4444
.RE
.PP
\fB\-P, \-\-trustStorePath {trustStorePath}\fR
.RS 4
Certificate trust store path
.sp
Default value: /path/to/OpenDJ/config/admin\-truststore
.RE
.PP
\fB\-T, \-\-trustStorePassword {trustStorePassword}\fR
.RS 4
Certificate trust store PIN
.RE
.PP
\fB\-u, \-\-keyStorePasswordFile {keyStorePasswordFile}\fR
.RS 4
Certificate key store PIN file
.RE
.PP
\fB\-U, \-\-trustStorePasswordFile {path}\fR
.RS 4
Certificate trust store PIN file
.RE
.PP
\fB\-w, \-\-adminPassword {bindPassword}\fR
.RS 4
Password for the global administrator
.RE
.PP
\fB\-W, \-\-keyStorePassword {keyStorePassword}\fR
.RS 4
Certificate key store PIN
.RE
.PP
\fB\-X, \-\-trustAll\fR
.RS 4
Trust all server SSL certificates
.RE
.SS "Utility Input/Output Options"
.PP
\fB\-\-commandFilePath {path}\fR
.RS 4
The full path to the file where the equivalent non\-interactive commands will be written when this command is run in interactive mode\&.
.RE
.PP
\fB\-\-displayCommand\fR
.RS 4
Display the equivalent non\-interactive option on standard output when this command is run in interactive mode\&.
.RE
.PP
\fB\-F, \-\-batchFilePath {batchFilePath}\fR
.RS 4
Path to a batch file containing a set of dsconfig commands to be executed
.RE
.PP
\fB\-n, \-\-no\-prompt\fR
.RS 4
Use non\-interactive mode\&. If data in the command is missing, the user is not prompted and the command exits with an error\&.
.RE
.PP
\fB\-\-noPropertiesFile\fR
.RS 4
No properties file will be used to get default command line argument values
.RE
.PP
\fB\-\-propertiesFilePath {propertiesFilePath}\fR
.RS 4
Path to the file containing default property values used for command line arguments
.RE
.PP
\fB\-Q, \-\-quiet\fR
.RS 4
Do not write progress information to standard output
.RE
.PP
\fB\-s, \-\-script\-friendly\fR
.RS 4
Use script\-friendly mode
.RE
.PP
\fB\-v, \-\-verbose\fR
.RS 4
Use verbose mode
.RE
.SS "General Options"
.PP
\fB\-\-version\fR
.RS 4
Display version information
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information
.RE
.SH "DSCONFIG SUBCOMMANDS"
.PP
This section covers individual
\fBdsconfig\fR
subcommands\&.
.PP
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\&.
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
create\-\fIcomponent\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
list\-\fIcomponent\fRs
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
delete\-\fIcomponent\fR
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
get\-\fIcomponent\fR\-prop
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
set\-\fIcomponent\fR\-prop
.RE
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
> 0
.RS 4
An error occurred\&.
.RE
.SH "EXAMPLES"
.PP
Much of the
OpenDJ Administration Guide
consists of
\fBdsconfig\fR
examples with text in between\&. This section therefore remains short\&.
.PP
The following example starts
\fBdsconfig\fR
in interactive, menu\-driven mode on the default port of the current host\&.
.sp
.if n \{\
.RS 4
.\}
.nf
\fBdsconfig\fR \fIsubcommand\fR \fIoptions\fR
$ dsconfig \-h `hostname` \-p 4444 \-D "cn=Directory Manager" \-w password

>>>> OpenDJ configuration console main menu

What do you want to configure?

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

    q)   quit

Enter choice: 
.fi
.if n \{\
.RE
.\}
.PP
The following examples demonstrates generating a batch file that corresponds to an interactive session enabling the debug log\&. The example then demonstates using a modified batch file to disable the debug log\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ dsconfig
 \-\-hostname `hostname`
 \-\-port 4444
 \-\-bindDN "cn=Directory Manager"
 \-\-bindPassword password
 \-\-commandFilePath ~/enable\-debug\-log\&.batch
 \&.\&.\&.
$ cat ~/enable\-debug\-log\&.batch
# dsconfig session start date: 19/Oct/2011:08:52:22 +0000

.SH DESCRIPTION
.sp
.LP
The \fBdsconfig\fR command enables you to create, manage,
and remove the base configuration for a directory server instance. The directory
server configuration is organized as a set of components that \fBdsconfig\fR can
access by using one or more subcommands. All components have zero or more
configurable properties. These properties can be queried and modified to change
the behavior of the component.
.sp
.LP
Unless you specify all configuration parameters and the \fB-n\fR (\fB--no-prompt\fR) option, \fBdsconfig\fR runs in interactive
mode. Interactive mode works much like a wizard, walking you through every
aspect of the server configuration.
.sp
.LP
Run \fBdsconfig --help\fR for more information,
or use the dsconfig online documentation at http://docs.opends.org/1.2/page/Dsconfig\&.
.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for
descriptions of the following attributes:
.sp
# Session operation number: 1
# Operation date: 19/Oct/2011:08:55:06 +0000
dsconfig set\-log\-publisher\-prop \e
          \-\-publisher\-name File\-Based\e Debug\e Logger \e
          \-\-set enabled:true \e
          \-\-hostname opendj\&.example\&.com \e
          \-\-port 4444 \e
          \-\-trustStorePath /path/to/OpenDJ/config/admin\-truststore \e
          \-\-bindDN cn=Directory\e Manager \e
          \-\-bindPassword ****** \e
          \-\-no\-prompt

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityUncommitted
.TE
$ cp ~/enable\-debug\-log\&.batch ~/disable\-debug\-log\&.batch
$ vi ~/disable\-debug\-log\&.batch
$ cat ~/disable\-debug\-log\&.batch
set\-log\-publisher\-prop \e
          \-\-publisher\-name File\-Based\e Debug\e Logger \e
          \-\-set enabled:false \e
          \-\-hostname opendj\&.example\&.com \e
          \-\-port 4444 \e
          \-\-trustStorePath /path/to/OpenDJ/config/admin\-truststore \e
          \-\-bindDN cn=Directory\e Manager \e
          \-\-bindPassword password \e
          \-\-no\-prompt

$ dsconfig \-\-batchFilePath ~/disable\-debug\-log\&.batch \-\-no\-prompt
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

$
.fi
.if n \{\
.RE
.\}
.PP
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
\fBdsconfig\fR, strip
dsconfig
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)\&.
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp

 opends/resource/man/man1/dsframework.1

New file
@@ -0,0 +1,272 @@
'\" t
.\"     Title: dsframework
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "DSFRAMEWORK" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
dsframework \- manage OpenDJ administration framework
.SH "SYNOPSIS"
.HP \w'\fBdsframework\fR\fB\fIsubcommand\fR\fR\ 'u
\fBdsframework\fR\fB\fIsubcommand\fR\fR {options}
.SH "DESCRIPTION"
.PP
This utility can be used to perform operations in the directory server administration framework\&.
.PP
This utility has no interactive mode\&. Consider using
\fB\-X\fR
if you authenticate over a secure connection protected with a self\-signed certificate\&.
.SH "SUBCOMMANDS"
.PP
The
\fBdsconfig\fR
command provides many subcommands\&. Use the following options to view help for subcommands\&.
.PP
\fB\-\-help\-all\fR
.RS 4
Display all subcommands
.RE
.PP
\fB\-\-help\-admin\-user\fR
.RS 4
Display subcommands relating to admin\-user
.RE
.PP
\fB\-\-help\-server\fR
.RS 4
Display subcommands relating to server
.RE
.PP
\fB\-\-help\-server\-group\fR
.RS 4
Display subcommands relating to server\-group
.RE
.PP
For help with individual subcommands, use
\fBdsframework \fR\fB\fIsubcommand\fR\fR\fB \-\-help\fR\&.
.SH "OPTIONS"
.PP
The following options are supported\&.
.SS "LDAP Connection Options"
.PP
\fB\-\-connectTimeout {timeout}\fR
.RS 4
Maximum length of time (in milliseconds) that can be taken to establish a connection\&. Use \*(Aq0\*(Aq to specify no time out\&.
.sp
Default value: 30000
.RE
.PP
\fB\-h, \-\-hostname {host}\fR
.RS 4
Directory server hostname or IP address
.sp
Default value: localhost\&.localdomain
.RE
.PP
\fB\-I, \-\-adminUID {adminUID}\fR
.RS 4
User ID of the global administrator to use to bind to the server\&. For the
\fBenable\fR
subcommand, if no global administrator was defined previously for any servers, the global administrator will be created using the UID provided\&.
.sp
Default value: admin
.RE
.PP
\fB\-j, \-\-adminPasswordFile {bindPasswordFile}\fR
.RS 4
Global administrator password file
.RE
.PP
\fB\-K, \-\-keyStorePath {keyStorePath}\fR
.RS 4
Certificate key store path
.RE
.PP
\fB\-N, \-\-certNickname {nickname}\fR
.RS 4
Nickname of certificate for SSL client authentication
.RE
.PP
\fB\-o, \-\-saslOption {name=value}\fR
.RS 4
SASL bind options
.RE
.PP
\fB\-p, \-\-port {port}\fR
.RS 4
Directory server administration port number
.sp
Default value: 4444
.RE
.PP
\fB\-P, \-\-trustStorePath {trustStorePath}\fR
.RS 4
Certificate trust store path
.sp
Default value: /path/to/OpenDJ/config/admin\-truststore
.RE
.PP
\fB\-T, \-\-trustStorePassword {trustStorePassword}\fR
.RS 4
Certificate trust store PIN
.RE
.PP
\fB\-u, \-\-keyStorePasswordFile {keyStorePasswordFile}\fR
.RS 4
Certificate key store PIN file
.RE
.PP
\fB\-U, \-\-trustStorePasswordFile {path}\fR
.RS 4
Certificate trust store PIN file
.RE
.PP
\fB\-w, \-\-adminPassword {bindPassword}\fR
.RS 4
Password for the global administrator
.RE
.PP
\fB\-W, \-\-keyStorePassword {keyStorePassword}\fR
.RS 4
Certificate key store PIN
.RE
.PP
\fB\-X, \-\-trustAll\fR
.RS 4
Trust all server SSL certificates
.RE
.SS "Utility Input/Output Options"
.PP
\fB\-\-noPropertiesFile\fR
.RS 4
No properties file will be used to get default command line argument values
.RE
.PP
\fB\-\-propertiesFilePath {propertiesFilePath}\fR
.RS 4
Path to the file containing default property values used for command line arguments
.RE
.PP
\fB\-v, \-\-verbose\fR
.RS 4
Use verbose mode
.RE
.SS "General Options"
.PP
\fB\-V, \-\-version\fR
.RS 4
Display version information
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information
.RE
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
> 0
.RS 4
An error occurred\&.
.RE
.SH "EXAMPLES"
.PP
This example lists server properties\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ dsframework \-p 4444 \-h `hostname` \-D "cn=Directory Manager" \-w password \-X
 list\-server\-properties
Option Types:

 r \-\- Property value(s) are readable
 w \-\- Property value(s) are writable
 m \-\- The property is mandatory
 s \-\- The property is single\-valued

Property                       Options  Syntax              Default value
\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
ldapsport                      rw\-\-     INTEGER             \-
certificate                    rw\-s     STRING              \-
hostname                       r\-ms     STRING              localhost
ldapport                       rwm\-     INTEGER             389
jmxsEnabled                    rw\-s     BOOLEAN             false
instancepath                   rw\-s     STRING              \-
ldapsEnabled                   rw\-s     BOOLEAN             false
jmxsport                       rw\-\-     INTEGER             \-
os                             rw\-s     STRING              \-
ds\-cfg\-key\-id                  rw\-s     STRING              \-
jmxport                        rw\-\-     INTEGER             \-
description                    rw\-s     STRING              \-
id                             rw\-s     STRING              \-
startTLSEnabled                rw\-s     BOOLEAN             false
jmxEnabled                     rw\-s     BOOLEAN             false
ds\-cfg\-public\-key\-certificate  rw\-s     CERTIFICATE_BINARY  \-
location                       rw\-s     STRING              \-
ldapEnabled                    rw\-s     BOOLEAN             false
.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp

 opends/resource/man/man1/dsjavaproperties.1

New file
@@ -0,0 +1,124 @@
'\" t
.\"     Title: dsjavaproperties
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "DSJAVAPROPERTIES" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
dsjavaproperties \- apply OpenDJ Java home and JVM settings
.SH "SYNOPSIS"
.HP \w'\fBdsjavaproperties\fR\ 'u
\fBdsjavaproperties\fR [options]
.SH "DESCRIPTION"
.PP
This utility can be used to change the Java arguments and Java home that are used by other server commands\&.
.PP
Before launching the command, edit the properties file located in
/path/to/OpenDJ/config/java\&.properties
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\&.
.PP
Changes apply to the current server installation\&. No modifications are made to your environment variables\&.
.SH "OPTIONS"
.PP
The following options are supported\&.
.PP
\fB\-Q, \-\-quiet\fR
.RS 4
Run the tool in quiet mode\&. Quiet mode will not output progress information to standard output\&.
.RE
.PP
\fB\-V, \-\-version\fR
.RS 4
Display version information\&.
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information\&.
.RE
.SH "FILES"
.PP
This command depends on the content of the
config/java\&.properties
file\&.
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
> 0
.RS 4
An error occurred\&.
.RE
.SH "EXAMPLES"
.sp
.if n \{\
.RS 4
.\}
.nf
$ dsjavaproperties 
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
.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp

 opends/resource/man/man1/dsreplication.1

@@ -1,540 +1,337 @@
'\" te
.\" Copyright (c) 2008, Sun Microsystems Inc. All
.\" Rights Reserved.
.TH dsreplication 1 "December 2008" "1.1" "User Commands"
.SH NAME
dsreplication \- configures replication between
directory servers so that the data of the servers is synchronized
.SH SYNOPSIS
.LP
'\" t
.\"     Title: dsreplication
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "DSREPLICATION" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
dsreplication \- manage OpenDJ directory data replication
.SH "SYNOPSIS"
.HP \w'\fBdsreplication\fR\fB\fIsubcommand\fR\fR\ 'u
\fBdsreplication\fR\fB\fIsubcommand\fR\fR [options]
.SH "DESCRIPTION"
.PP
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
\fBenable\fR
subcommand and then initialize the contents of one of the servers with the contents of the other using the
\fBinitialize\fR
subcommand\&.
.SH "SUBCOMMANDS"
.PP
The following subcommands are supported\&.
.PP
\fBdisable\fR
.RS 4
Disable replication on the specified server for the provided base DN and removes references in the other servers with which it is replicating data\&.
.RE
.PP
\fBenable\fR
.RS 4
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\&.
.RE
.PP
\fBinitialize\fR
.RS 4
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\&.
\fBinitialize\-all\fR
can also be used for this purpose\&.
.RE
.PP
\fBinitialize\-all\fR
.RS 4
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
\fBinitialize\fR
for each server to achieve the same effect\&.
.RE
.PP
\fBpost\-external\-initialization\fR
.RS 4
This subcommand must be called after initializing the contents of all the replicated servers using the
\fBimport\-ldif\fR
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
\fBpre\-external\-initialization \-\-help\fR
for more information\&.
.RE
.PP
\fBpre\-external\-initialization\fR
.RS 4
This subcommand must be called before initializing the contents of all the replicated servers using the
\fBimport\-ldif\fR
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
\fBpost\-external\-initialization\fR
subcommand\&.
.RE
.PP
\fBpurge\-historical\fR
.RS 4
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\&.
.RE
.PP
\fBstatus\fR
.RS 4
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\&.
.RE
.SH "OPTIONS"
.PP
The following options are supported\&.
.PP
\fB\-\-advanced\fR
.RS 4
Access advanced settings when running this command in interactive mode\&.
.RE
.PP
\fB\-b, \-\-baseDN {baseDN}\fR
.RS 4
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\&.
.RE
.SS "LDAP Connection Options"
.PP
\fB\-\-connectTimeout {timeout}\fR
.RS 4
Maximum length of time (in milliseconds) that can be taken to establish a connection\&. Use \*(Aq0\*(Aq to specify no time out\&.
.sp
Default value: 30000
.RE
.PP
\fB\-h, \-\-hostname {host}\fR
.RS 4
Directory server hostname or IP address
.sp
Default value: localhost\&.localdomain
.RE
.PP
\fB\-I, \-\-adminUID {adminUID}\fR
.RS 4
User ID of the global administrator to use to bind to the server\&. For the
\fBenable\fR
subcommand, if no global administrator was defined previously for any servers, the global administrator will be created using the UID provided\&.
.sp
Default value: admin
.RE
.PP
\fB\-j, \-\-adminPasswordFile {bindPasswordFile}\fR
.RS 4
Global administrator password file
.RE
.PP
\fB\-K, \-\-keyStorePath {keyStorePath}\fR
.RS 4
Certificate key store path
.RE
.PP
\fB\-N, \-\-certNickname {nickname}\fR
.RS 4
Nickname of certificate for SSL client authentication
.RE
.PP
\fB\-o, \-\-saslOption {name=value}\fR
.RS 4
SASL bind options
.RE
.PP
\fB\-p, \-\-port {port}\fR
.RS 4
Directory server administration port number
.sp
Default value: 4444
.RE
.PP
\fB\-P, \-\-trustStorePath {trustStorePath}\fR
.RS 4
Certificate trust store path
.sp
Default value: /path/to/OpenDJ/config/admin\-truststore
.RE
.PP
\fB\-T, \-\-trustStorePassword {trustStorePassword}\fR
.RS 4
Certificate trust store PIN
.RE
.PP
\fB\-u, \-\-keyStorePasswordFile {keyStorePasswordFile}\fR
.RS 4
Certificate key store PIN file
.RE
.PP
\fB\-U, \-\-trustStorePasswordFile {path}\fR
.RS 4
Certificate trust store PIN file
.RE
.PP
\fB\-w, \-\-adminPassword {bindPassword}\fR
.RS 4
Password for the global administrator
.RE
.PP
\fB\-W, \-\-keyStorePassword {keyStorePassword}\fR
.RS 4
Certificate key store PIN
.RE
.PP
\fB\-X, \-\-trustAll\fR
.RS 4
Trust all server SSL certificates
.RE
.SS "Utility Input/Output Options"
.PP
\fB\-\-commandFilePath {path}\fR
.RS 4
The full path to the file where the equivalent non\-interactive commands will be written when this command is run in interactive mode\&.
.RE
.PP
\fB\-\-displayCommand\fR
.RS 4
Display the equivalent non\-interactive option on standard output when this command is run in interactive mode\&.
.RE
.PP
\fB\-n, \-\-no\-prompt\fR
.RS 4
Use non\-interactive mode\&. If data in the command is missing, the user is not prompted and the command exits with an error\&.
.RE
.PP
\fB\-\-noPropertiesFile\fR
.RS 4
No properties file will be used to get default command line argument values
.RE
.PP
\fB\-\-propertiesFilePath {propertiesFilePath}\fR
.RS 4
Path to the file containing default property values used for command line arguments
.RE
.PP
\fB\-Q, \-\-quiet\fR
.RS 4
Do not write progress information to standard output
.RE
.SS "General Options"
.PP
\fB\-\-version\fR
.RS 4
Display version information
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information
.RE
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
> 0
.RS 4
An error occurred\&.
.RE
.SH "EXAMPLES"
.PP
The following example enables and then initializes replication for a new replica whose admin port is 5444 from an existing replica whose admin port is 4444\&.
.sp
.if n \{\
.RS 4
.\}
.nf
\fBdsreplication\fR \fIsubcommand\fR \fIoptions\fR
$ dsreplication enable \-I admin \-w password \-X \-n \-b dc=example,dc=com
 \-\-host1 `hostname` \-\-port1 4444 \-\-bindDN1 "cn=Directory Manager"
 \-\-bindPassword1 password \-\-replicationPort1 8989
 \-\-host2 `hostname` \-\-port2 5444 \-\-bindDN2 "cn=Directory Manager"
 \-\-bindPassword2 password \-\-replicationPort2 9989

Establishing connections \&.\&.\&.\&.\&. Done\&.
Checking registration information \&.\&.\&.\&.\&. Done\&.
Updating remote references on server localhost:4444 \&.\&.\&.\&.\&. Done\&.
Configuring Replication port on server localhost:5444 \&.\&.\&.\&.\&. Done\&.
Updating replication configuration for baseDN dc=example,dc=com on server
 localhost:4444 \&.\&.\&.\&.\&. Done\&.
Updating replication configuration for baseDN dc=example,dc=com on server
 localhost:5444 \&.\&.\&.\&.\&. Done\&.
Updating registration configuration on server localhost:4444 \&.\&.\&.\&.\&. Done\&.
Updating registration configuration on server localhost:5444 \&.\&.\&.\&.\&. Done\&.
Updating replication configuration for baseDN cn=schema on server
 localhost:4444 \&.\&.\&.\&.\&. Done\&.
Updating replication configuration for baseDN cn=schema on server
 localhost:5444 \&.\&.\&.\&.\&. Done\&.
Initializing registration information on server localhost:5444 with the
 contents of server localhost:4444 \&.\&.\&.\&.\&. Done\&.
Initializing schema on server localhost:5444 with the contents of server
 localhost:4444 \&.\&.\&.\&.\&. Done\&.

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

See
/var/\&.\&.\&./opends\-replication\-7958637258600693490\&.log
for a detailed log of this operation\&.
$ dsreplication initialize\-all \-I admin \-w password \-X \-n \-b dc=example,dc=com
 \-h `hostname` \-p 4444

Initializing base DN dc=example,dc=com with the contents from localhost:4444:
160 entries processed (100 % complete)\&.
Base DN initialized successfully\&.

See
/var/\&.\&.\&./opends\-replication\-5020375834904394170\&.log
for a detailed log of this operation\&.
.fi

.SH DESCRIPTION
.sp
.LP
The \fBdsreplication\fR command can be used to configure
replication between directory servers so that the data of the servers is synchronized.
First enable replication by using the \fBenable\fR subcommand
and then initialize the contents of one directory server with the contents
of another server by using the \fBinitialize\fR subcommand.
.sp
.LP
Like the \fBdsconfig\fR command, \fBdsreplication\fR can
be run in interactive mode, which walks you through the replication setup
process.  To run \fBdsreplication\fR in interactive mode, type
the command name with no parameters.
.sp
.LP
Run \fBdsreplication --help\fR for more information, or
use the dsreplication online documentation at http://docs.opends.org/1.2/page/Dsreplication\&.
.SH SUB-COMMANDS
.sp
.LP
The following subcommands are used with the \fBdsreplication\fR command.
.sp
.ne 2
.mk
.na
\fB\fBdisable\fR\fR
.ad
.sp .6
.RS 4n
Disable replication on the specified directory server for
the specified base DN. This subcommand removes references to the specified
server in the configuration of the servers with which this server is replicating
data. Suboptions are as follows:
.sp
\fB-D, --bindDN \fIbindDN\fR\fR. The
DN used to bind to the server on which replication will be disabled. This
option must be used if no global administrator has been defined on the server
or if you do not want to remove references in the other replicated servers.
The password provided for the global administrator is used when this option
is specified.
.sp
\fB-h, --hostname \fIhost\fR\fR. Directory
server host name or IP address.
.sp
\fB-p, --port \fIport\fR\fR. Directory
server administration port number.
.if n \{\
.RE

.sp
.ne 2
.mk
.na
\fB\fBenable\fR\fR
.ad
.sp .6
.RS 4n
Update the configuration of the directory servers to replicate
data under the specified base DN. If one of the specified servers is already
replicating the data under the base DN to other servers, executing this subcommand
updates the configuration of all the servers. It is therefore sufficient to
execute the subcommand once for each server that is added to the replication
topology. Suboptions are as follows:
.sp
\fB--bindDN2 \fIbindDN\fR\fR. The
DN used to bind to the second server whose contents will be replicated. If
no bind DN is specified, the global administrator is used to bind.
.sp
\fB--bindPassword1 \fIbindPassword\fR\fR.
The password used 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 is used to bind.
.sp
\fB--bindPassword2 \fIpassword\fR\fR.
The password used 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 is used to bind.
.sp
\fB--bindPasswordFile1 \fIfilename\fR\fR \fB\fR.
The file containing the password used 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 is used to bind.
.sp
\fB-D, --bindDN1 \fIbindDN\fR\fR.
The DN used to bind to the first server whose contents will be replicated.
If no bind DN is specified, the global administrator is used to bind.
.sp
\fB-F, --bindPasswordFile2 \fIfilename\fR\fR.
The file containing the password used 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 is used to bind.
.sp
\fB-h, --host1 \fIhost\fR\fR. Host
name or IP address of the first server whose contents will be replicated.
.sp
\fB--noSchemaReplication\fR. Do not replicate the schema
between the servers. Note that schema replication is enabled by default. Use
this option if you do not want the schema to be synchronized between servers.
.sp
\fB-O, --host2 \fIhost\fR\fR. Hostname
or IP address of the second server whose contents will be replicated. 
.sp
\fB-p, --port1 \fIport\fR\fR. Directory
server administration port number of the first server whose contents will
be replicated.
.sp
\fB--port2 \fIport\fR\fR. Directory
server administration port number of the second server whose contents will
be replicated.
.sp
\fB-r, --replicationPort1 \fIport\fR\fR.
The port that will be used by the replication mechanism in the first directory
server to communicate with other servers. Only specify this option if replication
was not previously configured on the first directory server.
.sp
\fB-R, --replicationPort2 \fIport\fR\fR.
The port that will be used by the replication mechanism in the second directory
server to communicate with other servers. Only specify this option if replication
was not previously configured in the second server.
.sp
\fB-S, --skipPortCheck\fR. Skip the check to determine
whether the specified replication ports are usable. If this argument is not
specified, the server checks that the port is available only if you are configuring
the local host.
.sp
\fB--secureReplication1\fR. Specifies whether communication
through the replication port of the first server is encrypted. This option
is only taken into account the first time replication is configured on the
first server.
.sp
\fB--secureReplication2\fR. Specifies whether communication
through the replication port of the second server is encrypted. This option
is only taken into account the first time replication is configured on the
second server.
.sp
\fB--useSecondServerAsSchemaSource\fR. Use the second server
to initialize the schema of the first server. If neither this option nor the \fB--noSchemaReplication\fR option is specified, the schema of the first
server is used to initialize the schema of the second server.
.\}
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE

.sp
.ne 2
.mk
.na
\fB\fBinitialize\fR\fR
.ad
.sp .6
.RS 4n
Initialize the contents of the data under the specified base
DN on the destination directory server with the contents on the source server.
This operation is required after enabling replication. Suboptions are as follows:
.sp
\fB-h, --hostSource \fIhost\fR\fR.
Directory server host name or IP address of the source server whose contents
will be used to initialize the destination server.
.sp
\fB-O, --hostDestination \fIhost\fR\fR \fBhost\fR. Directory server hostname or IP address of the destination
server whose contents will be initialized.
.sp
\fB-p, --portSource\fR \fBport\fR. Directory
server administration port number of the source server whose contents will
be used to initialize the destination server.
.sp
\fB--portDestination\fR \fBport\fR. Directory
server administration port number of the destination server whose contents
will be initialized.
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE

.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.ne 2
.mk
.na
\fB\fBinitialize-all\fR\fR
.ad
.sp .6
.RS 4n
Initialize the data under the specified base DN, on all the
directory servers in the topology, with the data on the specified server.
This operation is required after enabling replication for replication to work.
Alternatively, you can use the \fBinitialize\fR sub-command on
each individual server in the topology. Suboptions are as follows:
.sp
\fB-h, --hostname \fIhost\fR\fR. Directory
server host name or IP address of the source server.
.sp
\fB-p, --port \fIport\fR\fR. Directory
server administration port number of the source server.
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE

.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp
.ne 2
.mk
.na
\fB\fBpost-external-initialization\fR\fR
.ad
.sp .6
.RS 4n
Enable replication to work after the entire topology has been
reinitialized by using \fBimport-ldif\fR or binary copy. This
subcommand must be called after you initialize the contents of all directory
servers in a topology by using \fBimport-ldif\fR or binary copy.
If you do not run this subcommand, replication will no longer work after the
initialization. Suboptions are as follows:
.sp
\fB-h, --hostname \fIhost\fR\fR. Directory
server host name or IP address.
.sp
\fB-p, --port \fIport\fR\fR. Directory
server administration port number.
.RE

.sp
.ne 2
.mk
.na
\fB\fBpre-external-initialization\fR\fR
.ad
.sp .6
.RS 4n
Prepare a replication topology for initialization by using \fBimport-ldif\fR or binary copy. This subcommand must be called before
you initialize the contents of all directory servers in a topology by using \fBimport-ldif\fR or binary copy. If you do not run this subcommand, replication
will no longer work after the initialization. After running this subcommand,
initialize the contents of all the servers in the topology, then run the subcommand \fBpost-external-initialization\fR. Suboptions are as follows:
.sp
\fB-h, --hostname \fIhost\fR\fR. Directory
server host name or IP address.
.sp
\fB-l, --local-only\fR. Use this option when the contents
of only the specified directory server will be initialized with an external
method.
.sp
\fB-p, --port \fIport\fR\fR. Directory
server administration port number.
.RE

.sp
.ne 2
.mk
.na
\fB\fBstatus\fR\fR
.ad
.sp .6
.RS 4n
List the replication configuration for the specified base
DNs of all directory servers defined in the registration information. If no
base DNs are specified, the information for all base DNs is displayed. Suboptions
are as follows:
.sp
\fB-h, --hostname \fIhost\fR\fR. Directory
server host name or IP address.
.sp
\fB-p, --port \fIport\fR\fR. Directory
server administration port number.
.sp
\fB-s, --script-friendly\fR. Display the status in a format
that can be parsed by a script.
.RE

.SH OPTIONS
.sp
.LP
The following global options are supported:
.sp
.ne 2
.mk
.na
\fB\fB-b, --baseDN \fIbaseDN\fR\fR\fR
.ad
.sp .6
.RS 4n
Specify the base DN of the data to be replicated or initialized,
or for which replication should be disabled. Multiple base DNs can be specified
by using this option multiple times.
.RE

.sp
.ne 2
.mk
.na
\fB\fB-j, --adminPasswordFile \fIfilename\fR\fR\fR
.ad
.sp .6
.RS 4n
Use the global administrator password in the specified file
when authenticating to the directory server. This option must not be used
in conjunction with \fB--adminPassword\fR.
.RE

.sp
.ne 2
.mk
.na
\fB\fB-w, --adminPassword \fIpassword\fR\fR\fR
.ad
.sp .6
.RS 4n
Use the global administrator password when authenticating
to the directory server.
.RE

.sp
.LP
The following LDAP connection options are supported:
.sp
.ne 2
.mk
.na
\fB\fB-I, --adminUID \fIUID\fR\fR\fR
.ad
.sp .6
.RS 4n
Specify the User ID of the global administrator to bind to
the server. If no global administrator was defined previously for any of the
servers, this option creates a global administrator by using the data provided.
.RE

.sp
.ne 2
.mk
.na
\fB\fB-K, --keyStorePath \fIpath\fR\fR\fR
.ad
.sp .6
.RS 4n
Use the client keystore certificate in the specified path.
.RE

.sp
.ne 2
.mk
.na
\fB\fB-N, --certNickname \fInickname\fR\fR\fR
.ad
.sp .6
.RS 4n
Use the specified certificate for authentication.
.RE

.sp
.ne 2
.mk
.na
\fB\fB-o, --saslOption \fIname\fR=\fIvalue\fR\fR\fR
.ad
.sp .6
.RS 4n
Use the specified options for  SASL authentication.
.RE

.sp
.ne 2
.mk
.na
\fB\fB-P, --trustStorePath \fIpath\fR\fR\fR
.ad
.sp .6
.RS 4n
Use the client trust store certificate in the specified path.
This option is not needed if \fB--trustAll\fR is used, although
a trust store should be used when working in a production environment.
.RE

.sp
.ne 2
.mk
.na
\fB\fB-T, --trustStorePassword \fIpassword\fR\fR\fR
.ad
.sp .6
.RS 4n
Use the password needed to access the certificates in the
client trust store. This option is only required if \fB--trustStorePath\fR is
used and the specified trust store requires a password in order to access
its contents (which most trust stores do not require). This option must not
be used in conjunction with \fB--trustStorePasswordFile\fR.
.RE

.sp
.ne 2
.mk
.na
\fB\fB-u, --keyStorePasswordFile \fIfilename\fR\fR\fR
.ad
.sp .6
.RS 4n
Use the password in the specified file to access the certificates
in the client keystore. This option is only required if \fB--keyStorePath\fR is
used. This option must not be used in conjunction with \fB--keyStorePassword\fR.
.RE

.sp
.ne 2
.mk
.na
\fB\fB-U, --TrustStorePasswordFile \fIfilename\fR\fR\fR
.ad
.sp .6
.RS 4n
Use the password in the specified file to access the certificates
in the client trust store. This option is only required if \fB--trustStorePath\fR is used and the specified trust store requires a password in order
to access its contents (most trust stores do not require this). This option
must not be used in conjunction with \fB--trustStorePassword\fR.
.RE

.sp
.ne 2
.mk
.na
\fB\fB-W, --keyStorePassword \fIpassword\fR\fR\fR
.ad
.sp .6
.RS 4n
Use the password needed to access the certificates in the
client keystore. This option is only required if \fB--keyStorePath\fR is
used. This option must not be used in conjunction with \fB--keyStorePasswordFile\fR.
.RE

.sp
.ne 2
.mk
.na
\fB\fB-X, --trustAll\fR\fR
.ad
.sp .6
.RS 4n
Trust any certificate that the directory server might present
during SSL or StartTLS negotiation. This option can be used for convenience
and testing purposes, but for security reasons a trust store should be used
to determine whether the client should accept the server certificate.
.RE

.sp
.LP
The following input/output options are supported:
.sp
.ne 2
.mk
.na
\fB\fB-n, --no-prompt\fR\fR
.ad
.RS 29n
.rt  
Run in non-interactive mode.  If some data in the command
is missing, the user will not be prompted and the tool will fail.
.RE

.sp
.ne 2
.mk
.na
\fB\fB--noPropertiesFile\fR\fR
.ad
.RS 29n
.rt  
Indicate that the utility will not use a properties file to
get the default command-line options.
.RE

.sp
.ne 2
.mk
.na
\fB\fB--propertiesFilePath \fIpath\fR\fR\fR
.ad
.RS 29n
.rt  
Specify the path to the properties file that contains the
default command-line options.
.RE

.sp
.ne 2
.mk
.na
\fB\fB-Q, --quiet\fR\fR
.ad
.RS 29n
.rt  
Run in quiet mode. No output will be generated unless a significant
error occurs during the process.
.RE

.sp
.LP
The following general options are supported:
.sp
.ne 2
.mk
.na
\fB\fB-?, -H, --help\fR\fR
.ad
.RS 18n
.rt  
Display command-line usage information for the utility and
exit without making any attempt to stop or restart the directory server.
.RE

.sp
.ne 2
.mk
.na
\fB\fB-V, --version\fR\fR
.ad
.RS 18n
.rt  
Display the version information for the directory server and
exit rather than attempting to run this command.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for
descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityUncommitted
.TE


 opends/resource/man/man1/encode-password.1

New file
@@ -0,0 +1,186 @@
'\" t
.\"     Title: encode-password
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "ENCODE\-PASSWORD" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
encode-password \- encode a password with an OpenDJ storage scheme
.SH "SYNOPSIS"
.HP \w'\fBencode\-password\fR\ 'u
\fBencode\-password\fR {options}
.SH "DESCRIPTION"
.PP
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\&.
.SH "OPTIONS"
.PP
The following global options are supported\&.
.PP
\fB\-a, \-\-authPasswordSyntax\fR
.RS 4
Use the authentication password syntax rather than the user password syntax\&.
.RE
.PP
\fB\-c, \-\-clearPassword {clearPW}\fR
.RS 4
Clear\-text password to encode or to compare against an encoded password\&.
.RE
.PP
\fB\-e, \-\-encodedPassword {encodedPW}\fR
.RS 4
Encoded password to compare against the clear\-text password\&.
.RE
.PP
\fB\-E, \-\-encodedPasswordFile {file}\fR
.RS 4
Encoded password file\&.
.RE
.PP
\fB\-f, \-\-clearPasswordFile {file}\fR
.RS 4
Clear\-text password file\&.
.RE
.PP
\fB\-i, \-\-interactivePassword\fR
.RS 4
The password to encode or to compare against an encoded password is interactively asked to the user\&.
.RE
.PP
\fB\-l, \-\-listSchemes\fR
.RS 4
List available password storage schemes\&.
.RE
.PP
\fB\-r, \-\-useCompareResultCode\fR
.RS 4
Use the LDAP compare result as an exit code for the password comparison\&.
.RE
.PP
\fB\-s, \-\-storageScheme {scheme}\fR
.RS 4
Scheme to use for the encoded password\&.
.RE
.PP
\fB\-V, \-\-version\fR
.RS 4
Display version information\&.
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information\&.
.RE
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
5
.RS 4
The
\fB\-r\fR
option was used, and the compare did not match\&.
.RE
.PP
6
.RS 4
The
\fB\-r\fR
option was used, and the compare did match\&.
.RE
.PP
other
.RS 4
An error occurred\&.
.RE
.SH "EXAMPLES"
.PP
The following example encodes a password, and also shows comparison of a password with the encoded value\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ encode\-password \-l
3DES
AES
BASE64
BLOWFISH
CLEAR
CRYPT
MD5
RC4
SHA
SMD5
SSHA
SSHA256
SSHA384
SSHA512
$ encode\-password \-c secret12 \-s CRYPT
Encoded Password:  "{CRYPT}ZulJ6Dy3TFnrE"
$ encode\-password \-c secret12 \-s CRYPT \-e "{CRYPT}ZulJ6Dy3TFnrE" \-r
The provided clear\-text and encoded passwords match
$ echo $?
6
.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp

 opends/resource/man/man1/export-ldif.1

New file
@@ -0,0 +1,299 @@
'\" t
.\"     Title: export-ldif
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "EXPORT\-LDIF" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
export-ldif \- export OpenDJ directory data in LDIF
.SH "SYNOPSIS"
.HP \w'\fBexport\-ldif\fR\ 'u
\fBexport\-ldif\fR {options}
.SH "DESCRIPTION"
.PP
This utility can be used to export data from a directory server backend in LDIF form\&.
.SH "OPTIONS"
.PP
The following options are supported\&.
.PP
\fB\-a, \-\-appendToLDIF\fR
.RS 4
Append an existing LDIF file rather than overwriting it\&.
.RE
.PP
\fB\-b, \-\-includeBranch {branchDN}\fR
.RS 4
Base DN of a branch to include in the LDIF export\&.
.RE
.PP
\fB\-B, \-\-excludeBranch {branchDN}\fR
.RS 4
Base DN of a branch to exclude from the LDIF export\&.
.RE
.PP
\fB\-c, \-\-compress\fR
.RS 4
Compress the LDIF data as it is exported\&.
.RE
.PP
\fB\-e, \-\-excludeAttribute {attribute}\fR
.RS 4
Attribute to exclude from the LDIF export\&.
.RE
.PP
\fB\-E, \-\-excludeFilter {filter}\fR
.RS 4
Filter to identify entries to exclude from the LDIF export\&.
.RE
.PP
\fB\-i, \-\-includeAttribute {attribute}\fR
.RS 4
Attribute to include in the LDIF export\&.
.RE
.PP
\fB\-I, \-\-includeFilter {filter}\fR
.RS 4
Filter to identify entries to include in the LDIF export\&.
.RE
.PP
\fB\-l, \-\-ldifFile {ldifFile}\fR
.RS 4
Path to the LDIF file to be written\&.
.RE
.PP
\fB\-n, \-\-backendID {backendName}\fR
.RS 4
Backend ID for the backend to export\&.
.RE
.PP
\fB\-O, \-\-excludeOperational\fR
.RS 4
Exclude operational attributes from the LDIF export\&.
.RE
.PP
\fB\-\-wrapColumn {wrapColumn}\fR
.RS 4
Column at which to wrap long lines (0 for no wrapping)\&.
.sp
Default value: 0
.RE
.SS "Task Backend Connection Options"
.PP
\fB\-\-connectTimeout {timeout}\fR
.RS 4
Maximum length of time (in milliseconds) that can be taken to establish a connection\&. Use \*(Aq0\*(Aq to specify no time out\&.
.sp
Default value: 30000
.RE
.PP
\fB\-D, \-\-bindDN {bindDN}\fR
.RS 4
DN to use to bind to the server
.sp
Default value: cn=Directory Manager
.RE
.PP
\fB\-h, \-\-hostname {host}\fR
.RS 4
Directory server hostname or IP address
.sp
Default value: localhost\&.localdomain
.RE
.PP
\fB\-j, \-\-bindPasswordFile {bindPasswordFile}\fR
.RS 4
Bind password file
.RE
.PP
\fB\-K, \-\-keyStorePath {keyStorePath}\fR
.RS 4
Certificate key store path
.RE
.PP
\fB\-N, \-\-certNickname {nickname}\fR
.RS 4
Nickname of certificate for SSL client authentication
.RE
.PP
\fB\-o, \-\-saslOption {name=value}\fR
.RS 4
SASL bind options
.RE
.PP
\fB\-p, \-\-port {port}\fR
.RS 4
Directory server administration port number
.sp
Default value: 4444
.RE
.PP
\fB\-P, \-\-trustStorePath {trustStorePath}\fR
.RS 4
Certificate trust store path
.RE
.PP
\fB\-T, \-\-trustStorePassword {trustStorePassword}\fR
.RS 4
Certificate trust store PIN
.RE
.PP
\fB\-u, \-\-keyStorePasswordFile {keyStorePasswordFile}\fR
.RS 4
Certificate key store PIN file
.RE
.PP
\fB\-U, \-\-trustStorePasswordFile {path}\fR
.RS 4
Certificate trust store PIN file
.RE
.PP
\fB\-w, \-\-bindPassword {bindPassword}\fR
.RS 4
Password to use to bind to the server
.RE
.PP
\fB\-W, \-\-keyStorePassword {keyStorePassword}\fR
.RS 4
Certificate key store PIN
.RE
.PP
\fB\-X, \-\-trustAll\fR
.RS 4
Trust all server SSL certificates
.RE
.SS "Task Scheduling Options"
.PP
\fB\-\-completionNotify {emailAddress}\fR
.RS 4
Email address of a recipient to be notified when the task completes\&. This option may be specified more than once\&.
.RE
.PP
\fB\-\-dependency {taskID}\fR
.RS 4
ID of a task upon which this task depends\&. A task will not start execution until all its dependencies have completed execution\&.
.RE
.PP
\fB\-\-errorNotify {emailAddress}\fR
.RS 4
Email address of a recipient to be notified if an error occurs when this task executes\&. This option may be specified more than once\&.
.RE
.PP
\fB\-\-failedDependencyAction {action}\fR
.RS 4
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\&.
.RE
.PP
\fB\-\-recurringTask {schedulePattern}\fR
.RS 4
Indicates the task is recurring and will be scheduled according to the value argument expressed in crontab(5) compatible time/date pattern\&.
.RE
.PP
\fB\-t, \-\-start {startTime}\fR
.RS 4
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 \*(Aq0\*(Aq 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\&.
.RE
.SS "Utility Input/Output Options"
.PP
\fB\-\-noPropertiesFile\fR
.RS 4
No properties file will be used to get default command line argument values
.RE
.PP
\fB\-\-propertiesFilePath {propertiesFilePath}\fR
.RS 4
Path to the file containing default property values used for command line arguments
.RE
.SS "General Options"
.PP
\fB\-V, \-\-version\fR
.RS 4
Display version information
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information
.RE
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
> 0
.RS 4
An error occurred\&.
.RE
.SH "EXAMPLES"
.PP
The following example exports data to a file,
Example\&.ldif, with the server offline\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ export\-ldif \-b dc=example,dc=com \-n userRoot \-l \&.\&./ldif/Example\&.ldif
[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)
.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp

 opends/resource/man/man1/import-ldif.1

New file
@@ -0,0 +1,352 @@
'\" t
.\"     Title: import-ldif
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "IMPORT\-LDIF" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
import-ldif \- import OpenDJ directory data from LDIF
.SH "SYNOPSIS"
.HP \w'\fBimport\-ldif\fR\ 'u
\fBimport\-ldif\fR {options}
.SH "DESCRIPTION"
.PP
This utility can be used to import LDIF data into a directory server backend\&.
.SH "OPTIONS"
.PP
The following options are supported\&.
.PP
\fB\-a, \-\-appendToLDIF\fR
.RS 4
Append an existing LDIF file rather than overwriting it\&.
.RE
.PP
\fB\-A, \-\-templateFile {templateFile}\fR
.RS 4
Path to a MakeLDIF template to use to generate the import data\&.
.RE
.PP
\fB\-b, \-\-includeBranch {branchDN}\fR
.RS 4
Base DN of a branch to include in the LDIF import\&.
.RE
.PP
\fB\-B, \-\-excludeBranch {branchDN}\fR
.RS 4
Base DN of a branch to exclude from the LDIF import\&.
.RE
.PP
\fB\-c, \-\-isCompressed\fR
.RS 4
LDIF file is compressed\&.
.RE
.PP
\fB\-\-countRejects\fR
.RS 4
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)\&.
.RE
.PP
\fB\-e, \-\-excludeAttribute {attribute}\fR
.RS 4
Attribute to exclude from the LDIF import\&.
.RE
.PP
\fB\-E, \-\-excludeFilter {filter}\fR
.RS 4
Filter to identify entries to exclude from the LDIF import\&.
.RE
.PP
\fB\-F, \-\-clearBackend\fR
.RS 4
Remove all entries for all base DNs in the backend before importing\&.
.RE
.PP
\fB\-i, \-\-includeAttribute {attribute}\fR
.RS 4
Attribute to include in the LDIF import\&.
.RE
.PP
\fB\-I, \-\-includeFilter {filter}\fR
.RS 4
Filter to identify entries to include in the LDIF import\&.
.RE
.PP
\fB\-l, \-\-ldifFile {ldifFile}\fR
.RS 4
Path to the LDIF file to be imported\&.
.RE
.PP
\fB\-n, \-\-backendID {backendName}\fR
.RS 4
Backend ID for the backend to import\&.
.RE
.PP
\fB\-O, \-\-overwrite\fR
.RS 4
Overwrite an existing rejects and/or skip file rather than appending to it\&.
.RE
.PP
\fB\-r, \-\-replaceExisting\fR
.RS 4
Replace existing entries when appending to the database\&.
.RE
.PP
\fB\-R, \-\-rejectFile {rejectFile}\fR
.RS 4
Write rejected entries to the specified file\&.
.RE
.PP
\fB\-s, \-\-randomSeed {seed}\fR
.RS 4
Seed for the MakeLDIF random number generator\&.
.sp
Default value: 0
.RE
.PP
\fB\-S, \-\-skipSchemaValidation\fR
.RS 4
Skip schema validation during the LDIF import\&.
.RE
.PP
\fB\-\-skipDNValidation\fR
.RS 4
Perform DN validation during later part of LDIF import\&.
.RE
.PP
\fB\-\-skipFile {skipFile}\fR
.RS 4
Write skipped entries to the specified file\&.
.RE
.PP
\fB\-\-threadCount {count}\fR
.RS 4
Number of threads used to read LDIF file during import\&. Default value (0) equals: 2 x (number of CPUs)\&.
.RE
.PP
\fB\-\-tmpdirectory {directory}\fR
.RS 4
Path to temporary directory for index scratch files during LDIF import\&.
.sp
Default value:
import\-tmp
.RE
.SS "Task Backend Connection Options"
.PP
\fB\-\-connectTimeout {timeout}\fR
.RS 4
Maximum length of time (in milliseconds) that can be taken to establish a connection\&. Use \*(Aq0\*(Aq to specify no time out\&.
.sp
Default value: 30000
.RE
.PP
\fB\-D, \-\-bindDN {bindDN}\fR
.RS 4
DN to use to bind to the server
.sp
Default value: cn=Directory Manager
.RE
.PP
\fB\-h, \-\-hostname {host}\fR
.RS 4
Directory server hostname or IP address
.sp
Default value: localhost\&.localdomain
.RE
.PP
\fB\-j, \-\-bindPasswordFile {bindPasswordFile}\fR
.RS 4
Bind password file
.RE
.PP
\fB\-K, \-\-keyStorePath {keyStorePath}\fR
.RS 4
Certificate key store path
.RE
.PP
\fB\-N, \-\-certNickname {nickname}\fR
.RS 4
Nickname of certificate for SSL client authentication
.RE
.PP
\fB\-o, \-\-saslOption {name=value}\fR
.RS 4
SASL bind options
.RE
.PP
\fB\-p, \-\-port {port}\fR
.RS 4
Directory server administration port number
.sp
Default value: 4444
.RE
.PP
\fB\-P, \-\-trustStorePath {trustStorePath}\fR
.RS 4
Certificate trust store path
.RE
.PP
\fB\-T, \-\-trustStorePassword {trustStorePassword}\fR
.RS 4
Certificate trust store PIN
.RE
.PP
\fB\-u, \-\-keyStorePasswordFile {keyStorePasswordFile}\fR
.RS 4
Certificate key store PIN file
.RE
.PP
\fB\-U, \-\-trustStorePasswordFile {path}\fR
.RS 4
Certificate trust store PIN file
.RE
.PP
\fB\-w, \-\-bindPassword {bindPassword}\fR
.RS 4
Password to use to bind to the server
.RE
.PP
\fB\-W, \-\-keyStorePassword {keyStorePassword}\fR
.RS 4
Certificate key store PIN
.RE
.PP
\fB\-X, \-\-trustAll\fR
.RS 4
Trust all server SSL certificates
.RE
.SS "Task Scheduling Options"
.PP
\fB\-\-completionNotify {emailAddress}\fR
.RS 4
Email address of a recipient to be notified when the task completes\&. This option may be specified more than once\&.
.RE
.PP
\fB\-\-dependency {taskID}\fR
.RS 4
ID of a task upon which this task depends\&. A task will not start execution until all its dependencies have completed execution\&.
.RE
.PP
\fB\-\-errorNotify {emailAddress}\fR
.RS 4
Email address of a recipient to be notified if an error occurs when this task executes\&. This option may be specified more than once\&.
.RE
.PP
\fB\-\-failedDependencyAction {action}\fR
.RS 4
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\&.
.RE
.PP
\fB\-\-recurringTask {schedulePattern}\fR
.RS 4
Indicates the task is recurring and will be scheduled according to the value argument expressed in crontab(5) compatible time/date pattern\&.
.RE
.PP
\fB\-t, \-\-start {startTime}\fR
.RS 4
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 \*(Aq0\*(Aq 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\&.
.RE
.SS "Utility Input/Output Options"
.PP
\fB\-\-noPropertiesFile\fR
.RS 4
No properties file will be used to get default command line argument values
.RE
.PP
\fB\-\-propertiesFilePath {propertiesFilePath}\fR
.RS 4
Path to the file containing default property values used for command line arguments
.RE
.SS "General Options"
.PP
\fB\-V, \-\-version\fR
.RS 4
Display version information
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information
.RE
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
> 0
.RS 4
An error occurred\&.
.RE
.SH "EXAMPLES"
.PP
The following example imports the content of the LDIF file,
Example\&.ldif, with the server offline\&.
.sp
.if n \{\
.RS 4
.\}
.nf
  $ import\-ldif \-b dc=example,dc=com \-n userRoot \-l /path/to/Example\&.ldif
  [21/Jun/2011:13:38:03 +0200] category=RUNTIME_INFORMATION severity=NOTICE\&.\&.\&.
  \&.\&.\&. msg=Import LDIF environment close took 0 seconds
.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp

 opends/resource/man/man1/ldapcompare.1

New file
@@ -0,0 +1,316 @@
'\" t
.\"     Title: ldapcompare
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "LDAPCOMPARE" "1" "October\ \&20,\ \&2011" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ldapcompare \- perform LDAP compare operations
.SH "SYNOPSIS"
.HP \w'\fBldapcompare\fR\ 'u
\fBldapcompare\fR {options} [[attribute] | [:] | [value]] [DN...]
.SH "DESCRIPTION"
.PP
This utility can be used to perform LDAP compare operations in the directory\&.
.SH "OPTIONS"
.PP
The following options are supported\&.
.PP
\fB\-\-assertionFilter {filter}\fR
.RS 4
Use the LDAP assertion control with the provided filter
.RE
.PP
\fB\-c, \-\-continueOnError\fR
.RS 4
Continue processing even if there are errors
.RE
.PP
\fB\-f, \-\-filename {file}\fR
.RS 4
LDIF file containing one DN per line of entries to compare
.RE
.PP
\fB\-J, \-\-control {controloid[:criticality[:value|::b64value|:<filePath]]}\fR
.RS 4
Use a request control with the provided information
.RE
.PP
\fB\-n, \-\-dry\-run\fR
.RS 4
Show what would be done but do not perform any operation
.RE
.PP
\fB\-Y, \-\-proxyAs {authzID}\fR
.RS 4
Use the proxied authorization control with the given authorization ID
.RE
.SS "LDAP Connection Options"
.PP
\fB\-D, \-\-bindDN {bindDN}\fR
.RS 4
DN to use to bind to the server
.sp
Default value: cn=Directory Manager
.RE
.PP
\fB\-E, \-\-reportAuthzID\fR
.RS 4
Use the authorization identity control
.RE
.PP
\fB\-h, \-\-hostname {host}\fR
.RS 4
Directory server hostname or IP address
.sp
Default value: localhost\&.localdomain
.RE
.PP
\fB\-j, \-\-bindPasswordFile {bindPasswordFile}\fR
.RS 4
Bind password file
.RE
.PP
\fB\-K, \-\-keyStorePath {keyStorePath}\fR
.RS 4
Certificate key store path
.RE
.PP
\fB\-N, \-\-certNickname {nickname}\fR
.RS 4
Nickname of certificate for SSL client authentication
.RE
.PP
\fB\-o, \-\-saslOption {name=value}\fR
.RS 4
SASL bind options
.RE
.PP
\fB\-p, \-\-port {port}\fR
.RS 4
Directory server port number
.sp
Default value: 389
.RE
.PP
\fB\-P, \-\-trustStorePath {trustStorePath}\fR
.RS 4
Certificate trust store path
.RE
.PP
\fB\-q, \-\-useStartTLS\fR
.RS 4
Use StartTLS to secure communication with the server
.RE
.PP
\fB\-T, \-\-trustStorePassword {trustStorePassword}\fR
.RS 4
Certificate trust store PIN
.RE
.PP
\fB\-u, \-\-keyStorePasswordFile {keyStorePasswordFile}\fR
.RS 4
Certificate key store PIN file
.RE
.PP
\fB\-U, \-\-trustStorePasswordFile {path}\fR
.RS 4
Certificate trust store PIN file
.RE
.PP
\fB\-\-usePasswordPolicyControl\fR
.RS 4
Use the password policy request control
.RE
.PP
\fB\-V, \-\-ldapVersion {version}\fR
.RS 4
LDAP protocol version number
.sp
Default value: 3
.RE
.PP
\fB\-w, \-\-bindPassword {bindPassword}\fR
.RS 4
Password to use to bind to the server
.RE
.PP
\fB\-W, \-\-keyStorePassword {keyStorePassword}\fR
.RS 4
Certificate key store PIN
.RE
.PP
\fB\-X, \-\-trustAll\fR
.RS 4
Trust all server SSL certificates
.RE
.PP
\fB\-Z, \-\-useSSL\fR
.RS 4
Use SSL for secure communication with the server
.RE
.SS "Utility Input/Output Options"
.PP
\fB\-i, \-\-encoding {encoding}\fR
.RS 4
Use the specified character set for command\-line input
.RE
.PP
\fB\-\-noPropertiesFile\fR
.RS 4
No properties file will be used to get default command line argument values
.RE
.PP
\fB\-\-propertiesFilePath {propertiesFilePath}\fR
.RS 4
Path to the file containing default property values used for command line arguments
.RE
.PP
\fB\-v, \-\-verbose\fR
.RS 4
Use verbose mode
.RE
.SS "General Options"
.PP
\fB\-\-version\fR
.RS 4
Display version information
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information
.RE
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
\fIldap\-error\fR
.RS 4
An LDAP error occurred while processing the operation\&.
.sp
LDAP result codes are described in
\m[blue]\fBRFC 4511\fR\m[]\&. Also see the additional information for details\&.
.RE
.PP
89
.RS 4
An error occurred while parsing the command\-line arguments\&.
.RE
.SH "FILES"
.PP
You can use
~/\&.opendj/tools\&.properties
to set the defaults for bind DN, host name, and port number as in the following example\&.
.sp
.if n \{\
.RS 4
.\}
.nf
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
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLES"
.PP
The following examples demonstrate comparing Babs Jensen\*(Aqs UID\&.
.PP
The following example uses a matching UID value\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ ldapcompare \-p 1389 uid:bjensen uid=bjensen,ou=people,dc=example,dc=com
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
.fi
.if n \{\
.RE
.\}
.PP
The following example uses a UID value that does not match\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ ldapcompare \-p 1389 uid:beavis uid=bjensen,ou=people,dc=example,dc=com
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
.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp

 opends/resource/man/man1/ldapdelete.1

New file
@@ -0,0 +1,317 @@
'\" t
.\"     Title: ldapdelete
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "LDAPDELETE" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ldapdelete \- perform LDAP delete operations
.SH "SYNOPSIS"
.HP \w'\fBldapdelete\fR\ 'u
\fBldapdelete\fR {options} [\fIDN\fR]
.SH "DESCRIPTION"
.PP
This utility can be used to perform LDAP delete operations in the directory\&.
.SH "OPTIONS"
.PP
The following options are supported\&.
.PP
\fB\-\-assertionFilter {filter}\fR
.RS 4
Use the LDAP assertion control with the provided filter
.RE
.PP
\fB\-c, \-\-continueOnError\fR
.RS 4
Continue processing even if there are errors
.RE
.PP
\fB\-f, \-\-filename {file}\fR
.RS 4
LDIF file containing the changes to apply
.RE
.PP
\fB\-J, \-\-control {controloid[:criticality[:value|::b64value|:<filePath]]}\fR
.RS 4
Use a request control with the provided information
.RE
.PP
\fB\-n, \-\-dry\-run\fR
.RS 4
Show what would be done but do not perform any operation
.RE
.PP
\fB\-x, \-\-deleteSubtree\fR
.RS 4
Delete the specified entry and all entries below it
.RE
.PP
\fB\-Y, \-\-proxyAs {authzID}\fR
.RS 4
Use the proxied authorization control with the given authorization ID
.RE
.SS "LDAP Connection Options"
.PP
\fB\-D, \-\-bindDN {bindDN}\fR
.RS 4
DN to use to bind to the server
.sp
Default value: cn=Directory Manager
.RE
.PP
\fB\-E, \-\-reportAuthzID\fR
.RS 4
Use the authorization identity control
.RE
.PP
\fB\-h, \-\-hostname {host}\fR
.RS 4
Directory server hostname or IP address
.sp
Default value: localhost\&.localdomain
.RE
.PP
\fB\-j, \-\-bindPasswordFile {bindPasswordFile}\fR
.RS 4
Bind password file
.RE
.PP
\fB\-K, \-\-keyStorePath {keyStorePath}\fR
.RS 4
Certificate key store path
.RE
.PP
\fB\-N, \-\-certNickname {nickname}\fR
.RS 4
Nickname of certificate for SSL client authentication
.RE
.PP
\fB\-o, \-\-saslOption {name=value}\fR
.RS 4
SASL bind options
.RE
.PP
\fB\-p, \-\-port {port}\fR
.RS 4
Directory server port number
.sp
Default value: 389
.RE
.PP
\fB\-P, \-\-trustStorePath {trustStorePath}\fR
.RS 4
Certificate trust store path
.RE
.PP
\fB\-q, \-\-useStartTLS\fR
.RS 4
Use StartTLS to secure communication with the server
.RE
.PP
\fB\-T, \-\-trustStorePassword {trustStorePassword}\fR
.RS 4
Certificate trust store PIN
.RE
.PP
\fB\-u, \-\-keyStorePasswordFile {keyStorePasswordFile}\fR
.RS 4
Certificate key store PIN file
.RE
.PP
\fB\-U, \-\-trustStorePasswordFile {path}\fR
.RS 4
Certificate trust store PIN file
.RE
.PP
\fB\-\-usePasswordPolicyControl\fR
.RS 4
Use the password policy request control
.RE
.PP
\fB\-V, \-\-ldapVersion {version}\fR
.RS 4
LDAP protocol version number
.sp
Default value: 3
.RE
.PP
\fB\-w, \-\-bindPassword {bindPassword}\fR
.RS 4
Password to use to bind to the server
.RE
.PP
\fB\-W, \-\-keyStorePassword {keyStorePassword}\fR
.RS 4
Certificate key store PIN
.RE
.PP
\fB\-X, \-\-trustAll\fR
.RS 4
Trust all server SSL certificates
.RE
.PP
\fB\-Z, \-\-useSSL\fR
.RS 4
Use SSL for secure communication with the server
.RE
.SS "Utility Input/Output Options"
.PP
\fB\-i, \-\-encoding {encoding}\fR
.RS 4
Use the specified character set for command\-line input
.RE
.PP
\fB\-\-noPropertiesFile\fR
.RS 4
No properties file will be used to get default command line argument values
.RE
.PP
\fB\-\-propertiesFilePath {propertiesFilePath}\fR
.RS 4
Path to the file containing default property values used for command line arguments
.RE
.PP
\fB\-v, \-\-verbose\fR
.RS 4
Use verbose mode
.RE
.SS "General Options"
.PP
\fB\-\-version\fR
.RS 4
Display version information
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information
.RE
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
\fIldap\-error\fR
.RS 4
An LDAP error occurred while processing the operation\&.
.sp
LDAP result codes are described in
\m[blue]\fBRFC 4511\fR\m[]\&. Also see the additional information for details\&.
.RE
.PP
89
.RS 4
An error occurred while parsing the command\-line arguments\&.
.RE
.SH "FILES"
.PP
You can use
~/\&.opendj/tools\&.properties
to set the defaults for bind DN, host name, and port number as in the following example\&.
.sp
.if n \{\
.RS 4
.\}
.nf
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
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLES"
.PP
The following command deletes a user entry from the directory\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ ldapdelete \-p 1389 \-D "cn=Directory Manager" \-w password
 uid=bjensen,ou=people,dc=example,dc=com
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
.fi
.if n \{\
.RE
.\}
.PP
The following command deletes the ou=Groups entry and all entries underneath ou=Groups\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ ldapdelete \-p 1389 \-D "cn=Directory Manager" \-w password \-x
 ou=groups,dc=example,dc=com
Processing DELETE request for ou=groups,dc=example,dc=com
DELETE operation successful for DN ou=groups,dc=example,dc=com
.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp

 opends/resource/man/man1/ldapmodify.1

New file
@@ -0,0 +1,398 @@
'\" t
.\"     Title: ldapmodify
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "LDAPMODIFY" "1" "October\ \&20,\ \&2011" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ldapmodify \- perform LDAP modify, add, delete, mod DN operations
.SH "SYNOPSIS"
.HP \w'\fBldapmodify\fR\ 'u
\fBldapmodify\fR {options}
.SH "DESCRIPTION"
.PP
This utility can be used to perform LDAP modify, add, delete, and modify DN operations in the directory\&.
.PP
When not using a file to specify modifications, end your input with EOF (Ctrl+D on UNIX, Ctrl+Z on Windows)\&.
.SH "OPTIONS"
.PP
The following options are supported\&.
.PP
\fB\-a, \-\-defaultAdd\fR
.RS 4
Treat records with no changetype as add operations
.RE
.PP
\fB\-\-assertionFilter {filter}\fR
.RS 4
Use the LDAP assertion control with the provided filter
.RE
.PP
\fB\-c, \-\-continueOnError\fR
.RS 4
Continue processing even if there are errors
.RE
.PP
\fB\-f, \-\-filename {file}\fR
.RS 4
LDIF file containing the changes to apply
.RE
.PP
\fB\-J, \-\-control {controloid[:criticality[:value|::b64value|:<filePath]]}\fR
.RS 4
Use a request control with the provided information
.RE
.PP
\fB\-n, \-\-dry\-run\fR
.RS 4
Show what would be done but do not perform any operation
.RE
.PP
\fB\-\-postReadAttributes {attrList}\fR
.RS 4
Use the LDAP ReadEntry post\-read control
.RE
.PP
\fB\-\-preReadAttributes {attrList}\fR
.RS 4
Use the LDAP ReadEntry pre\-read control
.RE
.PP
\fB\-Y, \-\-proxyAs {authzID}\fR
.RS 4
Use the proxied authorization control with the given authorization ID
.RE
.SS "LDAP Connection Options"
.PP
\fB\-D, \-\-bindDN {bindDN}\fR
.RS 4
DN to use to bind to the server
.sp
Default value: cn=Directory Manager
.RE
.PP
\fB\-E, \-\-reportAuthzID\fR
.RS 4
Use the authorization identity control
.RE
.PP
\fB\-h, \-\-hostname {host}\fR
.RS 4
Directory server hostname or IP address
.sp
Default value: localhost\&.localdomain
.RE
.PP
\fB\-j, \-\-bindPasswordFile {bindPasswordFile}\fR
.RS 4
Bind password file
.RE
.PP
\fB\-K, \-\-keyStorePath {keyStorePath}\fR
.RS 4
Certificate key store path
.RE
.PP
\fB\-N, \-\-certNickname {nickname}\fR
.RS 4
Nickname of certificate for SSL client authentication
.RE
.PP
\fB\-o, \-\-saslOption {name=value}\fR
.RS 4
SASL bind options
.RE
.PP
\fB\-p, \-\-port {port}\fR
.RS 4
Directory server port number
.sp
Default value: 389
.RE
.PP
\fB\-P, \-\-trustStorePath {trustStorePath}\fR
.RS 4
Certificate trust store path
.RE
.PP
\fB\-q, \-\-useStartTLS\fR
.RS 4
Use StartTLS to secure communication with the server
.RE
.PP
\fB\-T, \-\-trustStorePassword {trustStorePassword}\fR
.RS 4
Certificate trust store PIN
.RE
.PP
\fB\-u, \-\-keyStorePasswordFile {keyStorePasswordFile}\fR
.RS 4
Certificate key store PIN file
.RE
.PP
\fB\-U, \-\-trustStorePasswordFile {path}\fR
.RS 4
Certificate trust store PIN file
.RE
.PP
\fB\-\-usePasswordPolicyControl\fR
.RS 4
Use the password policy request control
.RE
.PP
\fB\-V, \-\-ldapVersion {version}\fR
.RS 4
LDAP protocol version number
.sp
Default value: 3
.RE
.PP
\fB\-w, \-\-bindPassword {bindPassword}\fR
.RS 4
Password to use to bind to the server
.RE
.PP
\fB\-W, \-\-keyStorePassword {keyStorePassword}\fR
.RS 4
Certificate key store PIN
.RE
.PP
\fB\-X, \-\-trustAll\fR
.RS 4
Trust all server SSL certificates
.RE
.PP
\fB\-Z, \-\-useSSL\fR
.RS 4
Use SSL for secure communication with the server
.RE
.SS "Utility Input/Output Options"
.PP
\fB\-i, \-\-encoding {encoding}\fR
.RS 4
Use the specified character set for command\-line input
.RE
.PP
\fB\-\-noPropertiesFile\fR
.RS 4
No properties file will be used to get default command line argument values
.RE
.PP
\fB\-\-propertiesFilePath {propertiesFilePath}\fR
.RS 4
Path to the file containing default property values used for command line arguments
.RE
.PP
\fB\-v, \-\-verbose\fR
.RS 4
Use verbose mode
.RE
.SS "General Options"
.PP
\fB\-\-version\fR
.RS 4
Display version information
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information
.RE
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
\fIldap\-error\fR
.RS 4
An LDAP error occurred while processing the operation\&.
.sp
LDAP result codes are described in
\m[blue]\fBRFC 4511\fR\m[]\&. Also see the additional information for details\&.
.RE
.PP
89
.RS 4
An error occurred while parsing the command\-line arguments\&.
.RE
.SH "FILES"
.PP
You can use
~/\&.opendj/tools\&.properties
to set the defaults for bind DN, host name, and port number as in the following example\&.
.sp
.if n \{\
.RS 4
.\}
.nf
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
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLES"
.PP
The following example demonstrates use of the command to add an entry to the directory\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ cat newuser\&.ldif 
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

$ ldapmodify \-p 1389 \-a \-f newuser\&.ldif
 \-D uid=kvaughan,ou=people,dc=example,dc=com \-w bribery
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
.fi
.if n \{\
.RE
.\}
.PP
The following example demonstrates adding a Description attribute to the new user\*(Aqs entry\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ cat newdesc\&.ldif 
dn: uid=newuser,ou=People,dc=example,dc=com
changetype: modify
add: description
description: A new user\*(Aqs entry

$ ldapmodify \-p 1389 \-f newdesc\&.ldif
 \-D uid=kvaughan,ou=people,dc=example,dc=com \-w bribery
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
.fi
.if n \{\
.RE
.\}
.PP
The following example demonstrates changing the Description attribute for the new user\*(Aqs entry\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ cat moddesc\&.ldif 
dn: uid=newuser,ou=People,dc=example,dc=com
changetype: modify
replace: description
description: Another description

$ ldapmodify \-p 1389 \-f moddesc\&.ldif
 \-D uid=kvaughan,ou=people,dc=example,dc=com \-w bribery
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
.fi
.if n \{\
.RE
.\}
.PP
The following example demonstrates deleting the new user\*(Aqs entry\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ cat deluser\&.ldif 
dn: uid=newuser,ou=People,dc=example,dc=com
changetype: delete

$ ldapmodify \-p 1389 \-f deluser\&.ldif
 \-D uid=kvaughan,ou=people,dc=example,dc=com \-w bribery
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
.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp

 opends/resource/man/man1/ldappasswordmodify.1

New file
@@ -0,0 +1,305 @@
'\" t
.\"     Title: ldappasswordmodify
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "LDAPPASSWORDMODIFY" "1" "October\ \&20,\ \&2011" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ldappasswordmodify \- perform LDAP password modifications
.SH "SYNOPSIS"
.HP \w'\fBldappasswordmodify\fR\ 'u
\fBldappasswordmodify\fR {options}
.SH "DESCRIPTION"
.PP
This utility can be used to perform LDAP password modify operations in the directory\&.
.SH "OPTIONS"
.PP
The following options are supported\&.
.PP
\fB\-a, \-\-authzID {authzID}\fR
.RS 4
Authorization ID for the user entry whose password should be changed
.sp
The authorization ID is a string having either the prefix
dn:
followed by the user\*(Aqs distinguished name, or the prefix
u:
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
dn:uid=bjensen,ou=People,dc=example,dc=com, and, if we assume that
bjensen
is mapped to Barbara Jensen\*(Aqs entry,
u:bjensen\&.
.RE
.PP
\fB\-c, \-\-currentPassword {currentPassword}\fR
.RS 4
Current password for the target user
.RE
.PP
\fB\-C, \-\-currentPasswordFile {file}\fR
.RS 4
Path to a file containing the current password for the target user
.RE
.PP
\fB\-F, \-\-newPasswordFile {file}\fR
.RS 4
Path to a file containing the new password to provide for the target user
.RE
.PP
\fB\-J, \-\-control {controloid[:criticality[:value|::b64value|:<filePath]]}\fR
.RS 4
Use a request control with the provided information
.RE
.PP
\fB\-n, \-\-newPassword {newPassword}\fR
.RS 4
New password to provide for the target user
.RE
.SS "LDAP Connection Options"
.PP
\fB\-D, \-\-bindDN {bindDN}\fR
.RS 4
DN to use to bind to the server
.sp
Default value: cn=Directory Manager
.RE
.PP
\fB\-E, \-\-reportAuthzID\fR
.RS 4
Use the authorization identity control
.RE
.PP
\fB\-h, \-\-hostname {host}\fR
.RS 4
Directory server hostname or IP address
.sp
Default value: localhost\&.localdomain
.RE
.PP
\fB\-j, \-\-bindPasswordFile {bindPasswordFile}\fR
.RS 4
Bind password file
.RE
.PP
\fB\-K, \-\-keyStorePath {keyStorePath}\fR
.RS 4
Certificate key store path
.RE
.PP
\fB\-N, \-\-certNickname {nickname}\fR
.RS 4
Nickname of certificate for SSL client authentication
.RE
.PP
\fB\-o, \-\-saslOption {name=value}\fR
.RS 4
SASL bind options
.RE
.PP
\fB\-p, \-\-port {port}\fR
.RS 4
Directory server port number
.sp
Default value: 389
.RE
.PP
\fB\-P, \-\-trustStorePath {trustStorePath}\fR
.RS 4
Certificate trust store path
.RE
.PP
\fB\-q, \-\-useStartTLS\fR
.RS 4
Use StartTLS to secure communication with the server
.RE
.PP
\fB\-T, \-\-trustStorePassword {trustStorePassword}\fR
.RS 4
Certificate trust store PIN
.RE
.PP
\fB\-u, \-\-keyStorePasswordFile {keyStorePasswordFile}\fR
.RS 4
Certificate key store PIN file
.RE
.PP
\fB\-U, \-\-trustStorePasswordFile {path}\fR
.RS 4
Certificate trust store PIN file
.RE
.PP
\fB\-\-usePasswordPolicyControl\fR
.RS 4
Use the password policy request control
.RE
.PP
\fB\-V, \-\-ldapVersion {version}\fR
.RS 4
LDAP protocol version number
.sp
Default value: 3
.RE
.PP
\fB\-w, \-\-bindPassword {bindPassword}\fR
.RS 4
Password to use to bind to the server
.RE
.PP
\fB\-W, \-\-keyStorePassword {keyStorePassword}\fR
.RS 4
Certificate key store PIN
.RE
.PP
\fB\-X, \-\-trustAll\fR
.RS 4
Trust all server SSL certificates
.RE
.PP
\fB\-Z, \-\-useSSL\fR
.RS 4
Use SSL for secure communication with the server
.RE
.SS "Utility Input/Output Options"
.PP
\fB\-\-noPropertiesFile\fR
.RS 4
No properties file will be used to get default command line argument values
.RE
.PP
\fB\-\-propertiesFilePath {propertiesFilePath}\fR
.RS 4
Path to the file containing default property values used for command line arguments
.RE
.PP
\fB\-v, \-\-verbose\fR
.RS 4
Use verbose mode
.RE
.SS "General Options"
.PP
\fB\-\-version\fR
.RS 4
Display version information
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information
.RE
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
\fIldap\-error\fR
.RS 4
An LDAP error occurred while processing the operation\&.
.sp
LDAP result codes are described in
\m[blue]\fBRFC 4511\fR\m[]\&. Also see the additional information for details\&.
.RE
.PP
89
.RS 4
An error occurred while parsing the command\-line arguments\&.
.RE
.SH "FILES"
.PP
You can use
~/\&.opendj/tools\&.properties
to set the defaults for bind DN, host name, and port number as in the following example\&.
.sp
.if n \{\
.RS 4
.\}
.nf
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
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLES"
.PP
The following example demonstrates a user changing the password for her entry\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ cat /tmp/currpwd\&.txt /tmp/newpwd\&.txt 
bribery
secret12
$ ldappasswordmodify \-p 1389 \-C /tmp/currpwd\&.txt \-F /tmp/newpwd\&.txt
 \-a "dn:uid=kvaughan,ou=people,dc=example,dc=com"
 \-D uid=kvaughan,ou=people,dc=example,dc=com \-w bribery
The LDAP password modify operation was successful
.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp

 opends/resource/man/man1/ldapsearch.1

New file
@@ -0,0 +1,417 @@
'\" t
.\"     Title: ldapsearch
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "LDAPSEARCH" "1" "October\ \&20,\ \&2011" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ldapsearch \- perform LDAP search operations
.SH "SYNOPSIS"
.HP \w'\fBldapsearch\fR\ 'u
\fBldapsearch\fR {options} [filter] [attributes...]
.SH "DESCRIPTION"
.PP
This utility can be used to perform LDAP search operations in the directory\&.
.PP
In the list of attributes to return, you can specify
*
to return all user attributes,
+
to return all operational attributes, and
@\fIobject\-class\fR
to return all attributes associated with the
\fIobject\-class\fR
such as
@person\&.
.SH "OPTIONS"
.PP
The following options are supported\&.
.PP
\fB\-a, \-\-dereferencePolicy {dereferencePolicy}\fR
.RS 4
Alias dereference policy (\*(Aqnever\*(Aq, \*(Aqalways\*(Aq, \*(Aqsearch\*(Aq, or \*(Aqfind\*(Aq)
.sp
Default value: never
.RE
.PP
\fB\-A, \-\-typesOnly\fR
.RS 4
Only retrieve attribute names but not their values
.RE
.PP
\fB\-\-assertionFilter {filter}\fR
.RS 4
Use the LDAP assertion control with the provided filter
.RE
.PP
\fB\-b, \-\-baseDN {baseDN}\fR
.RS 4
Base DN format string
.RE
.PP
\fB\-c, \-\-continueOnError\fR
.RS 4
Continue processing even if there are errors
.RE
.PP
\fB\-C, \-\-persistentSearch ps[:changetype[:changesonly[:entrychgcontrols]]]\fR
.RS 4
Use the persistent search control
.RE
.PP
\fB\-\-countEntries\fR
.RS 4
Count the number of entries returned by the server
.RE
.PP
\fB\-e, \-\-getEffectiveRightsAttribute {attribute}\fR
.RS 4
Specifies geteffectiverights control specific attribute list
.RE
.PP
\fB\-f, \-\-filename {file}\fR
.RS 4
LDIF file containing the changes to apply
.RE
.PP
\fB\-g, \-\-getEffectiveRightsAuthzid {authzID}\fR
.RS 4
Use geteffectiverights control with the provided authzid
.RE
.PP
\fB\-G, \-\-virtualListView {before:after:index:count | before:after:value}\fR
.RS 4
Use the virtual list view control to retrieve the specified results page
.RE
.PP
\fB\-J, \-\-control {controloid[:criticality[:value|::b64value|:<filePath]]}\fR
.RS 4
Use a request control with the provided information
.RE
.PP
\fB\-l, \-\-timeLimit {timeLimit}\fR
.RS 4
Maximum length of time in seconds to allow for the search
.sp
Default value: 0
.RE
.PP
\fB\-\-matchedValuesFilter {filter}\fR
.RS 4
Use the LDAP matched values control with the provided filter
.RE
.PP
\fB\-n, \-\-dry\-run\fR
.RS 4
Show what would be done but do not perform any operation
.RE
.PP
\fB\-s, \-\-searchScope {searchScope}\fR
.RS 4
Search scope (\*(Aqbase\*(Aq, \*(Aqone\*(Aq, \*(Aqsub\*(Aq, or \*(Aqsubordinate\*(Aq)
.sp
Default value: sub
.sp
subordinate
is an LDAP extension that might not work with all LDAP servers\&.
.RE
.PP
\fB\-S, \-\-sortOrder {sortOrder}\fR
.RS 4
Sort the results using the provided sort order
.RE
.PP
\fB\-\-simplePageSize {numEntries}\fR
.RS 4
Use the simple paged results control with the given page size
.sp
Default value: 1000
.RE
.PP
\fB\-Y, \-\-proxyAs {authzID}\fR
.RS 4
Use the proxied authorization control with the given authorization ID
.RE
.PP
\fB\-z, \-\-sizeLimit {sizeLimit}\fR
.RS 4
Maximum number of entries to return from the search
.sp
Default value: 0
.RE
.SS "LDAP Connection Options"
.PP
\fB\-D, \-\-bindDN {bindDN}\fR
.RS 4
DN to use to bind to the server
.sp
Default value: cn=Directory Manager
.RE
.PP
\fB\-E, \-\-reportAuthzID\fR
.RS 4
Use the authorization identity control
.RE
.PP
\fB\-h, \-\-hostname {host}\fR
.RS 4
Directory server hostname or IP address
.sp
Default value: localhost\&.localdomain
.RE
.PP
\fB\-j, \-\-bindPasswordFile {bindPasswordFile}\fR
.RS 4
Bind password file
.RE
.PP
\fB\-K, \-\-keyStorePath {keyStorePath}\fR
.RS 4
Certificate key store path
.RE
.PP
\fB\-N, \-\-certNickname {nickname}\fR
.RS 4
Nickname of certificate for SSL client authentication
.RE
.PP
\fB\-o, \-\-saslOption {name=value}\fR
.RS 4
SASL bind options
.RE
.PP
\fB\-p, \-\-port {port}\fR
.RS 4
Directory server port number
.sp
Default value: 389
.RE
.PP
\fB\-P, \-\-trustStorePath {trustStorePath}\fR
.RS 4
Certificate trust store path
.RE
.PP
\fB\-q, \-\-useStartTLS\fR
.RS 4
Use StartTLS to secure communication with the server
.RE
.PP
\fB\-T, \-\-trustStorePassword {trustStorePassword}\fR
.RS 4
Certificate trust store PIN
.RE
.PP
\fB\-u, \-\-keyStorePasswordFile {keyStorePasswordFile}\fR
.RS 4
Certificate key store PIN file
.RE
.PP
\fB\-U, \-\-trustStorePasswordFile {path}\fR
.RS 4
Certificate trust store PIN file
.RE
.PP
\fB\-\-usePasswordPolicyControl\fR
.RS 4
Use the password policy request control
.RE
.PP
\fB\-V, \-\-ldapVersion {version}\fR
.RS 4
LDAP protocol version number
.sp
Default value: 3
.RE
.PP
\fB\-w, \-\-bindPassword {bindPassword}\fR
.RS 4
Password to use to bind to the server
.RE
.PP
\fB\-W, \-\-keyStorePassword {keyStorePassword}\fR
.RS 4
Certificate key store PIN
.RE
.PP
\fB\-X, \-\-trustAll\fR
.RS 4
Trust all server SSL certificates
.RE
.PP
\fB\-Z, \-\-useSSL\fR
.RS 4
Use SSL for secure communication with the server
.RE
.SS "Utility Input/Output Options"
.PP
\fB\-i, \-\-encoding {encoding}\fR
.RS 4
Use the specified character set for command\-line input
.RE
.PP
\fB\-\-noPropertiesFile\fR
.RS 4
No properties file will be used to get default command line argument values
.RE
.PP
\fB\-\-propertiesFilePath {propertiesFilePath}\fR
.RS 4
Path to the file containing default property values used for command line arguments
.RE
.PP
\fB\-t, \-\-dontWrap\fR
.RS 4
Do not wrap long lines
.RE
.PP
\fB\-v, \-\-verbose\fR
.RS 4
Use verbose mode
.RE
.SS "General Options"
.PP
\fB\-\-version\fR
.RS 4
Display version information
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information
.RE
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
\fIldap\-error\fR
.RS 4
An LDAP error occurred while processing the operation\&.
.sp
LDAP result codes are described in
\m[blue]\fBRFC 4511\fR\m[]\&. Also see the additional information for details\&.
.RE
.PP
89
.RS 4
An error occurred while parsing the command\-line arguments\&.
.RE
.SH "FILES"
.PP
You can use
~/\&.opendj/tools\&.properties
to set the defaults for bind DN, host name, and port number as in the following example\&.
.sp
.if n \{\
.RS 4
.\}
.nf
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
.fi
.if n \{\
.RE
.\}
.SH "EXAMPLES"
.PP
The following example searches for entries with UID containing
jensen, returning only DNs and uid values\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ ldapsearch \-p 1389 \-b dc=example,dc=com "(uid=*jensen*)" uid
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)
.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp

 opends/resource/man/man1/ldif-diff.1

New file
@@ -0,0 +1,184 @@
'\" t
.\"     Title: ldif-diff
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "LDIF\-DIFF" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ldif-diff \- compare small LDIF files
.SH "SYNOPSIS"
.HP \w'\fBldif\-diff\fR\ 'u
\fBldif\-diff\fR {options}
.SH "DESCRIPTION"
.PP
This utility can be used to compare two LDIF files and report the differences in LDIF format\&.
.SH "OPTIONS"
.PP
The following options are supported\&.
.PP
\fB\-a, \-\-ignoreAttrs {file}\fR
.RS 4
File containing a list of attributes to ignore when computing the difference\&.
.RE
.PP
\fB\-\-checkSchema\fR
.RS 4
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\&.
.RE
.PP
\fB\-e, \-\-ignoreEntries {file}\fR
.RS 4
File containing a list of entries (DN) to ignore when computing the difference\&.
.RE
.PP
\fB\-o, \-\-outputLDIF {file}\fR
.RS 4
File to which the output should be written\&.
.RE
.PP
\fB\-O, \-\-overwriteExisting\fR
.RS 4
Any existing output file should be overwritten rather than appending to it\&.
.RE
.PP
\fB\-s, \-\-sourceLDIF {file}\fR
.RS 4
LDIF file to use as the source data\&.
.RE
.PP
\fB\-S, \-\-singleValueChanges\fR
.RS 4
Each attribute\-level change should be written as a separate modification per attribute value rather than one modification per entry\&.
.RE
.PP
\fB\-t, \-\-targetLDIF {file}\fR
.RS 4
LDIF file to use as the target data\&.
.RE
.PP
\fB\-V, \-\-version\fR
.RS 4
Display version information\&.
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information\&.
.RE
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
> 0
.RS 4
An error occurred\&.
.RE
.SH "EXAMPLES"
.PP
The following example demonstrates use of the command with two small LDIF files\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ cat /path/to/newuser\&.ldif 
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

$ cat /path/to/neweruser\&.ldif 
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\&.

$ ldif\-diff \-s /path/to/newuser\&.ldif \-t /path/to/neweruser\&.ldif
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\&.
.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp

 opends/resource/man/man1/ldifmodify.1

New file
@@ -0,0 +1,161 @@
'\" t
.\"     Title: ldifmodify
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "LDIFMODIFY" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ldifmodify \- apply LDIF changes to LDIF
.SH "SYNOPSIS"
.HP \w'\fBldifmodify\fR\ 'u
\fBldifmodify\fR {options}
.SH "DESCRIPTION"
.PP
This utility can be used to apply a set of modify, add, and delete operations against data in an LDIF file\&.
.SH "OPTIONS"
.PP
The following options are supported\&.
.PP
\fB\-m, \-\-changesLDIF {ldifFile}\fR
.RS 4
LDIF file containing the changes to apply\&.
.RE
.PP
\fB\-s, \-\-sourceLDIF {ldifFile}\fR
.RS 4
LDIF file containing the data to be updated\&.
.RE
.PP
\fB\-t, \-\-targetLDIF {ldifFile}\fR
.RS 4
File to which the updated data should be written\&.
.RE
.PP
\fB\-V, \-\-version\fR
.RS 4
Display version information\&.
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information\&.
.RE
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
> 0
.RS 4
An error occurred\&.
.RE
.SH "EXAMPLES"
.PP
The following example demonstrates use of the command\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ cat /path/to/newuser\&.ldif 
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
  
$ cat /path/to/newdiff\&.ldif 
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\&.

$ ldifmodify \-s /path/to/newuser\&.ldif \-m /path/to/newdiff\&.ldif \-t neweruser\&.ldif
$ cat neweruser\&.ldif 
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

.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp

 opends/resource/man/man1/ldifsearch.1

New file
@@ -0,0 +1,179 @@
'\" t
.\"     Title: ldifsearch
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "LDIFSEARCH" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
ldifsearch \- search LDIF with LDAP filters
.SH "SYNOPSIS"
.HP \w'\fBldifsearch\fR\ 'u
\fBldifsearch\fR {options} [filter] [attribute...]
.SH "DESCRIPTION"
.PP
This utility can be used to perform search operations against data in an LDIF file\&.
.SH "OPTIONS"
.PP
The following options are supported\&.
.PP
\fB\-b, \-\-baseDN {baseDN}\fR
.RS 4
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\&.
.RE
.PP
\fB\-f, \-\-filterFile {filterFile}\fR
.RS 4
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\&.
.RE
.PP
\fB\-l, \-\-ldifFile {ldifFile}\fR
.RS 4
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\&.
.RE
.PP
\fB\-o, \-\-outputFile {outputFile}\fR
.RS 4
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\&.
.RE
.PP
\fB\-O, \-\-overwriteExisting\fR
.RS 4
Any existing output file should be overwritten rather than appending to it\&.
.RE
.PP
\fB\-s, \-\-searchScope {scope}\fR
.RS 4
The scope for the search\&. It must be one of \*(Aqbase\*(Aq, \*(Aqone\*(Aq, \*(Aqsub\*(Aq, or \*(Aqsubordinate\*(Aq\&. If it is not provided, then \*(Aqsub\*(Aq will be used\&.
.RE
.PP
\fB\-t, \-\-timeLimit {timeLimit}\fR
.RS 4
Maximum length of time (in seconds) to spend processing\&.
.sp
Default value: 0
.RE
.PP
\fB\-T, \-\-dontWrap\fR
.RS 4
Long lines should not be wrapped\&.
.RE
.PP
\fB\-V, \-\-version\fR
.RS 4
Display version information\&.
.RE
.PP
\fB\-z, \-\-sizeLimit {sizeLimit}\fR
.RS 4
Maximum number of matching entries to return\&.
.sp
Default value: 0
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information\&.
.RE
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
> 0
.RS 4
An error occurred\&.
.RE
.SH "EXAMPLES"
.PP
The following example demonstrates use of the command\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ ldifsearch \-l /path/to/Example\&.ldif \-b dc=example,dc=com uid=bjensen
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

.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp

 opends/resource/man/man1/list-backends.1

New file
@@ -0,0 +1,128 @@
'\" t
.\"     Title: list-backends
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "LIST\-BACKENDS" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
list-backends \- list OpenDJ backends and base DNs
.SH "SYNOPSIS"
.HP \w'\fBlist\-backends\fR\ 'u
\fBlist\-backends\fR [options]
.SH "DESCRIPTION"
.PP
This utility can be used to list the backends and base DNs configured in the Directory Server\&.
.SH "OPTIONS"
.PP
The following options are supported\&.
.PP
\fB\-b, \-\-baseDN {baseDN}\fR
.RS 4
Base DN for which to list the backend ID\&.
.RE
.PP
\fB\-n, \-\-backendID {backendName}\fR
.RS 4
Backend ID of the backend for which to list the base DNs\&.
.RE
.PP
\fB\-V, \-\-version\fR
.RS 4
Display version information\&.
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information\&.
.RE
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
> 0
.RS 4
An error occurred\&.
.RE
.SH "EXAMPLES"
.sp
.if n \{\
.RS 4
.\}
.nf
$ list\-backends 
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
replicationChanges : dc=replicationChanges
schema             : cn=schema
tasks              : cn=tasks
userRoot           : "dc=example,dc=com"
.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp

 opends/resource/man/man1/make-ldif.1

New file
@@ -0,0 +1,129 @@
'\" t
.\"     Title: make-ldif
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "MAKE\-LDIF" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
make-ldif \- generate test LDIF
.SH "SYNOPSIS"
.HP \w'\fBmake\-ldif\fR\ 'u
\fBmake\-ldif\fR {options}
.SH "DESCRIPTION"
.PP
This utility can be used to generate LDIF data based on a definition in a template file\&.
.SH "OPTIONS"
.PP
The following options are supported\&.
.PP
\fB\-o, \-\-ldifFile {file}\fR
.RS 4
The path to the LDIF file to be written\&.
.RE
.PP
\fB\-s, \-\-randomSeed {seed}\fR
.RS 4
The seed to use to initialize the random number generator\&.
.sp
Default value: 0
.RE
.PP
\fB\-t, \-\-templateFile {file}\fR
.RS 4
The path to the template file with information about the LDIF data to generate\&.
.RE
.PP
\fB\-V, \-\-version\fR
.RS 4
Display version information\&.
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information\&.
.RE
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
> 0
.RS 4
An error occurred\&.
.RE
.SH "EXAMPLES"
.PP
The following example uses the default template to generate LDIF\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ make\-ldif \-t \&.\&./config/MakeLDIF/example\&.template \-o \&.\&./ldif/generated\&.ldif
Processed 1000 entries
Processed 2000 entries
\&.\&.\&.
Processed 10000 entries
LDIF processing complete\&.  10003 entries written
.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp

 opends/resource/man/man1/manage-account.1

New file
@@ -0,0 +1,342 @@
'\" t
.\"     Title: manage-account
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "MANAGE\-ACCOUNT" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
manage-account \- manage state of directory server accounts
.SH "SYNOPSIS"
.HP \w'\fBmanage\-account\fR\fB\fIsubcommand\fR\fR\ 'u
\fBmanage\-account\fR\fB\fIsubcommand\fR\fR {options}
.SH "DESCRIPTION"
.PP
This utility can be used to retrieve and manipulate the values of password policy state variables\&.
.SH "SUBCOMMANDS"
.PP
The following subcommands are supported\&.
.PP
\fBmanage\-account clear\-account\-is\-disabled\fR
.RS 4
Clear account disabled state information from the user account
.RE
.PP
\fBmanage\-account get\-account\-expiration\-time\fR
.RS 4
Display when the user account will expire
.RE
.PP
\fBmanage\-account get\-account\-is\-disabled\fR
.RS 4
Display information about whether the user account has been administratively disabled
.RE
.PP
\fBmanage\-account get\-all\fR
.RS 4
Display all password policy state information for the user
.RE
.PP
\fBmanage\-account get\-authentication\-failure\-times\fR
.RS 4
Display the authentication failure times for the user
.RE
.PP
\fBmanage\-account get\-grace\-login\-use\-times\fR
.RS 4
Display the grace login use times for the user
.RE
.PP
\fBmanage\-account get\-last\-login\-time\fR
.RS 4
Display the time that the user last authenticated to the server
.RE
.PP
\fBmanage\-account get\-password\-changed\-by\-required\-time\fR
.RS 4
Display the required password change time with which the user last complied
.RE
.PP
\fBmanage\-account get\-password\-changed\-time\fR
.RS 4
Display the time that the user\*(Aqs password was last changed
.RE
.PP
\fBmanage\-account get\-password\-expiration\-warned\-time\fR
.RS 4
Display the time that the user first received an expiration warning notice
.RE
.PP
\fBmanage\-account get\-password\-history\fR
.RS 4
Display password history state values for the user
.RE
.PP
\fBmanage\-account get\-password\-is\-reset\fR
.RS 4
Display information about whether the user will be required to change his or her password on the next successful authentication
.RE
.PP
\fBmanage\-account get\-password\-policy\-dn\fR
.RS 4
Display the DN of the password policy for the user
.RE
.PP
\fBmanage\-account get\-remaining\-authentication\-failure\-count\fR
.RS 4
Display the number of remaining authentication failures until the user\*(Aqs account is locked
.RE
.PP
\fBmanage\-account get\-remaining\-grace\-login\-count\fR
.RS 4
Display the number of grace logins remaining for the user
.RE
.PP
\fBmanage\-account get\-seconds\-until\-account\-expiration\fR
.RS 4
Display the length of time in seconds until the user account expires
.RE
.PP
\fBmanage\-account get\-seconds\-until\-authentication\-failure\-unlock\fR
.RS 4
Display the length of time in seconds until the authentication failure lockout expires
.RE
.PP
\fBmanage\-account get\-seconds\-until\-idle\-lockout\fR
.RS 4
Display the length of time in seconds until user\*(Aqs account is locked because it has remained idle for too long
.RE
.PP
\fBmanage\-account get\-seconds\-until\-password\-expiration\fR
.RS 4
Display length of time in seconds until the user\*(Aqs password expires
.RE
.PP
\fBmanage\-account get\-seconds\-until\-password\-expiration\-warning\fR
.RS 4
Display the length of time in seconds until the user should start receiving password expiration warning notices
.RE
.PP
\fBmanage\-account get\-seconds\-until\-password\-reset\-lockout\fR
.RS 4
Display the length of time in seconds until user\*(Aqs account is locked because the user failed to change the password in a timely manner after an administrative reset
.RE
.PP
\fBmanage\-account get\-seconds\-until\-required\-change\-time\fR
.RS 4
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
.RE
.PP
\fBmanage\-account set\-account\-is\-disabled\fR
.RS 4
Specify whether the user account has been administratively disabled
.RE
.SH "GLOBAL OPTIONS"
.PP
The following global options are supported\&.
.PP
\fB\-b, \-\-targetDN {targetDN}\fR
.RS 4
The DN of the user entry for which to get and set password policy state information
.RE
.SS "LDAP Connection Options"
.PP
\fB\-D, \-\-bindDN {bindDN}\fR
.RS 4
DN to use to bind to the server
.sp
Default value: cn=Directory Manager
.RE
.PP
\fB\-h, \-\-hostname {host}\fR
.RS 4
Directory server hostname or IP address
.sp
Default value: localhost\&.localdomain
.RE
.PP
\fB\-j, \-\-bindPasswordFile {bindPasswordFile}\fR
.RS 4
Bind password file
.RE
.PP
\fB\-K, \-\-keyStorePath {keyStorePath}\fR
.RS 4
Certificate key store path
.RE
.PP
\fB\-N, \-\-certNickname {nickname}\fR
.RS 4
Nickname of certificate for SSL client authentication
.RE
.PP
\fB\-o, \-\-saslOption {name=value}\fR
.RS 4
SASL bind options
.RE
.PP
\fB\-p, \-\-port {port}\fR
.RS 4
Directory server administration port number
.sp
Default value: 4444
.RE
.PP
\fB\-P, \-\-trustStorePath {trustStorePath}\fR
.RS 4
Certificate trust store path
.RE
.PP
\fB\-T, \-\-trustStorePassword {trustStorePassword}\fR
.RS 4
Certificate trust store PIN
.RE
.PP
\fB\-u, \-\-keyStorePasswordFile {keyStorePasswordFile}\fR
.RS 4
Certificate key store PIN file
.RE
.PP
\fB\-U, \-\-trustStorePasswordFile {path}\fR
.RS 4
Certificate trust store PIN file
.RE
.PP
\fB\-w, \-\-bindPassword {bindPassword}\fR
.RS 4
Password to use to bind to the server
.RE
.PP
\fB\-W, \-\-keyStorePassword {keyStorePassword}\fR
.RS 4
Certificate key store PIN
.RE
.PP
\fB\-X, \-\-trustAll\fR
.RS 4
Trust all server SSL certificates
.RE
.SS "General Options"
.PP
\fB\-V, \-\-version\fR
.RS 4
Display version information
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information
.RE
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
89
.RS 4
An error occurred while parsing the command\-line arguments\&.
.RE
.SH "EXAMPLES"
.PP
For the following examples, the directory admin user, Kirsten Vaughan, has
ds\-privilege\-name: password\-reset, and the following ACI on
ou=People,dc=example,dc=com\&.
.sp
.if n \{\
.RS 4
.\}
.nf
(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";)
.fi
.if n \{\
.RE
.\}
.PP
The following command locks a user account\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ 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
Account Is Disabled:  true
.fi
.if n \{\
.RE
.\}
.PP
The following command unlocks a user account\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ 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
Account Is Disabled:  false
.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp

 opends/resource/man/man1/manage-tasks.1

New file
@@ -0,0 +1,228 @@
'\" t
.\"     Title: manage-tasks
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "MANAGE\-TASKS" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
manage-tasks \- manage OpenDJ server administration tasks
.SH "SYNOPSIS"
.HP \w'\fBmanage\-tasks\fR\ 'u
\fBmanage\-tasks\fR {options}
.SH "DESCRIPTION"
.PP
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\&.
.SH "OPTIONS"
.PP
The following options are supported\&.
.PP
\fB\-c, \-\-cancel {taskID}\fR
.RS 4
ID of a particular task to cancel
.RE
.PP
\fB\-i, \-\-info {taskID}\fR
.RS 4
ID of a particular task about which this tool will display information
.RE
.PP
\fB\-s, \-\-summary\fR
.RS 4
Print a summary of tasks
.RE
.SS "LDAP Connection Options"
.PP
\fB\-\-connectTimeout {timeout}\fR
.RS 4
Maximum length of time (in milliseconds) that can be taken to establish a connection\&. Use \*(Aq0\*(Aq to specify no time out\&.
.sp
Default value: 30000
.RE
.PP
\fB\-D, \-\-bindDN {bindDN}\fR
.RS 4
DN to use to bind to the server
.sp
Default value: cn=Directory Manager
.RE
.PP
\fB\-h, \-\-hostname {host}\fR
.RS 4
Directory server hostname or IP address
.sp
Default value: localhost\&.localdomain
.RE
.PP
\fB\-j, \-\-bindPasswordFile {bindPasswordFile}\fR
.RS 4
Bind password file
.RE
.PP
\fB\-K, \-\-keyStorePath {keyStorePath}\fR
.RS 4
Certificate key store path
.RE
.PP
\fB\-N, \-\-certNickname {nickname}\fR
.RS 4
Nickname of certificate for SSL client authentication
.RE
.PP
\fB\-o, \-\-saslOption {name=value}\fR
.RS 4
SASL bind options
.RE
.PP
\fB\-p, \-\-port {port}\fR
.RS 4
Directory server administration port number
.sp
Default value: 4444
.RE
.PP
\fB\-P, \-\-trustStorePath {trustStorePath}\fR
.RS 4
Certificate trust store path
.RE
.PP
\fB\-T, \-\-trustStorePassword {trustStorePassword}\fR
.RS 4
Certificate trust store PIN
.RE
.PP
\fB\-u, \-\-keyStorePasswordFile {keyStorePasswordFile}\fR
.RS 4
Certificate key store PIN file
.RE
.PP
\fB\-U, \-\-trustStorePasswordFile {path}\fR
.RS 4
Certificate trust store PIN file
.RE
.PP
\fB\-w, \-\-bindPassword {bindPassword}\fR
.RS 4
Password to use to bind to the server
.RE
.PP
\fB\-W, \-\-keyStorePassword {keyStorePassword}\fR
.RS 4
Certificate key store PIN
.RE
.PP
\fB\-X, \-\-trustAll\fR
.RS 4
Trust all server SSL certificates
.RE
.SS "Utility Input/Output Options"
.PP
\fB\-n, \-\-no\-prompt\fR
.RS 4
Use non\-interactive mode\&. If data in the command is missing, the user is not prompted and the tool will fail
.RE
.PP
\fB\-\-noPropertiesFile\fR
.RS 4
No properties file will be used to get default command line argument values
.RE
.PP
\fB\-\-propertiesFilePath {propertiesFilePath}\fR
.RS 4
Path to the file containing default property values used for command line arguments
.RE
.SS "General Options"
.PP
\fB\-V, \-\-version\fR
.RS 4
Display version information
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information
.RE
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
> 0
.RS 4
An error occurred\&.
.RE
.SH "EXAMPLES"
.PP
The following example demonstrates use of the command with a server that does daily backups at 2:00 AM\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ manage\-tasks \-p 4444 \-h `hostname` \-D "cn=Directory Manager" \-w password \-s

  ID                                Type    Status
  \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-
  example\-backup                    Backup  Recurring
  example\-backup\-20110622020000000  Backup  Waiting on start time
.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp

 opends/resource/man/man1/rebuild-index.1

New file
@@ -0,0 +1,264 @@
'\" t
.\"     Title: rebuild-index
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "REBUILD\-INDEX" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
rebuild-index \- rebuild index after configuration change
.SH "SYNOPSIS"
.HP \w'\fBrebuild\-index\fR\ 'u
\fBrebuild\-index\fR {options}
.SH "DESCRIPTION"
.PP
This utility can be used to rebuild index data within a backend based on the Berkeley DB Java Edition\&.
.SH "OPTIONS"
.PP
The following options are supported\&.
.PP
\fB\-b, \-\-baseDN {baseDN}\fR
.RS 4
Base DN of a backend supporting indexing\&. Rebuild is performed on indexes within the scope of the given base DN\&.
.RE
.PP
\fB\-i, \-\-index {index}\fR
.RS 4
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
\fB\-\-rebuildAll\fR
option\&.
.RE
.PP
\fB\-\-rebuildAll\fR
.RS 4
Rebuild all indexes, including any DN2ID, DN2URI, VLV and extensible indexes\&. Cannot be used with the
\fB\-\-index\fR
option\&.
.RE
.PP
\fB\-\-tmpdirectory {directory}\fR
.RS 4
Path to temporary directory for index scratch files during index rebuilding\&.
.sp
Default value: import\-tmp
.RE
.SS "Task Backend Connection Options"
.PP
\fB\-\-connectTimeout {timeout}\fR
.RS 4
Maximum length of time (in milliseconds) that can be taken to establish a connection\&. Use \*(Aq0\*(Aq to specify no time out\&.
.sp
Default value: 30000
.RE
.PP
\fB\-D, \-\-bindDN {bindDN}\fR
.RS 4
DN to use to bind to the server
.sp
Default value: cn=Directory Manager
.RE
.PP
\fB\-h, \-\-hostname {host}\fR
.RS 4
Directory server hostname or IP address
.sp
Default value: localhost\&.localdomain
.RE
.PP
\fB\-j, \-\-bindPasswordFile {bindPasswordFile}\fR
.RS 4
Bind password file
.RE
.PP
\fB\-K, \-\-keyStorePath {keyStorePath}\fR
.RS 4
Certificate key store path
.RE
.PP
\fB\-N, \-\-certNickname {nickname}\fR
.RS 4
Nickname of certificate for SSL client authentication
.RE
.PP
\fB\-o, \-\-saslOption {name=value}\fR
.RS 4
SASL bind options
.RE
.PP
\fB\-p, \-\-port {port}\fR
.RS 4
Directory server administration port number
.sp
Default value: 4444
.RE
.PP
\fB\-P, \-\-trustStorePath {trustStorePath}\fR
.RS 4
Certificate trust store path
.RE
.PP
\fB\-T, \-\-trustStorePassword {trustStorePassword}\fR
.RS 4
Certificate trust store PIN
.RE
.PP
\fB\-u, \-\-keyStorePasswordFile {keyStorePasswordFile}\fR
.RS 4
Certificate key store PIN file
.RE
.PP
\fB\-U, \-\-trustStorePasswordFile {path}\fR
.RS 4
Certificate trust store PIN file
.RE
.PP
\fB\-w, \-\-bindPassword {bindPassword}\fR
.RS 4
Password to use to bind to the server
.RE
.PP
\fB\-W, \-\-keyStorePassword {keyStorePassword}\fR
.RS 4
Certificate key store PIN
.RE
.PP
\fB\-X, \-\-trustAll\fR
.RS 4
Trust all server SSL certificates
.RE
.SS "Task Scheduling Options"
.PP
\fB\-\-completionNotify {emailAddress}\fR
.RS 4
Email address of a recipient to be notified when the task completes\&. This option may be specified more than once\&.
.RE
.PP
\fB\-\-dependency {taskID}\fR
.RS 4
ID of a task upon which this task depends\&. A task will not start execution until all its dependencies have completed execution\&.
.RE
.PP
\fB\-\-errorNotify {emailAddress}\fR
.RS 4
Email address of a recipient to be notified if an error occurs when this task executes\&. This option may be specified more than once\&.
.RE
.PP
\fB\-\-failedDependencyAction {action}\fR
.RS 4
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\&.
.RE
.PP
\fB\-\-recurringTask {schedulePattern}\fR
.RS 4
Indicates the task is recurring and will be scheduled according to the value argument expressed in crontab(5) compatible time/date pattern\&.
.RE
.PP
\fB\-t, \-\-start {startTime}\fR
.RS 4
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 \*(Aq0\*(Aq 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\&.
.RE
.SS "Utility Input/Output Options"
.PP
\fB\-\-noPropertiesFile\fR
.RS 4
No properties file will be used to get default command line argument values
.RE
.PP
\fB\-\-propertiesFilePath {propertiesFilePath}\fR
.RS 4
Path to the file containing default property values used for command line arguments
.RE
.SS "General Options"
.PP
\fB\-V, \-\-version\fR
.RS 4
Display version information
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information
.RE
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
1
.RS 4
An error occurred while parsing the command\-line arguments\&.
.RE
.SH "EXAMPLES"
.PP
The following example schedules a task to start immediately that rebuilds the
cn
(common name) index\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ rebuild\-index \-p 4444 \-h `hostname` \-D "cn=Directory Manager" \-w password
 \-b dc=example,dc=com \-i cn \-t 0
Rebuild Index task 20110607160349596 scheduled to start Jun 7, 2011 4:03:49 PM
.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp

 opends/resource/man/man1/restore.1

New file
@@ -0,0 +1,256 @@
'\" t
.\"     Title: restore
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "RESTORE" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
restore \- restore OpenDJ directory data backups
.SH "SYNOPSIS"
.HP \w'\fBrestore\fR\ 'u
\fBrestore\fR {options}
.SH "DESCRIPTION"
.PP
This utility can be used to restore a backup of a directory server backend\&.
.SH "OPTIONS"
.PP
The following options are supported\&.
.PP
\fB\-d, \-\-backupDirectory {backupDir}\fR
.RS 4
Path to the target directory for the backup file(s)
.RE
.PP
\fB\-I, \-\-backupID {backupID}\fR
.RS 4
Use the provided identifier for the backup
.RE
.PP
\fB\-l, \-\-listBackups\fR
.RS 4
List available backups in the backup directory
.RE
.PP
\fB\-n, \-\-dry\-run\fR
.RS 4
Verify the contents of the backup but do not restore it
.RE
.SS "Task Backend Connection Options"
.PP
\fB\-\-connectTimeout {timeout}\fR
.RS 4
Maximum length of time (in milliseconds) that can be taken to establish a connection\&. Use \*(Aq0\*(Aq to specify no time out\&.
.sp
Default value: 30000
.RE
.PP
\fB\-D, \-\-bindDN {bindDN}\fR
.RS 4
DN to use to bind to the server
.sp
Default value: cn=Directory Manager
.RE
.PP
\fB\-h, \-\-hostname {host}\fR
.RS 4
Directory server hostname or IP address
.sp
Default value: localhost\&.localdomain
.RE
.PP
\fB\-j, \-\-bindPasswordFile {bindPasswordFile}\fR
.RS 4
Bind password file
.RE
.PP
\fB\-K, \-\-keyStorePath {keyStorePath}\fR
.RS 4
Certificate key store path
.RE
.PP
\fB\-N, \-\-certNickname {nickname}\fR
.RS 4
Nickname of certificate for SSL client authentication
.RE
.PP
\fB\-o, \-\-saslOption {name=value}\fR
.RS 4
SASL bind options
.RE
.PP
\fB\-p, \-\-port {port}\fR
.RS 4
Directory server administration port number
.sp
Default value: 4444
.RE
.PP
\fB\-P, \-\-trustStorePath {trustStorePath}\fR
.RS 4
Certificate trust store path
.RE
.PP
\fB\-T, \-\-trustStorePassword {trustStorePassword}\fR
.RS 4
Certificate trust store PIN
.RE
.PP
\fB\-u, \-\-keyStorePasswordFile {keyStorePasswordFile}\fR
.RS 4
Certificate key store PIN file
.RE
.PP
\fB\-U, \-\-trustStorePasswordFile {path}\fR
.RS 4
Certificate trust store PIN file
.RE
.PP
\fB\-w, \-\-bindPassword {bindPassword}\fR
.RS 4
Password to use to bind to the server
.RE
.PP
\fB\-W, \-\-keyStorePassword {keyStorePassword}\fR
.RS 4
Certificate key store PIN
.RE
.PP
\fB\-X, \-\-trustAll\fR
.RS 4
Trust all server SSL certificates
.RE
.SS "Task Scheduling Options"
.PP
\fB\-\-completionNotify {emailAddress}\fR
.RS 4
Email address of a recipient to be notified when the task completes\&. This option may be specified more than once\&.
.RE
.PP
\fB\-\-dependency {taskID}\fR
.RS 4
ID of a task upon which this task depends\&. A task will not start execution until all its dependencies have completed execution\&.
.RE
.PP
\fB\-\-errorNotify {emailAddress}\fR
.RS 4
Email address of a recipient to be notified if an error occurs when this task executes\&. This option may be specified more than once\&.
.RE
.PP
\fB\-\-failedDependencyAction {action}\fR
.RS 4
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\&.
.RE
.PP
\fB\-\-recurringTask {schedulePattern}\fR
.RS 4
Indicates the task is recurring and will be scheduled according to the value argument expressed in crontab(5) compatible time/date pattern\&.
.RE
.PP
\fB\-t, \-\-start {startTime}\fR
.RS 4
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 \*(Aq0\*(Aq 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\&.
.RE
.SS "Utility Input/Output Options"
.PP
\fB\-\-noPropertiesFile\fR
.RS 4
No properties file will be used to get default command line argument values
.RE
.PP
\fB\-\-propertiesFilePath {propertiesFilePath}\fR
.RS 4
Path to the file containing default property values used for command line arguments
.RE
.SS "General Options"
.PP
\fB\-V, \-\-version\fR
.RS 4
Display version information
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information
.RE
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
1
.RS 4
An error occurred while parsing the command\-line arguments\&.
.RE
.SH "EXAMPLES"
.PP
The following example schedules a restore as a task to begin immediately\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ restore \-p 5444 \-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
.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp

 opends/resource/man/man1/setup.1

New file
@@ -0,0 +1,295 @@
'\" t
.\"     Title: setup
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "SETUP" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
setup \- install OpenDJ directory server
.SH "SYNOPSIS"
.HP \w'\fBsetup\fR\ 'u
\fBsetup\fR [options]
.SH "DESCRIPTION"
.PP
This utility can be used to setup the directory server\&.
.SH "OPTIONS"
.PP
The following options are supported\&.
.PP
\fB\-a, \-\-addBaseEntry\fR
.RS 4
Indicates whether to create the base entry in the directory server database
.RE
.PP
\fB\-\-adminConnectorPort {port}\fR
.RS 4
Port on which the Administration Connector should listen for communication
.sp
Default value: 4444
.RE
.PP
\fB\-b, \-\-baseDN {baseDN}\fR
.RS 4
Base DN for user information in the directory server\&. Multiple base DNs may be provided by using this option multiple times
.sp
Default value: dc=example,dc=com
.RE
.PP
\fB\-d, \-\-sampleData {numEntries}\fR
.RS 4
Specifies that the database should be populated with the specified number of sample entries
.sp
Default value: 0
.RE
.PP
\fB\-D, \-\-rootUserDN {rootUserDN}\fR
.RS 4
DN for the initial root user for the directory server
.sp
Default value: cn=Directory Manager
.RE
.PP
\fB\-\-generateSelfSignedCertificate\fR
.RS 4
Generate a self\-signed certificate that the server should use when accepting SSL\-based connections or performing StartTLS negotiation
.RE
.PP
\fB\-h, \-\-hostname {host}\fR
.RS 4
Directory server host name or IP address that will be used to generate the self\-signed certificate\&. This argument will be taken into account only if the self\-signed certificate argument generateSelfSignedCertificate is specified
.sp
Default value: localhost\&.localdomain
.RE
.PP
\fB\-i, \-\-cli\fR
.RS 4
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
.RE
.PP
\fB\-j, \-\-rootUserPasswordFile {rootUserPasswordFile}\fR
.RS 4
Path to a file containing the password for the initial root user for the directory server
.RE
.PP
\fB\-l, \-\-ldifFile {ldifFile}\fR
.RS 4
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
.RE
.PP
\fB\-N, \-\-certNickname {nickname}\fR
.RS 4
Nickname of the certificate that the server should use when accepting SSL\-based connections or performing StartTLS negotiation
.RE
.PP
\fB\-O, \-\-doNotStart\fR
.RS 4
Do not start the server when the configuration is completed
.RE
.PP
\fB\-p, \-\-ldapPort {port}\fR
.RS 4
Port on which the Directory Server should listen for LDAP communication
.sp
Default value: 389
.RE
.PP
\fB\-q, \-\-enableStartTLS\fR
.RS 4
Enable StartTLS to allow secure communication with the server using the LDAP port
.RE
.PP
\fB\-R, \-\-rejectFile {rejectFile}\fR
.RS 4
Write rejected entries to the specified file
.RE
.PP
\fB\-S, \-\-skipPortCheck\fR
.RS 4
Skip the check to determine whether the specified ports are usable
.RE
.PP
\fB\-\-skipFile {skipFile}\fR
.RS 4
Write skipped entries to the specified file
.RE
.PP
\fB\-u, \-\-keyStorePasswordFile {keyStorePasswordFile}\fR
.RS 4
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
.RE
.PP
\fB\-\-useJavaKeystore {keyStorePath}\fR
.RS 4
Path of a Java Key Store (JKS) containing a certificate to be used as the server certificate
.RE
.PP
\fB\-\-useJCEKS {keyStorePath}\fR
.RS 4
Path of a JCEKS containing a certificate to be used as the server certificate
.RE
.PP
\fB\-\-usePkcs11Keystore\fR
.RS 4
Use a certificate in a PKCS#11 token that the server should use when accepting SSL\-based connections or performing StartTLS negotiation
.RE
.PP
\fB\-\-usePkcs12keyStore {keyStorePath}\fR
.RS 4
Path of a PKCS#12 key store containing the certificate that the server should use when accepting SSL\-based connections or performing StartTLS negotiation
.RE
.PP
\fB\-w, \-\-rootUserPassword {rootUserPassword}\fR
.RS 4
Password for the initial root user for the Directory Server
.RE
.PP
\fB\-W, \-\-keyStorePassword {keyStorePassword}\fR
.RS 4
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
.RE
.PP
\fB\-x, \-\-jmxPort {jmxPort}\fR
.RS 4
Port on which the Directory Server should listen for JMX communication
.sp
Default value: 1689
.RE
.PP
\fB\-Z, \-\-ldapsPort {port}\fR
.RS 4
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
.sp
Default value: 636
.RE
.SS "Utility Input/Output Options"
.PP
\fB\-n, \-\-no\-prompt\fR
.RS 4
Use non\-interactive mode\&. If data in the command is missing, the user is not prompted and the tool will fail
.RE
.PP
\fB\-\-noPropertiesFile\fR
.RS 4
No properties file will be used to get default command line argument values
.RE
.PP
\fB\-\-propertiesFilePath {propertiesFilePath}\fR
.RS 4
Path to the file containing default property values used for command line arguments
.RE
.PP
\fB\-Q, \-\-quiet\fR
.RS 4
Run setup in quiet mode\&. Quiet mode will not output progress information to standard output
.RE
.PP
\fB\-v, \-\-verbose\fR
.RS 4
Use verbose mode
.RE
.SS "General Options"
.PP
\fB\-V, \-\-version\fR
.RS 4
Display version information
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information
.RE
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
> 0
.RS 4
An error occurred\&.
.RE
.SH "EXAMPLES"
.PP
The following command installs OpenDJ directory server, enabling StartTLS and importing 100 example entries without interaction\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ \&./OpenDJ/setup \-\-cli \-b dc=example,dc=com \-d 100 \-D "cn=Directory Manager"
 \-w password \-h `hostname` \-p 1389
 \-\-generateSelfSignedCertificate \-\-enableStartTLS \-n 

OpenDJ 2\&.5\&.0
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
.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp

 opends/resource/man/man1/start-ds.1

New file
@@ -0,0 +1,134 @@
'\" t
.\"     Title: start-ds
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "START\-DS" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
start-ds \- start OpenDJ directory server
.SH "SYNOPSIS"
.HP \w'\fBstart\-ds\fR\ 'u
\fBstart\-ds\fR [options]
.SH "DESCRIPTION"
.PP
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\&.
.SH "OPTIONS"
.PP
The following options are supported\&.
.PP
\fB\-L, \-\-useLastKnownGoodConfig\fR
.RS 4
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\&.
.RE
.PP
\fB\-N, \-\-nodetach\fR
.RS 4
Do not detach from the terminal and continue running in the foreground\&. This option cannot be used with the \-t, \-\-timeout option\&.
.RE
.PP
\fB\-Q, \-\-quiet\fR
.RS 4
Use quiet mode\&.
.RE
.PP
\fB\-s, \-\-systemInfo\fR
.RS 4
Display general system information\&.
.RE
.PP
\fB\-t, \-\-timeout {seconds}\fR
.RS 4
Maximum time (in seconds) to wait before the command returns (the server continues the startup process, regardless)\&. A value of \*(Aq0\*(Aq 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\&.
.sp
Default value: 200
.RE
.PP
\fB\-V, \-\-version\fR
.RS 4
Display version information\&.
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information\&.
.RE
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
> 0
.RS 4
An error occurred\&.
.RE
.SH "EXAMPLES"
.PP
The following command starts the server without displaying information about the startup process\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ start\-ds \-Q
.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp

 opends/resource/man/man1/status.1

New file
@@ -0,0 +1,237 @@
'\" t
.\"     Title: status
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "STATUS" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
status \- display basic OpenDJ server information
.SH "SYNOPSIS"
.HP \w'\fBstatus\fR\ 'u
\fBstatus\fR [options]
.SH "DESCRIPTION"
.PP
This utility can be used to display basic server information\&.
.SH "OPTIONS"
.PP
The following options are supported\&.
.SS "LDAP Connection Options"
.PP
\fB\-\-connectTimeout {timeout}\fR
.RS 4
Maximum length of time (in milliseconds) that can be taken to establish a connection\&. Use \*(Aq0\*(Aq to specify no time out\&.
.sp
Default value: 30000
.RE
.PP
\fB\-D, \-\-bindDN {bindDN}\fR
.RS 4
DN to use to bind to the server
.sp
Default value: cn=Directory Manager
.RE
.PP
\fB\-j, \-\-bindPasswordFile {bindPasswordFile}\fR
.RS 4
Bind password file
.RE
.PP
\fB\-K, \-\-keyStorePath {keyStorePath}\fR
.RS 4
Certificate key store path
.RE
.PP
\fB\-N, \-\-certNickname {nickname}\fR
.RS 4
Nickname of certificate for SSL client authentication
.RE
.PP
\fB\-o, \-\-saslOption {name=value}\fR
.RS 4
SASL bind options
.RE
.PP
\fB\-P, \-\-trustStorePath {trustStorePath}\fR
.RS 4
Certificate trust store path
.RE
.PP
\fB\-T, \-\-trustStorePassword {trustStorePassword}\fR
.RS 4
Certificate trust store PIN
.RE
.PP
\fB\-u, \-\-keyStorePasswordFile {keyStorePasswordFile}\fR
.RS 4
Certificate key store PIN file
.RE
.PP
\fB\-U, \-\-trustStorePasswordFile {path}\fR
.RS 4
Certificate trust store PIN file
.RE
.PP
\fB\-w, \-\-bindPassword {bindPassword}\fR
.RS 4
Password to use to bind to the server
.RE
.PP
\fB\-W, \-\-keyStorePassword {keyStorePassword}\fR
.RS 4
Certificate key store PIN
.RE
.PP
\fB\-X, \-\-trustAll\fR
.RS 4
Trust all server SSL certificates
.RE
.SS "Utility Input/Output Options"
.PP
\fB\-n, \-\-no\-prompt\fR
.RS 4
Use non\-interactive mode\&. If data in the command is missing, the user is not prompted and the tool will fail
.RE
.PP
\fB\-\-noPropertiesFile\fR
.RS 4
No properties file will be used to get default command line argument values
.RE
.PP
\fB\-r, \-\-refresh {period}\fR
.RS 4
When this argument is specified, the status command will display its contents periodically\&. Used to specify the period (in seconds) between two status displays
.RE
.PP
\fB\-s, \-\-script\-friendly\fR
.RS 4
Use script\-friendly mode
.RE
.SS "General Options"
.PP
\fB\-V, \-\-version\fR
.RS 4
Display version information
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information
.RE
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
> 0
.RS 4
An error occurred\&.
.RE
.SH "EXAMPLES"
.sp
.if n \{\
.RS 4
.\}
.nf
$ status \-D "cn=Directory Manager" \-w password

          \-\-\- 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 2\&.5\&.0
Java Version:             1\&.6\&.0_24
Administration Connector: Port 4444 (LDAPS)

          \-\-\- Connection Handlers \-\-\-
Address:Port : Protocol    : State
\-\-\-\-\-\-\-\-\-\-\-\-\-:\-\-\-\-\-\-\-\-\-\-\-\-\-:\-\-\-\-\-\-\-\-\-
\-\-           : LDIF        : Disabled
9989         : 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
.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp

 opends/resource/man/man1/stop-ds.1

New file
@@ -0,0 +1,222 @@
'\" t
.\"     Title: stop-ds
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "STOP\-DS" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
stop-ds \- stop OpenDJ directory server
.SH "SYNOPSIS"
.HP \w'\fBstop\-ds\fR\ 'u
\fBstop\-ds\fR [options]
.SH "DESCRIPTION"
.PP
This utility can be used to request that the directory server stop running or perform a restart\&.
.SH "OPTIONS"
.PP
The following options are supported\&.
.PP
\fB\-r, \-\-stopReason {stopReason}\fR
.RS 4
Reason the server is being stopped or restarted\&.
.RE
.PP
\fB\-R, \-\-restart\fR
.RS 4
Attempt to automatically restart the server once it has stopped\&.
.RE
.PP
\fB\-t, \-\-stopTime {stopTime}\fR
.RS 4
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 \*(Aq0\*(Aq 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\&.
.RE
.PP
\fB\-Y, \-\-proxyAs {authzID}\fR
.RS 4
Use the proxied authorization control with the given authorization ID\&.
.RE
.SS "LDAP Connection Options"
.PP
\fB\-D, \-\-bindDN {bindDN}\fR
.RS 4
DN to use to bind to the server
.RE
.PP
\fB\-h, \-\-hostname {host}\fR
.RS 4
Directory server hostname or IP address
.sp
Default value: 127\&.0\&.0\&.1
.RE
.PP
\fB\-j, \-\-bindPasswordFile {bindPasswordFile}\fR
.RS 4
Bind password file
.RE
.PP
\fB\-K, \-\-keyStorePath {keyStorePath}\fR
.RS 4
Certificate key store path
.RE
.PP
\fB\-N, \-\-certNickname {nickname}\fR
.RS 4
Nickname of certificate for SSL client authentication
.RE
.PP
\fB\-o, \-\-saslOption {name=value}\fR
.RS 4
SASL bind options
.RE
.PP
\fB\-p, \-\-port {port}\fR
.RS 4
Directory server administration port number
.sp
Default value: 4444
.RE
.PP
\fB\-P, \-\-trustStorePath {trustStorePath}\fR
.RS 4
Certificate trust store path
.RE
.PP
\fB\-T, \-\-trustStorePassword {trustStorePassword}\fR
.RS 4
Certificate trust store PIN
.RE
.PP
\fB\-u, \-\-keyStorePasswordFile {keyStorePasswordFile}\fR
.RS 4
Certificate key store PIN file
.RE
.PP
\fB\-U, \-\-trustStorePasswordFile {path}\fR
.RS 4
Certificate trust store PIN file
.RE
.PP
\fB\-w, \-\-bindPassword {bindPassword}\fR
.RS 4
Password to use to bind to the server
.RE
.PP
\fB\-W, \-\-keyStorePassword {keyStorePassword}\fR
.RS 4
Certificate key store PIN
.RE
.PP
\fB\-X, \-\-trustAll\fR
.RS 4
Trust all server SSL certificates
.RE
.SS "Utility Input/Output Options"
.PP
\fB\-\-noPropertiesFile\fR
.RS 4
No properties file will be used to get default command line argument values
.RE
.PP
\fB\-\-propertiesFilePath {propertiesFilePath}\fR
.RS 4
Path to the file containing default property values used for command line arguments
.RE
.PP
\fB\-Q, \-\-quiet\fR
.RS 4
Use quiet mode
.RE
.SS "General Options"
.PP
\fB\-V, \-\-version\fR
.RS 4
Display version information
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information
.RE
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
> 0
.RS 4
An error occurred\&.
.RE
.SH "EXAMPLES"
.PP
The following example restarts OpenDJ directory server\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ stop\-ds \-\-restart
Stopping Server\&.\&.\&.

\&.\&.\&.The Directory Server has started successfully
.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp

 opends/resource/man/man1/unconfigure.1

@@ -1,9 +1,34 @@
'\" te
.\" Copyright (c) 2008, Sun Microsystems Inc. All
.\" Rights Reserved.
.TH unconfigure 1 "December 2008" "1.1" "User Commands"
'\" t
.\"     Title: setup
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "unconfigure" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH NAME
unconfigure \- unconfigures an OpenDS instance that was  installed by using the package installation
unconfigure \- unconfigures an OpenDJ instance that was  installed by using the package installation
.SH SYNOPSIS
.LP
.nf
@@ -13,10 +38,10 @@
.SH DESCRIPTION
.sp
.LP
The \fBunconfigure\fR command ensures that the removal of an OpenDS  package does not leave the host in an inconsistent state. The command stops the  directory server instance, removes the SMF registration, and resets the instance  location. The command does not remove the server instance files themselves.
The \fBunconfigure\fR command ensures that the removal of an OpenDJ package does not leave the host in an inconsistent state. The command stops the  directory server instance, removes the SMF registration, and resets the instance  location. The command does not remove the server instance files themselves.
.sp
.LP
Run the \fBunconfigure\fR command as root before removing the OpenDS  package. Do not run this command if you intend to upgrade the directory server.
Run the \fBunconfigure\fR command as root before removing the OpenDJ package. Do not run this command if you intend to upgrade the directory server.
.sp
.LP
This command is available in the OpenSolaris\u\s-2TM\s+2\d package installation only.
@@ -34,7 +59,7 @@
\fB\fB-?\fR, \fB-H\fR, \fB--help\fR\fR
.ad
.RS 18n
.rt  
.rt
Displays usage information.
.RE

@@ -45,7 +70,7 @@
\fB\fB-V\fR, \fB--version\fR\fR
.ad
.RS 18n
.rt  
.rt
Displays directory server version information.
.RE

@@ -59,8 +84,8 @@
.sp
.in +2
.nf
# /usr/opends/unconfigure 
# pkgrm opends
# /usr/opendj/unconfigure
# pkgrm opendj
.fi
.in -2
.sp
@@ -74,11 +99,34 @@
.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
cw(2.75i) |cw(2.75i)
lw(2.75i) |lw(2.75i)
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
Interface StabilityUncommitted
.TE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp



 opends/resource/man/man1/uninstall.1

New file
@@ -0,0 +1,266 @@
'\" t
.\"     Title: uninstall
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "UNINSTALL" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
uninstall \- remove OpenDJ directory server software
.SH "SYNOPSIS"
.HP \w'\fBuninstall\fR\ 'u
\fBuninstall\fR [options]
.SH "DESCRIPTION"
.PP
This utility can be used to uninstall the directory server\&.
.SH "OPTIONS"
.PP
The following options are supported\&.
.PP
\fB\-a, \-\-remove\-all\fR
.RS 4
Remove all components of the server (this option is not compatible with the rest of remove options)
.RE
.PP
\fB\-b, \-\-backup\-files\fR
.RS 4
Remove backup files
.RE
.PP
\fB\-c, \-\-configuration\-files\fR
.RS 4
Remove configuration files
.RE
.PP
\fB\-d, \-\-databases\fR
.RS 4
Remove database contents
.RE
.PP
\fB\-e, \-\-ldif\-files\fR
.RS 4
Remove LDIF files
.RE
.PP
\fB\-f, \-\-forceOnError\fR
.RS 4
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\&.
.RE
.PP
\fB\-i, \-\-cli\fR
.RS 4
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
.RE
.PP
\fB\-l, \-\-server\-libraries\fR
.RS 4
Remove Server Libraries and Administrative Tools
.RE
.PP
\fB\-L, \-\-log\-files\fR
.RS 4
Remove log files
.RE
.SS "LDAP Connection Options"
.PP
\fB\-\-connectTimeout {timeout}\fR
.RS 4
Maximum length of time (in milliseconds) that can be taken to establish a connection\&. Use \*(Aq0\*(Aq to specify no time out\&.
.sp
Default value: 30000
.RE
.PP
\fB\-h, \-\-referencedHostName {host}\fR
.RS 4
The name of this host (or IP address) as it is referenced in remote servers for replication
.sp
Default value: localhost\&.localdomain
.RE
.PP
\fB\-I, \-\-adminUID {adminUID}\fR
.RS 4
User ID of the Global Administrator to use to bind to the server\&.
.sp
Default value: admin
.RE
.PP
\fB\-j, \-\-bindPasswordFile {bindPasswordFile}\fR
.RS 4
Bind password file
.RE
.PP
\fB\-K, \-\-keyStorePath {keyStorePath}\fR
.RS 4
Certificate key store path
.RE
.PP
\fB\-N, \-\-certNickname {nickname}\fR
.RS 4
Nickname of certificate for SSL client authentication
.RE
.PP
\fB\-o, \-\-saslOption {name=value}\fR
.RS 4
SASL bind options
.RE
.PP
\fB\-P, \-\-trustStorePath {trustStorePath}\fR
.RS 4
Certificate trust store path
.RE
.PP
\fB\-T, \-\-trustStorePassword {trustStorePassword}\fR
.RS 4
Certificate trust store PIN
.RE
.PP
\fB\-u, \-\-keyStorePasswordFile {keyStorePasswordFile}\fR
.RS 4
Certificate key store PIN file
.RE
.PP
\fB\-U, \-\-trustStorePasswordFile {path}\fR
.RS 4
Certificate trust store PIN file
.RE
.PP
\fB\-w, \-\-bindPassword {bindPassword}\fR
.RS 4
Password to use to bind to the server
.RE
.PP
\fB\-W, \-\-keyStorePassword {keyStorePassword}\fR
.RS 4
Certificate key store PIN
.RE
.PP
\fB\-X, \-\-trustAll\fR
.RS 4
Trust all server SSL certificates
.RE
.SS "Utility Input/Output Options"
.PP
\fB\-n, \-\-no\-prompt\fR
.RS 4
Use non\-interactive mode\&. If data in the command is missing, the user is not prompted and the tool will fail
.RE
.PP
\fB\-\-noPropertiesFile\fR
.RS 4
No properties file will be used to get default command line argument values
.RE
.PP
\fB\-\-propertiesFilePath {propertiesFilePath}\fR
.RS 4
Path to the file containing default property values used for command line arguments
.RE
.PP
\fB\-Q, \-\-quiet\fR
.RS 4
Run setup in quiet mode\&. Quiet mode will not output progress information to standard output
.RE
.PP
\fB\-v, \-\-verbose\fR
.RS 4
Use verbose mode
.RE
.SS "General Options"
.PP
\fB\-V, \-\-version\fR
.RS 4
Display version information
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information
.RE
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
> 0
.RS 4
An error occurred\&.
.RE
.SH "EXAMPLES"
.PP
The following command removes OpenDJ directory server without interaction\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ \&./OpenDJ/uninstall \-a \-\-cli \-I admin \-w password \-n

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\&.
$ rm \-rf OpenDJ
.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp

 opends/resource/man/man1/upgrade.1

New file
@@ -0,0 +1,164 @@
'\" t
.\"     Title: upgrade
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "UPGRADE" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
upgrade \- upgrade OpenDJ directory server
.SH "SYNOPSIS"
.HP \w'\fBupgrade\fR\ 'u
\fBupgrade\fR {options}
.SH "DESCRIPTION"
.PP
This utility can be used to upgrade the directory server to a newer version or revert to a previous version\&.
.PP
When using this tool to upgrade the server you should first downloaded an OpenDJ install package (\&.zip) file and specify its location using the \-f/\-\-file option\&. You can also upgrade your server using the Java Web Start version of this tool by visiting the OpenDJ web site at www\&.forgerock\&.org/opendj\&.html\&.
.PP
When using the tool to revert to a previous version you must either indicate that you want to revert to the version before the most recent upgrade using the \-r/\-\-revertMostRecent option or specify the location of a reversion archive using the \-a/\-\-reversionArchive option\&.
.SH "OPTIONS"
.PP
The following options are supported\&.
.PP
\fB\-a, \-\-reversionArchive {directory}\fR
.RS 4
Directory where reversion files are stored\&. This should be one of the child directories of the \*(Aqhistory\*(Aq directory that is created when the upgrade tool is run\&.
.RE
.PP
\fB\-f, \-\-file {file}\fR
.RS 4
Specifies an existing server package (\&.zip) file to which the current build will be upgraded using the command line version of this tool
.RE
.PP
\fB\-r, \-\-revertMostRecent\fR
.RS 4
The installation will be reverted to the state before the most recent upgrade
.RE
.SS "Utility Input/Output Options"
.PP
\fB\-n, \-\-no\-prompt\fR
.RS 4
Use non\-interactive mode\&. If data in the command is missing, the user is not prompted and the tool will fail
.RE
.PP
\fB\-Q, \-\-quiet\fR
.RS 4
Run setup in quiet mode\&. Quiet mode will not output progress information to standard output
.RE
.PP
\fB\-v, \-\-verbose\fR
.RS 4
Use verbose mode
.RE
.SS "General Options"
.PP
\fB\-V, \-\-version\fR
.RS 4
Display version information
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information
.RE
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
> 0
.RS 4
An error occurred\&.
.RE
.SH "EXAMPLES"
.PP
The following example demonstrates upgrade without interaction\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ \&./OpenDJ/upgrade \-f ~/Downloads/OpenDJ\-2\&.5\&.0\&.zip \-n
See
/var/\&.\&.\&./opends\-upgrade\-5650414945123366149\&.log
 for a detailed log of this operation\&.

Initializing Upgrade \&.\&.\&.\&.\&. Done\&.
Calculating Schema Customizations \&.\&.\&.\&.\&. Done\&.
Calculating Configuration Customizations \&.\&.\&.\&.\&. Done\&.
Backing Up Files \&.\&.\&.\&.\&. Done\&.
Upgrading Components \&.\&.\&.\&.\&. Done\&.
Preparing Customizations \&.\&.\&.\&.\&. Done\&.
Applying Configuration Customizations \&.\&.\&.\&.\&. Done\&.
Verifying Upgrade \&.\&.\&.\&.\&. Done\&.
Cleaning Up \&.\&.\&.\&.\&. Done\&.
Recording Upgrade History \&.\&.\&.\&.\&. Done\&.
See /path/to/OpenDJ/history/log for a detailed installation history\&.
QuickUpgrade Completed Successfully\&.  The OpenDJ installation at
/path/to/OpenDJ has now been upgraded to version OpenDJ 2\&.5\&.0 (Build ID:
YYYYMMDDhhmmssZ)\&.

See /var/\&.\&.\&./opends\-upgrade\-5650414945123366149\&.log
 for a detailed log of this operation\&.
.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp

 opends/resource/man/man1/verify-index.1

New file
@@ -0,0 +1,155 @@
'\" t
.\"     Title: verify-index
.\"    Author: Mark Craig
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
.\"      Date: October\ \&20,\ \&2011
.\"    Manual: Tools Reference
.\"    Source: OpenDJ 2.5.0
.\"  Language: English
.\"
.TH "VERIFY\-INDEX" "1" "October\ \&20,\ \&2011" "OpenDJ 2.5.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
verify-index \- check index for consistency or errors
.SH "SYNOPSIS"
.HP \w'\fBverify\-index\fR\ 'u
\fBverify\-index\fR {options}
.SH "DESCRIPTION"
.PP
This utility can be used to ensure that index data is consistent within a backend based on the Berkeley DB Java Edition\&.
.SH "OPTIONS"
.PP
The following options are supported\&.
.PP
\fB\-b, \-\-baseDN {baseDN}\fR
.RS 4
Base DN of a backend supporting indexing\&. Verification is performed on indexes within the scope of the given base DN\&.
.RE
.PP
\fB\-c, \-\-clean\fR
.RS 4
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\&.
.RE
.PP
\fB\-\-countErrors\fR
.RS 4
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)\&.
.RE
.PP
\fB\-i, \-\-index {index}\fR
.RS 4
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\&.
.RE
.SS "General Options"
.PP
\fB\-V, \-\-version\fR
.RS 4
Display version information
.RE
.PP
\fB\-?, \-H, \-\-help\fR
.RS 4
Display usage information
.RE
.SH "EXIT CODES"
.PP
0
.RS 4
The command completed successfully\&.
.RE
.PP
1
.RS 4
An error occurred while parsing the command\-line arguments\&.
.RE
.PP
0\-255
.RS 4
The number of errors in the index, as indicated for the
\fB\-\-countErrors\fR
option\&.
.RE
.SH "EXAMPLES"
.PP
The following example verifies the
cn
(common name) index for completeness and for errors\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ verify\-index \-b dc=example,dc=com \-i cn \-\-clean \-\-countErrors
[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
.fi
.if n \{\
.RE
.\}
.SH "AUTHORS"
.PP
\fBMark Craig\fR
.RS 4
Author.
.RE
.PP
\fBNemanja Lukić\fR
.RS 4
Author.
.RE
.SH "COPYRIGHT"
.br
Copyright \(co 2011 ForgeRock AS
.br
.sp
.RS 4
[IMAGE]
.PP
This work is licensed under the
\m[blue]\fBCreative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License\fR\m[].
.RE
.PP
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.
.PP
Trademarks are the property of their respective owners.
.PP
UNLESS OTHERWISE MUTUALLY AGREED BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
.PP
EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
.sp

 opends/resource/man/man5/opendj.5

File was renamed from opends/resource/man/man5/opends.5
@@ -1,22 +1,23 @@
'\" te
.\" Copyright (c) 2008, Sun Microsystems Inc. All
.\" Rights Reserved.
.TH opends 5 "December 2008" "1.1" "&man5;"
.\" Portions Copyright (c) 2011 ForgeRock AS.
.TH opendj 5 "October 2011" "1.2" "&man5;"
.SH NAME
OpenDS \- a high-performance, highly-extensible,
OpenDJ \- a high-performance, highly-extensible,
LDAPv3 compliant directory server
.SH DESCRIPTION
.sp
.LP
OpenDS is a high-performance, highly-extensible, pure Java directory
OpenDJ is a high-performance, highly-extensible, pure Java directory
server. The server is fully compliant with the LDAPv3 standard, and passes
all of the compliance, interoperability and security tests suites. The 
all of the compliance, interoperability and security tests suites. The
directory server implements most of the standard and experimental LDAP extensions
defined in the IETF as RFCs or Internet-Drafts, ensuring maximum
interoperability with LDAP client applications.
.sp
.LP
The OpenDS software includes a rich set of APIs making the directory
The OpenDJ software includes a rich set of APIs making the directory
server easy to extend. The directory server supports a loosely consistent
multi-master replication model that guarantees high availability of data for
all operations, searches or updates. While theoretically unlimited with regard
@@ -24,7 +25,7 @@
and durable load with four masters.
.sp
.LP
The OpenDS software includes:
The OpenDJ software includes:
.RS +4
.TP
.ie t \(bu
@@ -63,10 +64,10 @@
.TP
.ie t \(bu
.el o
Extensive user documentation at http://docs.opends.org/1.2\&.
Extensive user documentation at http://opendj.forgerock.org/docs.html.
.RE
.LP
Note - 
Note -
.sp
.RS 2
The default settings for the directory server are targeted
@@ -76,8 +77,8 @@
.RE
.sp
.LP
A Sun-supported version of OpenDS is available
at http://wikis.sun.com/display/sunopends/Home\&.
Support for OpenDJ is available from ForgeRock. More information
at http://www.forgerock.com.
.SH USAGE
.sp
.LP
@@ -87,19 +88,20 @@
.TP
.ie t \(bu
.el o
As the root user, run the \fBconfigure\fR 
command to create an instance of the directory server in a specific location, 
As the root user, run the \fBconfigure\fR
command to create an instance of the directory server in a specific location,
running as a specific user. For more information, see the configure (1) man page.
.RE
.RS +4
.TP
.ie t \(bu
.el o
Run the \fBsetup\fR command as this user to 
Run the \fBsetup\fR command as this user to
install and configure the directory server instance. For more information,
see http://docs.opends.org/1.2/page/Setup\&.
see http://opendj.forgerock.org/doc/install-guide/OpenDJ-Install-Guide.html\&.
.RE
.sp
.LP
For additional configuration of the directory server, use the \fBcontrol-panel\fR or the \fBdsconfig\fR command. For more information,
see http://docs.opends.org/1.2/page/ControlPanel and http://docs.opends.org/1.2/page/Dsconfig\&.
see http://opendj.forgerock.org/doc/admin-guide/OpenDJ-Admin-Guide/control-panel-1.html
and http://opendj.forgerock.org/doc/admin-guide/OpenDJ-Admin-Guide/dsconfig-1.html\&.

 opends/resource/servicetag/opends.uuids.properties

@@ -1,10 +1,6 @@
org.opends.server.servicetag.productname=OpenDS 2.4
org.opends.server.servicetag.version=2.4
org.opends.server.servicetag.uuid=urn:uuid:16cff1a9-f950-11de-a671-080020a9ed93
org.opends.server.servicetag.productname=OpenDJ 2.5
org.opends.server.servicetag.version=2.5
org.opends.server.servicetag.uuid=urn:uuid:00450d2d-26b0-3d92-b9e8-f616539697fa
org.opends.server.servicetag.parent=Unknown
org.opends.server.servicetag.parenturn=Unknown
org.opends.server.servicetag.vendor=Opends.org




org.opends.server.servicetag.vendor=Opendj.org

 opends/resource/setup.bat

@@ -24,6 +24,7 @@
rem
rem
rem      Copyright 2006-2010 Sun Microsystems, Inc.
rem      Portions Copyright 2011 ForgeRock AS

setlocal

@@ -59,7 +60,7 @@
goto callJava

:invalidPath
echo Error: The current path contains a %% character.  OpenDS cannot
echo Error: The current path contains a %% character.  OpenDJ cannot
echo        be installed on a path containing this character.
pause
goto end

 opends/resource/webstart/create-webstart-standalone.sh

@@ -3,7 +3,7 @@
GREP="/usr/bin/grep"

# Determine the location to this script so that we know where we are in the
# OpenDS source tree.
# OpenDJ source tree.
cd "`dirname $0`"
SCRIPT_DIR=`pwd`
cd ../..
@@ -12,7 +12,7 @@
echo "ROOT_DIR:       ${ROOT_DIR}"

if test -z "${PRODUCT_FILE}"
then 
then
  PRODUCT_FILE="${ROOT_DIR}/PRODUCT"
fi
echo "PRODUCT_FILE:   ${PRODUCT_FILE}"
@@ -92,7 +92,7 @@
  exit 1
fi

# Make sure that the OpenDS build directory exists.  If not, then create it.
# Make sure that the OpenDJ build directory exists.  If not, then create it.

if test -z "${BUILD_DIR}"
then
@@ -115,7 +115,7 @@
fi


# Determine what the name should be for the OpenDS zip file name, but without
# Determine what the name should be for the OpenDJ zip file name, but without
# the ".zip" extension.
ZIP_FILEPATH=`ls ${BUILD_DIR}/package/${PRODUCT_NAME}*.zip`
ZIP_FILENAME=`basename ${ZIP_FILEPATH}`
@@ -137,12 +137,12 @@
find "${INSTALL_DIR}/images" -type d -name '.svn' -exec rm -rf {} \;


# Copy the appropriate OpenDS library files and make sure they are signed.
# Copy the appropriate OpenDJ library files and make sure they are signed.
PKG_LIB_DIR="${BUILD_DIR}/package/${ZIP_FILENAME_BASE}/lib"
CERT_KEYSTORE="${ROOT_DIR}/tests/unit-tests-testng/resource/server.keystore"
CERT_KEYSTORE_PIN="password"
CERT_ALIAS="server-cert"
for LIBFILE in ${PRODUCT_NAME}.jar je.jar quicksetup.jar 
for LIBFILE in ${PRODUCT_NAME}.jar je.jar quicksetup.jar
do
  echo "Signing ${LIBFILE} ..."
  cp "${PKG_LIB_DIR}/${LIBFILE}" "${INSTALL_DIR}/lib"
@@ -195,11 +195,11 @@
    <property name="org.opends.quicksetup.lazyjarurls" value="${INSTALLER_URI}/lib/${PRODUCT_NAME}.jar ${INSTALLER_URI}/lib/zipped.jar ${INSTALLER_URI}/lib/je.jar" />
    <property name="org.opends.quicksetup.zipfilename" value="${ZIP_FILENAME_BASE}.zip"/>
  </resources>
  

  <resources os="AIX">
    <j2se version="1.6+"/>
  </resources>
  

  <application-desc main-class="org.opends.quicksetup.SplashScreen"/>
</jnlp>
ENDOFINSTALLJNLP