More tidy up of download page and community landing page

Ludovic Poitou

01.43.2011 0fa6258ec545a18952abe2db428dac31dee0894a

More tidy up of download page and community landing page

 opendj3/src/main/docbkx/admin-guide/chap-troubleshooting.xml

@@ -23,17 +23,22 @@
  !      Copyright 2011 ForgeRock AS
  !    
-->
<chapter xml:id='chap-troubleshooting'
 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>Troubleshooting Server Problems</title>
<chapter version="5.0"
         xsi:schemaLocation="http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd"
         xml:id="chap-troubleshooting" xml:lang="en"
         xmlns="http://docbook.org/ns/docbook"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xmlns:xs="http://www.w3.org/2001/XMLSchema"
         xmlns:xlink="http://www.w3.org/1999/xlink"
         xmlns:xinclude="http://www.w3.org/2001/XInclude"
         xmlns:ns="http://docbook.org/ns/docbook">
  <title>Troubleshooting Server Problems</title>

 <para>This chapter describes how to troubleshoot common server problems,
 and how to collect information necessary when seeking support help.</para>
  <para>This chapter describes how to troubleshoot common server problems, and
  how to collect information necessary when seeking support help.</para>

  <section>
    <title>Troubleshooting SSL Connections</title>
 
 <section>
  <title>Identifying the Problem</title>
@@ -256,4 +261,8 @@
  </itemizedlist>
 </section>

    <para>Troubleshooting</para>

    <para></para>
  </section>
</chapter>

 opendj3/src/main/docbkx/admin-guide/preface.xml

@@ -21,16 +21,16 @@
  ! CCPL HEADER END
  !
  !      Copyright 2011 ForgeRock AS
  !    
  !
-->
<preface xml:id='preface' 
<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'>
 <title>Preface</title>
 

 <para>This guide shows you how to configure, maintain, and troubleshoot
 OpenDJ directory services. This guide also describes file layouts, ports
 used, and standards, controls, extended operations, and languages supported
@@ -38,11 +38,11 @@

 <section>
  <title>Who Should Read this Guide</title>
  

  <para>This guide is written for directory designers and administrators who
  build, deploy, and maintain OpenDJ directory services for your
  organizations.</para>
  

  <para>This guide starts by introducing the OpenDJ administrative interfaces
  and tools, and by showing how to manage OpenDJ server processes. It also
  demonstrates how to import and export directory data. This guide continues
@@ -52,7 +52,7 @@
  tune, troubleshoot, and move servers. This guide concludes with appendices
  of useful reference information for directory designers and
  administrators.</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
  software can help. You do need some background in managing servers and
@@ -74,13 +74,13 @@

 <section>
  <title>Formatting Conventions</title>
  

  <note><para>Pay attention to notes like this one.</para></note>
  

  <para>Some items might be formatted differently from other text, like
  <filename>filenames</filename>, <command>commands</command>, and
  <literal>literal values</literal>.</para>
  

  <screen>$ echo Terminal sessions are formatted like this.
Terminal sessions are formatted like this.</screen>

@@ -92,7 +92,7 @@

    }
}</programlisting>
  

  <para>In many cases, sections pertaining to UNIX, GNU/Linux, Mac OS X, BSD,
  and so forth are marked (UNIX). Sections pertaining to Microsoft Windows
  might be marked (Windows). To avoid repetition, however, file system
@@ -105,7 +105,7 @@

 <section>
  <title>Accessing OpenDJ Documentation Online</title>
  

  <para>Core documentation, such as what you are now reading, aims to
  be technically accurate and complete with respect to the software
  documented. Core documentation therefore follows a <link
@@ -113,11 +113,11 @@
  >three-phase review process</link> designed to eliminate errors. The
  review process should slow authors down enough that documentation you get
  with a stable release has had time to bake fully.</para>
  

  <!-- TODO: online location of core documentation, perhaps docs.forgerock.org? -->
  <para>Fully baked core documentation is available at <link
  xlink:href='http://...'>...</link>.</para>
  

  <para>You need not wait until the core documentation is finished, though,
  to read more about OpenDJ, and also to read about related topics that
  involve OpenDJ without being strictly about OpenDJ. The <link
