index.xml revision 16cd0b700bf132f7988ee61beadf685c3320eb47
<?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-pages/man-backup.xml'>
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href='/man-pages/man-base64.xml'>
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href='/man-pages/man-control-panel.xml'>
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href='/man-pages/man-create-rc-script.xml'>
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href='/man-pages/man-dbtest.xml'>
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href='/man-pages/man-dsconfig.xml'>
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href='/man-pages/man-dsjavaproperties.xml'>
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href='/man-pages/man-dsreplication.xml'>
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href='/man-pages/man-encode-password.xml'>
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href='/man-pages/man-export-ldif.xml'>
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href='/man-pages/man-import-ldif.xml'>
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href='/man-pages/man-ldapcompare.xml'>
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href='/man-pages/man-ldapdelete.xml'>
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href='/man-pages/man-ldapmodify.xml'>
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href='/man-pages/man-ldappasswordmodify.xml'>
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href='/man-pages/man-ldapsearch.xml'>
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href='/man-pages/man-ldif-diff.xml'>
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href='/man-pages/man-ldifmodify.xml'>
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href='/man-pages/man-ldifsearch.xml'>
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href='/man-pages/man-list-backends.xml'>
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href='/man-pages/man-make-ldif.xml'>
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href='/man-pages/man-make-ldif-template.xml' />
<xinclude:include href='/man-pages/man-manage-account.xml'>
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href='/man-pages/man-manage-tasks.xml'>
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href='/man-pages/man-rebuild-index.xml'>
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href='/man-pages/man-restore.xml'>
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href='/man-pages/man-setup.xml'>
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href='/man-pages/man-start-ds.xml'>
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href='/man-pages/man-status.xml'>
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href='/man-pages/man-stop-ds.xml'>
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href='/man-pages/man-uninstall.xml'>
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href='/man-pages/man-upgrade.xml'>
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href='/man-pages/man-verify-index.xml'>
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href='/man-pages/man-windows-service.xml' />
</reference>
<xinclude:include href="/man-pages/man-dsconfig-subcommands-ref.xml">
<xinclude:fallback><!-- Failed to include page --></xinclude:fallback>
</xinclude:include>
<xinclude:include href="/shared/glossary.xml" />
<xinclude:include href="appendix-rest2ldap.xml" />
<xinclude:include href="/shared/appendix-ldap-result-codes.xml">
<xinclude:fallback>
<appendix>
<title>LDAP Result Codes Missing</title>
<para>The generated LDAP result codes appendix is missing.</para>
</appendix>
</xinclude:fallback>
</xinclude:include>
<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='/shared/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>
<reference>
<title>OpenSolaris Support Reference</title>
<xinclude:include href='/man-pages/man-configure.xml' />
<xinclude:include href='/man-pages/man-opendj.xml' />
</reference>
<index />
</book>