CR-6147 OPENDJ-1785 Add "extra" doc into code for generated content

Mark Craig

20.18.2015 27d398c0bcca6adaf643fa3f6fd02ed67ff4adf1

 opendj-cli/src/main/java/com/forgerock/opendj/cli/ArgumentParser.java

@@ -613,6 +613,32 @@
    }

    /**
     * A short description for this tool, suitable in a man page summary line.
     */
    private LocalizableMessage shortToolDescription;

    /**
     * Gets a short description for this tool, suitable in a man page summary line.
     *
     * @return  A short description for this tool,
     *          suitable in a man page summary line,
     *          or LocalizableMessage.EMPTY if there is no short description.
     */
    LocalizableMessage getShortToolDescription() {
        return shortToolDescription != null ? shortToolDescription : LocalizableMessage.EMPTY;
    }

    /**
     * Sets a short description for this tool, suitable in a man page summary line.
     *
     * @param   shortDescription    The short description for this tool,
     *                              suitable in a man page summary line.
     */
    public void setShortToolDescription(final LocalizableMessage shortDescription) {
        this.shortToolDescription = shortDescription;
    }

    /**
     * A supplement to the description for this tool
     * intended for use in generated reference documentation.
     */
@@ -687,6 +713,7 @@
        map.put("locale", Locale.getDefault().getLanguage());
        map.put("year", new SimpleDateFormat("yyyy").format(new Date()));
        map.put("name", scriptName);
        map.put("shortDesc", getShortToolDescription());
        map.put("descTitle", REF_TITLE_DESCRIPTION.get());
        map.put("optsTitle", REF_TITLE_OPTIONS.get());
        map.put("optsIntro", REF_INTRO_OPTIONS.get(scriptName));

 opendj-cli/src/main/resources/com/forgerock/opendj/cli/cli.properties

@@ -979,6 +979,7 @@
REF_INTRO_OPTIONS=The <command>%s</command> command takes the following options:
REF_DEFAULT=Default: %s
REF_TITLE_SUBCOMMANDS=Subcommands
REF_SHORT_DESC_UNINISTALL=remove OpenDJ directory server software

# Supplements to descriptions for generated reference documentation.
SUPPLEMENT_DESCRIPTION_CONTROLS=<para>                                             \

 opendj-cli/src/main/resources/templates/refEntry.ftl

@@ -72,7 +72,7 @@

 <refnamediv>
  <refname>${name}</refname>
  <refpurpose>TODO short description</refpurpose>
  <refpurpose>${shortDesc}</refpurpose>
 </refnamediv>

 <refsynopsisdiv>

 opendj-config/src/main/java/org/forgerock/opendj/config/dsconfig/DSConfig.java

