Menu
▾
▴
SF.net SVN: safekeep:[803] website/trunk/WebContent
|
From: <fcr...@us...> - 2012-02-11 10:14:37
|
Revision: 803
http://safekeep.svn.sourceforge.net/safekeep/?rev=803&view=rev
Author: fcrawford
Date: 2012-02-11 10:14:31 +0000 (Sat, 11 Feb 2012)
Log Message:
-----------
Update man pages on website to latest as of Sat Feb 11 21:14:15 EST 2012
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 2012-02-11 08:12:14 UTC (rev 802)
+++ website/trunk/WebContent/safekeep.backup.html 2012-02-11 10:14:31 UTC (rev 803)
@@ -28,50 +28,28 @@
<table border="0" bgcolor="#e8e8e8" width="100%" cellpadding="10"><tr><td>
<pre><backup id="my_workstation">
- <!-- 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" nice="10"
- key-ctrl="/home/jdoe/.ssh/backup_id_dsa"
- key-data="/home/jdoe/.ssh/backup2_id_dsa"
- />
+ <!-- the client backup host, the user and keys for access -->
+ <host name="myhost" user="root" nice="10"
+ key-ctrl="/home/jdoe/.ssh/backup_id_dsa"
+ key-data="/home/jdoe/.ssh/backup2_id_dsa" />
- <!-- you can customize the bandwidth limit on a client basis,
- for example to 50KB/s download/upload -->
+ <!-- rate limit bandwidth (kB/s) on a client basis -->
<bandwidth overall="80" download="50" upload="50" />
- <!-- location where the backups will be stored on the server
- and for how long (D=days, W=weeks, M=months, or Y=years) -->
- <repo path="./data" retention="10D"/>
+ <!-- where to stored the data on the server, and for now long -->
+ <repo path="./data" retention="10D" />
<!-- settings for database dump and for volume snapshot -->
<setup>
- <!-- database type ("postgres" or "mysql"), and database name,
- DB 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.
- Databases can be dumped individually using a dump clause for each database. -->
- <dump
- type="postgres"
- db="my_db"
- dbuser="foobar"
- options="--schema=public"
- file="/var/backup/dumps/mydata"
- cleanup="true"
- />
+ <!-- databases can be dumbed before the backup -->
+ <dump type="postgres" db="my_db" dbuser="foobar" options="--schema=public"
+ file="/var/backup/dumps/mydata" cleanup="true" />
- <!-- what volume is to be snapshot (device location) and the size
- of the snapshot (free space must exist in the volume group) -->
- <snapshot
- device="/path/to/volume"
- size="500M"
- />
+ <!-- what volume is to be snapshot, and the size of the snapshot -->
+ <snapshot device="/path/to/volume" size="500M" />
- <!-- location of a script to be executed on the client at different
- stages of the run. It is called with three arguments:
- the step of the backup, backup id and the backup root directory -->
- <script
- path="/path/to/script"
- />
+ <!-- location of a script to be executed at different stages of the run -->
+ <script path="server:/path/to/script" />
</setup>
@@ -127,6 +105,17 @@
</p>
</dd>
<dt>
+/backup/host/@port
+</dt>
+<dd>
+<p>
+ The network port to use when connecting to the client. This must
+ be a number and is passed to the network connection agent, usually
+ SSH.
+ Optional, default to not passing any port specification.
+</p>
+</dd>
+<dt>
/backup/host/@user
</dt>
<dd>
@@ -385,14 +374,26 @@
</p>
</dd>
<dt>
-/backup/setup/script/@path
+/backup/setup/snapshot/@tag
</dt>
<dd>
<p>
- Execute the script specified path on the client at certain steps
- of the backup process.
- This script is executed with three arguments:
+ A list of tags to be added to the snapshot, with the <tt>--addtag</tt>
+ argument to <tt>lvcreate</tt>. The @tag entry consists of a <tt>,</tt>
+ separated list of tags.
+ An <tt>@</tt> is automatically added to each generated tag.
+ Optional for a <tt><snapshot></tt> element.
</p>
+</dd>
+<dt>
+/backup/setup/script/@location
+</dt>
+<dd>
+<p>
+ Execute the script specified path on the client at certain steps
+ of the backup process.
+ This script is executed with three arguments:
+</p>
<ul>
<li>
<p>
@@ -407,8 +408,14 @@
<li>
<p>
Backup root directory (valid after creation of a snapshot)
- See the <tt>CLIENT SCRIPT</tt> section for more information.
- Mandatory for a <tt><script></tt> element.
+ The <tt>location</tt> optionally consists of an optional <tt>host</tt> and
+ a mandatory <tt>path</tt>, separated by a ":", where the host part is
+ either "client" or "server". If no host part is specified then
+ it is first looked for on the client, and if not found, then is
+ looked for on the server. If it not found on either, then a
+ warning is raised.
+ See the <tt>CLIENT SCRIPT</tt> section for more information.
+ Mandatory for a <tt><script></tt> element.
</p>
</li>
</ul>
@@ -537,6 +544,14 @@
<h2><a name="_client_script"></a>CLIENT SCRIPT</h2>
<p><tt>safekeep(1)</tt> support the optional execution of a script or program
on the client system at different steps during execution of the backup.</p>
+<p>The script may be located on either the server or the client. If it is
+located on the server, then the file is copied to the client into a
+temporary directory before execution. Note that this directory is located
+where ever the system normally creates temporary files, and it is possible
+that the execution of scripts are disallowed. In that case it is recommended
+that a client based script is used. In addition, the script is copied from
+the server on a line by line basis, and so it is not suitable to pass binary
+files.</p>
<p>Note: specification of a script which does not exist is not considered an
error, and is treated as the same as not specifying a script. However, if
the specified path does match a file or directory, the security tests listed
@@ -571,10 +586,12 @@
<pre>/etc/safekeep/backup.d/</pre>
<h2><a name="_see_also"></a>SEE ALSO</h2>
<p>safekeep(1), safekeep.conf(5), rdiff-backup(1), lvcreate(8)</p>
+<h2><a name="_author"></a>AUTHOR</h2>
+<p>This man page was written by Dimi Paun <<a href="mailto:di...@la...">di...@la...</a>>.</p>
<p></p>
<p></p>
<hr><p><small>
-Last updated 2011-11-05 20:40:04 EST
+Last updated 2012-01-20 23:22:08 EST
</small></p>
</body>
</html>
Modified: website/trunk/WebContent/safekeep.conf.html
===================================================================
--- website/trunk/WebContent/safekeep.conf.html 2012-02-11 08:12:14 UTC (rev 802)
+++ website/trunk/WebContent/safekeep.conf.html 2012-02-11 10:14:31 UTC (rev 803)
@@ -178,10 +178,12 @@
<pre>/etc/safekeep/safekeep.conf</pre>
<h2><a name="_see_also"></a>SEE ALSO</h2>
<p>safekeep(1), safekeep.backup(5), rdiff-backup(1), trickle(1), lvcreate(8)</p>
+<h2><a name="_author"></a>AUTHOR</h2>
+<p>This man page was written by Dimi Paun <<a href="mailto:di...@la...">di...@la...</a>>.</p>
<p></p>
<p></p>
<hr><p><small>
-Last updated 2011-11-05 20:40:04 EST
+Last updated 2011-12-24 17:01:56 EST
</small></p>
</body>
</html>
Modified: website/trunk/WebContent/safekeep.html
===================================================================
--- website/trunk/WebContent/safekeep.html 2012-02-11 08:12:14 UTC (rev 802)
+++ website/trunk/WebContent/safekeep.html 2012-02-11 10:14:31 UTC (rev 803)
@@ -415,7 +415,7 @@
<p></p>
<p></p>
<hr><p><small>
-Last updated 2011-11-05 20:40:04 EST
+Last updated 2011-12-24 17:01:56 EST
</small></p>
</body>
</html>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|
