From c932c6ad1d6a89db365bbadf6fe6eee3574e704a 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
---
opendj-sdk/opendj3/src/main/docbkx/shared/man-dsjavaproperties.xml | 77 ++++++++++++++++++++------------------
1 files changed, 41 insertions(+), 36 deletions(-)
diff --git a/opendj-sdk/opendj3/src/main/docbkx/shared/man-dsjavaproperties.xml b/opendj-sdk/opendj3/src/main/docbkx/shared/man-dsjavaproperties.xml
index e7611c6..f661632 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/shared/man-dsjavaproperties.xml
+++ b/opendj-sdk/opendj3/src/main/docbkx/shared/man-dsjavaproperties.xml
@@ -35,72 +35,77 @@
</refmeta>
<refnamediv>
<refname>dsjavaproperties</refname>
- <refpurpose>TODO one-line description</refpurpose>
+ <refpurpose>apply OpenDJ Java home and JVM settings</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>dsjavaproperties</command>
- <command><replaceable>subcommand</replaceable></command>
- <arg choice="opt">--options</arg>
+ <arg choice="opt">options</arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
- <para>TODO description.</para>
+ <para>This utility can be used to change the Java arguments and Java home
+ that are used by other server commands.</para>
+ <para>Before launching the command, edit the properties file located in
+ <filename>/path/to/OpenDJ/config/java.properties</filename> to specify the
+ Java arguments and Java home. When you have edited the properties file, run
+ this command for the changes to be taken into account.</para>
+ <para>Changes apply to the current server installation. No modifications
+ are made to your environment variables.</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>-Q, --quiet</option></term>
<listitem>
- <para>TODO Description.</para>
+ <para>Run the tool in quiet mode. Quiet mode will not output progress
+ information to standard output.</para>
+ </listitem>
+ </varlistentry>
+ <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>
</refsect1>
<refsect1>
- <title>Subcommands</title>
- <para>The following subcommands are supported.</para>
- <refsect2>
- <para>TODO Description.</para>
- <cmdsynopsis>
- <command>dsjavaproperties</command>
- <command>TODO</command>
- <arg choice="opt">--options</arg>
- </cmdsynopsis>
- <variablelist>
- <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>
+ <para>This command depends on the content of the
+ <filename>config/java.properties</filename> file.</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>
+ <screen width="80">$ dsjavaproperties
+The operation was successful. The server commands will use the java arguments
+ and java home specified in the properties file located in
+ /path/to/OpenDJ/config/java.properties</screen>
</refsect1>
</refentry>
--
Gitblit v1.10.0