Menu
▾
▴
SF.net SVN: safekeep: [283] website/trunk/WebContent/safekeep-man-1.shtml
|
From: <st...@us...> - 2007-01-12 11:58:58
|
Revision: 283
http://safekeep.svn.sourceforge.net/safekeep/?rev=283&view=rev
Author: stelian
Date: 2007-01-12 03:58:53 -0800 (Fri, 12 Jan 2007)
Log Message:
-----------
Add safekeep(1) man page.
Added Paths:
-----------
website/trunk/WebContent/safekeep-man-1.shtml
Added: website/trunk/WebContent/safekeep-man-1.shtml
===================================================================
--- website/trunk/WebContent/safekeep-man-1.shtml (rev 0)
+++ website/trunk/WebContent/safekeep-man-1.shtml 2007-01-12 11:58:53 UTC (rev 283)
@@ -0,0 +1,509 @@
+<!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 7.1.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.2em;
+}
+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 > 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;
+}
+td.hlist1 {
+ vertical-align: top;
+ font-style: italic;
+ padding-right: 0.8em;
+}
+td.hlist2 {
+ vertical-align: top;
+}
+
+@media print {
+ div#footer-badges { display: none; }
+}
+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;
+}
+</style>
+<title>safekeep(1)</title>
+</head>
+<body>
+<div id="header">
+<h1>
+safekeep(1) Manual Page
+</h1>
+<h2>NAME</h2>
+<div class="sectionbody">
+<p>safekeep -
+ Client/server backup script
+</p>
+</div>
+</div>
+<h2>SYNOPSIS</h2>
+<div class="sectionbody">
+<p><em>safekeep</em> [-s] [-q] [-v] [-C file] [-e <email>] [-m <smtp>]</p>
+<p><em>safekeep</em> -c</p>
+<p><em>safekeep</em> -k [-q] [-v] [--status|--print|--deploy] <clientid>*</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 or SSH key management 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
+system previously set up using <tt>safekeep -k --deploy</tt>), and launches
+<tt>safekeep --client</tt> onto the client host. The client does the real backup
+and sends the data over SSH to the SafeKeep server which stores it in
+the specified location.</p>
+<p>In client mode, SafeKeep does a few setup steps, depending on the
+client configuration (database dump, LVM device snapshot), then backups
+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>
+<p>The SSH key management mode is a helper mode for deploying or verifying
+the setup of the SSH authentification keys.</p>
+<p>Each mode accepts a few options as described below.</p>
+</div>
+<h2>OPTIONS</h2>
+<div class="sectionbody">
+<dl>
+<dt>
+-s, --server
+</dt>
+<dd>
+<p>
+ Selects the server mode (default)
+</p>
+</dd>
+<dt>
+-c, --client
+</dt>
+<dd>
+<p>
+ Selects the client mode. This should never be invoked manually, the
+ clients are started automatically by the server on the client machines
+ using SSH.
+</p>
+</dd>
+<dt>
+-k, --keys
+</dt>
+<dd>
+<p>
+ Selects the SSH key management mode
+</p>
+</dd>
+<dt>
+-h, --help
+</dt>
+<dd>
+<p>
+ Selects the help mode, in which safekeep prints out the
+ online help and exits.
+</p>
+</dd>
+<dt>
+-V, --version
+</dt>
+<dd>
+<p>
+ Selects the version mode, in which safekeep prints out the
+ version number and exits.
+</p>
+</dd>
+<dt>
+-q, --quiet
+</dt>
+<dd>
+<p>
+ Decreases the verbosity level. Can be specified more than
+ once.
+</p>
+</dd>
+<dt>
+-v, --verbose
+</dt>
+<dd>
+<p>
+ Increases the verbosity level. Can be specified more than
+ once.
+</p>
+</dd>
+<dt>
+-C, --cfg=FILE|DIR
+</dt>
+<dd>
+<p>
+ Specifies the configuration file location.
+ This can be a single file (for a single client configuration)
+ or a directory containing several configuration files (one per
+ backup client)
+</p>
+</dd>
+<dt>
+-e, --email=EMAIL
+</dt>
+<dd>
+<p>
+ In addition to writing the session logs
+ on the standard output, this parameter let the user specify
+ the mail address where the logs are to be send. Can be specified
+ more than once to send reports to multiple addresses.
+</p>
+</dd>
+<dt>
+-m, --smtp=SMTP
+</dt>
+<dd>
+<p>
+ Specifies the SMTP server used for sending
+ mails when <tt>-e</tt> is used. Defaults to <tt>localhost</tt>.
+</p>
+</dd>
+<dt>
+--status
+</dt>
+<dd>
+<p>
+ (key mode only) Display the key status for the clients.
+</p>
+</dd>
+<dt>
+--print
+</dt>
+<dd>
+<p>
+ (key mode only) Display the authorization keys for the clients.
+</p>
+</dd>
+<dt>
+--deploy
+</dt>
+<dd>
+<p>
+ (key mode only) Deploy the authorization keys on the clients.
+</p>
+</dd>
+</dl>
+</div>
+<h2>Configuration file</h2>
+<div class="sectionbody">
+<p>Each backup client is described by a configuration file in XML format of the
+following form:</p>
+<div class="listingblock">
+<div class="content">
+<pre><tt><!-- the client backup id -->
+<backup id="my.host.com primary backup">
+
+ <!-- the client backup host, the user under which the servers will connect,
+ the SSH keys used for launching "safekeep -c" and "rdiff-backup" -->
+ <host
+ name="localhost" user="guest"
+ key-ctrl="/home/dimi/.ssh/backup_id_dsa"
+ key-data="/home/dimi/.ssh/backup2_id_dsa"
+ />
+
+ <!-- location where the backuped data will be stored on the server
+ and for how long (s=sec, m=min, h=hours, D=days, W=weeks, M=months, or Y=years) -->
+ <repo
+ path="./tmp"
+ retention="10D"
+ />
+
+ <!-- settings for database dump and for volume snapshot -->
+ <setup>
+
+ <!-- database type ("postgres" or "mysql"), user with backup rights,
+ location of the dump file on the client host, and flag to remove
+ or not the dump file after the backup is done -->
+ <dump
+ type="postgres"
+ db="dbname"
+ user="foobar"
+ file="/var/backup/dumps/mydata"
+ cleanup="true"
+ />
+
+ <!-- what volume is to be snapshoted (device location) and the size
+ of the snapshot (unallocated space must exist in the volume group) -->
+ <snapshot
+ device="/path/to/volume"
+ size="500M"
+ />
+
+ </setup>
+
+ <!-- data to be backuped -->
+ <data>
+ <!-- each type of tag can be present more than one time -->
+ <!-- if a database dump was created, it must be added in this section -->
+ <include path="/home"/>
+ <exclude path="/home/guest"/>
+
+ <include glob="**/important/"/>
+ <exclude glob="/home/*/tmp"/>
+
+ <include regexp=".*\.ogg"/>
+ <exclude regexp=".*\.mp3"/>
+ </data>
+</backup></tt></pre>
+</div></div>
+</div>
+<h2>See Also</h2>
+<div class="sectionbody">
+<p>rdiff-backup(1)</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 12-Jan-2007 12:57:50 CEST
+</div>
+</div>
+</body>
+</html>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
