Menu
▾
▴
SF.net SVN: safekeep:[726] website/trunk/WebContent
|
From: <di...@us...> - 2010-11-23 04:30:16
|
Revision: 726
http://safekeep.svn.sourceforge.net/safekeep/?rev=726&view=rev
Author: dimi
Date: 2010-11-23 04:30:09 +0000 (Tue, 23 Nov 2010)
Log Message:
-----------
Update man pages on website to latest as of Mon Nov 22 23:29:59 EST 2010
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 2010-11-23 04:13:03 UTC (rev 725)
+++ website/trunk/WebContent/safekeep.backup.html 2010-11-23 04:30:09 UTC (rev 726)
@@ -2,7 +2,7 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="generator" content="AsciiDoc 8.4.1">
+<meta name="generator" content="AsciiDoc 8.4.5">
<title>safekeep.backup</title>
</head>
<body>
@@ -15,7 +15,7 @@
<p>safekeep.backup -
Configuration file for a 'safekeep(1)' client
</p>
-<h2>SYNOPSIS</h2>
+<h2><a name="_synopsis"></a>SYNOPSIS</h2>
<p>These files are usually placed in <tt>/etc/safekeep/backup.d/</tt> to be picked
up automatically by <b>safekeep(1)</b>. They must have a <tt>.backup</tt> extension.</p>
<h2><a name="_description"></a>DESCRIPTION</h2>
@@ -31,7 +31,7 @@
<!-- the client backup host, the user under which the servers will connect,
the SSH keys used for control and data transfer -->
<host
- name="myhost" user="root"
+ name="myhost" user="root" nice="10"
key-ctrl="/home/jdoe/.ssh/backup_id_dsa"
key-data="/home/jdoe/.ssh/backup2_id_dsa"
/>
@@ -138,6 +138,17 @@
</p>
</dd>
<dt>
+/backup/host/@nice
+</dt>
+<dd>
+<p>
+ The nice adjustment for the client. This settings is normally
+ not all that important, as most of the load rests on the server side.
+ NB: if you change this value, you will have to re-deploy the auth keys.
+ Optional, defaults to no nice level.
+</p>
+</dd>
+<dt>
/backup/host/@key-ctrl
</dt>
<dd>
@@ -563,7 +574,7 @@
<p></p>
<p></p>
<hr><p><small>
-Last updated 2009-05-21 11:18:36 EDT
+Last updated 2010-11-19 01:25:42 EDT
</small></p>
</body>
</html>
Modified: website/trunk/WebContent/safekeep.conf.html
===================================================================
--- website/trunk/WebContent/safekeep.conf.html 2010-11-23 04:13:03 UTC (rev 725)
+++ website/trunk/WebContent/safekeep.conf.html 2010-11-23 04:30:09 UTC (rev 726)
@@ -2,7 +2,7 @@
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
-<meta name="generator" content="AsciiDoc 8.4.1">
+<meta name="generator" content="AsciiDoc 8.4.5">
<title>safekeep.conf</title>
</head>
<body>
@@ -15,7 +15,7 @@
<p>safekeep.conf -
Configuration file for 'safekeep(1)'
</p>
-<h2>SYNOPSIS</h2>
+<h2><a name="_synopsis"></a>SYNOPSIS</h2>
<p>This file resides in <tt>/etc/safekeep/</tt> from where it
will be automatically picked up by <b>safekeep(1)</b>.</p>
<h2><a name="_description"></a>DESCRIPTION</h2>
@@ -75,15 +75,52 @@
</dt>
<dd>
<p>
- The nice level adjustment for safekeep, for the time
- being used only on the server side.
+ The default nice level adjustment for safekeep.
It specifies an integer to be added to the current nice
level. Nicenesses range from -20 (most favorable scheduling)
to 19 (least favorable).
- If no nice level is specified, safekeep is not niced.
+ To disable nice, set this value to 0.
+ If no nice level is specified, safekeep is niced at +10.
</p>
</dd>
<dt>
+nice.adjustment.server
+</dt>
+<dd>
+<p>
+ The nice level adjustment for safekeep, used on the server side.
+ It overrides the generic setting in nice.adjustment.
+</p>
+</dd>
+<dt>
+nice.adjustment.client
+</dt>
+<dd>
+<p>
+ The default nice adjustment for the client. This settings is normally
+ not all that important, as most of the load is on the server side.
+ You can also set the remove nice level on a per-client basis in
+ the .backup file (see /backup/host/@nice).
+ NB: if you change this value, you will have to re-deploy the auth keys.
+</p>
+</dd>
+<dt>
+ionice.adjustment
+</dt>
+<dd>
+<p>
+ The default IO nice level adjustment for safekeep.
+ It can be either <b>none</b>, <b>idle</b>, or an integer between 0-7
+ (with 0 being higher priority). See ionice(1) for more information.
+ This is currently being used only on the server side, where
+ IO load tends to be a problem.
+ NB: this depends on the availability of <b>ionice(1)</b> on the
+ system where the server is running. If ionice cannot be found,
+ this setting is ignored.
+ If no level is specified, it defaults to <b>idle</b>.
+</p>
+</dd>
+<dt>
bandwidth.overall
</dt>
<dd>
@@ -135,7 +172,7 @@
<p></p>
<p></p>
<hr><p><small>
-Last updated 2009-05-21 11:18:36 EDT
+Last updated 2010-11-21 14:01:30 EDT
</small></p>
</body>
</html>
Modified: website/trunk/WebContent/safekeep.html
===================================================================
--- website/trunk/WebContent/safekeep.html 2010-11-23 04:13:03 UTC (rev 725)
+++ website/trunk/WebContent/safekeep.html 2010-11-23 04:30:09 UTC (rev 726)
@@ -1,27 +1,328 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<html>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+ "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<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.4.1">
-<title>safekeep</title>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+<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 {
+/*
+ border: 1px solid red;
+*/
+}
+
+body {
+ margin: 1em 5% 1em 5%;
+}
+
+a {
+ color: blue;
+ text-decoration: underline;
+}
+a:visited {
+ color: fuchsia;
+}
+
+em {
+ font-style: italic;
+}
+
+strong {
+ font-weight: bold;
+}
+
+tt {
+ color: navy;
+}
+
+h1, h2, h3, h4, h5, h6 {
+ color: #527bbd;
+ font-family: sans-serif;
+ margin-top: 1.2em;
+ margin-bottom: 0.5em;
+ line-height: 1.3;
+}
+
+h1 {
+ border-bottom: 2px solid silver;
+}
+h2 {
+ border-bottom: 2px solid silver;
+ padding-top: 0.5em;
+}
+
+div.sectionbody {
+ font-family: serif;
+ margin-left: 0;
+}
+
+hr {
+ border: 1px solid silver;
+}
+
+p {
+ margin-top: 0.5em;
+ margin-bottom: 0.5em;
+}
+
+pre {
+ padding: 0;
+ margin: 0;
+}
+
+span#author {
+ color: #527bbd;
+ font-family: sans-serif;
+ font-weight: bold;
+ font-size: 1.1em;
+}
+span#email {
+}
+span#revision {
+ font-family: sans-serif;
+}
+
+div#footer {
+ font-family: sans-serif;
+ font-size: small;
+ border-top: 2px solid silver;
+ padding-top: 0.5em;
+ margin-top: 4.0em;
+}
+div#footer-text {
+ float: left;
+ padding-bottom: 0.5em;
+}
+div#footer-badges {
+ float: right;
+ padding-bottom: 0.5em;
+}
+
+div#preamble,
+div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
+div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
+div.admonitionblock {
+ margin-right: 10%;
+ margin-top: 1.5em;
+ margin-bottom: 1.5em;
+}
+div.admonitionblock {
+ margin-top: 2.5em;
+ margin-bottom: 2.5em;
+}
+
+div.content { /* Block element content. */
+ padding: 0;
+}
+
+/* Block element titles. */
+div.title, caption.title {
+ font-family: sans-serif;
+ font-weight: bold;
+ text-align: left;
+ margin-top: 1.0em;
+ margin-bottom: 0.5em;
+}
+div.title + * {
+ margin-top: 0;
+}
+
+td div.title:first-child {
+ margin-top: 0.0em;
+}
+div.content div.title:first-child {
+ margin-top: 0.0em;
+}
+div.content + div.title {
+ margin-top: 0.0em;
+}
+
+div.sidebarblock > div.content {
+ background: #ffffee;
+ border: 1px solid silver;
+ padding: 0.5em;
+}
+
+div.listingblock {
+ margin-right: 0%;
+}
+div.listingblock > div.content {
+ border: 1px solid silver;
+ background: #f4f4f4;
+ padding: 0.5em;
+}
+
+div.quoteblock > div.content {
+ padding-left: 2.0em;
+}
+
+div.attribution {
+ text-align: right;
+}
+div.verseblock + div.attribution {
+ text-align: left;
+}
+
+div.admonitionblock .icon {
+ vertical-align: top;
+ font-size: 1.1em;
+ font-weight: bold;
+ text-decoration: underline;
+ color: #527bbd;
+ padding-right: 0.5em;
+}
+div.admonitionblock td.content {
+ padding-left: 0.5em;
+ border-left: 2px solid silver;
+}
+
+div.exampleblock > div.content {
+ border-left: 2px solid silver;
+ padding: 0.5em;
+}
+
+div.verseblock div.content {
+ white-space: pre;
+}
+
+div.imageblock div.content { padding-left: 0; }
+div.imageblock img { border: 1px solid silver; }
+span.image img { border-style: none; }
+
+dl {
+ margin-top: 0.8em;
+ margin-bottom: 0.8em;
+}
+dt {
+ margin-top: 0.5em;
+ margin-bottom: 0;
+ font-style: italic;
+}
+dd > *:first-child {
+ margin-top: 0;
+}
+
+ul, ol {
+ list-style-position: outside;
+}
+ol.olist2 {
+ list-style-type: lower-alpha;
+}
+
+div.tableblock > table {
+ border: 3px solid #527bbd;
+}
+thead {
+ font-family: sans-serif;
+ font-weight: bold;
+}
+tfoot {
+ font-weight: bold;
+}
+
+div.hlist {
+ margin-top: 0.8em;
+ margin-bottom: 0.8em;
+}
+div.hlist td {
+ padding-bottom: 5px;
+}
+td.hlist1 {
+ vertical-align: top;
+ font-style: italic;
+ padding-right: 0.8em;
+}
+td.hlist2 {
+ vertical-align: top;
+}
+
+@media print {
+ div#footer-badges { display: none; }
+}
+
+div#toctitle {
+ color: #527bbd;
+ font-family: sans-serif;
+ font-size: 1.1em;
+ font-weight: bold;
+ margin-top: 1.0em;
+ margin-bottom: 0.1em;
+}
+
+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. */
+
+div.sidebar-content {
+ background: #ffffee;
+ border: 1px solid silver;
+ padding: 0.5em;
+}
+div.sidebar-title, div.image-title {
+ font-family: sans-serif;
+ font-weight: bold;
+ margin-top: 0.0em;
+ margin-bottom: 0.5em;
+}
+
+div.listingblock div.content {
+ border: 1px solid silver;
+ background: #f4f4f4;
+ padding: 0.5em;
+}
+
+div.quoteblock-content {
+ padding-left: 2.0em;
+}
+
+div.exampleblock-content {
+ border-left: 2px solid silver;
+ padding-left: 0.5em;
+}
+
+/* IE6 sets dynamically generated links as visited. */
+div#toc a:visited { color: blue; }
+</style>
+<title>safekeep(1)</title>
</head>
<body>
-<hr>
+<div id="header">
<h1>
- safekeep(1) Manual Page
+safekeep(1) Manual Page
</h1>
-<hr>
<h2>NAME</h2>
+<div class="sectionbody">
<p>safekeep -
Client/server backup script
</p>
+</div>
+</div>
<h2>SYNOPSIS</h2>
-<p><b>safekeep</b> --server [-q] [-v] [--noemail] [--force] [-c file] [--cleanup] <clientid>*</p>
-<p><b>safekeep</b> --keys [-q] [-v] [--noemail] [-c file] [-i file] [--status] [--print] [--deploy] <clientid>*</p>
-<p><b>safekeep</b> --list [-q] [-v] [--noemail] [-c file] [--increments] [--parsable-output] [--sizes] [--changed=<time>] [--at-time=<time>] <clientid>*</p>
-<p><b>safekeep</b> --client [--cleanup]</p>
-<p><b>safekeep</b> -h | -V</p>
-<h2><a name="_description"></a>DESCRIPTION</h2>
+<div class="sectionbody">
+<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 [--cleanup]</p>
+<p><em>safekeep</em> -h | -V</p>
+</div>
+<h2>DESCRIPTION</h2>
+<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, SSH key management mode
@@ -53,7 +354,9 @@
arguments. If no client ID is given, SafeKeep will operate over all known
clients.</p>
<p>Each mode accepts a few options as described below.</p>
-<h2><a name="_operation_mode"></a>OPERATION MODE</h2>
+</div>
+<h2>OPERATION MODE</h2>
+<div class="sectionbody">
<dl>
<dt>
--server
@@ -93,7 +396,9 @@
<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>
-<h2><a name="_general_options"></a>GENERAL OPTIONS</h2>
+</div>
+<h2>GENERAL OPTIONS</h2>
+<div class="sectionbody">
<dl>
<dt>
-c, --conf=FILE
@@ -152,7 +457,9 @@
</p>
</dd>
</dl>
-<h2><a name="_server_options"></a>SERVER OPTIONS</h2>
+</div>
+<h2>SERVER OPTIONS</h2>
+<div class="sectionbody">
<dl>
<dt>
--force
@@ -181,7 +488,9 @@
</p>
</dd>
</dl>
-<h2><a name="_client_options"></a>CLIENT OPTIONS</h2>
+</div>
+<h2>CLIENT OPTIONS</h2>
+<div class="sectionbody">
<dl>
<dt>
--cleanup
@@ -197,7 +506,9 @@
</p>
</dd>
</dl>
-<h2><a name="_keys_options"></a>KEYS OPTIONS</h2>
+</div>
+<h2>KEYS OPTIONS</h2>
+<div class="sectionbody">
<dl>
<dt>
-i FILE
@@ -225,7 +536,7 @@
<dd>
<p>
Display the authorization keys for the clients. This is useful in
- case you want to manually copy it into the client’s
+ case you want to manually copy it into the client's
<tt>~/.ssh/authorized_keys</tt> file. This option is seldom useful.
</p>
</dd>
@@ -238,7 +549,9 @@
</p>
</dd>
</dl>
-<h2><a name="_list_options"></a>LIST OPTIONS</h2>
+</div>
+<h2>LIST OPTIONS</h2>
+<div class="sectionbody">
<dl>
<dt>
--increments
@@ -295,21 +608,25 @@
</p>
</dd>
</dl>
-<h2><a name="_configuration"></a>CONFIGURATION</h2>
+</div>
+<h2>CONFIGURATION</h2>
+<div class="sectionbody">
<p>Normally the configuration files are placed in the <tt>/etc/safekeep/backup.d/</tt>
directory from where they will get picked up automatically by SafeKeep.
Each backup client is described by a configuration file in XML format.
The minimum configuration file is:</p>
-<table border="0" bgcolor="#e8e8e8" width="100%" cellpadding="10"><tr><td>
-<pre><backup>
+<div class="listingblock">
+<div class="content">
+<pre><tt><backup>
<host name="my_workstation" />
-</backup></pre>
-</td></tr></table>
+</backup></tt></pre>
+</div></div>
<p>This will simply backup all relevant files (excluding temporary files,
caches, etc) from the client with the address <tt>my_workstation</tt>.</p>
<p>A more realistic example:</p>
-<table border="0" bgcolor="#e8e8e8" width="100%" cellpadding="10"><tr><td>
-<pre><backup>
+<div class="listingblock">
+<div class="content">
+<pre><tt><backup>
<host name="my_workstation" />
<repo retention="10D" />
<setup>
@@ -343,34 +660,41 @@
<exclude path="/"/>
</data>
-</backup></pre>
-</td></tr></table>
+</backup></tt></pre>
+</div></div>
<p>In this case, SafeKeep will dump all databases managed by PostgreSQL,
snapshot the disk via LVM, and proceed to backup <tt>/etc</tt>, <tt>/home</tt>,
<tt>/root</tt>, <tt>/srv</tt>, <tt>/var</tt>, while excluding some unneeded files and
directories. Older data will be retained for 10 days.</p>
<p>For full reference documentation of the configuration format, see
safekeep.backup(5).</p>
-<h2><a name="_client_ids"></a>CLIENT IDS</h2>
+</div>
+<h2>CLIENT IDS</h2>
+<div class="sectionbody">
<p>Normally the client IDs are generated automatically from the configuration
filenames without the extension. E.g. if a configuration file is named
<tt>my_workstation.conf</tt>, the client ID becomes <tt>my_workstation</tt>. For more
information on this topic, see safekeep.backup(5).</p>
-<h2><a name="_key_deployment"></a>KEY DEPLOYMENT</h2>
+</div>
+<h2>KEY DEPLOYMENT</h2>
+<div class="sectionbody">
<p>The <tt>safekeep(1)</tt> server needs to access the clients in order to conduct
the backup. To that end, it establishes two ssh(1) pipes: one for control,
and one for data. To simplify the deployment of the keys, <tt>safekeep(1)</tt>
has a key deploy mode.</p>
<p>When deploying keys using the built-in key management functionality,
<tt>safekeep(1)</tt> needs to be invoked as the user under which it will function
-as a server. By default, that user is <b>safekeep</b>. For extra security,
+as a server. By default, that user is <em>safekeep</em>. For extra security,
you can not login into that account, so you have to invoke <tt>safekeep(1)</tt>
-as <b>root</b>:</p>
-<table border="0" bgcolor="#e8e8e8" width="100%" cellpadding="10"><tr><td>
-<pre> [root@yourbox ~] # safekeep --keys --deploy</pre>
-</td></tr></table>
-<h2><a name="_restoring"></a>RESTORING</h2>
-<p>Since <tt>safekeep(1)</tt> is built around <tt>rdiff-backup(1)</tt>, it doesn’t have any
+as <em>root</em>:</p>
+<div class="listingblock">
+<div class="content">
+<pre><tt> [root@yourbox ~] # safekeep --keys --deploy</tt></pre>
+</div></div>
+</div>
+<h2>RESTORING</h2>
+<div class="sectionbody">
+<p>Since <tt>safekeep(1)</tt> is built around <tt>rdiff-backup(1)</tt>, it doesn't have any
built-in restore capabilities. It simply relies on <tt>rdiff-backup</tt> to perform
this task.</p>
<p>To do so, you just need to know the directory where the data is actually
@@ -378,44 +702,54 @@
<tt>/etc/safekeep/backup.d/mybox.backup</tt>, the data will be stored under
<tt>/var/lib/safekeep/mybox/</tt>. Please refer to <tt>safekeep.backup(5)</tt> for more
information on this matter.</p>
-<p>Once you have determined where the data will be stored (we’ll continue
+<p>Once you have determined where the data will be stored (we'll continue
the example above), all you have to do is run <tt>rdiff-backup</tt>:</p>
-<table border="0" bgcolor="#e8e8e8" width="100%" cellpadding="10"><tr><td>
-<pre> # rdiff-backup -r 1s /var/lib/safekeep/mybox my-restore-dir</pre>
-</td></tr></table>
+<div class="listingblock">
+<div class="content">
+<pre><tt> # rdiff-backup -r 1s /var/lib/safekeep/mybox my-restore-dir</tt></pre>
+</div></div>
<p>You will be able to find more information on the restore procedure in
the <tt>rdiff-backup(1)</tt> man page.</p>
-<h2><a name="_file_selection"></a>FILE SELECTION</h2>
+</div>
+<h2>FILE SELECTION</h2>
+<div class="sectionbody">
<p>It is important to note that the <tt>include</tt>/<tt>exclude</tt> directives that
control file selection are matched in the order they appear in the
configuration file, and the first one that matches dictates whether
the file will be included or excluded. As a result, you have to
add the more specific ones first, or the more generic specifications
will always win. For example:</p>
-<table border="0" bgcolor="#e8e8e8" width="100%" cellpadding="10"><tr><td>
-<pre>...
+<div class="listingblock">
+<div class="content">
+<pre><tt>...
<include path="/home"/>
<exclude path="/home/joe"/>
-...</pre>
-</td></tr></table>
+...</tt></pre>
+</div></div>
<p>will NOT do what you expect, because the <tt>/home</tt> will match before
<tt>/home/joe</tt>, and thus all files under <tt>/home</tt> will be included.
The correct way is to flip the two around</p>
-<table border="0" bgcolor="#e8e8e8" width="100%" cellpadding="10"><tr><td>
-<pre>...
+<div class="listingblock">
+<div class="content">
+<pre><tt>...
<exclude path="/home/joe"/>
<include path="/home"/>
-...</pre>
-</td></tr></table>
+...</tt></pre>
+</div></div>
<p>Please see safekeep.backup(5) for more information on file selection.</p>
-<h2><a name="_see_also"></a>SEE ALSO</h2>
+</div>
+<h2>SEE ALSO</h2>
+<div class="sectionbody">
<p>rdiff-backup(1), safekeep.conf(5), safekeep.backup(5)</p>
-<h2><a name="_author"></a>AUTHOR</h2>
-<p>Written by Dimi Paun <<a href="mailto:di...@la...">di...@la...</a>> and Stelian Pop <<a href="mailto:st...@la...">st...@la...</a>>.</p>
-<p></p>
-<p></p>
-<hr><p><small>
-Last updated 2009-05-21 11:18:36 EDT
-</small></p>
+</div>
+<h2>AUTHOR</h2>
+<div class="sectionbody">
+<p>Written by Dimi Paun <di...@la...> and Stelian Pop <st...@la...>.</p>
+</div>
+<div id="footer">
+<div id="footer-text">
+Last updated 07-Oct-2008 16:17:26 EDT
+</div>
+</div>
</body>
</html>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