@@ -131,29 +131,29 @@

 <section>
  <title>Joining the OpenDJ Community</title>
  

  <para>After you <link
  xlink:href='https://idp.forgerock.org/openam/UI/Login?service=register'
  >sign up</link> at ForgeRock, you can also login to the Wiki and the issue
  database to follow what is happening with the project.</para>
  

  <para>If you have questions regarding OpenDJ which are not answered by the
  documentation, there is a mailing list which can be found at
  <link xlink:href='https://lists.forgerock.org/mailman/listinfo/opendj'
  >https://lists.forgerock.org/mailman/listinfo/opendj</link> where you are
  likely to find an answer.</para>
 

  <para>You can join the IRC discussion in the #opendj room at
  irc.freenode.net.</para>
  

  <para>The Wiki has information on how to check out OpenDJ source code.
  There is also a mailing list for OpenDJ development which can be found at
  <link xlink:href='https://lists.forgerock.org/mailman/listinfo/opendj-dev'
  >https://lists.forgerock.org/mailman/listinfo/opendj-dev</link>
  Should you want to contribute a patch, test, or feature, or want to author
  part of the core documentation, first have a look on the ForgeRock site
  at <link xlink:href='http://www.forgerock.com/fcpa-faq.html'>how to get
  involved</link>.</para>
  part of the core documentation, first have a look on the ForgeRock Community
  page at <link xlink:href='http://www.forgerock.org/community_process.html'>
  how to get involved</link>.</para>
 </section>

</preface>

 opendj3/src/main/docbkx/dev-guide/preface.xml

@@ -21,16 +21,16 @@
  ! CCPL HEADER END
  !
  !      Copyright 2011 ForgeRock AS
  !    
  !
-->
<preface xml:id='preface' 
<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'>
 <title>Preface</title>
 

 <para>This guide shows you how to work with OpenDJ SDK to create client
 applications in the Java language to connect to LDAP servers and perform
 LDAP operations.</para>
@@ -40,11 +40,11 @@

  <para>This guide is written for Java developers who want to build directory
  client applications with OpenDJ SDK.</para>
  

  <para>This guide starts by explaining LDAP directories briefly, and
  describing best practices for LDAP client applications. Then it demonstrates
  how to install and use OpenDJ SDK to build LDAP clients.</para>
  

  <para>You do not need to be an LDAP wizard to learn something from this
  guide. You do need some background in writing Java 6 and client-server
  applications to get the most out of this guide. You can nevertheless get
@@ -53,25 +53,25 @@

 <section>
  <title>Using Samples</title>
 

  <para>This work is licensed under the <link
  xlink:href="http://creativecommons.org/licenses/by-nc-nd/3.0/"
  >Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported
  License</link>.</para>
 

  <para>See the license for the specific language governing permissions and
  limitations under the license.</para>
 </section>

 <section>
  <title>Formatting Conventions</title>
  

  <note><para>Pay attention to notes like this one.</para></note>
  

  <para>Some items might be formatted differently from other text, like
  <filename>filenames</filename>, <command>commands</command>, and
  <literal>literal values</literal>.</para>
  

  <screen>$ echo Terminal sessions are formatted like this.
Terminal sessions are formatted like this.</screen>

@@ -83,7 +83,7 @@

    }
}</programlisting>
  

  <para>In many cases, sections pertaining to UNIX, GNU/Linux, Mac OS X, BSD,
  and so forth are marked (UNIX). Sections pertaining to Microsoft Windows
  might be marked (Windows). To avoid repetition, however, file system
@@ -96,7 +96,7 @@

 <section>
  <title>Accessing OpenDJ Documentation Online</title>
  

  <para>Core documentation, such as what you are now reading, aims to
  be technically accurate and complete with respect to the software
  documented. Core documentation therefore follows a <link