@@ -860,6 +860,7 @@
        super(new PrintStream(out), new PrintStream(err));

        this.parser = new SubCommandArgumentParser(getClass().getName(), INFO_DSCFG_TOOL_DESCRIPTION.get(), false);
        this.parser.setShortToolDescription(REF_SHORT_DESC_DSCONFIG.get());
        this.parser.setVersionHandler(new VersionHandler() {
            @Override
            public void printVersion() {

 opendj-config/src/main/resources/com/forgerock/opendj/dsconfig/dsconfig.properties

@@ -503,3 +503,4 @@
REF_DSCFG_IP_ADDRESS_MASK_1037=An IP address mask
REF_DSCFG_STRING_1038=A String
REF_DSCFG_UNKNOWN_1039=Unknown
REF_SHORT_DESC_DSCONFIG_1040=manage OpenDJ directory server configuration

 opendj-ldap-toolkit/src/main/java/com/forgerock/opendj/ldap/tools/AddRate.java

@@ -416,6 +416,7 @@
        final LocalizableMessage toolDescription = INFO_ADDRATE_TOOL_DESCRIPTION.get();
        final ArgumentParser argParser =
            new ArgumentParser(AddRate.class.getName(), toolDescription, false, true, 1, 1, "template-file-path");
        argParser.setShortToolDescription(REF_SHORT_DESC_ADDRATE.get());
        argParser.setDocToolDescriptionSupplement(SUPPLEMENT_DESCRIPTION_RATE_TOOLS.get());

        final ConnectionFactoryProvider connectionFactoryProvider;

 opendj-ldap-toolkit/src/main/java/com/forgerock/opendj/ldap/tools/AuthRate.java

@@ -391,6 +391,7 @@
        final ArgumentParser argParser =
                new ArgumentParser(AuthRate.class.getName(), toolDescription, false, true, 0, 0,
                        "[filter format string] [attributes ...]");
        argParser.setShortToolDescription(REF_SHORT_DESC_AUTHRATE.get());
        argParser.setDocToolDescriptionSupplement(SUPPLEMENT_DESCRIPTION_RATE_TOOLS.get());

        ConnectionFactoryProvider connectionFactoryProvider;

 opendj-ldap-toolkit/src/main/java/com/forgerock/opendj/ldap/tools/LDAPCompare.java

@@ -22,7 +22,7 @@
 *
 *
 *      Copyright 2010 Sun Microsystems, Inc.
 *      Portions Copyright 2011-2014 ForgeRock AS
 *      Portions Copyright 2011-2015 ForgeRock AS.
 */
package com.forgerock.opendj.ldap.tools;

@@ -146,6 +146,7 @@
        final ArgumentParser argParser =
                new ArgumentParser(LDAPCompare.class.getName(), toolDescription, false, true, 1, 0,
                        "attribute:value [DN ...]");
        argParser.setShortToolDescription(REF_SHORT_DESC_LDAPCOMPARE.get());
        ConnectionFactoryProvider connectionFactoryProvider;
        ConnectionFactory connectionFactory;


 opendj-ldap-toolkit/src/main/java/com/forgerock/opendj/ldap/tools/LDAPModify.java

@@ -22,7 +22,7 @@
 *
 *
 *      Copyright 2010 Sun Microsystems, Inc.
 *      Portions Copyright 2011-2014 ForgeRock AS
 *      Portions Copyright 2011-2015 ForgeRock AS.
 */
package com.forgerock.opendj.ldap.tools;

@@ -250,6 +250,7 @@
        final LocalizableMessage toolDescription = INFO_LDAPMODIFY_TOOL_DESCRIPTION.get();
        final ArgumentParser argParser =
                new ArgumentParser(LDAPModify.class.getName(), toolDescription, false);
        argParser.setShortToolDescription(REF_SHORT_DESC_LDAPMODIFY.get());
        ConnectionFactoryProvider connectionFactoryProvider;
        ConnectionFactory connectionFactory;


 opendj-ldap-toolkit/src/main/java/com/forgerock/opendj/ldap/tools/LDAPPasswordModify.java

@@ -22,7 +22,7 @@
 *
 *
 *      Copyright 2010 Sun Microsystems, Inc.
 *      Portions Copyright 2011-2014 ForgeRock AS
 *      Portions Copyright 2011-2015 ForgeRock AS.
 */
package com.forgerock.opendj.ldap.tools;

@@ -101,6 +101,7 @@
        final LocalizableMessage toolDescription = INFO_LDAPPWMOD_TOOL_DESCRIPTION.get();
        final ArgumentParser argParser =
                new ArgumentParser(LDAPPasswordModify.class.getName(), toolDescription, false);
        argParser.setShortToolDescription(REF_SHORT_DESC_LDAPPASSWORDMODIFY.get());
        ConnectionFactoryProvider connectionFactoryProvider;
        ConnectionFactory connectionFactory;


 opendj-ldap-toolkit/src/main/java/com/forgerock/opendj/ldap/tools/LDAPSearch.java

@@ -22,7 +22,7 @@
 *
 *
 *      Copyright 2010 Sun Microsystems, Inc.
 *      Portions Copyright 2011-2014 ForgeRock AS
 *      Portions Copyright 2011-2015 ForgeRock AS.
 */
package com.forgerock.opendj.ldap.tools;

@@ -238,6 +238,7 @@
        final ArgumentParser argParser =
                new ArgumentParser(LDAPSearch.class.getName(), toolDescription, false, true, 0, 0,
                        "[filter] [attributes ...]");
        argParser.setShortToolDescription(REF_SHORT_DESC_LDAPSEARCH.get());
        ConnectionFactoryProvider connectionFactoryProvider;
        ConnectionFactory connectionFactory;


 opendj-ldap-toolkit/src/main/java/com/forgerock/opendj/ldap/tools/LDIFDiff.java

@@ -22,7 +22,7 @@
 *
 *
 *      Copyright 2012-2013 ForgeRock AS
 *      Portions copyright 2014 ForgeRock AS
 *      Portions Copyright 2014-2015 ForgeRock AS.
 */
package com.forgerock.opendj.ldap.tools;

@@ -83,6 +83,7 @@
        final ArgumentParser argParser =
                new ArgumentParser(LDIFDiff.class.getName(), toolDescription, false, true, 2, 2,
                        "source target");
        argParser.setShortToolDescription(REF_SHORT_DESC_LDIFDIFF.get());

        final BooleanArgument showUsage;
        final StringArgument outputFilename;

 opendj-ldap-toolkit/src/main/java/com/forgerock/opendj/ldap/tools/LDIFModify.java

@@ -21,7 +21,7 @@
 * CDDL HEADER END
 *
 *
 *      Copyright 2012-2014 ForgeRock AS
 *      Copyright 2012-2015 ForgeRock AS.
 */
package com.forgerock.opendj.ldap.tools;

@@ -90,6 +90,7 @@
        final ArgumentParser argParser =
                new ArgumentParser(LDIFModify.class.getName(), toolDescription, false, true, 1, 2,
                        "source [changes]");
        argParser.setShortToolDescription(REF_SHORT_DESC_LDIFMODIFY.get());

        final BooleanArgument continueOnError;
        final BooleanArgument showUsage;

 opendj-ldap-toolkit/src/main/java/com/forgerock/opendj/ldap/tools/LDIFSearch.java

@@ -21,7 +21,7 @@
 * CDDL HEADER END
 *
 *
 *      Copyright 2012-2014 ForgeRock AS
 *      Copyright 2012-2015 ForgeRock AS.
 */
package com.forgerock.opendj.ldap.tools;

@@ -92,6 +92,7 @@
        final ArgumentParser argParser =
                new ArgumentParser(LDIFSearch.class.getName(), toolDescription, false, true, 1, 0,
                        "source [filter] [attributes ...]");
        argParser.setShortToolDescription(REF_SHORT_DESC_LDIFSEARCH.get());

        final BooleanArgument showUsage;
        final StringArgument outputFilename;

 opendj-ldap-toolkit/src/main/java/com/forgerock/opendj/ldap/tools/MakeLDIF.java

@@ -87,6 +87,7 @@
        final LocalizableMessage toolDescription = INFO_MAKELDIF_TOOL_DESCRIPTION.get();
        final ArgumentParser argParser = new ArgumentParser(MakeLDIF.class.getName(), toolDescription,
                false, true, 1, 1, "template-file-path");
        argParser.setShortToolDescription(REF_SHORT_DESC_MAKELDIF.get());
        argParser.setDocToolDescriptionSupplement(SUPPLEMENT_DESCRIPTION_MAKELDIF.get());

        BooleanArgument showUsage;

 opendj-ldap-toolkit/src/main/java/com/forgerock/opendj/ldap/tools/ModRate.java

@@ -167,6 +167,7 @@
        final ArgumentParser argParser =
                new ArgumentParser(ModRate.class.getName(), toolDescription, false, true, 1, 0,
                        "[(attribute:value format string) ...]");
        argParser.setShortToolDescription(REF_SHORT_DESC_MODRATE.get());
        argParser.setDocToolDescriptionSupplement(SUPPLEMENT_DESCRIPTION_RATE_TOOLS.get());
        ConnectionFactoryProvider connectionFactoryProvider;
        ConnectionFactory connectionFactory;

 opendj-ldap-toolkit/src/main/java/com/forgerock/opendj/ldap/tools/SearchRate.java

@@ -212,6 +212,7 @@
        final ArgumentParser argParser =
                new ArgumentParser(SearchRate.class.getName(), toolDescription, false, true, 1, 0,
                        "[filter format string] [attributes ...]");
        argParser.setShortToolDescription(REF_SHORT_DESC_SEARCHRATE.get());
        argParser.setDocToolDescriptionSupplement(SUPPLEMENT_DESCRIPTION_RATE_TOOLS.get());

        ConnectionFactoryProvider connectionFactoryProvider;

 opendj-ldap-toolkit/src/main/resources/com/forgerock/opendj/ldap/tools/tools.properties

@@ -553,6 +553,20 @@
 the maximum number of add operations
INFO_ADDRATE_DESCRIPTION_NOPURGE=Disable the purge phase when the tool stops.

# Strings for generated reference documentation.
REF_SHORT_DESC_ADDRATE=measure add and delete throughput and response time
REF_SHORT_DESC_AUTHRATE=measure bind throughput and response time
REF_SHORT_DESC_LDAPCOMPARE=perform LDAP compare operations
REF_SHORT_DESC_LDAPMODIFY=perform LDAP modify, add, delete, mod DN operations
REF_SHORT_DESC_LDAPPASSWORDMODIFY=perform LDAP password modifications
REF_SHORT_DESC_LDAPSEARCH=perform LDAP search operations
REF_SHORT_DESC_LDIFDIFF=compare small LDIF files
REF_SHORT_DESC_LDIFMODIFY=apply LDIF changes to LDIF
REF_SHORT_DESC_LDIFSEARCH=search LDIF with LDAP filters
REF_SHORT_DESC_MAKELDIF=generate test LDIF
REF_SHORT_DESC_MODRATE=measure modification throughput and response time
REF_SHORT_DESC_SEARCHRATE=measure search throughput and response time

# Supplements to descriptions for generated reference documentation.
SUPPLEMENT_DESCRIPTION_RATE_TOOLS=<para>                                         \
    When you do not use the <option>-f</option> option                           \

 opendj-server-legacy/src/main/java/org/opends/guitools/controlpanel/ControlPanelArgumentParser.java

@@ -22,7 +22,7 @@
 *
 *
 *      Copyright 2009-2010 Sun Microsystems, Inc.
 *      Portions Copyright 2011-2015 ForgeRock AS
 *      Portions Copyright 2011-2015 ForgeRock AS.
 */
package org.opends.guitools.controlpanel;

@@ -80,6 +80,7 @@
      LocalizableMessage msg)
  {
    super(mainClassName, msg, false);
    setShortToolDescription(REF_SHORT_DESC_CONTROL_PANEL.get());
    setVersionHandler(new DirectoryServerVersionHandler());
  }


 opendj-server-legacy/src/main/java/org/opends/guitools/uninstaller/UninstallerArgumentParser.java

@@ -22,7 +22,7 @@
 *
 *
 *      Copyright 2008-2010 Sun Microsystems, Inc.
 *      Portions Copyright 2014-2015 ForgeRock AS
 *      Portions Copyright 2014-2015 ForgeRock AS.
 */
package org.opends.guitools.uninstaller;

@@ -86,6 +86,7 @@
      LocalizableMessage toolDescription, boolean longArgumentsCaseSensitive)
  {
    super(mainClassName, toolDescription, longArgumentsCaseSensitive);
    setShortToolDescription(REF_SHORT_DESC_UNINISTALL.get());
    setVersionHandler(new DirectoryServerVersionHandler());
  }


 opendj-server-legacy/src/main/java/org/opends/server/core/DirectoryServer.java

@@ -7797,6 +7797,7 @@
    ArgumentParser argParser =
         new ArgumentParser("org.opends.server.core.DirectoryServer",
                            theToolDescription, false);
    argParser.setShortToolDescription(REF_SHORT_DESC_START_DS.get());

    // Initialize all the command-line argument types and register them with the
    // parser.

 opendj-server-legacy/src/main/java/org/opends/server/tools/BackUpDB.java

@@ -167,6 +167,7 @@
    LDAPConnectionArgumentParser argParser =
            createArgParser("org.opends.server.tools.BackUpDB",
                            INFO_BACKUPDB_TOOL_DESCRIPTION.get());
    argParser.setShortToolDescription(REF_SHORT_DESC_BACKUP.get());


    // Initialize all the command-line argument types and register them with the

 opendj-server-legacy/src/main/java/org/opends/server/tools/ConfigureWindowsService.java

@@ -22,7 +22,7 @@
 *
 *
 *      Copyright 2008-2010 Sun Microsystems, Inc.
 *      Portions Copyright 2011-2015 ForgeRock AS
 *      Portions Copyright 2011-2015 ForgeRock AS.
 */
package org.opends.server.tools;

@@ -202,6 +202,7 @@
        INFO_CONFIGURE_WINDOWS_SERVICE_TOOL_DESCRIPTION.get();
    ArgumentParser argParser = new ArgumentParser(CLASS_NAME,
        toolDescription, false);
    argParser.setShortToolDescription(REF_SHORT_DESC_WINDOWS_SERVICE.get());
    BooleanArgument enableService = null;
    BooleanArgument disableService = null;
    BooleanArgument serviceState = null;

 opendj-server-legacy/src/main/java/org/opends/server/tools/CreateRCScript.java

@@ -22,7 +22,7 @@
 *
 *
 *      Copyright 2008 Sun Microsystems, Inc.
 *      Portions Copyright 2010-2015 ForgeRock AS
 *      Portions Copyright 2010-2015 ForgeRock AS.
 */
package org.opends.server.tools;

@@ -119,6 +119,7 @@
    LocalizableMessage description = INFO_CREATERC_TOOL_DESCRIPTION.get();
    ArgumentParser argParser =
         new ArgumentParser(CreateRCScript.class.getName(), description, false);
    argParser.setShortToolDescription(REF_SHORT_DESC_CREATE_RC_SCRIPT.get());
    argParser.setVersionHandler(new DirectoryServerVersionHandler());

    BooleanArgument showUsage;

 opendj-server-legacy/src/main/java/org/opends/server/tools/DBTest.java

@@ -176,6 +176,7 @@

    LocalizableMessage toolDescription = INFO_DESCRIPTION_DBTEST_TOOL.get();
    this.parser = new SubCommandArgumentParser(getClass().getName(), toolDescription, false);
    this.parser.setShortToolDescription(REF_SHORT_DESC_DBTEST.get());
    this.parser.setVersionHandler(new DirectoryServerVersionHandler());
  }


 opendj-server-legacy/src/main/java/org/opends/server/tools/EncodePassword.java

