From 1443af4c15194809c99d0a30d9e4c3a835130e57 Mon Sep 17 00:00:00 2001
From: Mark Craig <mark.craig@forgerock.com>
Date: Fri, 28 Sep 2012 11:51:28 +0000
Subject: [PATCH] Additional fix for OPENDJ-601: Syntax for offline backup is incorrect
---
opendj-sdk/opendj3/src/main/docbkx/shared/man-restore.xml | 23 +++++++++++
opendj-sdk/opends/resource/man/man1/backup.1 | 27 +++++++++++--
opendj-sdk/opendj3/src/main/docbkx/shared/man-backup.xml | 18 ++++++++-
opendj-sdk/opends/resource/man/man1/restore.1 | 36 ++++++++++++++++-
4 files changed, 94 insertions(+), 10 deletions(-)
diff --git a/opendj-sdk/opendj3/src/main/docbkx/shared/man-backup.xml b/opendj-sdk/opendj3/src/main/docbkx/shared/man-backup.xml
index fbde0fd..da34629 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/shared/man-backup.xml
+++ b/opendj-sdk/opendj3/src/main/docbkx/shared/man-backup.xml
@@ -328,17 +328,31 @@
</refsect1>
<refsect1>
<title>Examples</title>
- <para>The following example backs up all user data on the server.</para>
+ <para>The following example backs up all user data while the server is
+ online.</para>
<screen>$ backup -p 4444 -D "cn=Directory Manager" -w password
-a -d /path/to/OpenDJ/bak -t 0
Backup task 20110613143801866 scheduled to start Jun 13, 2011 2:38:01 PM CEST</screen>
<para>The following example schedules back up of all user data every night at
- 2 AM, and notifies diradmin@example.com when finished, or on error.</para>
+ 2 AM when the server is online, and notifies diradmin@example.com when
+ finished, or on error.</para>
<screen>$ backup -p 4444 -D "cn=Directory Manager" -w password -a
-d /path/to/OpenDJ/bak --recurringTask "00 02 * * *"
--completionNotify diradmin@example.com --errorNotify diradmin@example.com
Recurring Backup task BackupTask-988d6adf-4d65-44bf-8546-6ea74a2480b0
scheduled successfully</screen>
+
+ <para>The following example backs up all user data while the server is
+ offline.</para>
+ <screen>$ /path/to/OpenDJ/bin/stop-ds
+Stopping Server...
+...
+$ /path/to/OpenDJ/bin/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
+[28/Sep/2012:12:15:48 +0200] ... The Directory Server has started successfully
+</screen>
</refsect1>
</refentry>
diff --git a/opendj-sdk/opendj3/src/main/docbkx/shared/man-restore.xml b/opendj-sdk/opendj3/src/main/docbkx/shared/man-restore.xml
index 0b227fe..c907347 100644
--- a/opendj-sdk/opendj3/src/main/docbkx/shared/man-restore.xml
+++ b/opendj-sdk/opendj3/src/main/docbkx/shared/man-restore.xml
@@ -293,9 +293,30 @@
<refsect1>
<title>Examples</title>
<para>The following example schedules a restore as a task to begin
- immediately.</para>
+ immediately while OpenDJ directory server is online.</para>
<screen>$ restore -p 4444 -D "cn=Directory Manager" -w password
-d /path/to/OpenDJ/bak -I 20110613080032 -t 0
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
+Stopping Server...
+...
+$ /path/to/OpenDJ/bin/restore --backupDirectory /path/to/OpenDJ/bak/userRoot
+ --listBackups
+Backup ID: 20120928102414Z
+Backup Date: 28/Sep/2012:12:24:17 +0200
+Is Incremental: false
+Is Compressed: false
+Is Encrypted: false
+Has Unsigned Hash: false
+Has Signed Hash: false
+Dependent Upon: none
+
+$ /path/to/OpenDJ/bin/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
+[28/Sep/2012:12:27:29 +0200] ... The Directory Server has started successfully</screen>
</refsect1>
</refentry>
diff --git a/opendj-sdk/opends/resource/man/man1/backup.1 b/opendj-sdk/opends/resource/man/man1/backup.1
index 4cc748c..1c4bf9e 100644
--- a/opendj-sdk/opends/resource/man/man1/backup.1
+++ b/opendj-sdk/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: 07/17/2012
+.\" Date: 09/28/2012
.\" Manual: Tools Reference
.\" Source: OpenDJ 2.5.0
.\" Language: English
.\"
-.TH "BACKUP" "1" "07/17/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
+.TH "BACKUP" "1" "09/28/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -242,7 +242,7 @@
.RE
.SH "EXAMPLES"
.PP
-The following example backs up all user data on the server\&.
+The following example backs up all user data while the server is online\&.
.sp
.if n \{\
.RS 4
@@ -256,7 +256,7 @@
.RE
.\}
.PP
-The following example schedules back up of all user data every night at 2 AM, and notifies diradmin@example\&.com when finished, or on error\&.
+The following example schedules back up of all user data every night at 2 AM when the server is online, and notifies diradmin@example\&.com when finished, or on error\&.
.sp
.if n \{\
.RS 4
@@ -271,6 +271,25 @@
.if n \{\
.RE
.\}
+.PP
+The following example backs up all user data while the server is offline\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+$ /path/to/OpenDJ/bin/stop\-ds
+Stopping Server\&.\&.\&.
+\&.\&.\&.
+$ /path/to/OpenDJ/bin/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
+[28/Sep/2012:12:15:48 +0200] \&.\&.\&. The Directory Server has started successfully
+.fi
+.if n \{\
+.RE
+.\}
.SH "COPYRIGHT"
.br
Copyright \(co 2011-2012 ForgeRock AS
diff --git a/opendj-sdk/opends/resource/man/man1/restore.1 b/opendj-sdk/opends/resource/man/man1/restore.1
index 03846ae..9c14f0e 100644
--- a/opendj-sdk/opends/resource/man/man1/restore.1
+++ b/opendj-sdk/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: 07/17/2012
+.\" Date: 09/28/2012
.\" Manual: Tools Reference
.\" Source: OpenDJ 2.5.0
.\" Language: English
.\"
-.TH "RESTORE" "1" "07/17/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
+.TH "RESTORE" "1" "09/28/2012" "OpenDJ 2\&.5\&.0" "Tools Reference"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@@ -212,7 +212,7 @@
.RE
.SH "EXAMPLES"
.PP
-The following example schedules a restore as a task to begin immediately\&.
+The following example schedules a restore as a task to begin immediately while OpenDJ directory server is online\&.
.sp
.if n \{\
.RS 4
@@ -225,6 +225,36 @@
.if n \{\
.RE
.\}
+.PP
+The following example restores data while OpenDJ is offline\&.
+.sp
+.if n \{\
+.RS 4
+.\}
+.nf
+$ /path/to/OpenDJ/bin/stop\-ds
+Stopping Server\&.\&.\&.
+\&.\&.\&.
+$ /path/to/OpenDJ/bin/restore \-\-backupDirectory /path/to/OpenDJ/bak/userRoot
+ \-\-listBackups
+Backup ID: 20120928102414Z
+Backup Date: 28/Sep/2012:12:24:17 +0200
+Is Incremental: false
+Is Compressed: false
+Is Encrypted: false
+Has Unsigned Hash: false
+Has Signed Hash: false
+Dependent Upon: none
+
+$ /path/to/OpenDJ/bin/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
+[28/Sep/2012:12:27:29 +0200] \&.\&.\&. The Directory Server has started successfully
+.fi
+.if n \{\
+.RE
+.\}
.SH "COPYRIGHT"
.br
Copyright \(co 2011-2012 ForgeRock AS
--
Gitblit v1.10.0