@@ -104,11 +104,11 @@
  >three-phase review process</link> designed to eliminate errors. The
  review process should slow authors down enough that documentation you get
  with a stable release has had time to bake fully.</para>
  

  <!-- TODO: online location of core documentation, perhaps docs.forgerock.org? -->
  <para>Fully baked core documentation is available at <link
  xlink:href='http://...'>...</link>.</para>
  

  <para>You need not wait until the core documentation is finished, though,
  to read more about OpenDJ, and also to read about related topics that
  involve OpenDJ without being strictly about OpenDJ. The <link
@@ -117,34 +117,34 @@
  you are welcome to <link
  xlink:href='https://idp.forgerock.org/openam/UI/Login?service=register'
  >sign up</link> and then edit the Wiki if you notice an error, or if you
  have something to share.</para>  
  have something to share.</para>
 </section>

 <section>
  <title>Joining the OpenDJ Community</title>
  

  <para>After you <link
  xlink:href='https://idp.forgerock.org/openam/UI/Login?service=register'
  >sign up</link> at ForgeRock, you can also login to the Wiki and the issue
  database to follow what is happening with the project.</para>
  

  <para>If you have questions regarding OpenDJ which are not answered by the
  documentation, there is a mailing list which can be found at
  <link xlink:href='https://lists.forgerock.org/mailman/listinfo/opendj'
  >https://lists.forgerock.org/mailman/listinfo/opendj</link> where you are
  likely to find an answer.</para>
 

  <para>You can join the IRC discussion in the #opendj room at
  irc.freenode.net.</para>
  

  <para>The Wiki has information on how to check out OpenDJ source code.
  There is also a mailing list for OpenDJ development which can be found at
  <link xlink:href='https://lists.forgerock.org/mailman/listinfo/opendj-dev'
  >https://lists.forgerock.org/mailman/listinfo/opendj-dev</link>
  Should you want to contribute a patch, test, or feature, or want to author
  part of the core documentation, first have a look on the ForgeRock site
  at <link xlink:href='http://www.forgerock.com/fcpa-faq.html'>how to get
  involved</link>.</para>
  part of the core documentation, first have a look on the ForgeRock Community
  page at <link xlink:href='http://www.forgerock.org/community_process.html'>
  how to get involved</link>.</para>
 </section>

</preface>

 opendj3/src/main/docbkx/install-guide/chap-install-cli.xml

@@ -21,7 +21,7 @@
  ! CCPL HEADER END
  !
  !      Copyright 2011 ForgeRock AS
  !    
  !
-->
<chapter xml:id='chap-install-cli'
 xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
@@ -30,21 +30,21 @@
 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
 information on setup options.</para>

 <procedure>
  <title>To Prepare For Installation</title>
   

  <step>
   <para>Make sure you have the correct Java environment installed.</para>
   

   <screen>$ java -version
java version "1.6.0_24"
Java(TM) SE Runtime Environment (build 1.6.0_24-b07-334-9M3326)
Java HotSpot(TM) 64-Bit Server VM (build 19.1-b02-334, mixed mode)</screen>
      

   <para>If your default Java environment is not appropriate, set
   <literal>OPENDS_JAVA_HOME</literal> to the path to the correct Java
   environment, or set <literal>OPENDS_JAVA_BIN</literal> to the absolute path
@@ -53,10 +53,10 @@
   environment installed, and want to make sure you use the 64-bit
   version.</para>
  </step>
    

  <step>
   <para>Get the appropriate installation packages from the <link
     xlink:href='http://www.forgerock.com/downloads-opendj.html'
     xlink:href='http://www.forgerock.org/opendj.html'
     >OpenDJ download page</link>.</para>
   <variablelist>
    <varlistentry>
@@ -79,7 +79,7 @@
    </varlistentry>
   </variablelist>
  </step>
    

  <step>
   <para>Allow OpenDJ software to use at least 64K (65536) file descriptors
   to operate properly.</para>
@@ -91,7 +91,7 @@
   <para>Typically you use the <command>ulimit -a</command> command to list
   current settings.</para>
  </step>
  

  <step>
   <para>If you plan to install OpenDJ DSML gateway, make sure you have an
   appropriate application server installed.</para>
