mirror of https://github.com/OpenIdentityPlatform/OpenDJ.git

Mark Craig
02.54.2015 e680e90e169eaf761b92114c893ea43a0729cb98
CR-6546 OPENDJ-1787 Automate man page generation

This patch adds man pages to the .deb, RPM, and SVR4 packaging.
It removes the non-generated man pages as they are no longer needed.

This patch introduces a profile for building server docs, -P docs.

Thanks to Gaetan for review and help testing.
34 files deleted
2 files added
5 files modified
13193 ■■■■■ changed files
opendj-server-legacy/pom.xml 299 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man1/backup.1 296 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man1/base64.1 135 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man1/control-panel.1 128 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man1/create-rc-script.1 100 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man1/dbtest.1 195 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man1/dsconfig.1 4533 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man1/dsjavaproperties.1 95 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man1/dsreplication.1 633 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man1/encode-password.1 157 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man1/export-ldif.1 274 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man1/import-ldif.1 327 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man1/ldapcompare.1 304 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man1/ldapdelete.1 288 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man1/ldapmodify.1 376 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man1/ldappasswordmodify.1 270 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man1/ldapsearch.1 607 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man1/ldif-diff.1 170 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man1/ldifmodify.1 132 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man1/ldifsearch.1 220 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man1/list-backends.1 98 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man1/make-ldif.1 100 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man1/manage-account.1 317 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man1/manage-tasks.1 200 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man1/rebuild-index.1 259 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man1/restore.1 261 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man1/setup.1 266 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man1/start-ds.1 105 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man1/status.1 208 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man1/stop-ds.1 203 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man1/uninstall.1 237 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man1/upgrade.1 200 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man1/verify-index.1 126 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man5/make-ldif.template.5 541 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/resource/man/man5/opendj.5 107 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/src/main/docbkx/install-guide/chap-install-cli.xml 37 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/src/main/docbkx/man-pages/man-configure.xml 166 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/src/main/docbkx/man-pages/man-opendj.xml 154 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/src/main/docbkx/reference/index.xml 6 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/src/svr4/OpenDJ/layout.xml 2 ●●● patch | view | raw | blame | history
pom.xml 61 ●●●●● patch | view | raw | blame | history
opendj-server-legacy/pom.xml
@@ -527,43 +527,7 @@
            </configuration>
          </execution>
          <!-- Generates log references for documentation -->
          <execution>
            <goals>
              <goal>generate-xml-messages-doc</goal>
            </goals>
            <configuration>
              <messagesDirectory>${basedir}/src/messages/org/opends/messages</messagesDirectory>
              <outputDirectory>${project.build.directory}/docgen/logref</outputDirectory>
              <logMessageReferenceFilePath>${basedir}/resource/log-message-reference.xml</logMessageReferenceFilePath>
              <messageFileNames>
                <!-- for xxx_yyy.properties generates a log-ref-xxx-yyy.xml file -->
                <messageFileName>admin</messageFileName>
                <messageFileName>backend</messageFileName>
                <messageFileName>config</messageFileName>
                <messageFileName>core</messageFileName>
                <messageFileName>dsconfig</messageFileName>
                <messageFileName>extension</messageFileName>
                <messageFileName>jeb</messageFileName>
                <messageFileName>logger</messageFileName>
                <messageFileName>plugin</messageFileName>
                <messageFileName>protocol</messageFileName>
                <messageFileName>replication</messageFileName>
                <messageFileName>schema</messageFileName>
                <messageFileName>task</messageFileName>
                <messageFileName>tool</messageFileName>
                <messageFileName>utility</messageFileName>
                <!-- Ignore following message files as we document only serious errors. -->
                <!-- <messageFileName>access_control</messageFileName> -->
                <!-- <messageFileName>admin_tool</messageFileName> -->
                <!-- <messageFileName>quicksetup.properties</messageFileName> -->
                <!-- <messageFileName>runtime_information.properties</messageFileName> -->
                <!-- <messageFileName>version.properties</messageFileName> -->
              </messageFileNames>
            </configuration>
          </execution>
          <!-- Generates man page sources -->
          <execution>
             <id>generate-doc</id>
             <goals>