@@ -156,6 +156,7 @@
    ArgumentParser argParser =
         new ArgumentParser("org.opends.server.tools.EncodePassword",
                            toolDescription, false);
    argParser.setShortToolDescription(REF_SHORT_DESC_ENCODE_PASSWORD.get());
    argParser.setVersionHandler(new DirectoryServerVersionHandler());

    // Initialize all the command-line argument types and register them with the

 opendj-server-legacy/src/main/java/org/opends/server/tools/ExportLDIF.java

@@ -169,6 +169,7 @@
    LDAPConnectionArgumentParser argParser =
            createArgParser("org.opends.server.tools.ExportLDIF",
                            INFO_LDIFEXPORT_TOOL_DESCRIPTION.get());
    argParser.setShortToolDescription(REF_SHORT_DESC_EXPORT_LDIF.get());


    // Initialize all the command-line argument types and register them with the

 opendj-server-legacy/src/main/java/org/opends/server/tools/ImportLDIF.java

@@ -192,6 +192,7 @@
    LDAPConnectionArgumentParser argParser =
            createArgParser("org.opends.server.tools.ImportLDIF",
                            INFO_LDIFIMPORT_TOOL_DESCRIPTION.get());
    argParser.setShortToolDescription(REF_SHORT_DESC_IMPORT_LDIF.get());

    // Initialize all the command-line argument types and register them with the
    // parser.

 opendj-server-legacy/src/main/java/org/opends/server/tools/InstallDSArgumentParser.java