@@ -103,34 +103,34 @@
   properly signed digital certificate that your client applications
   recognize, such as one that fits with your organization's PKI or one
   provided by a recognized certificate authority.</para>
   

   <para>To use the certificate during installation, the certificate
   must be located in a key store provided with Java (JKS, JCEKS, PKCS#12),
   or on a PKCS#11 token. To import a signed certificate into a key store,
   you can use the Java <command>keytool</command> command.</para>
   

   <!-- TODO: Show how this is done for at least one key store type. -->
  </step>
 </procedure>
  

 <procedure>
  <title>To Install OpenDJ Directory Server</title>
  

  <step>
   <para>Unzip <filename>OpenDJ-<?eval ${project.version}?>.zip</filename>
   in the file system directory where you want to install the server.</para>
   

   <para>Unlike the web-based Quick Setup install, the <command>setup</command>
   command uses the directory where you unzipped the files as the installation
   directory, and does not ask you where to install OpenDJ. Therefore, if you
   want to install elsewhere on the file system, unzip the files in that
   location.</para>
  </step>
  

  <step>
   <para>Run the <command>setup --cli</command> command found in the
   <filename>OpenDJ-<?eval ${project.version}?></filename> directory.</para>
   

   <para>This command starts the setup program in interactive mode on the
   command line, prompting you for each option. Alternatively, use
   additional <command>setup</command> options to specify
@@ -142,25 +142,25 @@
   <literal>--cli</literal> option runs the Quick Start
   GUI installer with your local version of software, as does
   Java WebStart with a remote version of the software.</para>
   

   <screen>$ /path/to/OpenDJ-<?eval ${project.version}?>/setup --cli

OpenDJ <?eval ${project.version}?>
Please wait while the setup program initializes...

What would you like to use as the initial root user DN for the Directory
Server? [cn=Directory Manager]: 
Please provide the password to use for the initial root user: 
Please re-enter the password for confirmation: 
Server? [cn=Directory Manager]:
Please provide the password to use for the initial root user:
Please re-enter the password for confirmation:

On which port would you like the Directory Server to accept connections from
LDAP clients? [1389]: 
LDAP clients? [1389]:

On which port would you like the Administration Connector to accept
connections? [4444]: 
Do you want to create base DNs in the server? (yes / no) [yes]: 
connections? [4444]:
Do you want to create base DNs in the server? (yes / no) [yes]:

Provide the base DN for the directory data: [dc=example,dc=com]: 
Provide the base DN for the directory data: [dc=example,dc=com]:
Options for populating the database:

    1)  Only create the base entry
@@ -173,12 +173,12 @@
Please specify the path to the LDIF file containing the data to import: \
/path/to/Example.ldif

Do you want to enable SSL? (yes / no) [no]: 
Do you want to enable SSL? (yes / no) [no]:

Do you want to enable Start TLS? (yes / no) [no]: 
Do you want to enable Start TLS? (yes / no) [no]:

Do you want to start the server when the configuration is completed? (yes /
no) [yes]: 
no) [yes]:


Setup Summary
@@ -200,7 +200,7 @@
    3)  Print equivalent non-interactive command-line
    4)  Cancel and exit

Enter choice [1]: 
Enter choice [1]:

See /var/....log for a detailed log of this operation.

@@ -210,7 +210,7 @@

To see basic server configuration status and configuration you can launch \
/path/to/OpenDJ-<?eval ${project.version}?>/bin/status</screen>
      

   <variablelist>
    <para>Some notes on the options follow.</para>
    <varlistentry>
@@ -264,7 +264,7 @@
       not want to import the data at the same time you install is because
       your data uses attributes not defined in the default schema, and so
       you will wait to add schema definitions before you import.</para>
       

       <para>If you have a huge data set to import, you no doubt should
       also increase the import cache size, which you can do by passing
       a Java properties file. You might also prefer to perform data
@@ -316,18 +316,18 @@
    </varlistentry>
   </variablelist>
  </step>
    

  <step>
   <para>Run the <command>status</command> command to make sure your OpenDJ
   server is working as expected.</para>
   

   <screen>$ /path/to/OpenDJ-<?eval ${project.version}?>/bin/status