@@ -1454,65 +1418,6 @@
        </executions>
      </plugin>
      <!-- Generate documentation -->
      <plugin>
        <groupId>org.forgerock.opendj</groupId>
        <artifactId>opendj-doc-plugin</artifactId>
        <version>${project.version}</version>
        <executions>
          <execution>
            <id>generate-schema-reference-doc</id>
            <phase>pre-site</phase>
            <goals>
              <goal>generate-schema-ref</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
      <plugin>
        <groupId>org.forgerock.commons</groupId>
        <artifactId>forgerock-doc-maven-plugin</artifactId>
        <version>${frDocPluginVersion}</version>
        <inherited>false</inherited>
        <configuration>
          <projectName>${shortProductName}</projectName>
          <projectVersion>${docTargetVersion}</projectVersion>
          <releaseVersion>${docTargetVersion}</releaseVersion>
          <googleAnalyticsId>${gaId}</googleAnalyticsId>
        </configuration>
        <executions>
          <execution>
            <id>pre-process-doc</id>
            <phase>pre-site</phase>
            <goals>
              <goal>process</goal>
            </goals>
          </execution>
          <execution>
            <id>build-doc</id>
            <phase>pre-site</phase>
            <goals>
              <goal>build</goal>
            </goals>
          </execution>
          <execution>
            <id>layout-doc</id>
            <phase>site</phase>
            <goals>
              <goal>site</goal>
            </goals>
          </execution>
          <execution>
            <id>layout-release</id>
            <phase>site</phase>
            <goals>
              <goal>release</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
      <!-- Build javadoc -->
      <plugin>
        <groupId>org.forgerock.maven.plugins</groupId>
@@ -1921,6 +1826,98 @@
      </build>
    </profile>
    <profile>
      <!-- Build documentation -->
      <id>docs</id>
      <build>
        <plugins>
          <plugin>
            <groupId>org.forgerock.opendj</groupId>
            <artifactId>opendj-doc-plugin</artifactId>
            <version>${project.version}</version>
            <executions>
              <execution>
                <id>generate-schema-reference-doc</id>
                <phase>prepare-package</phase>
                <goals>
                  <goal>generate-schema-ref</goal>
                </goals>
              </execution>
            </executions>
          </plugin>
          <plugin>
            <groupId>org.forgerock.opendj</groupId>
            <artifactId>opendj-maven-plugin</artifactId>
            <version>${project.version}</version>
            <executions>
              <execution>
                <goals>
                  <goal>generate-xml-messages-doc</goal>
                </goals>
                <phase>prepare-package</phase>
                <configuration>
                  <messagesDirectory>${basedir}/src/messages/org/opends/messages</messagesDirectory>
                  <outputDirectory>${project.build.directory}/docgen/logref</outputDirectory>
                  <logMessageReferenceFilePath>${basedir}/resource/log-message-reference.xml</logMessageReferenceFilePath>
                  <messageFileNames>
                    <!-- for xxx_yyy.properties generates a log-ref-xxx-yyy.xml file -->
                    <messageFileName>admin</messageFileName>
                    <messageFileName>backend</messageFileName>
                    <messageFileName>config</messageFileName>
                    <messageFileName>core</messageFileName>
                    <messageFileName>dsconfig</messageFileName>
                    <messageFileName>extension</messageFileName>
                    <messageFileName>jeb</messageFileName>
                    <messageFileName>logger</messageFileName>
                    <messageFileName>plugin</messageFileName>
                    <messageFileName>protocol</messageFileName>
                    <messageFileName>replication</messageFileName>
                    <messageFileName>schema</messageFileName>
                    <messageFileName>task</messageFileName>
                    <messageFileName>tool</messageFileName>
                    <messageFileName>utility</messageFileName>
                    <!-- Ignore following message files as we document only serious errors. -->
                    <!-- <messageFileName>access_control</messageFileName> -->
                    <!-- <messageFileName>admin_tool</messageFileName> -->
                    <!-- <messageFileName>quicksetup.properties</messageFileName> -->
                    <!-- <messageFileName>runtime_information.properties</messageFileName> -->
                    <!-- <messageFileName>version.properties</messageFileName> -->
                  </messageFileNames>
                </configuration>
              </execution>
            </executions>
          </plugin>
          <plugin>
            <groupId>org.forgerock.commons</groupId>
            <artifactId>forgerock-doc-maven-plugin</artifactId>
            <inherited>false</inherited>
            <executions>
              <execution>
                <id>build-doc</id>
                <phase>pre-site</phase>
                <goals>
                  <goal>process</goal>
                  <goal>build</goal>
                </goals>
              </execution>
              <execution>
                <id>layout-doc</id>
                <phase>site</phase>
                <goals>
                  <goal>site</goal>
                  <goal>release</goal>
                </goals>
              </execution>
            </executions>
          </plugin>
        </plugins>
      </build>
    </profile>
    <!-- Build the debian package -->
    <profile>
      <id>package-deb</id>