@@ -114,6 +114,7 @@
  public InstallDSArgumentParser(String mainClassName)
  {
    super(mainClassName, INFO_INSTALLDS_TOOL_DESCRIPTION.get(), false);
    setShortToolDescription(REF_SHORT_DESC_SETUP.get());
    setVersionHandler(new DirectoryServerVersionHandler());
  }


 opendj-server-legacy/src/main/java/org/opends/server/tools/JavaPropertiesToolArgumentParser.java

@@ -70,6 +70,7 @@
    super(mainClassName,
        INFO_JAVAPROPERTIES_TOOL_DESCRIPTION.get(getDefaultPropertiesValue()),
        false);
    setShortToolDescription(REF_SHORT_DESC_DSJAVAPROPERTIES.get());
    setVersionHandler(new DirectoryServerVersionHandler());
  }


 opendj-server-legacy/src/main/java/org/opends/server/tools/LDAPCompare.java

@@ -22,7 +22,7 @@
 *
 *
 *      Copyright 2006-2010 Sun Microsystems, Inc.
 *      Portions Copyright 2012-2015 ForgeRock AS
 *      Portions Copyright 2012-2015 ForgeRock AS.
 */
package org.opends.server.tools;

@@ -402,6 +402,7 @@
    ArgumentParser argParser = new ArgumentParser(CLASS_NAME, toolDescription,
                                        false, true, 1, 0,
                                        " \'attribute:value\' \"DN\" ...");
    argParser.setShortToolDescription(REF_SHORT_DESC_LDAPCOMPARE.get());
    argParser.setVersionHandler(new DirectoryServerVersionHandler());

    try

 opendj-server-legacy/src/main/java/org/opends/server/tools/LDAPDelete.java