>>>> Specify OpenDJ LDAP connection parameters

Administrator user bind DN [cn=Directory Manager]: 
Administrator user bind DN [cn=Directory Manager]:

Password for user 'cn=Directory Manager': 
Password for user 'cn=Directory Manager':

          --- Server Status ---
Server Run Status:        Started
@@ -357,7 +357,7 @@
Replication: Disabled</screen>
  </step>
 </procedure>
 

 <note>
  <para>You can install OpenDJ in unattended and silent fashion by using the
  <command>setup</command> command with the <option>--no-prompt</option>
@@ -366,25 +366,25 @@

 <procedure>
  <title>To Install OpenDJ DSML gateway</title>
  

  <para>The OpenDJ DSML gateway functions as a web application located in a
  web application container. The DSML gateway runs independently of OpenDJ
  directory server. You configure the gateway to access your directory service
  by editing the <literal>ldap.host</literal> and <literal>ldap.port</literal>
  parameters in the <filename>WEB-INF/web.xml</filename> configuration
  file.</para>
  

  <step>
   <para>Deploy <filename>OpenDJ-<?eval ${project.version}?>-DSML.war</filename>
   according to the instructions for your application server.</para>
  </step>
  

  <step>
   <para>Edit <filename>WEB-INF/web.xml</filename> to ensure the values for
   <literal>ldap.host</literal> and <literal>ldap.port</literal> are
   correct.</para>
  </step>
  

  <step>
   <para>Restart the web application container according to the instructions
   for your application server.</para>

 opendj3/src/main/docbkx/install-guide/chap-install-gui.xml

@@ -21,7 +21,7 @@
  ! CCPL HEADER END
  !
  !      Copyright 2011 ForgeRock AS
  !    
  !
-->
<chapter xml:id='chap-install-gui'
 xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
@@ -34,7 +34,7 @@
 <para>If you want only to try OpenDJ server software, and you do not plan to
 store any real or important data that you want to keep, then read only this
 section, or just try out installation without reading any further. Visit the
 <link xlink:href='http://www.forgerock.com/downloads-opendj.html'>download
 <link xlink:href='http://www.forgerock.org/opendj.html'>download
 page</link>, and click the first link on the left for the latest release
 to start the Java WebStart installer directly from your browser.</para>

@@ -43,19 +43,19 @@
 to try OpenDJ directory server for the first time, or to do a quick test
 installation. You can also upgrade an OpenDJ directory server through the
 WebStart installer.</para>
 

 <note><para>OpenDJ directory server relies on Java 6, so if your browser
 picks up an old installation of Java 5 for example, installation can fail.
 Currently also if you are on a Linux system, you need to get Sun Java 6
 before you use OpenDJ directory server.</para>
 

 <para>If the WebStart installation does not work in your browser, copy
 the WebStart URL, ending in <literal>QuickSetup.jnlp</literal>, from the
 OpenDJ download page. This is the first link in the list of links for
 a version of OpenDJ. Next, pass the link as an argument to the
 <command>javaws</command> command in a terminal window to start the
  installer.</para>
 

 <screen>$ export PATH=/path/to/sun-java6/bin:$PATH
$ javaws http://www.forgerock.org/downloads/opendj/<?eval ${project.version}?>/install/QuickSetup.jnlp</screen>

@@ -64,17 +64,17 @@
 OpenDJ-<?eval ${project.version}?>/setup (UNIX), OpenDJ-<?eval
 ${project.version}?>\setup.bat (Windows), or QuickSetup.app (Mac OS X).</para>
 </note>
  

 <para>Java WebStart launches the the QuickSetup wizard, and soon the
 Welcome screen appears.</para>
  

 <mediaobject>
  <imageobject>
   <imagedata fileref="images/QuickSetup-welcome.png" format="PNG" />
  </imageobject>
  <caption><para>The Welcome screen appears.</para></caption>
 </mediaobject>
 

 <mediaobject>
  <imageobject>
   <imagedata fileref="images/QuickSetup-svrconf.png" format="PNG" />
