From def05ed8de5b653d3fed997ca56444e4f60a4dca Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Tue, 21 Jun 2011 14:32:57 +0000
Subject: [PATCH] Draft tools ref complete for Admin and Dev guides
---
opendj3/src/main/docbkx/shared/man-dsframework.xml | 229 +++++++++++++++++++++++++++++++++++++++++++++++---------
1 files changed, 191 insertions(+), 38 deletions(-)
diff --git a/opendj3/src/main/docbkx/shared/man-dsframework.xml b/opendj3/src/main/docbkx/shared/man-dsframework.xml
index a573018..611c07f 100644
--- a/opendj3/src/main/docbkx/shared/man-dsframework.xml
+++ b/opendj3/src/main/docbkx/shared/man-dsframework.xml
@@ -35,72 +35,225 @@
</refmeta>
<refnamediv>
<refname>dsframework</refname>
- <refpurpose>TODO one-line description</refpurpose>
+ <refpurpose>manage OpenDJ administration framework</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>dsframework</command>
<command><replaceable>subcommand</replaceable></command>
- <arg choice="opt">--options</arg>
+ <arg choice="req">options</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para>TODO description.</para>
- </refsect1>
- <refsect1>
- <title>Global Options</title>
- <para>The following global options are supported.</para>
- <variablelist>
- <varlistentry>
- <term><option>TODO</option></term>
- <listitem>
- <para>TODO Description.</para>
- </listitem>
- </varlistentry>
- </variablelist>
+ <para>This utility can be used to perform operations in the directory server
+ administration framework.</para>
</refsect1>
<refsect1>
<title>Subcommands</title>
- <para>The following subcommands are supported.</para>
+
+ <para>The <command>dsconfig</command> command provides many subcommands.
+ Use the following options to view help for subcommands.</para>
+
+ <variablelist>
+ <varlistentry>
+ <term><option>--help-all</option></term>
+ <listitem>
+ <para>Display all subcommands</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--help-admin-user</option></term>
+ <listitem>
+ <para>Display subcommands relating to admin-user</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--help-server</option></term>
+ <listitem>
+ <para>Display subcommands relating to server</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--help-server-group</option></term>
+ <listitem>
+ <para>Display subcommands relating to server-group</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+
+ <para>For help with individual subcommands, use <command>dsframework
+ <replaceable>subcommand</replaceable> --help</command>.</para>
+ </refsect1>
+ <refsect1>
+ <title>Options</title>
+ <para>The following options are supported.</para>
<refsect2>
- <para>TODO Description.</para>
- <cmdsynopsis>
- <command>dsframework</command>
- <command>TODO</command>
- <arg choice="opt">--options</arg>
- </cmdsynopsis>
+ <title>LDAP Connection Options</title>
<variablelist>
<varlistentry>
- <term><option>TODO</option></term>
+ <term><option>--connectTimeout {timeout}</option></term>
<listitem>
- <para>TODO description.</para>
+ <para>Maximum length of time (in milliseconds) that can be taken to
+ establish a connection. Use '0' to specify no time out.</para>
+ <para>Default value: 30000</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-h, --hostname {host}</option></term>
+ <listitem>
+ <para>Directory server hostname or IP address</para>
+ <para>Default value: localhost.localdomain</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-I, --adminUID {adminUID}</option></term>
+ <listitem>
+ <para>User ID of the global administrator to use to bind to the server.
+ For the <command>enable</command> subcommand, if no global administrator
+ was defined previously for any servers, the global administrator will be
+ created using the UID provided.</para>
+ <para>Default value: admin</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-j, --adminPasswordFile {bindPasswordFile}</option></term>
+ <listitem>
+ <para>Global administrator password file</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-K, --keyStorePath {keyStorePath}</option></term>
+ <listitem>
+ <para> Certificate key store path</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-N, --certNickname {nickname}</option></term>
+ <listitem>
+ <para>Nickname of certificate for SSL client authentication</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-o, --saslOption {name=value}</option></term>
+ <listitem>
+ <para>SASL bind options</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-p, --port {port}</option></term>
+ <listitem>
+ <para>Directory server administration port number</para>
+ <para>Default value: 4444</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-P, --trustStorePath {trustStorePath}</option></term>
+ <listitem>
+ <para>Certificate trust store path</para>
+ <para>Default value: /path/to/OpenDJ/config/admin-truststore</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-T, --trustStorePassword {trustStorePassword}</option></term>
+ <listitem>
+ <para>Certificate trust store PIN</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-u, --keyStorePasswordFile {keyStorePasswordFile}</option></term>
+ <listitem>
+ <para>Certificate key store PIN file</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-U, --trustStorePasswordFile {path}</option></term>
+ <listitem>
+ <para>Certificate trust store PIN file</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-w, --adminPassword {bindPassword}</option></term>
+ <listitem>
+ <para>Password for the global administrator</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-W, --keyStorePassword {keyStorePassword}</option></term>
+ <listitem>
+ <para>Certificate key store PIN</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-X, --trustAll</option></term>
+ <listitem>
+ <para>Trust all server SSL certificates</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
+ <refsect2>
+ <title>Utility Input/Output Options</title>
+ <variablelist>
+ <varlistentry>
+ <term><option>--noPropertiesFile</option></term>
+ <listitem>
+ <para>No properties file will be used to get default command line
+ argument values</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--propertiesFilePath {propertiesFilePath}</option></term>
+ <listitem>
+ <para>Path to the file containing default property values used for
+ command line arguments</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-v, --verbose</option></term>
+ <listitem>
+ <para>Use verbose mode</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
+ <refsect2>
+ <title>General Options</title>
+ <variablelist>
+ <varlistentry>
+ <term><option>-V, --version</option></term>
+ <listitem>
+ <para>Display version information</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-?, -H, --help</option></term>
+ <listitem>
+ <para>Display usage information</para>
</listitem>
</varlistentry>
</variablelist>
</refsect2>
</refsect1>
<refsect1>
- <title>Files</title>
- <para>TODO if command has configuration file.</para>
- </refsect1>
- <refsect1>
- <title>Environment</title>
- <para>TODO if command reads environment variables.</para>
- </refsect1>
- <refsect1>
<title>Exit Codes</title>
<variablelist>
<varlistentry>
- <term>TODO exit code</term>
+ <term>0</term>
<listitem>
- <para>TODO description.</para>
+ <para>The command completed successfully.</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>> 0</term>
+ <listitem>
+ <para>An error occurred.</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
- <refsect1>
- <title>Examples</title>
- <para>TODO</para>
- </refsect1>
+<!-- <refsect1> -->
+<!-- <title>Examples</title> -->
+<!-- <para>TODO, pending OPENDJ-209</para> -->
+<!-- </refsect1> -->
</refentry>
--
Gitblit v1.10.0