@@ -324,6 +324,7 @@
    LocalizableMessage toolDescription = INFO_LDAPDELETE_TOOL_DESCRIPTION.get();
    ArgumentParser argParser = new ArgumentParser(CLASS_NAME, toolDescription,
                                                  false, true, 0, 1, "\"DN\"");
    argParser.setShortToolDescription(REF_SHORT_DESC_LDAPDELETE.get());
    argParser.setVersionHandler(new DirectoryServerVersionHandler());
    try
    {

 opendj-server-legacy/src/main/java/org/opends/server/tools/LDAPModify.java

@@ -609,6 +609,7 @@
    LocalizableMessage toolDescription = INFO_LDAPMODIFY_TOOL_DESCRIPTION.get();
    ArgumentParser argParser = new ArgumentParser(CLASS_NAME, toolDescription,
                                                  false);
    argParser.setShortToolDescription(REF_SHORT_DESC_LDAPMODIFY.get());
    argParser.setVersionHandler(new DirectoryServerVersionHandler());
    try
    {

 opendj-server-legacy/src/main/java/org/opends/server/tools/LDAPPasswordModify.java

@@ -22,7 +22,7 @@
 *
 *
 *      Copyright 2006-2010 Sun Microsystems, Inc.
 *      Portions Copyright 2013-2015 ForgeRock AS
 *      Portions Copyright 2013-2015 ForgeRock AS.
 */
package org.opends.server.tools;

@@ -185,6 +185,7 @@
    LocalizableMessage toolDescription = INFO_LDAPPWMOD_TOOL_DESCRIPTION.get();
    ArgumentParser argParser = new ArgumentParser(CLASS_NAME, toolDescription,
                                                  false);
    argParser.setShortToolDescription(REF_SHORT_DESC_LDAPPASSWORDMODIFY.get());
    argParser.setVersionHandler(new DirectoryServerVersionHandler());

    try

 opendj-server-legacy/src/main/java/org/opends/server/tools/LDAPSearch.java

@@ -688,6 +688,7 @@
    ArgumentParser argParser = new ArgumentParser(CLASS_NAME, toolDescription,
                                                  false, true, 0, 0,
                                                  "[filter] [attributes ...]");
    argParser.setShortToolDescription(REF_SHORT_DESC_LDAPSEARCH.get());
    argParser.setVersionHandler(new DirectoryServerVersionHandler());

    try

 opendj-server-legacy/src/main/java/org/opends/server/tools/LDIFDiff.java

@@ -169,6 +169,7 @@
    LocalizableMessage toolDescription = INFO_LDIFDIFF_TOOL_DESCRIPTION.get();
    ArgumentParser argParser = new ArgumentParser(CLASS_NAME, toolDescription,
                                                  false);
    argParser.setShortToolDescription(REF_SHORT_DESC_LDIFDIFF.get());
    argParser.setVersionHandler(new DirectoryServerVersionHandler());
    try
    {

 opendj-server-legacy/src/main/java/org/opends/server/tools/LDIFModify.java

@@ -22,7 +22,7 @@
 *
 *
 *      Copyright 2006-2008 Sun Microsystems, Inc.
 *      Portions Copyright 2012-2015 ForgeRock AS
 *      Portions Copyright 2012-2015 ForgeRock AS.
 */
package org.opends.server.tools;

@@ -437,6 +437,7 @@
    LocalizableMessage toolDescription = INFO_LDIFMODIFY_TOOL_DESCRIPTION.get();
    ArgumentParser argParser = new ArgumentParser(CLASS_NAME, toolDescription,
                                                  false);
    argParser.setShortToolDescription(REF_SHORT_DESC_LDIFMODIFY.get());
    argParser.setVersionHandler(new DirectoryServerVersionHandler());

    try

 opendj-server-legacy/src/main/java/org/opends/server/tools/LDIFSearch.java

@@ -22,7 +22,7 @@
 *
 *
 *      Copyright 2006-2008 Sun Microsystems, Inc.
 *      Portions Copyright 2013-2015 ForgeRock AS
 *      Portions Copyright 2013-2015 ForgeRock AS.
 */
package org.opends.server.tools;

@@ -143,6 +143,7 @@
    ArgumentParser argParser = new ArgumentParser(CLASS_NAME, toolDescription,
                                                  false, true, 0, 0,
                                                  "[filter] [attributes ...]");
    argParser.setShortToolDescription(REF_SHORT_DESC_LDIFSEARCH.get());
    argParser.setVersionHandler(new DirectoryServerVersionHandler());

    try

 opendj-server-legacy/src/main/java/org/opends/server/tools/ListBackends.java

@@ -22,7 +22,7 @@
 *
 *
 *      Copyright 2006-2008 Sun Microsystems, Inc.
 *      Portions Copyright 2012-2015 ForgeRock AS
 *      Portions Copyright 2012-2015 ForgeRock AS.
 */
package org.opends.server.tools;

@@ -139,6 +139,7 @@
    ArgumentParser argParser =
         new ArgumentParser("org.opends.server.tools.ListBackends",
                            toolDescription, false);
    argParser.setShortToolDescription(REF_SHORT_DESC_LIST_BACKENDS.get());
    argParser.setVersionHandler(new DirectoryServerVersionHandler());

    // Initialize all the command-line argument types and register them with the

 opendj-server-legacy/src/main/java/org/opends/server/tools/ManageAccount.java

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

@@ -827,6 +827,7 @@
    argParser = new SubCommandArgumentParser(
            CLASS_NAME, INFO_PWPSTATE_TOOL_DESCRIPTION.get(),
            false);
    argParser.setShortToolDescription(REF_SHORT_DESC_MANAGE_ACCOUNT.get());
    argParser.setVersionHandler(new DirectoryServerVersionHandler());

    BooleanArgument   showUsage;

 opendj-server-legacy/src/main/java/org/opends/server/tools/ManageTasks.java

@@ -22,7 +22,7 @@
 *
 *
 *      Copyright 2008-2009 Sun Microsystems, Inc.
 *      Portions Copyright 2012-2015 ForgeRock AS
 *      Portions Copyright 2012-2015 ForgeRock AS.
 */
package org.opends.server.tools;

@@ -215,6 +215,7 @@
            "org.opends.server.tools.TaskInfo",
            INFO_TASKINFO_TOOL_DESCRIPTION.get(),
            false, null, alwaysSSL);
    argParser.setShortToolDescription(REF_SHORT_DESC_MANAGE_TASKS.get());

    // Initialize all the command-line argument types and register them with the
    // parser.

 opendj-server-legacy/src/main/java/org/opends/server/tools/RebuildIndex.java

@@ -22,7 +22,7 @@
 *
 *
 *      Copyright 2006-2009 Sun Microsystems, Inc.
 *      Portions Copyright 2011-2015 ForgeRock AS
 *      Portions Copyright 2011-2015 ForgeRock AS.
 */
package org.opends.server.tools;

@@ -268,6 +268,8 @@
  private void initializeArguments(final boolean isMultipleBackends)
      throws ArgumentException
  {
    argParser.setShortToolDescription(REF_SHORT_DESC_REBUILD_INDEX.get());

    configClass =
        new StringArgument("configclass", 'C', "configClass", true, false,
            true, INFO_CONFIGCLASS_PLACEHOLDER.get(), ConfigFileHandler.class

 opendj-server-legacy/src/main/java/org/opends/server/tools/RestoreDB.java

@@ -160,6 +160,8 @@
    // parser.
    try
    {
      argParser.setShortToolDescription(REF_SHORT_DESC_RESTORE.get());

      configClass =
           new StringArgument("configclass", OPTION_SHORT_CONFIG_CLASS,
                              OPTION_LONG_CONFIG_CLASS, true, false,

 opendj-server-legacy/src/main/java/org/opends/server/tools/StopDS.java

@@ -22,7 +22,7 @@
 *
 *
 *      Copyright 2006-2010 Sun Microsystems, Inc.
 *      Portions Copyright 2011-2015 ForgeRock AS
 *      Portions Copyright 2011-2015 ForgeRock AS.
 */
package org.opends.server.tools;

@@ -176,6 +176,8 @@
    LocalizableMessage toolDescription = INFO_STOPDS_TOOL_DESCRIPTION.get();
    ArgumentParser    argParser = new ArgumentParser(CLASS_NAME,
                                                     toolDescription, false);
    argParser.setShortToolDescription(REF_SHORT_DESC_STOP_DS.get());

    argParser.setVersionHandler(new DirectoryServerVersionHandler());
    BooleanArgument   checkStoppability;
    BooleanArgument   quietMode;

 opendj-server-legacy/src/main/java/org/opends/server/tools/VerifyIndex.java

@@ -121,6 +121,7 @@
    ArgumentParser argParser =
         new ArgumentParser("org.opends.server.tools.VerifyIndex",
                            toolDescription, false);
    argParser.setShortToolDescription(REF_SHORT_DESC_VERIFY_INDEX.get());
    argParser.setVersionHandler(new DirectoryServerVersionHandler());

    // Initialize all the command-line argument types and register them with the

 opendj-server-legacy/src/main/java/org/opends/server/tools/dsreplication/ReplicationCliArgumentParser.java

@@ -22,7 +22,7 @@
 *
 *
 *      Copyright 2007-2010 Sun Microsystems, Inc.
 *      Portions Copyright 2012-2015 ForgeRock AS
 *      Portions Copyright 2012-2015 ForgeRock AS.
 */
package org.opends.server.tools.dsreplication;

@@ -211,6 +211,7 @@
        INFO_REPLICATION_TOOL_DESCRIPTION.get(ENABLE_REPLICATION_SUBCMD_NAME,
            INITIALIZE_REPLICATION_SUBCMD_NAME),
            false);
    setShortToolDescription(REF_SHORT_DESC_DSREPLICATION.get());
    setVersionHandler(new DirectoryServerVersionHandler());
  }


 opendj-server-legacy/src/main/java/org/opends/server/tools/makeldif/MakeLDIF.java

@@ -22,7 +22,7 @@
 *
 *
 *      Copyright 2006-2010 Sun Microsystems, Inc.
 *      Portions Copyright 2013-2015 ForgeRock AS
 *      Portions Copyright 2013-2015 ForgeRock AS.
 */
package org.opends.server.tools.makeldif;

@@ -134,6 +134,7 @@
    LocalizableMessage toolDescription = INFO_MAKELDIF_TOOL_DESCRIPTION.get();
    ArgumentParser  argParser = new ArgumentParser(CLASS_NAME, toolDescription,
                                                   false);
    argParser.setShortToolDescription(REF_SHORT_DESC_MAKELDIF.get());
    argParser.setVersionHandler(new DirectoryServerVersionHandler());

    BooleanArgument showUsage;

 opendj-server-legacy/src/main/java/org/opends/server/tools/status/StatusCliArgumentParser.java

@@ -22,7 +22,7 @@
 *
 *
 *      Copyright 2008-2009 Sun Microsystems, Inc.
 *      Portions Copyright 2012-2015 ForgeRock AS
 *      Portions Copyright 2012-2015 ForgeRock AS.
 */
package org.opends.server.tools.status;

@@ -70,6 +70,7 @@
  {
    super(mainClassName, INFO_STATUS_CLI_USAGE_DESCRIPTION.get(), false);
    setVersionHandler(new DirectoryServerVersionHandler());
    setShortToolDescription(REF_SHORT_DESC_STATUS.get());
  }

  /**

 opendj-server-legacy/src/main/java/org/opends/server/tools/upgrade/UpgradeCli.java

@@ -102,6 +102,7 @@
        new SubCommandArgumentParser(getClass().getName(),
            INFO_UPGRADE_DESCRIPTION_CLI.get(), false);
    this.parser.setVersionHandler(new DirectoryServerVersionHandler());
    this.parser.setShortToolDescription(REF_SHORT_DESC_UPGRADE.get());
    this.parser.setDocToolDescriptionSupplement(SUPPLEMENT_DESCRIPTION_UPGRADE_CLI.get());
  }


 opendj-server-legacy/src/main/java/org/opends/server/util/Base64.java

@@ -22,7 +22,7 @@
 *
 *
 *      Copyright 2006-2009 Sun Microsystems, Inc.
 *      Portions Copyright 2014-2015 ForgeRock AS
 *      Portions Copyright 2014-2015 ForgeRock AS.
 */
package org.opends.server.util;

@@ -466,6 +466,7 @@
    SubCommandArgumentParser argParser =
         new SubCommandArgumentParser(Base64.class.getName(), description,
                                      false);
    argParser.setShortToolDescription(REF_SHORT_DESC_BASE64.get());
    argParser.setVersionHandler(new DirectoryServerVersionHandler());

    BooleanArgument showUsage        = null;

 opendj-server-legacy/src/messages/org/opends/messages/tool.properties

@@ -2616,6 +2616,39 @@
INFO_UPGRADE_TASK_11339_SUMMARY_10036=Removing config for 'Extensions'
INFO_UPGRADE_TASK_11476_SUMMARY_10037=Removing config for 'File System Entry Cache'

# Strings for generated reference documentation.
REF_SHORT_DESC_BACKUP_15000=back up OpenDJ directory data
REF_SHORT_DESC_BASE64_15001=encode and decode base64 strings
REF_SHORT_DESC_CONTROL_PANEL_15002=start the OpenDJ graphical admin interface
REF_SHORT_DESC_CREATE_RC_SCRIPT_15003=script to manage OpenDJ as a service on UNIX
REF_SHORT_DESC_DBTEST_15004=gather OpenDJ backend database debugging information
REF_SHORT_DESC_DSJAVAPROPERTIES_15005=apply OpenDJ Java home and JVM settings
REF_SHORT_DESC_DSREPLICATION_15006=manage OpenDJ directory data replication
REF_SHORT_DESC_ENCODE_PASSWORD_15007=encode a password with an OpenDJ storage scheme
REF_SHORT_DESC_EXPORT_LDIF_15008=export OpenDJ directory data in LDIF
REF_SHORT_DESC_IMPORT_LDIF_15009=import OpenDJ directory data from LDIF
REF_SHORT_DESC_LDAPCOMPARE_15010=perform LDAP compare operations
REF_SHORT_DESC_LDAPDELETE_15011=perform LDAP delete operations
REF_SHORT_DESC_LDAPMODIFY_15012=perform LDAP modify, add, delete, mod DN operations
REF_SHORT_DESC_LDAPPASSWORDMODIFY_15013=perform LDAP password modifications
REF_SHORT_DESC_LDAPSEARCH_15014=perform LDAP search operations
REF_SHORT_DESC_LDIFDIFF_15015=compare small LDIF files
REF_SHORT_DESC_LDIFMODIFY_15016=apply LDIF changes to LDIF
REF_SHORT_DESC_LDIFSEARCH_15017=search LDIF with LDAP filters
REF_SHORT_DESC_LIST_BACKENDS_15018=list OpenDJ backends and base DNs
REF_SHORT_DESC_MAKELDIF_15019=generate test LDIF
REF_SHORT_DESC_MANAGE_ACCOUNT_15020=manage state of OpenDJ server accounts
REF_SHORT_DESC_MANAGE_TASKS_15021=manage OpenDJ server administration tasks
REF_SHORT_DESC_REBUILD_INDEX_15022=rebuild index after configuration change
REF_SHORT_DESC_RESTORE_15023=restore OpenDJ directory data backups
REF_SHORT_DESC_SETUP_15024=install OpenDJ directory server
REF_SHORT_DESC_START_DS_15025=start OpenDJ directory server
REF_SHORT_DESC_STATUS_15026=display basic OpenDJ server information
REF_SHORT_DESC_STOP_DS_15027=stop OpenDJ directory server
REF_SHORT_DESC_UPGRADE_15028=upgrade OpenDJ configuration and application data
REF_SHORT_DESC_VERIFY_INDEX_15029=check index for consistency or errors
REF_SHORT_DESC_WINDOWS_SERVICE_15030=register OpenDJ as a Windows Service

# Supplements to descriptions for generated reference documentation.
SUPPLEMENT_DESCRIPTION_DBTEST_SUBCMD_LIST_INDEX_STATUS_20001=<para>                \
        When you list index status, the result is a table,                         \