@@ -82,7 +82,7 @@
  <caption><para>Notice in the Server Settings screen that the default ports
  are 389 or 1389 for LDAP, 4444 for administrative access.</para></caption>
 </mediaobject>
  

 <mediaobject>
   <imageobject>
     <imagedata fileref="images/QuickSetup-replopts.png" format="PNG" />
@@ -90,7 +90,7 @@
   <caption><para>You can replicate data for high availability through the
   Topology Options screen.</para></caption>
 </mediaobject>
 

 <mediaobject>
  <imageobject>
   <imagedata fileref="images/QuickSetup-gendata.png" format="PNG" />
@@ -98,7 +98,7 @@
  <caption><para>Generate test data as part of server setup in the Directory
  Data screen.</para></caption>
 </mediaobject>
 

 <mediaobject>
  <imageobject>
   <imagedata fileref="images/QuickSetup-jvmopts.png" format="PNG" />
@@ -106,14 +106,14 @@
  <caption><para>For a real installation, you adjust JVM parameters for
  your server, for example to allow OpenDJ to use more memory.</para></caption>
 </mediaobject>
 

 <mediaobject>
  <imageobject>
   <imagedata fileref="images/QuickSetup-review.png" format="PNG" />
  </imageobject>
  <caption><para>Opt to start your server when setup completes.</para></caption>
 </mediaobject>
 

 <mediaobject>
  <imageobject>
   <imagedata fileref="images/QuickSetup-finished.png" format="PNG" />
@@ -121,7 +121,7 @@
  <caption><para>Finally, click Launch Control Panel to check your newly
  installed server.</para></caption>
 </mediaobject>
 

 <mediaobject>
  <imageobject>
   <imagedata fileref="images/QuickSetup-cpstart.png" format="PNG" />

 opendj3/src/main/docbkx/install-guide/chap-upgrade.xml

@@ -21,7 +21,7 @@
  ! CCPL HEADER END
  !
  !      Copyright 2011 ForgeRock AS
  !    
  !
-->
<chapter xml:id='chap-upgrade'
 xmlns='http://docbook.org/ns/docbook' version='5.0' xml:lang='en'
@@ -34,31 +34,31 @@
 <para>You can upgrade from an earlier version of OpenDJ either directly
 from within the Java WebStart installer, or on the command-line using the
 <command>upgrade</command> command.</para>
  

 <note>
  <para>Upgrade from OpenDS 2.2 or OpenDJ 2.4 has been tested most thoroughly
  on Solaris, Mac OS X, and Linux. On Windows systems, export directory data
  to LDIF, start with a fresh installation of the OpenDJ software, and then
  import your data from LDIF.</para>
 </note>
  

 <section>
  <title>Before You Upgrade</title>
  

  <para>You must perform the upgrade procedure as the user who own the OpenDJ
  server. Make sure you have the credentials to run commands as the user who
  owns the server.</para>
      

  <para>Do a full backup of your current OpenDJ installation.</para>
  

  <para>When running a server version earlier than OpenDJ 2.4.1 fix the upgrade
  schema by following the appropriate steps depending on your platform.</para>
  

  <para>(UNIX) Download and apply <link
  xlink:href='http://wikis.forgerock.org/confluence/download/attachments/11632664/opendj_patch4upgrade.sh'
  >opendj_patch4upgrade.sh</link> to your current server, by
  running the shell script from the directory where the server is installed.</para>
  

  <screen>$ cd /path/to/OpenDJ
$ sh /downloads/opendj_patch4upgrade.sh
/path/to/OpenDJ has been patched, you can proceed with the upgrade program now</screen>
@@ -66,7 +66,7 @@
  <para>The <filename>opendj_patch4upgrade.sh</filename> script fixes a schema
  issuethat prevents smooth upgrades from earlier server versions. You can
  apply the script while the server is running.</para>
  

  <para>(Windows) Follow these steps.</para>
  <orderedlist>
   <listitem>
