From f2832d2adf885b6a58bf28593548383da1ac0755 Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Tue, 16 Jul 2013 12:55:19 +0000
Subject: [PATCH] CR-2006 Fix for OPENDJ-1046: Make paths to commands consistent throughout the doc set
---
opends/resource/man/man1/backup.1 | 12 +-
opends/src/main/docbkx/admin-guide/man-uninstall.xml | 2
opends/src/main/docbkx/admin-guide/man-setup.xml | 4
opends/src/main/docbkx/install-guide/chap-install-gui.xml | 6
opends/src/main/docbkx/admin-guide/man-backup.xml | 6
opends/src/main/docbkx/admin-guide/chap-troubleshooting.xml | 14 +--
opends/src/main/docbkx/admin-guide/man-restore.xml | 8 +-
opends/resource/man/man1/restore.1 | 14 +-
opends/resource/man/man1/uninstall.1 | 8 +-
opends/src/main/docbkx/shared/screen-upgrade.xml | 10 +-
opends/resource/man/man1/setup.1 | 12 +-
opends/src/main/docbkx/admin-guide/chap-account-lockout.xml | 8 +-
opends/src/main/docbkx/admin-guide/index.xml | 7 +
opends/src/main/docbkx/install-guide/chap-uninstall.xml | 13 +-
opends/src/main/docbkx/admin-guide/man-dsconfig.xml | 8 +-
opends/src/main/docbkx/admin-guide/chap-server-process.xml | 18 ++--
opends/src/main/docbkx/install-guide/chap-install-cli.xml | 2
opends/src/main/docbkx/admin-guide/chap-admin-tools.xml | 71 +++++++++++++----
18 files changed, 126 insertions(+), 97 deletions(-)
diff --git a/opends/resource/man/man1/backup.1 b/opends/resource/man/man1/backup.1
index d27b87b..9496ecd 100644
--- a/opends/resource/man/man1/backup.1
+++ b/opends/resource/man/man1/backup.1
@@ -2,12 +2,12 @@
.\" Title: backup
.\" Author:
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\" Date: 05/16/2013
+.\" Date: 07/16/2013
.\" Manual: Tools Reference
-.\" Source: OpenDJ 2.6.0
+.\" Source: OpenDJ 2.8.0
.\" Language: English
.\"
-.TH "BACKUP" "1" "05/16/2013" "OpenDJ 2\&.6\&.0" "Tools Reference"
+.TH "BACKUP" "1" "07/16/2013" "OpenDJ 2\&.8\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -278,13 +278,13 @@
.RS 4
.\}
.nf
-$ /path/to/opendj/bin/stop\-ds
+$ stop\-ds
Stopping Server\&.\&.\&.
\&.\&.\&.
-$ /path/to/opendj/bin/backup \-\-backupAll \-\-backupDirectory /path/to/opendj/bak
+$ backup \-\-backupAll \-\-backupDirectory /path/to/opendj/bak
\&.\&.\&.
[28/Sep/2012:12:14:22 +0200] \&.\&.\&. msg=The backup process completed successfully
-$ /path/to/opendj/bin/start\-ds
+$ start\-ds
[28/Sep/2012:12:15:48 +0200] \&.\&.\&. The Directory Server has started successfully
.fi
.if n \{\
diff --git a/opends/resource/man/man1/restore.1 b/opends/resource/man/man1/restore.1
index af93b17..95e7a10 100644
--- a/opends/resource/man/man1/restore.1
+++ b/opends/resource/man/man1/restore.1
@@ -2,12 +2,12 @@
.\" Title: restore
.\" Author:
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\" Date: 05/16/2013
+.\" Date: 07/16/2013
.\" Manual: Tools Reference
-.\" Source: OpenDJ 2.6.0
+.\" Source: OpenDJ 2.8.0
.\" Language: English
.\"
-.TH "RESTORE" "1" "05/16/2013" "OpenDJ 2\&.6\&.0" "Tools Reference"
+.TH "RESTORE" "1" "07/16/2013" "OpenDJ 2\&.8\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -232,10 +232,10 @@
.RS 4
.\}
.nf
-$ /path/to/opendj/bin/stop\-ds
+$ stop\-ds
Stopping Server\&.\&.\&.
\&.\&.\&.
-$ /path/to/opendj/bin/restore \-\-backupDirectory /path/to/opendj/bak/userRoot
+$ restore \-\-backupDirectory /path/to/opendj/bak/userRoot
\-\-listBackups
Backup ID: 20120928102414Z
Backup Date: 28/Sep/2012:12:24:17 +0200
@@ -246,10 +246,10 @@
Has Signed Hash: false
Dependent Upon: none
-$ /path/to/opendj/bin/restore \-\-backupDirectory /path/to/opendj/bak/userRoot
+$ restore \-\-backupDirectory /path/to/opendj/bak/userRoot
\-\-backupID 20120928102414Z
[28/Sep/2012:12:26:20 +0200] \&.\&.\&. msg=Restored: 00000000\&.jdb (size 355179)
-$ /path/to/opendj/bin/start\-ds
+$ start\-ds
[28/Sep/2012:12:27:29 +0200] \&.\&.\&. The Directory Server has started successfully
.fi
.if n \{\
diff --git a/opends/resource/man/man1/setup.1 b/opends/resource/man/man1/setup.1
index 540f3b7..c4d7adf 100644
--- a/opends/resource/man/man1/setup.1
+++ b/opends/resource/man/man1/setup.1
@@ -2,12 +2,12 @@
.\" Title: setup
.\" Author:
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\" Date: 05/16/2013
+.\" Date: 07/16/2013
.\" Manual: Tools Reference
-.\" Source: OpenDJ 2.6.0
+.\" Source: OpenDJ 2.8.0
.\" Language: English
.\"
-.TH "SETUP" "1" "05/16/2013" "OpenDJ 2\&.6\&.0" "Tools Reference"
+.TH "SETUP" "1" "07/16/2013" "OpenDJ 2\&.8\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -240,11 +240,11 @@
.RS 4
.\}
.nf
-$ \&./opendj/setup \-\-cli \-b dc=example,dc=com \-d 100 \-D "cn=Directory Manager"
- \-w password \-h `hostname` \-p 1389
+$ /path/to/opendj/setup \-\-cli \-b dc=example,dc=com \-d 100
+ \-D "cn=Directory Manager" \-w password \-h opendj\&.example\&.com \-p 1389
\-\-generateSelfSignedCertificate \-\-enableStartTLS \-n
-OpenDJ 2\&.6\&.0
+OpenDJ 2\&.8\&.0
Please wait while the setup program initializes\&.\&.\&.
See /var/\&.\&.\&./opends\-setup\-484\&.\&.\&.561\&.log for a detailed log of this operation\&.
diff --git a/opends/resource/man/man1/uninstall.1 b/opends/resource/man/man1/uninstall.1
index 36d2d02..8543e6c 100644
--- a/opends/resource/man/man1/uninstall.1
+++ b/opends/resource/man/man1/uninstall.1
@@ -2,12 +2,12 @@
.\" Title: uninstall
.\" Author:
.\" Generator: DocBook XSL-NS Stylesheets v1.76.1 <http://docbook.sf.net/>
-.\" Date: 05/16/2013
+.\" Date: 07/16/2013
.\" Manual: Tools Reference
-.\" Source: OpenDJ 2.6.0
+.\" Source: OpenDJ 2.8.0
.\" Language: English
.\"
-.TH "UNINSTALL" "1" "05/16/2013" "OpenDJ 2\&.6\&.0" "Tools Reference"
+.TH "UNINSTALL" "1" "07/16/2013" "OpenDJ 2\&.8\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -216,7 +216,7 @@
.RS 4
.\}
.nf
-$ \&./opendj/uninstall \-a \-\-cli \-I admin \-w password \-n
+$ /path/to/opendj/uninstall \-a \-\-cli \-I admin \-w password \-n
Stopping Directory Server \&.\&.\&.\&.\&. Done\&.
Deleting Files under the Installation Path \&.\&.\&.\&.\&. Done\&.
diff --git a/opends/src/main/docbkx/admin-guide/chap-account-lockout.xml b/opends/src/main/docbkx/admin-guide/chap-account-lockout.xml
index c135dff..3734c6f 100644
--- a/opends/src/main/docbkx/admin-guide/chap-account-lockout.xml
+++ b/opends/src/main/docbkx/admin-guide/chap-account-lockout.xml
@@ -72,7 +72,7 @@
<screen>$ dsconfig
set-password-policy-prop
--port 4444
- --hostname `hostname`
+ --hostname opendj.example.com
--bindDN "cn=Directory Manager"
--bindPassword password
--policy-name "Default Password Policy"
@@ -226,7 +226,7 @@
<screen>$ dsconfig
set-global-configuration-prop
--port 4444
- --hostname `hostname`
+ --hostname opendj.example.com
--bindDN "cn=Directory Manager"
--bindPassword password
--set smtp-server:smtp.example.com
@@ -239,7 +239,7 @@
<screen>$ dsconfig
set-account-status-notification-handler-prop
--port 4444
- --hostname `hostname`
+ --hostname opendj.example.com
--bindDN "cn=Directory Manager"
--bindPassword password
--handler-name "SMTP Handler"
@@ -264,7 +264,7 @@
<screen>$ dsconfig
set-password-policy-prop
--port 4444
- --hostname `hostname`
+ --hostname opendj.example.com
--bindDN "cn=Directory Manager"
--bindPassword password
--policy-name "Default Password Policy"
diff --git a/opends/src/main/docbkx/admin-guide/chap-admin-tools.xml b/opends/src/main/docbkx/admin-guide/chap-admin-tools.xml
index 76d9255..1877f45 100644
--- a/opends/src/main/docbkx/admin-guide/chap-admin-tools.xml
+++ b/opends/src/main/docbkx/admin-guide/chap-admin-tools.xml
@@ -40,7 +40,7 @@
the concepts, and how to perform a task using the command-line tools, you
no doubt need no more than to know where to start in the Control Panel to
accomplish what you set out to do.</para>
-
+
<para>At a protocol level, administration tools and interfaces connect to
servers through a different network port than that used to listen for traffic
from other client applications.</para>
@@ -59,13 +59,13 @@
<itemizedlist>
<para>Start OpenDJ Control Panel.</para>
<listitem>
- <para>(UNIX) Run <command>opendj/bin/control-panel</command>.</para>
+ <para>(Linux, Solaris) Run <command>/path/to/opendj/bin/control-panel</command>.</para>
</listitem>
<listitem>
- <para>(Windows) Double-click <filename>opendj\bat\control-panel.bat</filename>.</para>
+ <para>(Windows) Double-click <filename>C:\path\to\opendj\bat\control-panel.bat</filename>.</para>
</listitem>
<listitem>
- <para>(Mac OS X) Double-click <filename>opendj/bin/ControlPanel.app</filename>.</para>
+ <para>(Mac OS X) Double-click <filename>/path/to/opendj/bin/ControlPanel.app</filename>.</para>
</listitem>
</itemizedlist>
@@ -164,23 +164,54 @@
<title>Command-Line Tools</title>
<indexterm><primary>Commands</primary></indexterm>
+ <para>Before you try the examples in this guide, set your PATH to include
+ the OpenDJ directory server tools. Where the tools are located depends on
+ the operating system and on the packages used to install OpenDJ.</para>
+
+ <informaltable>
+ <thead>
+ <row>
+ <entry>OpenDJ running on...</entry>
+ <entry>OpenDJ installed from...</entry>
+ <entry>Default path to tools...</entry>
+ </row>
+ </thead>
+ <tbody>
+ <row>
+ <entry>Apple Mac OS X, Linux distributions, Oracle Solaris</entry>
+ <entry>WebStart, .zip</entry>
+ <entry><filename>/path/to/opendj/bin</filename></entry>
+ </row>
+ <row>
+ <entry>Linux distributions</entry>
+ <entry>.deb, .rpm</entry>
+ <entry><filename>/opt/opendj/bin</filename></entry>
+ </row>
+ <row>
+ <entry>Microsoft Windows</entry>
+ <entry>WebStart, .zip</entry>
+ <entry><filename>C:\path\to\opendj\bat</filename></entry>
+ </row>
+ <row>
+ <entry>Oracle Solaris</entry>
+ <entry>SVR4</entry>
+ <entry><filename>/usr/opendj/bin</filename></entry>
+ </row>
+ </tbody>
+ </informaltable>
+
+ <para>The <command>setup</command>, <command>upgrade</command>, and
+ <command>uninstall</command> tools are located in the parent directory of the
+ other tools, as these tools are not used for everyday administration.
+ For example, if the path to most tools is
+ <filename>/path/to/opendj/bin</filename> you can find these tools in
+ <filename>/path/to/opendj</filename>.</para>
+
<para>All OpenDJ command-line tools take the <option>--help</option> option.</para>
-
+
<para>All commands call Java programs and therefore involve starting a
JVM.</para>
-
- <itemizedlist>
- <para>Setup, upgrade, and uninstall tools are located in the directory where
- you unpacked OpenDJ, such as <filename>/path/to/opendj</filename>. Find the
- additional command-line tools for your platform.</para>
- <listitem>
- <para>(UNIX) In <filename>opendj/bin</filename>.</para>
- </listitem>
- <listitem>
- <para>(Windows) In <filename>opendj\bat</filename>.</para>
- </listitem>
- </itemizedlist>
-
+
<para>The following list uses the UNIX names for the tools. On Windows
all command-line tools have the extension .bat.</para>
@@ -439,7 +470,9 @@
</listitem>
</varlistentry>
<varlistentry>
- <term>windows-service.bat (Windows)</term>
+ <term><link xlink:href="admin-guide#windows-service"
+ xlink:role="http://docbook.org/xlink/role/olink">windows-service</link>
+ (Windows only)</term>
<listitem>
<para>Register OpenDJ as a Windows Service.</para>
</listitem>
diff --git a/opends/src/main/docbkx/admin-guide/chap-server-process.xml b/opends/src/main/docbkx/admin-guide/chap-server-process.xml
index e473616..0e6d291 100644
--- a/opends/src/main/docbkx/admin-guide/chap-server-process.xml
+++ b/opends/src/main/docbkx/admin-guide/chap-server-process.xml
@@ -49,7 +49,7 @@
<para>Use one of the following techniques.</para>
<listitem>
<para>Use the <command>start-ds</command> command.</para>
- <screen>$ opendj/bin/start-ds</screen>
+ <screen>$ start-ds</screen>
<para>Alternatively, you can specify the --no-detach option to start
the server in the foreground.</para>
</listitem>
@@ -59,7 +59,7 @@
<para>Unless you run OpenDJ as root, use the --userName
<replaceable>userName</replaceable> option to specify the user
who installed OpenDJ.</para>
- <screen>$ sudo opendj/bin/create-rc-script
+ <screen>$ sudo create-rc-script
--outputFile /etc/init.d/opendj
--userName mark
$ sudo /etc/init.d/opendj start</screen>
@@ -81,7 +81,7 @@
<listitem>
<para>(Windows) Register OpenDJ as a Windows Service, and then manage
the service through Windows administration tools.</para>
- <screen>C:\Users\Mark> opendj\bat\windows-service.bat --enableService</screen>
+ <screen>C:\path\to\opendj\bat> windows-service.bat --enableService</screen>
</listitem>
</itemizedlist>
@@ -103,12 +103,12 @@
<para>Use one of the following techniques.</para>
<listitem>
<para>Use the <command>stop-ds</command> command.</para>
- <screen>$ opendj/bin/stop-ds</screen>
+ <screen>$ stop-ds</screen>
</listitem>
<listitem>
<para>(UNIX) Create an RC script, and then use the script to stop
the server.</para>
- <screen>$ sudo opendj/bin/create-rc-script
+ <screen>$ sudo create-rc-script
--outputFile /etc/init.d/opendj
--userName mark
$ sudo /etc/init.d/opendj stop</screen>
@@ -116,7 +116,7 @@
<listitem>
<para>(Windows) Register OpenDJ as a Windows Service, and then manage
the service through Windows administration tools.</para>
- <screen>C:\Users\Mark> opendj\bat\windows-service.bat --enableService</screen>
+ <screen>C:\path\to\opendj\bat> windows-service.bat --enableService</screen>
</listitem>
</itemizedlist>
</section>
@@ -129,12 +129,12 @@
<para>Use one of the following techniques.</para>
<listitem>
<para>Use the <command>stop-ds</command> command.</para>
- <screen>$ opendj/bin/stop-ds --restart</screen>
+ <screen>$ stop-ds --restart</screen>
</listitem>
<listitem>
<para>(UNIX) Create an RC script, and then use the script to stop
the server.</para>
- <screen>$ sudo opendj/bin/create-rc-script
+ <screen>$ sudo create-rc-script
--outputFile /etc/init.d/opendj
--userName mark
$ /etc/init.d/opendj restart</screen>
@@ -142,7 +142,7 @@
<listitem>
<para>(Windows) Register OpenDJ as a Windows Service, and then manage
the service through Windows administration tools.</para>
- <screen>C:\Users\Mark> opendj\bat\windows-service.bat --enableService</screen>
+ <screen>C:\path\to\opendj\bat> windows-service.bat --enableService</screen>
</listitem>
</itemizedlist>
</section>
diff --git a/opends/src/main/docbkx/admin-guide/chap-troubleshooting.xml b/opends/src/main/docbkx/admin-guide/chap-troubleshooting.xml
index 06a1af7..47bb515 100644
--- a/opends/src/main/docbkx/admin-guide/chap-troubleshooting.xml
+++ b/opends/src/main/docbkx/admin-guide/chap-troubleshooting.xml
@@ -103,15 +103,14 @@
<step>
<para>Generate the encoded version of the new password using the OpenDJ
<command>encode-password</command> command.</para>
- <screen>$ cd /path/to/opendj/bin/
-$ ./encode-password --storageScheme SSHA512 --clearPassword password
+ <screen>$ encode-password --storageScheme SSHA512 --clearPassword password
Encoded Password: "{SSHA512}yWqHnYV4a5llPvE7WHLe5jzK27oZQWLIlVcs9gySu4TyZJMg
NQNRtnR/Xx2xces1wu1dVLI9jVVtl1W4BVsmOKjyjr0rWrHt"</screen>
</step>
<step>
<para>Stop OpenDJ directory server while you edit the configuration.</para>
- <screen>$ ./stop-ds</screen>
+ <screen>$ stop-ds</screen>
</step>
<step>
@@ -144,13 +143,13 @@
<step>
<para>Start OpenDJ directory server again.</para>
- <screen>$ ./start-ds</screen>
+ <screen>$ start-ds</screen>
</step>
<step>
<para>Verify that you can administer the server as Directory Manager using
the new password.</para>
- <screen>$ ./dsconfig -p 4444 -h `hostname` -D "cn=Directory Manager" -w password
+ <screen>$ dsconfig -p 4444 -h opendj.example.com -D "cn=Directory Manager" -w password
>>>> OpenDJ configuration console main menu
@@ -180,8 +179,7 @@
<step>
<para>Use the <command>ldappasswordmodify</command> command to reset the
global administrator's password</para>
- <screen>$ cd /path/to/opendj/bin/
-$ ./ldappasswordmodify
+ <screen>$ ldappasswordmodify
--useStartTLS
--port 1389
--hostname opendj.example.com
@@ -385,7 +383,7 @@
<screen>$ dsconfig
set-global-configuration-prop
--port 4444
- --hostname `hostname`
+ --hostname opendj.example.com
--bindDN "cn=Directory Manager"
--bindPassword password
--set single-structural-objectclass-behavior:warn
diff --git a/opends/src/main/docbkx/admin-guide/index.xml b/opends/src/main/docbkx/admin-guide/index.xml
index 5d6a9fd..4c9afe9 100644
--- a/opends/src/main/docbkx/admin-guide/index.xml
+++ b/opends/src/main/docbkx/admin-guide/index.xml
@@ -96,9 +96,10 @@
<title>Tools Reference</title>
<partintro>
- <para>You can find the tools under the <filename>bin/</filename> or
- <filename>bat\</filename> folder where you installed OpenDJ directory
- server. For example, <filename>/path/to/opendj/bin</filename>.</para>
+ <para>You can find tools under the folder where you installed OpenDJ
+ directory server as listed in <link xlink:href="admin-guide#cli-overview"
+ xlink:show="new" xlink:role="http://docbook.org/xlink/role/olink"
+ ><citetitle>Command-Line Tools</citetitle></link>.</para>
</partintro>
<xinclude:include href='man-backup.xml' />
diff --git a/opends/src/main/docbkx/admin-guide/man-backup.xml b/opends/src/main/docbkx/admin-guide/man-backup.xml
index cac42cd..8808af2 100644
--- a/opends/src/main/docbkx/admin-guide/man-backup.xml
+++ b/opends/src/main/docbkx/admin-guide/man-backup.xml
@@ -345,13 +345,13 @@
<para>The following example backs up all user data while the server is
offline.</para>
- <screen>$ /path/to/opendj/bin/stop-ds
+ <screen>$ stop-ds
Stopping Server...
...
-$ /path/to/opendj/bin/backup --backupAll --backupDirectory /path/to/opendj/bak
+$ backup --backupAll --backupDirectory /path/to/opendj/bak
...
[28/Sep/2012:12:14:22 +0200] ... msg=The backup process completed successfully
-$ /path/to/opendj/bin/start-ds
+$ start-ds
[28/Sep/2012:12:15:48 +0200] ... The Directory Server has started successfully
</screen>
</refsect1>
diff --git a/opends/src/main/docbkx/admin-guide/man-dsconfig.xml b/opends/src/main/docbkx/admin-guide/man-dsconfig.xml
index c5a7b5f..a3547a5 100644
--- a/opends/src/main/docbkx/admin-guide/man-dsconfig.xml
+++ b/opends/src/main/docbkx/admin-guide/man-dsconfig.xml
@@ -373,7 +373,7 @@
<listitem><para>get-<replaceable>component</replaceable>-prop</para></listitem>
<listitem><para>set-<replaceable>component</replaceable>-prop</para></listitem>
</itemizedlist>
-
+
<para>Component properties for the <command>dsconfig</command> command are
covered in the <link xlink:show="new" xlink:href="${configRefBase}"
><citetitle>OpenDJ Configuration Reference</citetitle></link>.</para>
@@ -5462,7 +5462,7 @@
<para>The following example starts <command>dsconfig</command> in interactive,
menu-driven mode on the default port of the current host.</para>
- <screen>$ dsconfig -h `hostname` -p 4444 -D "cn=Directory Manager" -w password
+ <screen>$ dsconfig -h opendj.example.com -p 4444 -D "cn=Directory Manager" -w password
>>>> OpenDJ configuration console main menu
@@ -5495,9 +5495,9 @@
<para>The following examples demonstrates generating a batch file that
corresponds to an interactive session enabling the debug log. The example
- then demonstates using a modified batch file to disable the debug log.</para>
+ then demonstrates using a modified batch file to disable the debug log.</para>
<screen>$ dsconfig
- --hostname `hostname`
+ --hostname opendj.example.com
--port 4444
--bindDN "cn=Directory Manager"
--bindPassword password
diff --git a/opends/src/main/docbkx/admin-guide/man-restore.xml b/opends/src/main/docbkx/admin-guide/man-restore.xml
index fc45468..145e9ef 100644
--- a/opends/src/main/docbkx/admin-guide/man-restore.xml
+++ b/opends/src/main/docbkx/admin-guide/man-restore.xml
@@ -299,10 +299,10 @@
Restore task 20110613155052932 scheduled to start Jun 13, 2011 3:50:52 PM CEST</screen>
<para>The following example restores data while OpenDJ is offline.</para>
- <screen>$ /path/to/opendj/bin/stop-ds
+ <screen>$ stop-ds
Stopping Server...
...
-$ /path/to/opendj/bin/restore --backupDirectory /path/to/opendj/bak/userRoot
+$ restore --backupDirectory /path/to/opendj/bak/userRoot
--listBackups
Backup ID: 20120928102414Z
Backup Date: 28/Sep/2012:12:24:17 +0200
@@ -313,10 +313,10 @@
Has Signed Hash: false
Dependent Upon: none
-$ /path/to/opendj/bin/restore --backupDirectory /path/to/opendj/bak/userRoot
+$ restore --backupDirectory /path/to/opendj/bak/userRoot
--backupID 20120928102414Z
[28/Sep/2012:12:26:20 +0200] ... msg=Restored: 00000000.jdb (size 355179)
-$ /path/to/opendj/bin/start-ds
+$ start-ds
[28/Sep/2012:12:27:29 +0200] ... The Directory Server has started successfully</screen>
</refsect1>
</refentry>
diff --git a/opends/src/main/docbkx/admin-guide/man-setup.xml b/opends/src/main/docbkx/admin-guide/man-setup.xml
index aa6d450..1c5687c 100644
--- a/opends/src/main/docbkx/admin-guide/man-setup.xml
+++ b/opends/src/main/docbkx/admin-guide/man-setup.xml
@@ -325,8 +325,8 @@
<title>Examples</title>
<para>The following command installs OpenDJ directory server, enabling
StartTLS and importing 100 example entries without interaction.</para>
- <screen>$ ./opendj/setup --cli -b dc=example,dc=com -d 100 -D "cn=Directory Manager"
- -w password -h `hostname` -p 1389
+ <screen>$ /path/to/opendj/setup --cli -b dc=example,dc=com -d 100
+ -D "cn=Directory Manager" -w password -h opendj.example.com -p 1389
--generateSelfSignedCertificate --enableStartTLS -n
OpenDJ <?eval ${docTargetVersion}?>
diff --git a/opends/src/main/docbkx/admin-guide/man-uninstall.xml b/opends/src/main/docbkx/admin-guide/man-uninstall.xml
index f6e40ea..3d96c9a 100644
--- a/opends/src/main/docbkx/admin-guide/man-uninstall.xml
+++ b/opends/src/main/docbkx/admin-guide/man-uninstall.xml
@@ -288,7 +288,7 @@
<title>Examples</title>
<para>The following command removes OpenDJ directory server without
interaction.</para>
- <screen>$ ./opendj/uninstall -a --cli -I admin -w password -n
+ <screen>$ /path/to/opendj/uninstall -a --cli -I admin -w password -n
Stopping Directory Server ..... Done.
Deleting Files under the Installation Path ..... Done.
diff --git a/opends/src/main/docbkx/install-guide/chap-install-cli.xml b/opends/src/main/docbkx/install-guide/chap-install-cli.xml
index 9941798..8835747 100644
--- a/opends/src/main/docbkx/install-guide/chap-install-cli.xml
+++ b/opends/src/main/docbkx/install-guide/chap-install-cli.xml
@@ -151,7 +151,7 @@
<step>
<para>Run the <command>setup --cli</command> command found in the
- <filename>opendj</filename> directory.</para>
+ <filename>/path/to/opendj</filename> directory.</para>
<para>This command starts the setup program in interactive mode on the
command line, prompting you for each option. Alternatively, use
diff --git a/opends/src/main/docbkx/install-guide/chap-install-gui.xml b/opends/src/main/docbkx/install-guide/chap-install-gui.xml
index 56b46de..6393784 100644
--- a/opends/src/main/docbkx/install-guide/chap-install-gui.xml
+++ b/opends/src/main/docbkx/install-guide/chap-install-gui.xml
@@ -169,13 +169,13 @@
following, depending on your host system.</para>
<listitem>
- <para>(Mac OS X) <command>opendj/bin/ControlPanel.app</command></para>
+ <para>(Mac OS X) <command>/path/to/opendj/bin/ControlPanel.app</command></para>
</listitem>
<listitem>
- <para>(UNIX) <command>opendj/bin/control-panel</command></para>
+ <para>(UNIX) <command>/path/to/opendj/bin/control-panel</command></para>
</listitem>
<listitem>
- <para>(Windows) <command>opendj\bat\control-panel.bat</command></para>
+ <para>(Windows) <command>C:\path\to\opendj\bat\control-panel.bat</command></para>
</listitem>
</itemizedlist>
</chapter>
diff --git a/opends/src/main/docbkx/install-guide/chap-uninstall.xml b/opends/src/main/docbkx/install-guide/chap-uninstall.xml
index 7a44a73..41b524c 100644
--- a/opends/src/main/docbkx/install-guide/chap-uninstall.xml
+++ b/opends/src/main/docbkx/install-guide/chap-uninstall.xml
@@ -33,14 +33,14 @@
<indexterm><primary>Uninstalling</primary></indexterm>
<para>Remove OpenDJ directory server software with the
- <command>uninstall</command> command.</para>
+ <command>/path/to/opendj/uninstall</command> command.</para>
<procedure xml:id="uninstall-gui">
<title>To Uninstall OpenDJ From the Graphical Uninstaller</title>
<step>
- <para>(UNIX) Run <command>opendj/uninstall</command>.</para>
- <para>(Windows) Double-click <filename>opendj\uninstall.bat</filename>.</para>
- <para>(Mac OS X) Double-click <filename>opendj/Uninstall.app</filename>.</para>
+ <para>(UNIX) Run <command>/path/to/opendj/uninstall</command>.</para>
+ <para>(Windows) Double-click <filename>/path/to/opendj\uninstall.bat</filename>.</para>
+ <para>(Mac OS X) Double-click <filename>/path/to/opendj/Uninstall.app</filename>.</para>
<mediaobject xml:id="figure-uninstall-start">
<imageobject>
@@ -75,15 +75,14 @@
</step>
<step>
- <para>Run the <command>opendj/uninstall --cli</command> command.</para>
+ <para>Run the <command>/path/to/opendj/uninstall --cli</command> command.</para>
<para>This command starts the removal program in interactive mode on the
command line, prompting you for each option. Alternatively, use additional
<command>uninstall</command> options to specify choices for the options.
See <command>uninstall --help</command> for more information.</para>
- <screen>$ cd /path/to/opendj
-$ ./uninstall --cli
+ <screen>$ /path/to/opendj/uninstall --cli
Do you want to remove all components of the server or select the components to
remove?
diff --git a/opends/src/main/docbkx/shared/screen-upgrade.xml b/opends/src/main/docbkx/shared/screen-upgrade.xml
index 494da88..292efaf 100644
--- a/opends/src/main/docbkx/shared/screen-upgrade.xml
+++ b/opends/src/main/docbkx/shared/screen-upgrade.xml
@@ -27,18 +27,16 @@
xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
xmlns:xlink='http://www.w3.org/1999/xlink'
xmlns:xinclude='http://www.w3.org/2001/XInclude'
->$ cd /path/to
-$ ls
-OpenDJ-2.4.5
-$ ./OpenDJ-2.4.5/bin/stop-ds --quiet
+>$ /path/to/OpenDJ-2.4.5/bin/stop-ds --quiet
... msg=The backend userRoot is now taken offline
... msg=The Directory Server is now stopped
+$ cd /path/to
$ zip -rq OpenDJ-backup.zip OpenDJ-2.4.5
$ unzip -q ~/Downloads/OpenDJ-2.6.0.zip
$ cp -r opendj/* OpenDJ-2.4.5/
$ rm -rf opendj
$ mv OpenDJ-2.4.5 opendj
-$ ./opendj/upgrade --no-prompt --acceptLicense
+$ /path/to/opendj/upgrade --no-prompt --acceptLicense
>>>> OpenDJ Upgrade Utility
@@ -95,5 +93,5 @@
>>>> OpenDJ was successfully upgraded from version 2.4.5.7743 to 2.6.0.9086
* See '/path/to/opendj/upgrade.log' for a detailed log of this operation
-$ ./opendj/bin/start-ds --quiet
+$ /path/to/opendj/bin/start-ds --quiet
$ </screen>
--
Gitblit v1.10.0