@@ -1930,10 +1927,32 @@
          <deb.docprefix>/usr/share/doc/${lowerCaseProductName}</deb.docprefix>
          <deb.release>1</deb.release>
          <deb.maintainer>opendj@forgerock.org</deb.maintainer>
          <manpage.dir>${project.build.directory}/docbkx/manpages/reference</manpage.dir>
        </properties>
        <build>
          <plugins>
            <!-- Build man pages -->
            <plugin>
                <groupId>org.forgerock.commons</groupId>
                <artifactId>forgerock-doc-maven-plugin</artifactId>
                <configuration>
                    <formats combine.self="override">
                        <format>man</format>
                    </formats>
                </configuration>
                <executions>
                    <execution>
                        <id>build-man-pages</id>
                        <phase>package</phase>
                        <goals>
                            <goal>process</goal>
                            <goal>build</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <!-- Filter deb install and remove scripts -->
            <plugin>
              <artifactId>maven-resources-plugin</artifactId>
@@ -1974,6 +1993,21 @@
                    </target>
                  </configuration>
                </execution>
                <execution>
                  <id>gzip-man-pages</id>
                  <phase>verify</phase>
                  <goals>
                    <goal>run</goal>
                  </goals>
                  <configuration>
                    <target>
                      <apply executable="gzip"><!-- Must we also build these packages on Windows? -->
                        <arg value="-9" />
                        <fileset dir="${manpage.dir}" />
                      </apply>
                    </target>
                  </configuration>
                </execution>
              </executions>
            </plugin>
@@ -2034,6 +2068,16 @@
                        </mapper>
                      </data>
                      <!-- OpenDJ man pages -->
                      <data>
                        <src>${manpage.dir}</src>
                        <type>directory</type>
                        <mapper>
                          <type>perm</type>
                          <prefix>${deb.prefix}/share/man</prefix>
                        </mapper>
                      </data>
                      <!-- OpenDJ archive files without specific permission -->
                      <data>
                        <src>${project.build.directory}/package/${lowerCaseProductName}</src>
@@ -2089,6 +2133,27 @@
      <build>
        <plugins>
            <!-- Build man pages -->
          <plugin>
            <groupId>org.forgerock.commons</groupId>
            <artifactId>forgerock-doc-maven-plugin</artifactId>
            <configuration>
              <formats combine.self="override">
                <format>man</format>
              </formats>
            </configuration>
            <executions>
              <execution>
                <id>build-man-pages</id>
                <phase>package</phase>
                <goals>
                  <goal>process</goal>
                  <goal>build</goal>
                </goals>
              </execution>
            </executions>
          </plugin>
          <plugin>
            <groupId>org.codehaus.mojo</groupId>
            <artifactId>rpm-maven-plugin</artifactId>
@@ -2136,6 +2201,12 @@
                  <directory>${rpm.prefix}/lib/extensions</directory>
                </mapping>
                <mapping>
                  <directory>${rpm.prefix}/share</directory>
                </mapping>
                <mapping>
                  <directory>${rpm.prefix}/share/man</directory>
                </mapping>
                <mapping>
                  <directory>${rpm.prefix}/snmp</directory>
                </mapping>
                <mapping>
@@ -2175,7 +2246,7 @@
                  </sources>
                </mapping>
                <!-- Add executables scripts and librairies -->
                <!-- Add executable scripts and libraries -->
                <mapping>
                  <directory>${rpm.prefix}</directory>
                  <filemode>755</filemode>