@@ -97,22 +97,22 @@

 <section>
  <title>Upgrading OpenDJ Servers</title>
  

  <para>You can upgrade from the graphical installer, or from the command
  line.</para>
   

  <procedure>
   <title>To Upgrade From the Graphical Installer</title>
   <step>
    <para>Login to a session where you can use a GUI as the user who owns the
    current OpenDJ server.</para>
   </step>
   

   <step performance='optional'>
    <para><link xlink:href='http://www.forgerock.com/downloads-opendj.html'
    <para><link xlink:href='http://www.forgerock.org/opendj.html'
     >Download OpenDJ</link>, and unzip the downloaded file.</para>
   </step>
   

   <step>
    <para>Start the installer.</para>
    <itemizedlist>
@@ -130,18 +130,18 @@
     </listitem>
    </itemizedlist>
   </step>
   

   <step>
    <para>In the OpenDJ QuickSetup Welcome screen, select Upgrade Existing
    Server Instance, and make sure Server to Upgrade points to the current
    OpenDJ server before clicking Next.</para>
   </step>
   

   <step>
    <para>Follow the instructions in the QuickSetup wizard to complete the
    upgrade.</para>
   </step>
  

   <step>
    <para>If you upgraded from OpenDS 2.2, open the OpenDJ control panel,
    select Indexes &gt; Rebuild Indexes..., and use the Rebuild Indexes dialog
@@ -151,11 +151,11 @@

  <procedure>
   <title>To Upgrade On the Command Line</title>
   

   <step>
    <para>Login as the user who owns the current OpenDJ server.</para>
   </step>
   

   <step>
    <para>Download the OpenDJ .zip file.</para>
    <screen>$ cd /tmp
@@ -193,7 +193,7 @@
    <para>If you upgraded from OpenDS 2.2, use the
    <command>rebuild-index</command> command to rebuild the
    <literal>dn2id</literal> index for your suffixes.</para>
    

    <screen>$ ./bin/rebuild-index -i dn2id -b "dc=example,dc=com"
...Rebuild complete. Processed 160 entries in 0 seconds (average rate 401.0/sec)</screen>
   </step>
@@ -205,7 +205,7 @@
    <para>Upgrade each server sequentially, as described above.</para>
   </step>
  </procedure>
  

  <procedure>
   <title>To Upgrade OpenDJ DSML Gateway</title>
   <step>

 opendj3/src/main/docbkx/install-guide/preface.xml

@@ -21,31 +21,31 @@
  ! CCPL HEADER END
  !
  !      Copyright 2011 ForgeRock AS
  !    
  !
-->
<preface xml:id='preface' 
<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'>
 <title>Preface</title>
 

 <para>This guide shows you how to install, upgrade, and remove OpenDJ
 software. Unless you are planning a throwaway evaluation or test
 installation, read the <citetitle>Release Notes</citetitle> before
 you get started.</para>
 

 <para>If you want only to try OpenDJ server software, and you
 do not plan to store any real or important data that you want to keep,
 then you need not read this guide right now. Instead, visit the <link
 xlink:href='http://www.forgerock.com/downloads-opendj.html'
 xlink:href='http://www.forgerock.org/opendj.html'
 >download page</link>, and click the link for the latest release to
 start the Java WebStart installer wizard directly from your browser.</para>

 <section>
  <title>Who Should Read this Guide</title>
  

  <para>This guide is written for anyone installing OpenDJ who plans to
  maintain directory services for client applications. Basic OpenDJ
  installation, especially using Java WebStart, can be simple and
@@ -54,17 +54,17 @@
  failure that can cause downtime requires at least a little thought
  and planning. Also, even in the case of basic installation, you may
  find yourself wanting more background about what you are doing.</para>
  

  <para>This guide covers the install, upgrade, and removal (a.k.a. uninstall)
  procedures that you theoretically perform only once per version. This guide
  aims to provide you with at least some idea of what happens behind the
  scenes when you perform the steps.</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
  software can help. You do need some background in managing servers and
  services on your operating system of choice. You can nevertheless get
  started with this guide, and then learn more as you go along.</para>  
  started with this guide, and then learn more as you go along.</para>
 </section>

 <section>
