From 1b8ca1df6d1dcc2d9fd9eabe0891b05795367e85 Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Fri, 17 Jun 2011 15:54:50 +0000
Subject: [PATCH] A couple of small refentrys for the admin docs
---
opendj3/src/main/docbkx/shared/man-base64.xml | 86 ++++++++++++--------
opendj3/src/main/docbkx/shared/man-control-panel.xml | 112 ++++++++++++++++++++-------
2 files changed, 132 insertions(+), 66 deletions(-)
diff --git a/opendj3/src/main/docbkx/shared/man-base64.xml b/opendj3/src/main/docbkx/shared/man-base64.xml
index 1213670..942d535 100644
--- a/opendj3/src/main/docbkx/shared/man-base64.xml
+++ b/opendj3/src/main/docbkx/shared/man-base64.xml
@@ -35,72 +35,88 @@
</refmeta>
<refnamediv>
<refname>base64</refname>
- <refpurpose>TODO one-line description</refpurpose>
+ <refpurpose>encode and decode base64 strings</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>base64</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>
+ <para>This utility can be used to encode and decode information using base64.</para>
</refsect1>
<refsect1>
- <title>Global Options</title>
- <para>The following global options are supported.</para>
+ <title>Subcommands</title>
+ <para>The following subcommands are supported.</para>
<variablelist>
<varlistentry>
- <term><option>TODO</option></term>
+ <term><command>base64 decode</command></term>
<listitem>
- <para>TODO Description.</para>
+ <para>Decode base64-encoded information into raw data</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><command>base64 encode</command></term>
+ <listitem>
+ <para>Encode raw data using base64</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
- <title>Subcommands</title>
- <para>The following subcommands are supported.</para>
- <refsect2>
- <para>TODO Description.</para>
- <cmdsynopsis>
- <command>base64</command>
- <command>TODO</command>
- <arg choice="opt">--options</arg>
- </cmdsynopsis>
- <variablelist>
+ <title>General Options</title>
+ <variablelist>
+ <varlistentry>
+ <term><option>-V, --version</option></term>
+ <listitem>
+ <para>Display version information</para>
+ </listitem>
+ </varlistentry>
<varlistentry>
- <term><option>TODO</option></term>
- <listitem>
- <para>TODO description.</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>
+ <term><option>-?, -H, --help</option></term>
+ <listitem>
+ <para>Display usage information</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</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>
+ <para>The following command shows the changes from the external change log
+ in human-readable format.</para>
+ <screen width="80">$ base64 decode -d YWRkOiBkZXNjcmlwdGlvbgpkZXNjcmlwdGlvbjogQSB0aGlyZCBjaGFuZ2UK
+LQpyZXBsYWNlOiBtb2RpZmllcnNOYW1lCm1vZGlmaWVyc05hbWU6IGNuPURpcmVjdG9yeSBNYW5hZ2V
+yLGNuPVJvb3QgRE5zLGNuPWNvbmZpZwotCnJlcGxhY2U6IG1vZGlmeVRpbWVzdGFtcAptb2RpZnlUaW
+1lc3RhbXA6IDIwMTEwNjEzMDcxMjEwWgotCg==
+add: description
+description: A third change
+-
+replace: modifiersName
+modifiersName: cn=Directory Manager,cn=Root DNs,cn=config
+-
+replace: modifyTimestamp
+modifyTimestamp: 20110613071210Z
+-
+</screen>
</refsect1>
</refentry>
diff --git a/opendj3/src/main/docbkx/shared/man-control-panel.xml b/opendj3/src/main/docbkx/shared/man-control-panel.xml
index f70430b..8a1dd7a 100644
--- a/opendj3/src/main/docbkx/shared/man-control-panel.xml
+++ b/opendj3/src/main/docbkx/shared/man-control-panel.xml
@@ -35,72 +35,122 @@
</refmeta>
<refnamediv>
<refname>control-panel</refname>
- <refpurpose>TODO one-line description</refpurpose>
+ <refpurpose>start the OpenDJ graphical admin interface</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>control-panel</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>
+ <para>This utility can be used to display the Control Panel window which
+ displays basic server information and allows to do some basic administration
+ tasks on the server.</para>
</refsect1>
<refsect1>
- <title>Global Options</title>
- <para>The following global options are supported.</para>
+ <title>Options</title>
+ <para>The following options are supported.</para>
<variablelist>
<varlistentry>
- <term><option>TODO</option></term>
+ <term><option>-r, --remote</option></term>
<listitem>
- <para>TODO Description.</para>
+ <para>Connect to a remote server</para>
</listitem>
</varlistentry>
</variablelist>
- </refsect1>
- <refsect1>
- <title>Subcommands</title>
- <para>The following subcommands are supported.</para>
<refsect2>
- <para>TODO Description.</para>
- <cmdsynopsis>
- <command>control-panel</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>-D, --bindDN {bindDN}</option></term>
+ <listitem>
+ <para>DN to use to bind to the server</para>
+ <para>Default value: cn=Directory Manager</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>-j, --adminPasswordFile {bindPasswordFile}</option></term>
+ <listitem>
+ <para>Global administrator password file</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>-w, --adminPassword {bindPassword}</option></term>
+ <listitem>
+ <para>Password for the global administrator</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>-X, --trustAll</option></term>
+ <listitem>
+ <para>Trust all server SSL certificates</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
+ <refsect2>
+ <title>General Options</title>
+ <variablelist>
+ <varlistentry>
+ <term><option>--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>
+ <para>The following example starts the Control Panel on a remote host.</para>
+
+ <screen width="80">$ control-panel -r -h opendj.example.com -p 4444 &</screen>
</refsect1>
</refentry>
--
Gitblit v1.10.0