@@ -2199,6 +2270,19 @@
                  </sources>
                </mapping>
                <!-- Add man pages -->
                <mapping>
                  <directory>${rpm.prefix}/share/man</directory>
                  <sources>
                    <source>
                      <location>${project.build.directory}/docbkx/manpages/reference</location>
                      <includes>
                        <include>**/*.*</include>
                      </includes>
                    </source>
                  </sources>
                </mapping>
                <!-- Add other files to the rpm -->
                <mapping>
                  <directory>${rpm.prefix}</directory>
@@ -2285,6 +2369,27 @@
      <id>package-svr4</id>
      <build>
        <plugins>
          <!-- Build man pages -->
          <plugin>
            <groupId>org.forgerock.commons</groupId>
            <artifactId>forgerock-doc-maven-plugin</artifactId>
            <configuration>
              <formats combine.self="override">
                <format>man</format>
              </formats>
            </configuration>
            <executions>
              <execution>
                <id>build-man-pages</id>
                <phase>package</phase>
                <goals>
                  <goal>process</goal>
                  <goal>build</goal>
                </goals>
              </execution>
            </executions>
          </plugin>
          <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-antrun-plugin</artifactId>
opendj-server-legacy/resource/man/man1/backup.1
File was deleted
opendj-server-legacy/resource/man/man1/base64.1
File was deleted
opendj-server-legacy/resource/man/man1/control-panel.1
File was deleted
opendj-server-legacy/resource/man/man1/create-rc-script.1
File was deleted
opendj-server-legacy/resource/man/man1/dbtest.1
File was deleted
opendj-server-legacy/resource/man/man1/dsconfig.1
File was deleted
opendj-server-legacy/resource/man/man1/dsjavaproperties.1
File was deleted
opendj-server-legacy/resource/man/man1/dsreplication.1
File was deleted
opendj-server-legacy/resource/man/man1/encode-password.1
File was deleted
opendj-server-legacy/resource/man/man1/export-ldif.1
File was deleted
opendj-server-legacy/resource/man/man1/import-ldif.1
File was deleted
opendj-server-legacy/resource/man/man1/ldapcompare.1
File was deleted
opendj-server-legacy/resource/man/man1/ldapdelete.1
File was deleted
opendj-server-legacy/resource/man/man1/ldapmodify.1
File was deleted
opendj-server-legacy/resource/man/man1/ldappasswordmodify.1
File was deleted
opendj-server-legacy/resource/man/man1/ldapsearch.1
File was deleted
opendj-server-legacy/resource/man/man1/ldif-diff.1
File was deleted
opendj-server-legacy/resource/man/man1/ldifmodify.1
File was deleted
opendj-server-legacy/resource/man/man1/ldifsearch.1
File was deleted
opendj-server-legacy/resource/man/man1/list-backends.1
File was deleted
opendj-server-legacy/resource/man/man1/make-ldif.1
File was deleted
opendj-server-legacy/resource/man/man1/manage-account.1
File was deleted
opendj-server-legacy/resource/man/man1/manage-tasks.1
File was deleted
opendj-server-legacy/resource/man/man1/rebuild-index.1
File was deleted
opendj-server-legacy/resource/man/man1/restore.1
File was deleted
opendj-server-legacy/resource/man/man1/setup.1
File was deleted
opendj-server-legacy/resource/man/man1/start-ds.1
File was deleted
opendj-server-legacy/resource/man/man1/status.1
File was deleted
opendj-server-legacy/resource/man/man1/stop-ds.1
File was deleted
opendj-server-legacy/resource/man/man1/uninstall.1
File was deleted
opendj-server-legacy/resource/man/man1/upgrade.1
File was deleted
opendj-server-legacy/resource/man/man1/verify-index.1
File was deleted
opendj-server-legacy/resource/man/man5/make-ldif.template.5
File was deleted
opendj-server-legacy/resource/man/man5/opendj.5
File was deleted
opendj-server-legacy/src/main/docbkx/install-guide/chap-install-cli.xml
@@ -9,8 +9,7 @@
  ! or send a letter to Creative Commons, 444 Castro Street,
  ! Suite 900, Mountain View, California, 94041, USA.
  !
  ! You can also obtain a copy of the license at
  ! trunk/opendj3/legal-notices/CC-BY-NC-ND.txt.
  ! 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.
  !
@@ -24,12 +23,12 @@
  !
-->
<chapter xml:id='chap-install-cli'
 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:xlink='http://www.w3.org/1999/xlink'
         xmlns:xinclude='http://www.w3.org/2001/XInclude'>
 <title>Installing OpenDJ From the Command Line</title>
 <para>This chapter covers command-line installation with additional
@@ -482,9 +481,13 @@
$
   </screen>
   <para>The .deb installs OpenDJ directory server in the directory
   <filename>/opt/opendj</filename>, generates service management scripts, and
   adds documentation files under <filename>/usr/share/doc/opendj</filename>.</para>
   <para>
    The .deb installs OpenDJ directory server
    in the <filename>/opt/opendj</filename> directory,
    generates service management scripts,
    adds documentation files under <filename>/usr/share/doc/opendj</filename>,
    and adds man pages under <filename>/opt/opendj/share/man</filename>.
   </para>
   <para>The files are owned by root by default, making it easier to have OpenDJ
   listen on ports 389 and 636.</para>
@@ -589,10 +592,14 @@
#
   </screen>
   <para>The .rpm installs OpenDJ directory server in the directory
   <filename>/opt/opendj</filename>, generates service management scripts, and
   adds documentation files under <filename>/usr/share/doc/opendj-<replaceable
   >version</replaceable></filename>.</para>
   <para>
    The .rpm installs OpenDJ directory server
    in the <filename>/opt/opendj</filename> directory,
    generates service management scripts,
    adds documentation files under
    <filename>/usr/share/doc/opendj-<replaceable>version</replaceable></filename>,
    and adds man pages under <filename>/opt/opendj/share/man</filename>.
   </para>
   <para>The files are owned by root by default, making it easier to have OpenDJ
   listen on ports 389 and 636.</para>
opendj-server-legacy/src/main/docbkx/man-pages/man-configure.xml
New file
@@ -0,0 +1,166 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
  ! CCPL HEADER START
  !
  ! This work is licensed under the Creative Commons
  ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
  ! To view a copy of this license, visit
  ! http://creativecommons.org/licenses/by-nc-nd/3.0/
  ! or send a letter to Creative Commons, 444 Castro Street,
  ! Suite 900, Mountain View, California, 94041, USA.
  !
  ! You can also obtain a copy of the license at
  ! trunk/opendj/legal-notices/CC-BY-NC-ND.txt.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
  ! If applicable, add the following below this CCPL HEADER, with the fields
  ! enclosed by brackets "[]" replaced with your own identifying information:
  !      Portions Copyright [yyyy] [name of copyright owner]
  !
  ! CCPL HEADER END
  !
  !      Copyright 2011-2015 ForgeRock AS.
  !
-->
<refentry xml:id='configure-1'
          xmlns='http://docbook.org/ns/docbook'
          version='5.0' xml:lang='en'
          xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
          xsi:schemaLocation='http://docbook.org/ns/docbook
                              http://docbook.org/xml/5.0/xsd/docbook.xsd'>
 <info>
  <copyright>
   <year>2011-2015</year>
   <holder>ForgeRock AS.</holder>
  </copyright>
 </info>
 <refmeta>
  <refentrytitle>configure</refentrytitle><manvolnum>1</manvolnum>
  <refmiscinfo class="software">OpenDJ</refmiscinfo>
  <refmiscinfo class="version">${docTargetVersion}</refmiscinfo>
 </refmeta>
 <refnamediv>
  <refname>configure</refname>
  <refpurpose>sets the instance location of an OpenDJ package installation</refpurpose>
 </refnamediv>
 <refsect1>
  <title>Description</title>
  <para>
   The <command>configure</command> 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.
  </para>
  <para>
   This command is available
   in the <trademark>OpenSolaris</trademark> package installation only.
  </para>
 </refsect1>
 <refsect1>
  <title>Options</title>
  <variablelist>
   <para>
    The following options are supported:
   </para>
   <varlistentry>
    <term><option>--groupName {groupName}</option></term>
    <listitem>
     <para>
      The group name of the instance owner.
      If no group name is specified,
      the primary group of the <replaceable>userName</replaceable> is used.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>--instancePath {path}</option></term>
    <listitem>
     <para>
      The path where the instance will be located.
      If no path is specified, the default <filename>/var/opendj</filename> is used.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>--userName {userName}</option></term>
    <listitem>
     <para>
      The user name of the instance owner.
      If no user name is specified, the default <literal>ldap</literal> is used.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-V, --version</option></term>
    <listitem>
     <para>
      Displays directory server version information.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><option>-?, -H, --help</option></term>
    <listitem>
     <para>
      Displays usage information.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>
 <refsect1>
  <title>Examples</title>
  <para>
   The following example configures the instance path,
   user name and group name for a directory server package installation:
  </para>
  <screen>
$ /usr/opendj/configure \
 --instancePath /var/opendj \
 --userName myUser \
 --groupName myGroup
  </screen>
 </refsect1>
 <refsect1>
  <title>Attributes</title>
  <para>
   See <citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>
   for descriptions of the following attributes:
  </para>
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>ATTRIBUTE TYPE</entry>
      <entry>ATTRIBUTE VALUE</entry>
     </row>
    </thead>
    <tbody align="center">
     <row>
      <entry>Interface Stability</entry>
      <entry>Uncommitted</entry>
     </row>
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>
</refentry>
opendj-server-legacy/src/main/docbkx/man-pages/man-opendj.xml
New file
@@ -0,0 +1,154 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
  ! CCPL HEADER START
  !
  ! This work is licensed under the Creative Commons
  ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
  ! To view a copy of this license, visit
  ! http://creativecommons.org/licenses/by-nc-nd/3.0/
  ! or send a letter to Creative Commons, 444 Castro Street,
  ! Suite 900, Mountain View, California, 94041, USA.
  !
  ! You can also obtain a copy of the license at
  ! trunk/opendj/legal-notices/CC-BY-NC-ND.txt.
  ! See the License for the specific language governing permissions
  ! and limitations under the License.
  !
  ! If applicable, add the following below this CCPL HEADER, with the fields
  ! enclosed by brackets "[]" replaced with your own identifying information:
  !      Portions Copyright [yyyy] [name of copyright owner]
  !
  ! CCPL HEADER END
  !
  !      Copyright 2011-2015 ForgeRock AS.
  !
-->
<refentry xml:id='opendj-5'
          xmlns='http://docbook.org/ns/docbook'
          version='5.0' xml:lang='en'
          xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
          xsi:schemaLocation='http://docbook.org/ns/docbook
                              http://docbook.org/xml/5.0/xsd/docbook.xsd'>
 <info>
  <copyright>
   <year>2011-2015</year>
   <holder>ForgeRock AS.</holder>
  </copyright>
 </info>
 <refmeta>
  <refentrytitle>opendj</refentrytitle><manvolnum>5</manvolnum>
  <refmiscinfo class="software">OpenDJ</refmiscinfo>
  <refmiscinfo class="version">${docTargetVersion}</refmiscinfo>
 </refmeta>
 <refnamediv>
  <refname>OpenDJ</refname>
  <refpurpose>a high-performance, highly-extensible, LDAPv3 compliant directory server</refpurpose>
 </refnamediv>
 <refsect1>
  <title>Description</title>
  <para>
   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 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.
  </para>
  <para>
   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 to the number of masters,
   the directory server has been stressed under heavy and durable load with four masters.
  </para>
  <itemizedlist>
   <para>
    OpenDJ software includes:
   </para>
   <listitem>
    <para>
     A graphical installation tool (<command>QuickSetup</command>) that enables you
     to have a server configured, and up and running in less than 3 minutes
    </para>
   </listitem>
   <listitem>
    <para>
     A graphical control panel (<command>bin/control-panel</command>)
     that displays server status information
     and enables you to perform basic directory server administration
    </para>
   </listitem>
   <listitem>
    <para>
     A rich set of command-line utilities to perform
     all online administrative tasks both interactively and with scripts
    </para>
   </listitem>
   <listitem>
    <para>
     Advanced security and password policies
    </para>
   </listitem>
   <listitem>
    <para>
     Advanced backup and restore capabilities
    </para>
   </listitem>
   <listitem>
    <para>
     Extensive user documentation
    </para>
   </listitem>
  </itemizedlist>
 </refsect1>
 <refsect1>
  <title>Usage</title>
  <para>
   See the <citetitle>Installation Guide</citetitle> for instructions
   on getting started with OpenDJ directory server.
  </para>
  <itemizedlist>
   <para>
    To install the directory server from IPS packages perform the following steps:
   </para>
   <listitem>
    <para>
     As the root user, run the <command>configure</command> command
     to create an instance of the directory server in a specific location,
     running as a specific user.
    </para>
   </listitem>
   <listitem>
    <para>
     Run the <command>setup</command> command as this user
     to install and configure the directory server instance.
    </para>
   </listitem>
   <listitem>
    <para>
     For additional configuration of the directory server,
     use the <command>control-panel</command> and <command>dsconfig</command> commands.
    </para>
   </listitem>
  </itemizedlist>
 </refsect1>
</refentry>
opendj-server-legacy/src/main/docbkx/reference/index.xml
@@ -210,5 +210,11 @@
  </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>
opendj-server-legacy/src/svr4/OpenDJ/layout.xml
@@ -77,7 +77,7 @@
    <!-- Add man pages -->
    <copy todir="${svr4.layout.pkg.dir}/man">
      <fileset dir="${resource.dir}/man" />
      <fileset dir="${project.build.directory}/docbkx/manpages/reference" />
    </copy>
  </target>
pom.xml
@@ -133,6 +133,7 @@
    <checkstyleHeaderLocation>org/forgerock/checkstyle/opendj-java-header</checkstyleHeaderLocation>
    <!-- START Documentation properties -->
    <shortProductName>OpenDJ</shortProductName>
    <docTargetVersion>${project.version}</docTargetVersion><!-- Reset before final publication -->
    <docPreviousVersion>2.6.0</docPreviousVersion>
    <sdkDocTargetVersion>${docTargetVersion}</sdkDocTargetVersion>
@@ -190,15 +191,8 @@
      <plugin>
        <groupId>org.forgerock.commons</groupId>
        <artifactId>forgerock-doc-maven-plugin</artifactId>
        <version>${frDocPluginVersion}</version>
        <inherited>false</inherited>
        <configuration>
         <!-- Standard configuration -->
         <projectName>OpenDJ</projectName>
         <projectVersion>${docTargetVersion}</projectVersion>
         <releaseVersion>${docTargetVersion}</releaseVersion>
         <googleAnalyticsId>${gaId}</googleAnalyticsId>
         <!-- JCite SDK Example code -->
         <jCiteSourcePaths>
           <jCiteSourcePath>${project.basedir}/opendj-ldap-sdk-examples/src/main/java</jCiteSourcePath>
@@ -206,32 +200,32 @@
        </configuration>
        <executions>
          <execution>
           <id>pre-process-doc</id>
           <phase>pre-site</phase>
           <goals>
            <goal>process</goal>
           </goals>
            <id>pre-process-doc</id>
            <phase>pre-site</phase>
            <goals>
              <goal>process</goal>
            </goals>
          </execution>
          <execution>
           <id>build-doc</id>
           <phase>pre-site</phase>
           <goals>
            <goal>build</goal>
           </goals>
            <id>build-doc</id>
            <phase>pre-site</phase>
            <goals>
              <goal>build</goal>
            </goals>
          </execution>
          <execution>
           <id>layout-site</id>
           <phase>site</phase>
           <goals>
            <goal>site</goal>
           </goals>
            <id>layout-doc</id>
            <phase>site</phase>
            <goals>
              <goal>site</goal>
            </goals>
          </execution>
          <execution>
           <id>layout-release</id>
           <phase>site</phase>
           <goals>
            <goal>release</goal>
           </goals>
            <id>layout-release</id>
            <phase>site</phase>
            <goals>
              <goal>release</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
@@ -390,6 +384,19 @@
                </execution>
            </executions>
        </plugin>
        <!-- Provides build capabilities for docs in DocBook XML format. -->
        <plugin>
            <groupId>org.forgerock.commons</groupId>
            <artifactId>forgerock-doc-maven-plugin</artifactId>
            <version>${frDocPluginVersion}</version>
            <configuration>
                <projectName>${shortProductName}</projectName>
                <projectVersion>${docTargetVersion}</projectVersion>
                <releaseVersion>${docTargetVersion}</releaseVersion>
                <googleAnalyticsId>${gaId}</googleAnalyticsId>
            </configuration>
        </plugin>
      </plugins>
    </pluginManagement>
  </build>