@@ -81,13 +81,13 @@

 <section>
  <title>Formatting Conventions</title>
  

  <note><para>Pay attention to notes like this one.</para></note>
  

  <para>Some items might be formatted differently from other text, like
  <filename>filenames</filename>, <command>commands</command>, and
  <literal>literal values</literal>.</para>
  

  <screen>$ echo Terminal sessions are formatted like this.
Terminal sessions are formatted like this.</screen>

@@ -99,7 +99,7 @@

    }
}</programlisting>
  

  <para>In many cases, sections pertaining to UNIX, GNU/Linux, Mac OS X, BSD,
  and so forth are marked (UNIX). Sections pertaining to Microsoft Windows
  might be marked (Windows). To avoid repetition, however, file system
@@ -112,7 +112,7 @@

 <section>
  <title>Accessing OpenDJ Documentation Online</title>
  

  <para>Core documentation, such as what you are now reading, aims to
  be technically accurate and complete with respect to the software
  documented. Core documentation therefore follows a <link
@@ -120,11 +120,11 @@
  >three-phase review process</link> designed to eliminate errors. The
  review process should slow authors down enough that documentation you get
  with a stable release has had time to bake fully.</para>
  

  <!-- TODO: online location of core documentation, perhaps docs.forgerock.org? -->
  <para>Fully baked core documentation is available at <link
  xlink:href='http://...'>...</link>.</para>
  

  <para>You need not wait until the core documentation is finished, though,
  to read more about OpenDJ, and also to read about related topics that
  involve OpenDJ without being strictly about OpenDJ. The <link
@@ -133,34 +133,34 @@
  you are welcome to <link
  xlink:href='https://idp.forgerock.org/openam/UI/Login?service=register'
  >sign up</link> and then edit the Wiki if you notice an error, or if you
  have something to share.</para>  
  have something to share.</para>
 </section>

 <section>
  <title>Joining the OpenDJ Community</title>
  

  <para>After you <link
  xlink:href='https://idp.forgerock.org/openam/UI/Login?service=register'
  >sign up</link> at ForgeRock, you can also login to the Wiki and the issue
  database to follow what is happening with the project.</para>
  

  <para>If you have questions regarding OpenDJ which are not answered by the
  documentation, there is a mailing list which can be found at
  <link xlink:href='https://lists.forgerock.org/mailman/listinfo/opendj'
  >https://lists.forgerock.org/mailman/listinfo/opendj</link> where you are
  likely to find an answer.</para>
 

  <para>You can join the IRC discussion in the #opendj room at
  irc.freenode.net.</para>
  

  <para>The Wiki has information on how to check out OpenDJ source code.
  There is also a mailing list for OpenDJ development which can be found at
  <link xlink:href='https://lists.forgerock.org/mailman/listinfo/opendj-dev'
  >https://lists.forgerock.org/mailman/listinfo/opendj-dev</link>
  Should you want to contribute a patch, test, or feature, or want to author
  part of the core documentation, first have a look on the ForgeRock site
  at <link xlink:href='http://www.forgerock.com/fcpa-faq.html'>how to get
  involved</link>.</para>
  part of the core documentation, first have a look on the ForgeRock Community
  page at <link xlink:href='http://www.forgerock.org/community_process.html'>
  how to get involved</link>.</para>
 </section>

</preface>

 opendj3/src/main/docbkx/shared/man-upgrade.xml

@@ -21,7 +21,7 @@
  ! CCPL HEADER END
  !
  !      Copyright 2011 ForgeRock AS
  !    
  !
-->
<refentry xml:id='upgrade-1'
 xmlns='http://docbook.org/ns/docbook'
@@ -51,7 +51,7 @@
  an OpenDJ install package (.zip) file and specify its location using the
  -f/--file option.  You can also upgrade your server using the Java Web Start
  version of this tool by visiting the OpenDJ web site at
  www.forgerock.org/downloads-opendj.html.</para>
  www.forgerock.org/opendj.html.</para>
  <para>When using the tool to revert to a previous version you must either
  indicate that you want to revert to the version before the most recent
  upgrade using the -r/--revertMostRecent option or specify the location of a