From f1eacda67980a6a103ce0bd5e06327a42adc380a Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Tue, 07 Jun 2011 10:38:08 +0000
Subject: [PATCH] Fix OpenDJ-188: Change of ~/.opends to ~/.opendj directory for tools.properties should be documented
---
opendj-sdk/opendj3/src/main/docbkx/shared/man-ldapmodify.xml | 15 +++++++
opendj-sdk/opendj3/src/main/docbkx/shared/man-ldapcompare.xml | 15 +++++++
opendj-sdk/opendj3/src/main/docbkx/shared/man-ldapsearch.xml | 15 +++++++
opendj-sdk/opendj3/src/main/docbkx/shared/man-ldapdelete.xml | 15 +++++++
opendj-sdk/opendj3/src/main/docbkx/shared/man-ldappasswordmodify.xml | 15 +++++++
opendj-sdk/opendj3/src/main/docbkx/admin-guide/chap-ldap-operations.xml | 19 +++++++++
6 files changed, 94 insertions(+), 0 deletions(-)
diff --git a/opendj-sdk/opendj3/src/main/docbkx/admin-guide/chap-ldap-operations.xml b/opendj-sdk/opendj3/src/main/docbkx/admin-guide/chap-ldap-operations.xml
index dd35866..490561b 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/admin-guide/chap-ldap-operations.xml
+++ b/opendj-sdk/opendj3/src/main/docbkx/admin-guide/chap-ldap-operations.xml
@@ -472,5 +472,24 @@
Password Is Reset: true</screen>
</example>
</section>
+
+ <section>
+ <title>Configuring Default Settings</title>
+
+ <para>You can use <filename>~/.opendj/tools.properties</filename> to set
+ the defaults for bind DN, host name, and port number as in the following
+ example.</para>
+ <programlisting language="java">hostname=directory.example.com
+port=1389
+bindDN=uid=kvaughan,ou=People,dc=example,dc=com
+
+ldapcompare.port=1389
+ldapdelete.port=1389
+ldapmodify.port=1389
+ldappasswordmodify.port=1389
+ldapsearch.port=1389</programlisting>
+ <para>The location on Windows is
+ <filename>%UserProfile%/.opendj/tools.properties</filename>.</para>
+ </section>
</chapter>
diff --git a/opendj-sdk/opendj3/src/main/docbkx/shared/man-ldapcompare.xml b/opendj-sdk/opendj3/src/main/docbkx/shared/man-ldapcompare.xml
index 85c7304..edda33b 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/shared/man-ldapcompare.xml
+++ b/opendj-sdk/opendj3/src/main/docbkx/shared/man-ldapcompare.xml
@@ -293,6 +293,21 @@
</variablelist>
</refsect1>
<refsect1>
+ <title>Files</title>
+ <para>You can use <filename>~/.opendj/tools.properties</filename> to set
+ the defaults for bind DN, host name, and port number as in the following
+ example.</para>
+ <programlisting language="java">hostname=directory.example.com
+port=1389
+bindDN=uid=kvaughan,ou=People,dc=example,dc=com
+
+ldapcompare.port=1389
+ldapdelete.port=1389
+ldapmodify.port=1389
+ldappasswordmodify.port=1389
+ldapsearch.port=1389</programlisting>
+ </refsect1>
+ <refsect1>
<title>Examples</title>
<para>The following examples demonstrate comparing Babs Jensen's UID.</para>
<para>The following example uses a matching UID value.</para>
diff --git a/opendj-sdk/opendj3/src/main/docbkx/shared/man-ldapdelete.xml b/opendj-sdk/opendj3/src/main/docbkx/shared/man-ldapdelete.xml
index fdb1d06..85ba054 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/shared/man-ldapdelete.xml
+++ b/opendj-sdk/opendj3/src/main/docbkx/shared/man-ldapdelete.xml
@@ -296,6 +296,21 @@
</variablelist>
</refsect1>
<refsect1>
+ <title>Files</title>
+ <para>You can use <filename>~/.opendj/tools.properties</filename> to set
+ the defaults for bind DN, host name, and port number as in the following
+ example.</para>
+ <programlisting language="java">hostname=directory.example.com
+port=1389
+bindDN=uid=kvaughan,ou=People,dc=example,dc=com
+
+ldapcompare.port=1389
+ldapdelete.port=1389
+ldapmodify.port=1389
+ldappasswordmodify.port=1389
+ldapsearch.port=1389</programlisting>
+ </refsect1>
+ <refsect1>
<title>Examples</title>
<para>The following command deletes a user entry from the directory.</para>
<screen width="80">$ ldapdelete -p 1389 -D "cn=Directory Manager" -w password \
diff --git a/opendj-sdk/opendj3/src/main/docbkx/shared/man-ldapmodify.xml b/opendj-sdk/opendj3/src/main/docbkx/shared/man-ldapmodify.xml
index ad2bd09..122760b 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/shared/man-ldapmodify.xml
+++ b/opendj-sdk/opendj3/src/main/docbkx/shared/man-ldapmodify.xml
@@ -311,6 +311,21 @@
</variablelist>
</refsect1>
<refsect1>
+ <title>Files</title>
+ <para>You can use <filename>~/.opendj/tools.properties</filename> to set
+ the defaults for bind DN, host name, and port number as in the following
+ example.</para>
+ <programlisting language="java">hostname=directory.example.com
+port=1389
+bindDN=uid=kvaughan,ou=People,dc=example,dc=com
+
+ldapcompare.port=1389
+ldapdelete.port=1389
+ldapmodify.port=1389
+ldappasswordmodify.port=1389
+ldapsearch.port=1389</programlisting>
+ </refsect1>
+ <refsect1>
<title>Examples</title>
<para>The following example demonstrates use of the command to add an entry
to the directory.</para>
diff --git a/opendj-sdk/opendj3/src/main/docbkx/shared/man-ldappasswordmodify.xml b/opendj-sdk/opendj3/src/main/docbkx/shared/man-ldappasswordmodify.xml
index 6bacc56..fe5bf79 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/shared/man-ldappasswordmodify.xml
+++ b/opendj-sdk/opendj3/src/main/docbkx/shared/man-ldappasswordmodify.xml
@@ -284,6 +284,21 @@
</variablelist>
</refsect1>
<refsect1>
+ <title>Files</title>
+ <para>You can use <filename>~/.opendj/tools.properties</filename> to set
+ the defaults for bind DN, host name, and port number as in the following
+ example.</para>
+ <programlisting language="java">hostname=directory.example.com
+port=1389
+bindDN=uid=kvaughan,ou=People,dc=example,dc=com
+
+ldapcompare.port=1389
+ldapdelete.port=1389
+ldapmodify.port=1389
+ldappasswordmodify.port=1389
+ldapsearch.port=1389</programlisting>
+ </refsect1>
+ <refsect1>
<title>Examples</title>
<para>The following example demonstrates a user changing the password
for her entry.</para>
diff --git a/opendj-sdk/opendj3/src/main/docbkx/shared/man-ldapsearch.xml b/opendj-sdk/opendj3/src/main/docbkx/shared/man-ldapsearch.xml
index 64f9207..03fd69f 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/shared/man-ldapsearch.xml
+++ b/opendj-sdk/opendj3/src/main/docbkx/shared/man-ldapsearch.xml
@@ -392,6 +392,21 @@
</variablelist>
</refsect1>
<refsect1>
+ <title>Files</title>
+ <para>You can use <filename>~/.opendj/tools.properties</filename> to set
+ the defaults for bind DN, host name, and port number as in the following
+ example.</para>
+ <programlisting language="java">hostname=directory.example.com
+port=1389
+bindDN=uid=kvaughan,ou=People,dc=example,dc=com
+
+ldapcompare.port=1389
+ldapdelete.port=1389
+ldapmodify.port=1389
+ldappasswordmodify.port=1389
+ldapsearch.port=1389</programlisting>
+ </refsect1>
+ <refsect1>
<title>Examples</title>
<para>The following example searches for entries with UID containing
<literal>jensen</literal>, returning only DNs and uid values.</para>
--
Gitblit v1.10.0