From 8f0a6f05316142870200716a59553dbd37a677b0 Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Fri, 06 Feb 2015 12:10:33 +0000
Subject: [PATCH] CR-5987 OPENDJ-1784 Move reference content to reference document
---
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-list-backends.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-privileges-acis.xml | 6
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-base64.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-ldappasswordmodify.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-uninstall.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-install-gui.xml | 4
opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-tuning.xml | 8
opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/preface.xml | 18 -
opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-admin-tools.xml | 64 +++---
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/appendix-standards.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/appendix-interface-stability.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-rest-operations.xml | 20 +-
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-export-ldif.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/appendix-rest2ldap.xml | 4
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-ldapsearch.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-indexing.xml | 10
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-dbtest.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-ldapdelete.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/index.xml | 146 ++++++++++++++++
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-start-ds.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-ldif-diff.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/appendix-extended-ops.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-ldapcompare.xml | 0
opendj-sdk/opendj3-server-dev/src/site/site.xml | 1
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-create-rc-script.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-import-export.xml | 20 +-
opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-server-process.xml | 8
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-restore.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-dsconfig.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-make-ldif.xml | 6
opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-account-lockout.xml | 8
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-status.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-ldapmodify.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-dsreplication.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-ldifmodify.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-rebuild-index.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-monitoring.xml | 12
opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-backup-restore.xml | 6
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-ldifsearch.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-uninstall.xml | 2
opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-pwd-policy.xml | 6
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-upgrade.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/appendix-file-layout.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-verify-index.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-backup.xml | 0
opendj-sdk/opendj3-server-dev/src/site/xdoc/docs.xml | 6
opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-ldap-operations.xml | 16
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-setup.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-connection-handlers.xml | 8
opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-install-cli.xml | 8
opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-replication.xml | 6
opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-understanding-ldap.xml | 6
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/appendix-ports-used.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-upgrade.xml | 4
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-stop-ds.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-make-ldif-template.xml | 6
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-dsjavaproperties.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-manage-tasks.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/index.xml | 76 -------
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-control-panel.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-encode-password.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/appendix-l10n.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-manage-account.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/appendix-controls.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/preface.xml | 55 ++++++
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-import-ldif.xml | 0
opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-windows-service.xml | 0
67 files changed, 341 insertions(+), 199 deletions(-)
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-account-lockout.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-account-lockout.xml
index 73c156b..902ab6c 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-account-lockout.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-account-lockout.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011-2014 ForgeRock AS
+ ! Copyright 2011-2015 ForgeRock AS.
!
-->
<chapter xml:id='chap-account-lockout'
@@ -57,13 +57,13 @@
This chapter shows you how to set up account lockout policies by using the
<link
xlink:show="new"
- xlink:href="admin-guide#dsconfig-1"
+ xlink:href="reference#dsconfig-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>dsconfig</command></link> command,
and how to intervene manually to lock and unlock accounts by using the
<link
xlink:show="new"
- xlink:href="admin-guide#manage-account-1"
+ xlink:href="reference#manage-account-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>manage-account</command></link> command.
</para>
@@ -244,7 +244,7 @@
automatically scan entries to send password expiry notifications. OpenDJ does
implement controls that you can pass in an LDAP search to determine whether a
user's password is about to expire. See the appendix on
- <link xlink:href="admin-guide#appendix-controls" xlink:show="new"
+ <link xlink:href="reference#appendix-controls" xlink:show="new"
xlink:role="http://docbook.org/xlink/role/olink"><citetitle>LDAP
Controls</citetitle></link> for a list. You can send notifications then
based on the results of your search.</para>
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-admin-tools.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-admin-tools.xml
index 88a5208..3ff3e70 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-admin-tools.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-admin-tools.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011-2014 ForgeRock AS
+ ! Copyright 2011-2015 ForgeRock AS.
!
-->
<chapter xml:id='chap-admin-tools'
@@ -61,7 +61,7 @@
Start OpenDJ Control Panel by running the
<link
xlink:show="new"
- xlink:href="admin-guide#control-panel-1"
+ xlink:href="reference#control-panel-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>control-panel</command></link> command.
</para>
@@ -240,14 +240,14 @@
<variablelist>
<varlistentry>
- <term><link xlink:href="admin-guide#backup-1"
+ <term><link xlink:href="reference#backup-1"
xlink:role="http://docbook.org/xlink/role/olink">backup</link></term>
<listitem>
<para>Backup or schedule backup of directory data.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><link xlink:href="admin-guide#base64-1"
+ <term><link xlink:href="reference#base64-1"
xlink:role="http://docbook.org/xlink/role/olink">base64</link></term>
<listitem>
<para>Encode and decode data in base64 format.</para>
@@ -256,7 +256,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><link xlink:href="admin-guide#create-rc-script-1"
+ <term><link xlink:href="reference#create-rc-script-1"
xlink:role="http://docbook.org/xlink/role/olink">create-rc-script</link>
(UNIX)</term>
<listitem>
@@ -266,14 +266,14 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><link xlink:href="admin-guide#dbtest-1"
+ <term><link xlink:href="reference#dbtest-1"
xlink:role="http://docbook.org/xlink/role/olink">dbtest</link></term>
<listitem>
<para>Debug JE databases.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><link xlink:href="admin-guide#dsconfig-1"
+ <term><link xlink:href="reference#dsconfig-1"
xlink:role="http://docbook.org/xlink/role/olink">dsconfig</link></term>
<listitem>
<para>The <command>dsconfig</command> command is the primary command-line
@@ -291,7 +291,7 @@
useful when you have many <command>dsconfig</command> commands to run
and want to avoid starting the JVM and setting up a new connection for
each command.</para>
- <para>In addition to the <link xlink:href="admin-guide#dsconfig-1"
+ <para>In addition to the <link xlink:href="reference#dsconfig-1"
xlink:role="http://docbook.org/xlink/role/olink">dsconfig</link> reference
that covers subcommands, the <link xlink:show="new"
xlink:href="${configRefBase}"
@@ -301,7 +301,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><link xlink:href="admin-guide#dsjavaproperties-1"
+ <term><link xlink:href="reference#dsjavaproperties-1"
xlink:role="http://docbook.org/xlink/role/olink">dsjavaproperties</link></term>
<listitem>
<para>Apply changes you make to
@@ -310,7 +310,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><link xlink:href="admin-guide#dsreplication-1"
+ <term><link xlink:href="reference#dsreplication-1"
xlink:role="http://docbook.org/xlink/role/olink">dsreplication</link></term>
<listitem>
<para>Configure data replication between directory servers to keep their
@@ -318,7 +318,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><link xlink:href="admin-guide#encode-password-1"
+ <term><link xlink:href="reference#encode-password-1"
xlink:role="http://docbook.org/xlink/role/olink">encode-password</link></term>
<listitem>
<para>Encode a clear text password according to one of the available
@@ -326,7 +326,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><link xlink:href="admin-guide#export-ldif-1"
+ <term><link xlink:href="reference#export-ldif-1"
xlink:role="http://docbook.org/xlink/role/olink">export-ldif</link></term>
<listitem>
<para>Export directory data to LDAP Data Interchange Format, a standard,
@@ -334,7 +334,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><link xlink:href="admin-guide#import-ldif-1"
+ <term><link xlink:href="reference#import-ldif-1"
xlink:role="http://docbook.org/xlink/role/olink">import-ldif</link></term>
<listitem>
<para>Load LDIF content into the directory, overwriting existing
@@ -342,7 +342,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><link xlink:href="admin-guide#ldapcompare-1"
+ <term><link xlink:href="reference#ldapcompare-1"
xlink:role="http://docbook.org/xlink/role/olink">ldapcompare</link></term>
<listitem>
<para>Compare the attribute values you specify with those stored on
@@ -350,7 +350,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><link xlink:href="admin-guide#ldapdelete-1"
+ <term><link xlink:href="reference#ldapdelete-1"
xlink:role="http://docbook.org/xlink/role/olink">ldapdelete</link></term>
<listitem>
<para>Delete one entry or an entire branch of subordinate entries in the
@@ -358,7 +358,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><link xlink:href="admin-guide#ldapmodify-1"
+ <term><link xlink:href="reference#ldapmodify-1"
xlink:role="http://docbook.org/xlink/role/olink">ldapmodify</link></term>
<listitem>
<para>Modify the specified attribute values for the specified
@@ -368,14 +368,14 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><link xlink:href="admin-guide#ldappasswordmodify-1"
+ <term><link xlink:href="reference#ldappasswordmodify-1"
xlink:role="http://docbook.org/xlink/role/olink">ldappasswordmodify</link></term>
<listitem>
<para>Modify user passwords.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><link xlink:href="admin-guide#ldapsearch-1"
+ <term><link xlink:href="reference#ldapsearch-1"
xlink:role="http://docbook.org/xlink/role/olink">ldapsearch</link></term>
<listitem>
<para>Search a branch of directory data for entries matching the LDAP
@@ -383,7 +383,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><link xlink:href="admin-guide#ldif-diff-1"
+ <term><link xlink:href="reference#ldif-diff-1"
xlink:role="http://docbook.org/xlink/role/olink">ldif-diff</link></term>
<listitem>
<para>Display differences between two LDIF files, with the resulting output
@@ -391,7 +391,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><link xlink:href="admin-guide#ldifmodify-1"
+ <term><link xlink:href="reference#ldifmodify-1"
xlink:role="http://docbook.org/xlink/role/olink">ldifmodify</link></term>
<listitem>
<para>Similar to the <command>ldapmodify</command> command, modify
@@ -399,7 +399,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><link xlink:href="admin-guide#ldifsearch-1"
+ <term><link xlink:href="reference#ldifsearch-1"
xlink:role="http://docbook.org/xlink/role/olink">ldifsearch</link></term>
<listitem>
<para>Similar to the <command>ldapsearch</command> command, search a branch
@@ -407,14 +407,14 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><link xlink:href="admin-guide#list-backends-1"
+ <term><link xlink:href="reference#list-backends-1"
xlink:role="http://docbook.org/xlink/role/olink">list-backends</link></term>
<listitem>
<para>List backends and base DNs served by OpenDJ.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><link xlink:href="admin-guide#make-ldif-1"
+ <term><link xlink:href="reference#make-ldif-1"
xlink:role="http://docbook.org/xlink/role/olink">make-ldif</link></term>
<listitem>
<para>Generate directory data in LDIF, based on templates that define how
@@ -425,7 +425,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><link xlink:href="admin-guide#manage-account-1"
+ <term><link xlink:href="reference#manage-account-1"
xlink:role="http://docbook.org/xlink/role/olink">manage-account</link></term>
<listitem>
<para>Lock and unlock user accounts, and view and manipulate password
@@ -433,7 +433,7 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><link xlink:href="admin-guide#manage-tasks-1"
+ <term><link xlink:href="reference#manage-tasks-1"
xlink:role="http://docbook.org/xlink/role/olink">manage-tasks</link></term>
<listitem>
<para>View information about tasks scheduled to run in the server, and
@@ -441,49 +441,49 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><link xlink:href="admin-guide#rebuild-index-1"
+ <term><link xlink:href="reference#rebuild-index-1"
xlink:role="http://docbook.org/xlink/role/olink">rebuild-index</link></term>
<listitem>
<para>Rebuild an index stored in a JE backend.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><link xlink:href="admin-guide#restore-1"
+ <term><link xlink:href="reference#restore-1"
xlink:role="http://docbook.org/xlink/role/olink">restore</link></term>
<listitem>
<para>Restore user data from backup.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><link xlink:href="admin-guide#start-ds-1"
+ <term><link xlink:href="reference#start-ds-1"
xlink:role="http://docbook.org/xlink/role/olink">start-ds</link></term>
<listitem>
<para>Start OpenDJ directory server.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><link xlink:href="admin-guide#status-1"
+ <term><link xlink:href="reference#status-1"
xlink:role="http://docbook.org/xlink/role/olink">status</link></term>
<listitem>
<para>Display information about the server.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><link xlink:href="admin-guide#stop-ds-1"
+ <term><link xlink:href="reference#stop-ds-1"
xlink:role="http://docbook.org/xlink/role/olink">stop-ds</link></term>
<listitem>
<para>Stop OpenDJ directory server.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><link xlink:href="admin-guide#verify-index-1"
+ <term><link xlink:href="reference#verify-index-1"
xlink:role="http://docbook.org/xlink/role/olink">verify-index</link></term>
<listitem>
<para>Verify that an index stored in a JE backend is not corrupt.</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><link xlink:href="admin-guide#windows-service"
+ <term><link xlink:href="reference#windows-service"
xlink:role="http://docbook.org/xlink/role/olink">windows-service</link>
(Windows only)</term>
<listitem>
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-backup-restore.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-backup-restore.xml
index 898d57a..6d14bf4 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-backup-restore.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-backup-restore.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011-2014 ForgeRock AS
+ ! Copyright 2011-2015 ForgeRock AS.
!
-->
<chapter xml:id='chap-backup-restore'
@@ -86,7 +86,7 @@
you run the
<link
xlink:show="new"
- xlink:href="admin-guide#backup-1"
+ xlink:href="reference#backup-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>backup</command></link> command
without connecting to the server, authenticating, or requesting a backup task.
@@ -244,7 +244,7 @@
To restore data when OpenDJ is stopped, you run the
<link
xlink:show="new"
- xlink:href="admin-guide#restore-1"
+ xlink:href="reference#restore-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>restore</command></link> command
without connecting to the server, authenticating, or requesting a restore task.
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-connection-handlers.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-connection-handlers.xml
index f3f36f0..5767402 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-connection-handlers.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-connection-handlers.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011-2014 ForgeRock AS
+ ! Copyright 2011-2015 ForgeRock AS.
!
-->
<chapter xml:id='chap-connection-handlers'
@@ -38,7 +38,7 @@
and update the configuration using the
<link
xlink:show="new"
- xlink:href="admin-guide#dsconfig-1"
+ xlink:href="reference#dsconfig-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>dsconfig</command></link> command.
</para>
@@ -1194,7 +1194,7 @@
by editing the configuration file for the HTTP connection handler, by
default <filename>/path/to/opendj/config/http-config.json</filename>. The
configuration is described in the appendix, <link xlink:show="new"
- xlink:href="admin-guide#appendix-rest2ldap"
+ xlink:href="reference#appendix-rest2ldap"
xlink:role="http://docbook.org/xlink/role/olink"><citetitle>REST LDAP
Configuration</citetitle></link>. The default mapping works out of the box
with Example.com data generated as part of the setup process and with
@@ -1377,7 +1377,7 @@
<step>
<para>Adjust the configuration for your directory service as described in
- <link xlink:href="admin-guide#appendix-rest2ldap"
+ <link xlink:href="reference#appendix-rest2ldap"
xlink:role="http://docbook.org/xlink/role/olink"><citetitle>REST LDAP
Configuration</citetitle></link>.</para>
</step>
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-import-export.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-import-export.xml
index 2016f86..28c1a5f 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-import-export.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-import-export.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011-2014 ForgeRock AS
+ ! Copyright 2011-2015 ForgeRock AS.
!
-->
<chapter xml:id='chap-import-export'
@@ -66,7 +66,7 @@
This procedure demonstrates how to generate LDIF by using the
<link
xlink:show="new"
- xlink:href="admin-guide#make-ldif-1"
+ xlink:href="reference#make-ldif-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>make-ldif</command></link> command.
</para>
@@ -94,7 +94,7 @@
<filename>OpenDJ/config/MakeLDIF/example.template</filename>, and
associated data.</para>
- <para>See <link xlink:href="admin-guide#make-ldif-template-5"
+ <para>See <link xlink:href="reference#make-ldif-template-5"
xlink:role="http://docbook.org/xlink/role/olink" xlink:show="new"><citetitle
>make-ldif.template</citetitle></link> for reference information about
template files.</para>
@@ -144,12 +144,12 @@
The following procedures demonstrate how to use the
<link
xlink:show="new"
- xlink:href="admin-guide#import-ldif-1"
+ xlink:href="reference#import-ldif-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>import-ldif</command></link> and
<link
xlink:show="new"
- xlink:href="admin-guide#export-ldif-1"
+ xlink:href="reference#export-ldif-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>export-ldif</command></link> commands.
</para>
@@ -268,17 +268,17 @@
This section demonstrates the
<link
xlink:show="new"
- xlink:href="admin-guide#ldifsearch-1"
+ xlink:href="reference#ldifsearch-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>ldifsearch</command></link>,
<link
xlink:show="new"
- xlink:href="admin-guide#ldifmodify-1"
+ xlink:href="reference#ldifmodify-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>ldifmodify</command></link> and
<link
xlink:show="new"
- xlink:href="admin-guide#ldif-diff-1"
+ xlink:href="reference#ldif-diff-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>ldif-diff</command></link> commands.
</para>
@@ -380,7 +380,7 @@
You can create new backends using the
<link
xlink:show="new"
- xlink:href="admin-guide#dsconfig-create-backend"
+ xlink:href="reference#dsconfig-create-backend"
xlink:role="http://docbook.org/xlink/role/olink"
><command>dsconfig create-backend</command></link> command.
The following example creates a local backend named <literal>testData</literal>.
@@ -621,7 +621,7 @@
You delete a database backend by using the
<link
xlink:show="new"
- xlink:href="admin-guide#dsconfig-delete-backend"
+ xlink:href="reference#dsconfig-delete-backend"
xlink:role="http://docbook.org/xlink/role/olink"
><command>dsconfig delete-backend</command></link> command.
</para>
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-indexing.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-indexing.xml
index 0faba8c..245a69d 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-indexing.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-indexing.xml
@@ -389,14 +389,14 @@
You modify index configurations by using the
<link
xlink:show="new"
- xlink:href="admin-guide#dsconfig-1"
+ xlink:href="reference#dsconfig-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>dsconfig</command></link> command.
The configuration changes then take effect
after you rebuild the index according to the new configuration, using the
<link
xlink:show="new"
- xlink:href="admin-guide#rebuild-index-1"
+ xlink:href="reference#rebuild-index-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>rebuild-index</command></link> command.
The <command>dsconfig --help-database</command> command lists subcommands
@@ -640,7 +640,7 @@
Start by testing the index status by using the
<link
xlink:show="new"
- xlink:href="admin-guide#dbtest-1"
+ xlink:href="reference#dbtest-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>dbtest</command></link> command.
The final column show in the output is the Index Valid column,
@@ -776,7 +776,7 @@
<para>
For an explanation of the output
of the <command>dbtest list-index-status</command> command, see
- <link xlink:show="new" xlink:href="admin-guide#dbtest-1"
+ <link xlink:show="new" xlink:href="reference#dbtest-1"
xlink:role="http://docbook.org/xlink/role/olink">dbtest(1)</link>.
</para>
@@ -844,7 +844,7 @@
and that indexes do not contain errors by using the
<link
xlink:show="new"
- xlink:href="admin-guide#verify-index-1"
+ xlink:href="reference#verify-index-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>verify-index</command></link> command.
</para>
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-ldap-operations.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-ldap-operations.xml
index ae745f9..29d5424 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-ldap-operations.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-ldap-operations.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011-2014 ForgeRock AS
+ ! Copyright 2011-2015 ForgeRock AS.
!
-->
<chapter xml:id='chap-ldap-operations'
@@ -63,7 +63,7 @@
The
<link
xlink:show="new"
- xlink:href="admin-guide#ldapsearch-1"
+ xlink:href="reference#ldapsearch-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>ldapsearch</command></link> command
thus takes at minimum a search base DN option and an LDAP filter.
@@ -372,7 +372,7 @@
<title>Search: Language Subtype</title>
<para>OpenDJ directory server supports many language subtypes. See the
- chapter on <link xlink:href="admin-guide#appendix-l10n"
+ chapter on <link xlink:href="reference#appendix-l10n"
xlink:role="http://docbook.org/xlink/role/olink"
><citetitle>Localization</citetitle></link> for a list.</para>
@@ -437,7 +437,7 @@
In this example, Kirsten Vaughan uses the
<link
xlink:show="new"
- xlink:href="admin-guide#ldapcompare-1"
+ xlink:href="reference#ldapcompare-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>ldapcompare</command></link> command
to check whether the hashed password value matches the stored value
@@ -471,7 +471,7 @@
You can use the
<link
xlink:show="new"
- xlink:href="admin-guide#ldapmodify-1"
+ xlink:href="reference#ldapmodify-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>ldapmodify</command></link> command to make changes.
</para>
@@ -616,7 +616,7 @@
<para>OpenDJ offers a couple of features to help you in this situation.
One of the features is the <link
xlink:role="http://docbook.org/xlink/role/olink"
- xlink:href="admin-guide#assertion-request-control">LDAP Assertion
+ xlink:href="reference#assertion-request-control">LDAP Assertion
Control</link>, used to tell OpenDJ to perform the modify only if
an assertion you make stays true. The other feature is OpenDJ's support
for <link xlink:href="http://tools.ietf.org/html/rfc2616#section-3.11"
@@ -1020,7 +1020,7 @@
With the
<link
xlink:show="new"
- xlink:href="admin-guide#ldappasswordmodify-1"
+ xlink:href="reference#ldappasswordmodify-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>ldappasswordmodify</command></link> command,
authorized users can change and reset user passwords.
@@ -1098,7 +1098,7 @@
You could also accomplish password reset with the
<link
xlink:show="new"
- xlink:href="admin-guide#manage-account-1"
+ xlink:href="reference#manage-account-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>manage-account</command></link> command,
although <command>set-password-is-reset</command> is a hidden option,
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-monitoring.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-monitoring.xml
index 693195e..27a789e 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-monitoring.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-monitoring.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011-2014 ForgeRock AS
+ ! Copyright 2011-2015 ForgeRock AS.
!
-->
<chapter xml:id='chap-monitoring'
@@ -49,7 +49,7 @@
exposed. The following example shows monitoring information about the
<literal>userRoot</literal> backend holding Example.com data.</para>
- <para>Interface stability: <link xlink:href="admin-guide#interface-stability"
+ <para>Interface stability: <link xlink:href="reference#interface-stability"
xlink:show="new" xlink:role="http://docbook.org/xlink/role/olink"
>Evolving</link></para>
@@ -199,7 +199,7 @@
<command>dsconfig</command> command to configure the JMX connection
handler.</para>
- <para>Interface stability: <link xlink:href="admin-guide#interface-stability"
+ <para>Interface stability: <link xlink:href="reference#interface-stability"
xlink:show="new" xlink:role="http://docbook.org/xlink/role/olink"
>Evolving</link></para>
@@ -257,7 +257,7 @@
The
<link
xlink:show="new"
- xlink:href="admin-guide#status-1"
+ xlink:href="reference#status-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>status</command></link> command
displays basic information about the local server,
@@ -265,7 +265,7 @@
The
<link
xlink:show="new"
- xlink:href="admin-guide#manage-tasks-1"
+ xlink:href="reference#manage-tasks-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>manage-tasks</command></link> command
lets you manage tasks scheduled on a server, such as nightly backup.
@@ -412,7 +412,7 @@
>Microsoft's implementation</link> as well. The following default
fields are shown here in the order they occur in the log file.</para>
- <para>Interface stability: <link xlink:href="admin-guide#interface-stability"
+ <para>Interface stability: <link xlink:href="reference#interface-stability"
xlink:show="new" xlink:role="http://docbook.org/xlink/role/olink"
>Evolving</link></para>
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-privileges-acis.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-privileges-acis.xml
index f5d1190..b78554f 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-privileges-acis.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-privileges-acis.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011-2015 ForgeRock AS
+ ! Copyright 2011-2015 ForgeRock AS.
!
-->
<chapter xml:id='chap-privileges-acis'
@@ -902,7 +902,7 @@
you configure privileges using the
<link
xlink:show="new"
- xlink:href="admin-guide#dsconfig-1"
+ xlink:href="reference#dsconfig-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>dsconfig</command></link> command.
</para>
@@ -912,7 +912,7 @@
you add privileges with the
<link
xlink:show="new"
- xlink:href="admin-guide#ldapmodify-1"
+ xlink:href="reference#ldapmodify-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>ldapmodify</command></link> command.
</para>
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-pwd-policy.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-pwd-policy.xml
index 48d668b..51cf71c 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-pwd-policy.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-pwd-policy.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011-2014 ForgeRock AS
+ ! Copyright 2011-2015 ForgeRock AS.
!
-->
<chapter xml:id='chap-pwd-policy'
@@ -344,7 +344,7 @@
You configure server based password policies by using the
<link
xlink:show="new"
- xlink:href="admin-guide#dsconfig-1"
+ xlink:href="reference#dsconfig-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>dsconfig</command></link> command.
Notice that server based password policies are
@@ -839,7 +839,7 @@
by using the
<link
xlink:show="new"
- xlink:href="admin-guide#ldappasswordmodify-1"
+ xlink:href="reference#ldappasswordmodify-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>ldappasswordmodify</command></link> command.
</para>
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-replication.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-replication.xml
index 87167f9..acaf196 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-replication.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-replication.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011-2014 ForgeRock AS
+ ! Copyright 2011-2015 ForgeRock AS.
!
-->
<chapter xml:id='chap-replication'
@@ -338,7 +338,7 @@
such as the
<link
xlink:show="new"
- xlink:href="admin-guide#dsreplication-1"
+ xlink:href="reference#dsreplication-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>dsreplication</command></link> command.
</para>
@@ -625,7 +625,7 @@
you can do so by using the
<link
xlink:show="new"
- xlink:href="admin-guide#dsconfig-1"
+ xlink:href="reference#dsconfig-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>dsconfig</command></link> command.
</para>
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-rest-operations.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-rest-operations.xml
index a8b6ffb..d95ccaa 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-rest-operations.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-rest-operations.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2013-2015 ForgeRock AS
+ ! Copyright 2013-2015 ForgeRock AS.
!
-->
<chapter xml:id='chap-rest-operations'
@@ -59,7 +59,7 @@
but the procedure also shows how to set up HTTPS access to the server.
</para>
- <para>Interface stability: <link xlink:href="admin-guide#interface-stability"
+ <para>Interface stability: <link xlink:href="reference#interface-stability"
xlink:show="new" xlink:role="http://docbook.org/xlink/role/olink"
>Evolving</link></para>
@@ -264,7 +264,7 @@
authentication to PLAIN SASL authentication on the LDAP side. Moreover, the
gateway can fall back to proxied authorization as necessary, using a root DN
authenticated connection to LDAP servers. See <link xlink:show="new"
- xlink:href="admin-guide#appendix-rest2ldap"
+ xlink:href="reference#appendix-rest2ldap"
xlink:role="http://docbook.org/xlink/role/olink"><citetitle>REST LDAP
Configuration</citetitle></link> for details on all configuration
choices.</para>
@@ -730,12 +730,14 @@
<para>The add operation ensures that the target field contains the value
provided, creating parent fields as necessary.</para>
- <para>If the target field is single-valued and a value already exists, then
- that value is replaced with the value you provide. <emphasis
- role="strong">Note that you do not get an error when adding a value to a
- single-valued field that already has a value.</emphasis> A single-valued
- field is one whose value is not an array (an object, string, boolean, or
- number).</para>
+ <para>
+ If the target field is single-valued and a value already exists,
+ then that value is replaced with the value you provide.
+ <emphasis>Note that you do not get an error when adding a value
+ to a single-valued field that already has a value.</emphasis>
+ A single-valued field is one whose value is not an array
+ (an object, string, boolean, or number).
+ </para>
<para>If the target field is multi-valued, then the array of values you
provide is merged with the set of values already in the resource. New
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-server-process.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-server-process.xml
index c03cc0f..2de5e66 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-server-process.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-server-process.xml
@@ -52,7 +52,7 @@
Use the
<link
xlink:show="new"
- xlink:href="admin-guide#start-ds-1"
+ xlink:href="reference#start-ds-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>start-ds</command></link> command.
</para>
@@ -89,7 +89,7 @@
(UNIX) Create an RC script by using the
<link
xlink:show="new"
- xlink:href="admin-guide#create-rc-script-1"
+ xlink:href="reference#create-rc-script-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>create-rc-script</command></link> command,
and then use the script to start the server.
@@ -130,7 +130,7 @@
(Windows) Register OpenDJ as a Windows Service by using the
<link
xlink:show="new"
- xlink:href="admin-guide#windows-service"
+ xlink:href="reference#windows-service"
xlink:role="http://docbook.org/xlink/role/olink"
><command>windows-service</command></link> command,
and then manage the service through Windows administration tools.
@@ -163,7 +163,7 @@
Use the
<link
xlink:show="new"
- xlink:href="admin-guide#stop-ds-1"
+ xlink:href="reference#stop-ds-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>stop-ds</command></link> command.
</para>
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-tuning.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-tuning.xml
index fd8ddc9..2aaf68a 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-tuning.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-tuning.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011-2014 ForgeRock AS
+ ! Copyright 2011-2015 ForgeRock AS.
!
-->
<chapter xml:id='chap-tuning'
@@ -208,7 +208,7 @@
production, and then conduct experiments to determine how best to meet
the requirements defined in the SLA.</para>
- <para>Use <link xlink:show="new" xlink:href="admin-guide#make-ldif-1"
+ <para>Use <link xlink:show="new" xlink:href="reference#make-ldif-1"
xlink:role="http://docbook.org/xlink/role/olink">make-ldif</link> to generate
sample data that match what you expect to find in production.</para>
@@ -296,7 +296,7 @@
and apply the changes with the
<link
xlink:show="new"
- xlink:href="admin-guide#dsjavaproperties-1"
+ xlink:href="reference#dsjavaproperties-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>dsjavaproperties</command></link> command.
</para>
@@ -434,7 +434,7 @@
Use the
<link
xlink:show="new"
- xlink:href="admin-guide#import-ldif-1"
+ xlink:href="reference#import-ldif-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>import-ldif</command></link> command
with the <option>--tmpdirectory</option> option
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-understanding-ldap.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-understanding-ldap.xml
index 0de2fd3..e5edba4 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-understanding-ldap.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/chap-understanding-ldap.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011-2014 ForgeRock AS
+ ! Copyright 2011-2015 ForgeRock AS.
!
-->
<chapter xml:id='chap-understanding-ldap'
@@ -359,7 +359,7 @@
responses for entry change notification, password policy, and paged results.</para>
<para>For the list of supported LDAP controls, see
- <link xlink:show="new" xlink:href="admin-guide#appendix-controls"
+ <link xlink:show="new" xlink:href="reference#appendix-controls"
xlink:role="http://docbook.org/xlink/role/olink"><citetitle>LDAP
Controls</citetitle></link>.</para>
@@ -375,7 +375,7 @@
Transport Layer Security negotiations to protect communications.</para>
<para>For the list of supported LDAP extended operations, see
- <link xlink:show="new" xlink:href="admin-guide#appendix-extended-ops"
+ <link xlink:show="new" xlink:href="reference#appendix-extended-ops"
xlink:role="http://docbook.org/xlink/role/olink"><citetitle>LDAP Extended
Operations</citetitle></link>.</para>
</section>
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/index.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/index.xml
index 8e4f98e..77f644b 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/index.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/index.xml
@@ -24,12 +24,11 @@
!
-->
<book xml:id='admin-guide'
- xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
- xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
- xsi:schemaLocation='http://docbook.org/ns/docbook
- http://docbook.org/xml/5.0/xsd/docbook.xsd'
- xmlns:xlink='http://www.w3.org/1999/xlink'
- xmlns:xinclude='http://www.w3.org/2001/XInclude'>
+ xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
+ xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
+ xsi:schemaLocation='http://docbook.org/ns/docbook
+ http://docbook.org/xml/5.0/xsd/docbook.xsd'
+ xmlns:xinclude='http://www.w3.org/2001/XInclude'>
<info>
<xinclude:include href="../shared/mediaobject-fr-logo.xml" />
<title>OpenDJ Administration Guide</title>
@@ -98,70 +97,5 @@
<xinclude:include href='chap-mv-servers.xml' />
<xinclude:include href='chap-troubleshooting.xml' />
- <reference xml:id="admin-tools-ref">
- <title>Tools Reference</title>
-
- <partintro>
- <para>You can find tools under the folder where you installed OpenDJ
- directory server as listed in <link xlink:href="admin-guide#cli-overview"
- xlink:show="new" xlink:role="http://docbook.org/xlink/role/olink"
- ><citetitle>Command-Line Tools</citetitle></link>.</para>
- </partintro>
-
- <xinclude:include href='man-backup.xml' />
- <xinclude:include href='man-base64.xml' />
- <xinclude:include href='man-control-panel.xml' />
- <xinclude:include href='man-create-rc-script.xml' />
- <xinclude:include href='man-dbtest.xml' />
- <xinclude:include href='man-dsconfig.xml' />
- <xinclude:include href='man-dsjavaproperties.xml' />
- <xinclude:include href='man-dsreplication.xml' />
- <xinclude:include href='man-encode-password.xml' />
- <xinclude:include href='man-export-ldif.xml' />
- <xinclude:include href='man-import-ldif.xml' />
- <xinclude:include href='man-ldapcompare.xml' />
- <xinclude:include href='man-ldapdelete.xml' />
- <xinclude:include href='man-ldapmodify.xml' />
- <xinclude:include href='man-ldappasswordmodify.xml' />
- <xinclude:include href='man-ldapsearch.xml' />
- <xinclude:include href='man-ldif-diff.xml' />
- <xinclude:include href='man-ldifmodify.xml' />
- <xinclude:include href='man-ldifsearch.xml' />
- <xinclude:include href='man-list-backends.xml' />
- <xinclude:include href='man-make-ldif.xml' />
- <xinclude:include href='man-make-ldif-template.xml' />
- <xinclude:include href='man-manage-account.xml' />
- <xinclude:include href='man-manage-tasks.xml' />
- <xinclude:include href='man-rebuild-index.xml' />
- <xinclude:include href='man-restore.xml' />
- <xinclude:include href='man-setup.xml' />
- <xinclude:include href='man-start-ds.xml' />
- <xinclude:include href='man-status.xml' />
- <xinclude:include href='man-stop-ds.xml' />
- <xinclude:include href='man-uninstall.xml' />
- <xinclude:include href='man-upgrade.xml' />
- <xinclude:include href='man-verify-index.xml' />
- <xinclude:include href='man-windows-service.xml' />
- </reference>
-
- <xinclude:include href="../shared/glossary.xml" />
-
- <xinclude:include href="appendix-rest2ldap.xml" />
- <xinclude:include href='appendix-file-layout.xml' />
- <xinclude:include href='appendix-ports-used.xml' />
- <xinclude:include href='appendix-standards.xml' />
- <xinclude:include href='appendix-controls.xml' />
- <xinclude:include href='appendix-extended-ops.xml' />
- <xinclude:include href='appendix-l10n.xml' />
- <xinclude:include href='appendix-interface-stability.xml' />
- <xinclude:include href='${basedir}/build/docgen/logref/log-message-reference.xml'>
- <xinclude:fallback>
- <appendix>
- <title>Log Message Reference Missing</title>
- <para>The log message reference is missing.</para>
- </appendix>
- </xinclude:fallback>
- </xinclude:include>
-
<index />
</book>
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/preface.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/preface.xml
index 8145ebb..c44733a 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/preface.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/preface.xml
@@ -20,15 +20,15 @@
!
! CCPL HEADER END
!
- ! Copyright 2011-2012 ForgeRock AS
+ ! Copyright 2011-2015 ForgeRock AS.
!
-->
<preface xml:id='preface'
- xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
- xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
- xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
- xmlns:xlink='http://www.w3.org/1999/xlink'
- xmlns:xinclude='http://www.w3.org/2001/XInclude'>
+ xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
+ xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
+ xsi:schemaLocation='http://docbook.org/ns/docbook
+ http://docbook.org/xml/5.0/xsd/docbook.xsd'
+ xmlns:xinclude='http://www.w3.org/2001/XInclude'>
<title>Preface</title>
<para>This guide shows you how to configure, maintain, and troubleshoot
@@ -39,7 +39,7 @@
<section>
<title>Who Should Read this Guide</title>
- <para>This guide is written for directory designers and administrators who
+ <para>This guide is written for directory integrators and administrators who
build, deploy, and maintain OpenDJ directory services for your
organizations.</para>
@@ -49,9 +49,7 @@
by showing how to configure and monitor the principle features of individual
OpenDJ servers, and how to configure and monitor replicated server
topologies for distributed high availability. It then demonstrates how to
- tune, troubleshoot, and move servers. This guide concludes with appendices
- of useful reference information for directory designers and
- administrators.</para>
+ tune, troubleshoot, and move servers.</para>
<para>You do not need to be an LDAP wizard to learn something from this
guide, though a background in directory services and maintaining server
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-install-cli.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-install-cli.xml
index b9dfec0..64070ac 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-install-cli.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-install-cli.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011-2014 ForgeRock AS
+ ! Copyright 2011-2015 ForgeRock AS.
!
-->
<chapter xml:id='chap-install-cli'
@@ -147,7 +147,7 @@
Unlike the web-based Quick Setup install, the
<link
xlink:show="new"
- xlink:href="admin-guide#setup-1"
+ xlink:href="reference#setup-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>setup</command></link> command uses
the directory where you unzipped the files as the installation directory,
@@ -392,7 +392,7 @@
Run the
<link
xlink:show="new"
- xlink:href="admin-guide#status-1"
+ xlink:href="reference#status-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>status</command></link> command
to make sure your OpenDJ server is working as expected.
@@ -802,7 +802,7 @@
correctly match your directory data.</para>
<para>For details on the configuration, see <link
- xlink:href="admin-guide#appendix-rest2ldap" xlink:show="new"
+ xlink:href="reference#appendix-rest2ldap" xlink:show="new"
xlink:role="http://docbook.org/xlink/role/olink"><citetitle>REST LDAP
Configuration</citetitle></link>.</para>
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-install-gui.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-install-gui.xml
index 578eb75..64404ef 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-install-gui.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-install-gui.xml
@@ -82,7 +82,7 @@
and then run the
<link
xlink:show="new"
- xlink:href="admin-guide#setup-1"
+ xlink:href="reference#setup-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>setup</command></link> command,
<command>opendj/setup</command> (UNIX),
@@ -294,7 +294,7 @@
To launch OpenDJ Control Panel again later, run the
<link
xlink:show="new"
- xlink:href="admin-guide#control-panel-1"
+ xlink:href="reference#control-panel-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>control-panel</command></link> command.
Depending on your host system, this command is one of the following.
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-uninstall.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-uninstall.xml
index 8439154..3e44637 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-uninstall.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-uninstall.xml
@@ -49,7 +49,7 @@
Run the
<link
xlink:show="new"
- xlink:href="admin-guide#uninstall-1"
+ xlink:href="reference#uninstall-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>uninstall</command></link> command.
</para>
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-upgrade.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-upgrade.xml
index 3985657..a2d3468 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-upgrade.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/install-guide/chap-upgrade.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011-2014 ForgeRock AS
+ ! Copyright 2011-2015 ForgeRock AS.
!
-->
<chapter xml:id='chap-upgrade'
@@ -113,7 +113,7 @@
Run the
<link
xlink:show="new"
- xlink:href="admin-guide#upgrade-1"
+ xlink:href="reference#upgrade-1"
xlink:role="http://docbook.org/xlink/role/olink"
><command>upgrade</command></link> command
to bring OpenDJ configuration and application data up to date
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/appendix-controls.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/appendix-controls.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/appendix-controls.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/appendix-controls.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/appendix-extended-ops.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/appendix-extended-ops.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/appendix-extended-ops.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/appendix-extended-ops.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/appendix-file-layout.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/appendix-file-layout.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/appendix-file-layout.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/appendix-file-layout.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/appendix-interface-stability.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/appendix-interface-stability.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/appendix-interface-stability.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/appendix-interface-stability.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/appendix-l10n.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/appendix-l10n.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/appendix-l10n.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/appendix-l10n.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/appendix-ports-used.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/appendix-ports-used.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/appendix-ports-used.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/appendix-ports-used.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/appendix-rest2ldap.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/appendix-rest2ldap.xml
similarity index 99%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/appendix-rest2ldap.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/appendix-rest2ldap.xml
index 03dde18..75961ef 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/appendix-rest2ldap.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/appendix-rest2ldap.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2013-2014 ForgeRock AS
+ ! Copyright 2013-2015 ForgeRock AS.
!
-->
<appendix xml:id='appendix-rest2ldap'
@@ -59,7 +59,7 @@
LDAP gateway configuration. The order here is the order shown in the default
configuration file.</para>
- <para>Interface stability: <link xlink:href="admin-guide#interface-stability"
+ <para>Interface stability: <link xlink:href="reference#interface-stability"
xlink:show="new" xlink:role="http://docbook.org/xlink/role/olink"
>Evolving</link></para>
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/appendix-standards.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/appendix-standards.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/appendix-standards.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/appendix-standards.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/index.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/index.xml
new file mode 100644
index 0000000..86e4357
--- /dev/null
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/index.xml
@@ -0,0 +1,146 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ! CCPL HEADER START
+ !
+ ! This work is licensed under the Creative Commons
+ ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
+ ! To view a copy of this license, visit
+ ! http://creativecommons.org/licenses/by-nc-nd/3.0/
+ ! or send a letter to Creative Commons, 444 Castro Street,
+ ! Suite 900, Mountain View, California, 94041, USA.
+ !
+ ! You can also obtain a copy of the license at legal-notices/CC-BY-NC-ND.txt.
+ ! See the License for the specific language governing permissions
+ ! and limitations under the License.
+ !
+ ! If applicable, add the following below this CCPL HEADER, with the fields
+ ! enclosed by brackets "[]" replaced with your own identifying information:
+ ! Portions Copyright [yyyy] [name of copyright owner]
+ !
+ ! CCPL HEADER END
+ !
+ ! Copyright 2015 ForgeRock AS.
+ !
+-->
+<book xml:id="reference"
+ xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://docbook.org/ns/docbook
+ http://docbook.org/xml/5.0/xsd/docbook.xsd"
+ xmlns:xinclude="http://www.w3.org/2001/XInclude"
+ xmlns:xlink="http://www.w3.org/1999/xlink">
+ <info>
+
+ <title>OpenDJ Reference</title>
+ <subtitle>Version ${docTargetVersion}</subtitle>
+
+ <abstract>
+ <para>
+ Reference for OpenDJ directory server and bundled tools.
+ The OpenDJ project offers open source LDAP directory services in Java.
+ </para>
+ </abstract>
+
+ <copyright>
+ <year>2015</year>
+ <holder>ForgeRock AS.</holder>
+ </copyright>
+
+ <authorgroup>
+ <author>
+ <personname>
+ <firstname>Mark </firstname><surname>Craig</surname>
+ </personname>
+ </author>
+ </authorgroup>
+
+ <xinclude:include href="../legal.xml" />
+
+ <date>${publicationDate}</date>
+ <pubdate>${publicationDate}</pubdate>
+ <releaseinfo>${softwareReleaseDate}</releaseinfo>
+
+ </info>
+
+ <toc />
+
+ <xinclude:include href="preface.xml" />
+
+ <!--
+ For man page sections, let"s follow the BSD and Linux numbering.
+ In other words, user tools are 1, admin tools are 8 rather than 1M.
+ See http://en.wikipedia.org/wiki/Man_page#Manual_sections for details.
+ -->
+
+ <reference xml:id="admin-tools-ref">
+ <title>Tools Reference</title>
+
+ <partintro>
+ <para>
+ You can find bundle tools under the folder
+ where you installed OpenDJ directory server as listed in
+ <link
+ xlink:href="admin-guide#cli-overview"
+ xlink:show="new"
+ xlink:role="http://docbook.org/xlink/role/olink"
+ ><citetitle>Command-Line Tools</citetitle></link>.
+ </para>
+ </partintro>
+
+ <xinclude:include href='man-backup.xml' />
+ <xinclude:include href='man-base64.xml' />
+ <xinclude:include href='man-control-panel.xml' />
+ <xinclude:include href='man-create-rc-script.xml' />
+ <xinclude:include href='man-dbtest.xml' />
+ <xinclude:include href='man-dsconfig.xml' />
+ <xinclude:include href='man-dsjavaproperties.xml' />
+ <xinclude:include href='man-dsreplication.xml' />
+ <xinclude:include href='man-encode-password.xml' />
+ <xinclude:include href='man-export-ldif.xml' />
+ <xinclude:include href='man-import-ldif.xml' />
+ <xinclude:include href='man-ldapcompare.xml' />
+ <xinclude:include href='man-ldapdelete.xml' />
+ <xinclude:include href='man-ldapmodify.xml' />
+ <xinclude:include href='man-ldappasswordmodify.xml' />
+ <xinclude:include href='man-ldapsearch.xml' />
+ <xinclude:include href='man-ldif-diff.xml' />
+ <xinclude:include href='man-ldifmodify.xml' />
+ <xinclude:include href='man-ldifsearch.xml' />
+ <xinclude:include href='man-list-backends.xml' />
+ <xinclude:include href='man-make-ldif.xml' />
+ <xinclude:include href='man-make-ldif-template.xml' />
+ <xinclude:include href='man-manage-account.xml' />
+ <xinclude:include href='man-manage-tasks.xml' />
+ <xinclude:include href='man-rebuild-index.xml' />
+ <xinclude:include href='man-restore.xml' />
+ <xinclude:include href='man-setup.xml' />
+ <xinclude:include href='man-start-ds.xml' />
+ <xinclude:include href='man-status.xml' />
+ <xinclude:include href='man-stop-ds.xml' />
+ <xinclude:include href='man-uninstall.xml' />
+ <xinclude:include href='man-upgrade.xml' />
+ <xinclude:include href='man-verify-index.xml' />
+ <xinclude:include href='man-windows-service.xml' />
+ </reference>
+
+ <xinclude:include href="../shared/glossary.xml" />
+
+ <xinclude:include href="appendix-rest2ldap.xml" />
+ <xinclude:include href='appendix-file-layout.xml' />
+ <xinclude:include href='appendix-ports-used.xml' />
+ <xinclude:include href='appendix-standards.xml' />
+ <xinclude:include href='appendix-controls.xml' />
+ <xinclude:include href='appendix-extended-ops.xml' />
+ <xinclude:include href='appendix-l10n.xml' />
+ <xinclude:include href='appendix-interface-stability.xml' />
+ <xinclude:include href='${basedir}/build/docgen/logref/log-message-reference.xml'>
+ <xinclude:fallback>
+ <appendix>
+ <title>Log Message Reference Missing</title>
+ <para>The log message reference is missing.</para>
+ </appendix>
+ </xinclude:fallback>
+ </xinclude:include>
+
+ <index />
+</book>
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-backup.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-backup.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-backup.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-backup.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-base64.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-base64.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-base64.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-base64.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-control-panel.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-control-panel.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-control-panel.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-control-panel.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-create-rc-script.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-create-rc-script.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-create-rc-script.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-create-rc-script.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-dbtest.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-dbtest.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-dbtest.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-dbtest.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-dsconfig.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-dsconfig.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-dsconfig.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-dsconfig.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-dsjavaproperties.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-dsjavaproperties.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-dsjavaproperties.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-dsjavaproperties.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-dsreplication.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-dsreplication.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-dsreplication.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-dsreplication.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-encode-password.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-encode-password.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-encode-password.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-encode-password.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-export-ldif.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-export-ldif.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-export-ldif.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-export-ldif.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-import-ldif.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-import-ldif.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-import-ldif.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-import-ldif.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-ldapcompare.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-ldapcompare.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-ldapcompare.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-ldapcompare.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-ldapdelete.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-ldapdelete.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-ldapdelete.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-ldapdelete.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-ldapmodify.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-ldapmodify.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-ldapmodify.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-ldapmodify.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-ldappasswordmodify.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-ldappasswordmodify.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-ldappasswordmodify.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-ldappasswordmodify.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-ldapsearch.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-ldapsearch.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-ldapsearch.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-ldapsearch.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-ldif-diff.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-ldif-diff.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-ldif-diff.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-ldif-diff.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-ldifmodify.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-ldifmodify.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-ldifmodify.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-ldifmodify.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-ldifsearch.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-ldifsearch.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-ldifsearch.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-ldifsearch.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-list-backends.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-list-backends.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-list-backends.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-list-backends.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-make-ldif-template.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-make-ldif-template.xml
similarity index 98%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-make-ldif-template.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-make-ldif-template.xml
index 4cc9b68..33b7536 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-make-ldif-template.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-make-ldif-template.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2012-2014 ForgeRock AS
+ ! Copyright 2012-2015 ForgeRock AS.
!
-->
<refentry xml:id='make-ldif-template-5'
@@ -30,7 +30,7 @@
xsi:schemaLocation='http://docbook.org/ns/docbook
http://docbook.org/xml/5.0/xsd/docbook.xsd'
xmlns:xlink='http://www.w3.org/1999/xlink'>
- <info><copyright><year>2012-2014</year><holder>ForgeRock AS</holder></copyright></info>
+ <info><copyright><year>2012-2015</year><holder>ForgeRock AS.</holder></copyright></info>
<refmeta>
<refentrytitle>make-ldif.template</refentrytitle><manvolnum>5</manvolnum>
<refmiscinfo class="software">OpenDJ</refmiscinfo>
@@ -448,7 +448,7 @@
</refsect1>
<refsect1>
<title>See Also</title>
- <para><link xlink:href="admin-guide#make-ldif-1"
+ <para><link xlink:href="reference#make-ldif-1"
xlink:role="http://docbook.org/xlink/role/olink"><citerefentry><refentrytitle
>make-ldif</refentrytitle><manvolnum>1</manvolnum></citerefentry></link
>, <filename>/path/to/opendj/config/MakeLDIF/example.template</filename></para>
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-make-ldif.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-make-ldif.xml
similarity index 95%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-make-ldif.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-make-ldif.xml
index 2b7ddd2..0e3e6ab 100644
--- a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-make-ldif.xml
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-make-ldif.xml
@@ -20,7 +20,7 @@
!
! CCPL HEADER END
!
- ! Copyright 2011-2014 ForgeRock AS
+ ! Copyright 2011-2015 ForgeRock AS.
!
-->
<refentry xml:id='make-ldif-1'
@@ -30,7 +30,7 @@
xsi:schemaLocation='http://docbook.org/ns/docbook
http://docbook.org/xml/5.0/xsd/docbook.xsd'
xmlns:xlink='http://www.w3.org/1999/xlink'>
- <info><copyright><year>2011-2014</year><holder>ForgeRock AS</holder></copyright></info>
+ <info><copyright><year>2011-2015</year><holder>ForgeRock AS.</holder></copyright></info>
<refmeta>
<refentrytitle>make-ldif</refentrytitle><manvolnum>1</manvolnum>
<refmiscinfo class="software">OpenDJ</refmiscinfo>
@@ -121,7 +121,7 @@
</refsect1>
<refsect1>
<title>See Also</title>
- <para><link xlink:href="admin-guide#make-ldif-template-5"
+ <para><link xlink:href="reference#make-ldif-template-5"
xlink:role="http://docbook.org/xlink/role/olink"><citerefentry><refentrytitle
>make-ldif.template</refentrytitle><manvolnum>5</manvolnum
></citerefentry></link></para>
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-manage-account.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-manage-account.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-manage-account.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-manage-account.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-manage-tasks.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-manage-tasks.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-manage-tasks.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-manage-tasks.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-rebuild-index.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-rebuild-index.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-rebuild-index.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-rebuild-index.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-restore.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-restore.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-restore.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-restore.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-setup.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-setup.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-setup.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-setup.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-start-ds.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-start-ds.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-start-ds.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-start-ds.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-status.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-status.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-status.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-status.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-stop-ds.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-stop-ds.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-stop-ds.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-stop-ds.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-uninstall.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-uninstall.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-uninstall.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-uninstall.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-upgrade.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-upgrade.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-upgrade.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-upgrade.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-verify-index.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-verify-index.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-verify-index.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-verify-index.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-windows-service.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-windows-service.xml
similarity index 100%
rename from opendj-sdk/opendj3-server-dev/src/main/docbkx/admin-guide/man-windows-service.xml
rename to opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/man-windows-service.xml
diff --git a/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/preface.xml b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/preface.xml
new file mode 100644
index 0000000..5723f9b
--- /dev/null
+++ b/opendj-sdk/opendj3-server-dev/src/main/docbkx/reference/preface.xml
@@ -0,0 +1,55 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ ! CCPL HEADER START
+ !
+ ! This work is licensed under the Creative Commons
+ ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
+ ! To view a copy of this license, visit
+ ! http://creativecommons.org/licenses/by-nc-nd/3.0/
+ ! or send a letter to Creative Commons, 444 Castro Street,
+ ! Suite 900, Mountain View, California, 94041, USA.
+ !
+ ! You can also obtain a copy of the license at legal-notices/CC-BY-NC-ND.txt.
+ ! See the License for the specific language governing permissions
+ ! and limitations under the License.
+ !
+ ! If applicable, add the following below this CCPL HEADER, with the fields
+ ! enclosed by brackets "[]" replaced with your own identifying information:
+ ! Portions Copyright [yyyy] [name of copyright owner]
+ !
+ ! CCPL HEADER END
+ !
+ ! Copyright 2015 ForgeRock AS.
+ !
+-->
+<preface xml:id="preface"
+ xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://docbook.org/ns/docbook
+ http://docbook.org/xml/5.0/xsd/docbook.xsd"
+ xmlns:xinclude="http://www.w3.org/2001/XInclude">
+ <title>Preface</title>
+
+ <para>
+ This reference covers OpenDJ directory server configuration,
+ tools bundled with OpenDJ directory server,
+ and a number of other topics such as supported languages and standards.
+ </para>
+
+ <section>
+ <title>Who Should Use this Reference</title>
+
+ <para>
+ This reference is written for OpenDJ integrators and administrators.
+ </para>
+
+ <para>
+ For API specifications suitable for OpenDJ developers,
+ see the appropriate Javadoc.
+ </para>
+ </section>
+
+ <xinclude:include href="../shared/sec-formatting-conventions.xml" />
+ <xinclude:include href="../shared/sec-accessing-doc-online.xml" />
+ <xinclude:include href="../shared/sec-joining-the-community.xml" />
+</preface>
diff --git a/opendj-sdk/opendj3-server-dev/src/site/site.xml b/opendj-sdk/opendj3-server-dev/src/site/site.xml
index e364463..5f69a59 100644
--- a/opendj-sdk/opendj3-server-dev/src/site/site.xml
+++ b/opendj-sdk/opendj3-server-dev/src/site/site.xml
@@ -76,6 +76,7 @@
<item name="Release Notes" href="./doc/bootstrap/release-notes/index.html" />
<item name="Installation Guide" href="./doc/bootstrap/install-guide/index.html" />
<item name="Administration Guide" href="./doc/bootstrap/admin-guide/index.html" />
+ <item name="Reference" href="./doc/bootstrap/reference/index.html" />
<item name="Config Reference" href="./configref/index.html" />
<item name="Plugin Javadoc" href="./javadoc/index.html" />
</menu>
diff --git a/opendj-sdk/opendj3-server-dev/src/site/xdoc/docs.xml b/opendj-sdk/opendj3-server-dev/src/site/xdoc/docs.xml
index f0714c2..3e46a44 100644
--- a/opendj-sdk/opendj3-server-dev/src/site/xdoc/docs.xml
+++ b/opendj-sdk/opendj3-server-dev/src/site/xdoc/docs.xml
@@ -63,6 +63,12 @@
<a href="./doc/OpenDJ-Admin-Guide.pdf">PDF</a>
</dd>
+ <dt>Reference</dt>
+ <dd>
+ <a href="./doc/bootstrap/reference/index.html">HTML</a>
+ <a href="./doc/OpenDJ-Reference.pdf">PDF</a>
+ </dd>
+
<dt>Developer Guide</dt>
<dd>
<a href="../doc/bootstrap/dev-guide/index.html">HTML</a>
--
Gitblit v1.10.0