|
From: <di...@us...> - 2008-10-07 20:18:23
|
Revision: 607
http://safekeep.svn.sourceforge.net/safekeep/?rev=607&view=rev
Author: dimi
Date: 2008-10-07 20:18:21 +0000 (Tue, 07 Oct 2008)
Log Message:
-----------
Update man pages on website to latest as of Tue Oct 7 16:18:17 EDT 2008
Modified Paths:
--------------
website/trunk/WebContent/safekeep.backup.html
website/trunk/WebContent/safekeep.html
Modified: website/trunk/WebContent/safekeep.backup.html
===================================================================
--- website/trunk/WebContent/safekeep.backup.html 2008-10-07 19:58:33 UTC (rev 606)
+++ website/trunk/WebContent/safekeep.backup.html 2008-10-07 20:18:21 UTC (rev 607)
@@ -342,6 +342,10 @@
and for how long (D=days, W=weeks, M=months, or Y=years) -->
<repo path="./data" retention="10D"/>
+ <options>
+ <special-files include="false" />
+ </options>
+
<!-- settings for database dump and for volume snapshot -->
<setup>
<!-- database type ("postgres" or "mysql"), and database name,
@@ -494,6 +498,30 @@
</p>
</dd>
<dt>
+/backup/options/special-files/@include
+</dt>
+<dd>
+<p>
+ One of "true" or "false". If "true", the dump file will
+ include all special files, including device files, fifo files and
+ socket files.
+ Optional, defaults to "false".
+ <strong>NOTE</strong>: specification of no options is equalent to false, but the
+ inclusion of other options may cause the underlying backup defaults
+ to be use.
+</p>
+</dd>
+<dt>
+/backup/options/rdiff-backup/@append
+</dt>
+<dd>
+<p>
+ Append the specified options to the current rdiff-backup run.
+ This is planned to be specific to the current rdiff-backup, and
+ different options will be made available for other backends.
+</p>
+</dd>
+<dt>
/backup/setup/dump/@type
</dt>
<dd>
@@ -523,6 +551,16 @@
</p>
</dd>
<dt>
+/backup/setup/dump/@dbpasswd
+</dt>
+<dd>
+<p>
+ Password of the database user to use while doing the dump.
+ This is currently supported only for MySQL databases.
+ Optional, it has no default value.
+</p>
+</dd>
+<dt>
/backup/setup/dump/@user
</dt>
<dd>
@@ -682,7 +720,7 @@
</div>
<div id="footer">
<div id="footer-text">
-Last updated 26-Feb-2008 16:08:19 EDT
+Last updated 07-Oct-2008 16:17:27 EDT
</div>
</div>
</body>
Modified: website/trunk/WebContent/safekeep.html
===================================================================
--- website/trunk/WebContent/safekeep.html 2008-10-07 19:58:33 UTC (rev 606)
+++ website/trunk/WebContent/safekeep.html 2008-10-07 20:18:21 UTC (rev 607)
@@ -315,10 +315,10 @@
</div>
<h2>SYNOPSIS</h2>
<div class="sectionbody">
-<p><em>safekeep</em> --server [-q] [-v] [--noemail] [--force] [-c file] <clientid>*</p>
+<p><em>safekeep</em> --server [-q] [-v] [--noemail] [--force] [-c file] [--cleanup] <clientid>*</p>
<p><em>safekeep</em> --keys [-q] [-v] [--noemail] [-c file] [-i file] [--status] [--print] [--deploy] <clientid>*</p>
<p><em>safekeep</em> --list [-q] [-v] [--noemail] [-c file] [--increments] [--parsable-output] [--sizes] [--changed=<time>] [--at-time=<time>] <clientid>*</p>
-<p><em>safekeep</em> --client</p>
+<p><em>safekeep</em> --client [--cleanup]</p>
<p><em>safekeep</em> -h | -V</p>
</div>
<h2>DESCRIPTION</h2>
@@ -339,7 +339,12 @@
the client data using <tt>rdiff-backup</tt>, and then cleanups the state
(removes the database dumps, deactivates the LVM snapshots)</p>
<p>Note that the client mode of SafeKeep should never be invoked manually,
-this mode is meant to be used only by the server mode of SafeKeep.</p>
+this mode is meant to be used only by the server mode of SafeKeep.
+The only exception to this is if run with the <tt>--cleanup</tt> option, which
+is used to remove LVM snapshots and mounts created by Safekeep, after a
+crash or some other failure, without a connection to the server.
+Normally this cleanup would be performed through the server command
+<tt>safekeep --server --cleanup</tt>.</p>
<p>The SSH key management mode is a helper mode for deploying or verifying
the setup of the SSH authentification keys.</p>
<p>In list mode, SafeKeep lists the details of existing archives. This is
@@ -468,8 +473,40 @@
logs tells you to use this option.
</p>
</dd>
+<dt>
+--cleanup
+</dt>
+<dd>
+<p>
+ Remove LVM snapshots and mounts left by Safekeep after a
+ crash or other failure. This will run also run the standard
+ cleanup processes, such as the removal of an DB dumps, and
+ forces a consistency check of the <tt>rdiff-backup</tt> destination
+ directory. This is the prefered cleanup procedure and can
+ be run with no danger of corrupting the system if there is
+ nothing to cleanup.
+</p>
+</dd>
</dl>
</div>
+<h2>CLIENT OPTIONS</h2>
+<div class="sectionbody">
+<dl>
+<dt>
+--cleanup
+</dt>
+<dd>
+<p>
+ Remove LVM snapshots and mounts left after a crash or other
+ failure from the local system. Unlike the equivalent <tt>--server</tt>
+ option, it does not do any other of the standard cleanups.
+ This option should only be used when it is not possible to
+ refer to the server, for example, when the network connection
+ to the server is no longer available.
+</p>
+</dd>
+</dl>
+</div>
<h2>KEYS OPTIONS</h2>
<div class="sectionbody">
<dl>
@@ -711,7 +748,7 @@
</div>
<div id="footer">
<div id="footer-text">
-Last updated 26-Feb-2008 16:08:18 EDT
+Last updated 07-Oct-2008 16:17:26 EDT
</div>
</div>
</body>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|