|
From: <di...@us...> - 2008-02-26 21:08:47
|
Revision: 585
http://safekeep.svn.sourceforge.net/safekeep/?rev=585&view=rev
Author: dimi
Date: 2008-02-26 13:08:40 -0800 (Tue, 26 Feb 2008)
Log Message:
-----------
Update man pages on website to latest as of Tue Feb 26 16:08:36 EST 2008
Modified Paths:
--------------
website/trunk/WebContent/safekeep.backup.html
website/trunk/WebContent/safekeep.conf.html
website/trunk/WebContent/safekeep.html
Modified: website/trunk/WebContent/safekeep.backup.html
===================================================================
--- website/trunk/WebContent/safekeep.backup.html 2008-02-26 21:07:30 UTC (rev 584)
+++ website/trunk/WebContent/safekeep.backup.html 2008-02-26 21:08:40 UTC (rev 585)
@@ -3,7 +3,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 8.1.0" />
+<meta name="generator" content="AsciiDoc 8.2.2" />
<style type="text/css">
/* Debug borders */
p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
@@ -225,6 +225,9 @@
margin-top: 0.8em;
margin-bottom: 0.8em;
}
+div.hlist td {
+ padding-bottom: 5px;
+}
td.hlist1 {
vertical-align: top;
font-style: italic;
@@ -247,13 +250,22 @@
margin-bottom: 0.1em;
}
-div.toclevel1, div.toclevel2 {
+div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
div.toclevel2 {
margin-left: 2em;
+ font-size: 0.9em;
}
+div.toclevel3 {
+ margin-left: 4em;
+ font-size: 0.9em;
+}
+div.toclevel4 {
+ margin-left: 6em;
+ font-size: 0.9em;
+}
include1::./stylesheets/xhtml11-manpage.css[]
/* Workarounds for IE6's broken and incomplete CSS2. */
@@ -549,8 +561,13 @@
</dt>
<dd>
<p>
- The path (device location) to the LVM volume to snapshot
- before the backup commences. It is recommended
+ The path (device location) to the client LVM volume to snapshot
+ before the backup commences. Note that the snapshot happens
+ on the client machines, and it ensures that the data that is
+ being backed-up is in a consistent state throughout the backup
+ process. Multiple snapshots may be specified, in which case the
+ order is important, the associated filesystems are mounted
+ in the order given.
Please note that using this feature requires that <tt>safekeep(1)</tt>
runs as <tt>root</tt> on the client.
Mandatory for a <tt><snapshot></tt> element.
@@ -665,7 +682,7 @@
</div>
<div id="footer">
<div id="footer-text">
-Last updated 17-Jun-2007 21:06:42 EDT
+Last updated 26-Feb-2008 16:08:19 EDT
</div>
</div>
</body>
Modified: website/trunk/WebContent/safekeep.conf.html
===================================================================
--- website/trunk/WebContent/safekeep.conf.html 2008-02-26 21:07:30 UTC (rev 584)
+++ website/trunk/WebContent/safekeep.conf.html 2008-02-26 21:08:40 UTC (rev 585)
@@ -3,7 +3,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 8.1.0" />
+<meta name="generator" content="AsciiDoc 8.2.2" />
<style type="text/css">
/* Debug borders */
p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
@@ -225,6 +225,9 @@
margin-top: 0.8em;
margin-bottom: 0.8em;
}
+div.hlist td {
+ padding-bottom: 5px;
+}
td.hlist1 {
vertical-align: top;
font-style: italic;
@@ -247,13 +250,22 @@
margin-bottom: 0.1em;
}
-div.toclevel1, div.toclevel2 {
+div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
div.toclevel2 {
margin-left: 2em;
+ font-size: 0.9em;
}
+div.toclevel3 {
+ margin-left: 4em;
+ font-size: 0.9em;
+}
+div.toclevel4 {
+ margin-left: 6em;
+ font-size: 0.9em;
+}
include1::./stylesheets/xhtml11-manpage.css[]
/* Workarounds for IE6's broken and incomplete CSS2. */
@@ -376,7 +388,7 @@
</div>
<div id="footer">
<div id="footer-text">
-Last updated 17-Jun-2007 21:06:41 EDT
+Last updated 26-Feb-2008 16:08:19 EDT
</div>
</div>
</body>
Modified: website/trunk/WebContent/safekeep.html
===================================================================
--- website/trunk/WebContent/safekeep.html 2008-02-26 21:07:30 UTC (rev 584)
+++ website/trunk/WebContent/safekeep.html 2008-02-26 21:08:40 UTC (rev 585)
@@ -3,7 +3,7 @@
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-<meta name="generator" content="AsciiDoc 8.1.0" />
+<meta name="generator" content="AsciiDoc 8.2.2" />
<style type="text/css">
/* Debug borders */
p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
@@ -225,6 +225,9 @@
margin-top: 0.8em;
margin-bottom: 0.8em;
}
+div.hlist td {
+ padding-bottom: 5px;
+}
td.hlist1 {
vertical-align: top;
font-style: italic;
@@ -247,13 +250,22 @@
margin-bottom: 0.1em;
}
-div.toclevel1, div.toclevel2 {
+div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
div.toclevel2 {
margin-left: 2em;
+ font-size: 0.9em;
}
+div.toclevel3 {
+ margin-left: 4em;
+ font-size: 0.9em;
+}
+div.toclevel4 {
+ margin-left: 6em;
+ font-size: 0.9em;
+}
include1::./stylesheets/xhtml11-manpage.css[]
/* Workarounds for IE6's broken and incomplete CSS2. */
@@ -303,8 +315,9 @@
</div>
<h2>SYNOPSIS</h2>
<div class="sectionbody">
-<p><em>safekeep</em> [--server] [-q] [-v] [--force] [-c file] <clientid>*</p>
-<p><em>safekeep</em> --keys [-q] [-v] [-c file] [-i file] [--status] [--print] [--deploy] <clientid>*</p>
+<p><em>safekeep</em> --server [-q] [-v] [--noemail] [--force] [-c file] <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> -h | -V</p>
</div>
@@ -312,7 +325,8 @@
<div class="sectionbody">
<p>SafeKeep is a client/server backup script which enhances the
power of rdiff-backup with simple configuration and use.</p>
-<p>SafeKeep can work in server mode, client mode or SSH key management mode.</p>
+<p>SafeKeep can work in server mode, client mode, SSH key management mode
+or list mode.</p>
<p>In server mode, SafeKeep parses a set of configurations files which
defines a set of backup clients. For each backup client, SafeKeep
connects to the client host over SSH (using a public key authentification
@@ -328,7 +342,9 @@
this mode is meant to be used only by the server mode of SafeKeep.</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 both server and keys management mode, you can restrict the operation
+<p>In list mode, SafeKeep lists the details of existing archives. This is
+basically an interface to the relevant options for <tt>rdiff-backup</tt>.</p>
+<p>In server, keys management and list mode, you can restrict the operation
to a specific set of clients by listing the desired client IDs as
arguments. If no client ID is given, SafeKeep will operate over all known
clients.</p>
@@ -342,7 +358,7 @@
</dt>
<dd>
<p>
- Selects the server mode (default)
+ Selects the server mode
</p>
</dd>
<dt>
@@ -363,7 +379,18 @@
Selects the SSH key management mode
</p>
</dd>
+<dt>
+--list
+</dt>
+<dd>
+<p>
+ Selects the list mode
+</p>
+</dd>
</dl>
+<p>Please note that you must always specify an operation mode. Earlier
+versions used do default to <tt>--server</tt> mode, but that proved to work
+out poorly in practice.</p>
</div>
<h2>GENERAL OPTIONS</h2>
<div class="sectionbody">
@@ -415,6 +442,15 @@
once.
</p>
</dd>
+<dt>
+--noemail
+</dt>
+<dd>
+<p>
+ Disables the sending of email, no matter what the settings
+ within the configuration file.
+</p>
+</dd>
</dl>
</div>
<h2>SERVER OPTIONS</h2>
@@ -477,6 +513,65 @@
</dd>
</dl>
</div>
+<h2>LIST OPTIONS</h2>
+<div class="sectionbody">
+<dl>
+<dt>
+--increments
+</dt>
+<dd>
+<p>
+ Pass the <tt>--list-increments</tt> option to <tt>rdiff-backup</tt>, to
+ list the number and date of partial incremental backups for
+ the given or all clients. This is the default list option.
+</p>
+</dd>
+<dt>
+--parseable-output
+</dt>
+<dd>
+<p>
+ Pass the <tt>--parsable-output</tt> option to <tt>rdiff-backup</tt> to
+ generate output in a format that is easily parsed by other
+ programs. This currently only works with the <tt>--increments</tt>.
+</p>
+</dd>
+<dt>
+--sizes
+</dt>
+<dd>
+<p>
+ Pass the <tt>--list-increment-sizes</tt> option to <tt>rdiff-backup</tt>,
+ to list the total size of all increment and mirror files by
+ time for the given or all clients. Note, this may take some time.
+</p>
+</dd>
+<dt>
+--changed=TIME
+</dt>
+<dd>
+<p>
+ Pass the <tt>--list-changed-since</tt> option for TIME to <tt>rdiff-backup</tt>,
+ to list the files changed since TIME for the given clients.
+ TIME is passed directly to <tt>rdiff-backup</tt>. Note, this may take
+ some time and generate considerable output. Also, unlike
+ <tt>rdiff-backup</tt> the is no option to select sub-directories.
+</p>
+</dd>
+<dt>
+--at-time=TIME
+</dt>
+<dd>
+<p>
+ Pass the <tt>--list-at-time</tt> option for TIME to <tt>rdiff-backup</tt>,
+ to list the files in the archive that were present at the
+ given time for the given clients. Note, this may take some
+ time and generate considerable output. Also, unlike
+ <tt>rdiff-backup</tt> the is no option to select sub-directories.
+</p>
+</dd>
+</dl>
+</div>
<h2>CONFIGURATION</h2>
<div class="sectionbody">
<p>Normally the configuration files are placed in the <tt>/etc/safekeep/backup.d/</tt>
@@ -616,7 +711,7 @@
</div>
<div id="footer">
<div id="footer-text">
-Last updated 19-Oct-2007 12:33:39 EDT
+Last updated 26-Feb-2008 16:08:18 EDT
</div>
</div>
</body>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|