[cedar-backup-svn] SF.net SVN: cedar-backup: [814] cedar-backup2/trunk
Brought to you by:
pronovic
|
From: <pro...@us...> - 2007-12-16 17:50:30
|
Revision: 814
http://cedar-backup.svn.sourceforge.net/cedar-backup/?rev=814&view=rev
Author: pronovic
Date: 2007-12-16 09:50:28 -0800 (Sun, 16 Dec 2007)
Log Message:
-----------
Document new --managed and --managed-only command-line options
Modified Paths:
--------------
cedar-backup2/trunk/CedarBackup2/cli.py
cedar-backup2/trunk/doc/cback.1
cedar-backup2/trunk/manual/src/commandline.xml
Modified: cedar-backup2/trunk/CedarBackup2/cli.py
===================================================================
--- cedar-backup2/trunk/CedarBackup2/cli.py 2007-12-16 16:55:27 UTC (rev 813)
+++ cedar-backup2/trunk/CedarBackup2/cli.py 2007-12-16 17:50:28 UTC (rev 814)
@@ -696,8 +696,8 @@
fd.write(" -q, --quiet Run quietly (display no output to the screen)\n")
fd.write(" -c, --config Path to config file (default: %s)\n" % DEFAULT_CONFIG)
fd.write(" -f, --full Perform a full backup, regardless of configuration\n")
- fd.write(" -M, --managed Include managed peers when executing actions\n")
- fd.write(" -N, --managed-only Include ONLY managed peers when executing actions\n")
+ fd.write(" -M, --managed Include managed clients when executing actions\n")
+ fd.write(" -N, --managed-only Include ONLY managed clients when executing actions\n")
fd.write(" -l, --logfile Path to logfile (default: %s)\n" % DEFAULT_LOGFILE)
fd.write(" -o, --owner Logfile ownership, user:group (default: %s:%s)\n" % (DEFAULT_OWNERSHIP[0], DEFAULT_OWNERSHIP[1]))
fd.write(" -m, --mode Octal logfile permissions mode (default: %o)\n" % DEFAULT_MODE)
Modified: cedar-backup2/trunk/doc/cback.1
===================================================================
--- cedar-backup2/trunk/doc/cback.1 2007-12-16 16:55:27 UTC (rev 813)
+++ cedar-backup2/trunk/doc/cback.1 2007-12-16 17:50:28 UTC (rev 814)
@@ -15,9 +15,9 @@
.\" #
.\" # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
.\"
-.TH cback "1" "July 2005" "Cedar Backup" "Kenneth J. Pronovici"
+.TH cback "1" "December 2007" "Cedar Backup" "Kenneth J. Pronovici"
.SH NAME
-cback \- Local and remote backups to CD-R/CD-RW media under Linux
+cback \- Local and remote backups to CD-R/CD-RW media
.SH SYNOPSIS
.B cback
[\fIswitches\fR]
@@ -47,6 +47,12 @@
actions, but only the master executes the stage and store actions. The
configuration file \fI/etc/cback.conf\fR controls the actions taken during
collect, stage, store and purge actions.
+.PP
+Cedar Backup also supports the concept of \fImanaged clients\fR. Managed
+clients have their entire backup process managed by the master via a remote
+shell. The same actions are run as part of the backup process, but the master
+controls when the actions are executed on the clients rather than the clients
+controlling it for themselves.
.SH SWITCHES
.TP
\fB\-h\fR, \fB\-\-help\fR
@@ -73,6 +79,16 @@
ignored and rewritten; for the store action, this means that a new disc will be
started.
.TP
+\fB\-M\fR, \fB\-\-managed\fR
+Include managed clients when executing actions. If the action being executed
+is listed as a managed action for a managed client, execute the action on that
+client after executing the action locally.
+.TP
+\fB\-N\fR, \fB\-\-managed-only\fR
+Include only managed clients when executing actions. If the action being
+executed is listed as a managed action for a managed client, execute the action
+on that client -- but do not execute the action locally.
+.TP
\fB\-l\fR, \fB\-\-logfile\fR
Specify the path to an alternate logfile. The default logfile file is
/var/log/cback.log.
@@ -164,10 +180,9 @@
Error executing specified backup actions.
.SH NOTES
.PP
-The script is designed to run as root, since otherwise it's difficult to
-back up system directories or write the CD or DVD device. However, pains
-are taken to use a backup user's effective user id (specified in
-configuration) when appropriate.
+The script is designed to run as root, since otherwise it's difficult to back
+up system directories or write the CD or DVD device. However, pains are taken
+to switch to a backup user (specified in configuration) when appropriate.
.PP
To use the script, you must specify at least one action to take. More than one
of the "collect", "stage", "store" or "purge" actions may be specified, in any
@@ -184,12 +199,13 @@
.PP
Note that there is no facility for restoring backups. It is assumed that the
user can deal with copying tarfiles off disc and using them to restore missing
-files as needed.
+files as needed. The user manual provides detailed intructions in Appendix C.
.PP
Finally, you should be aware that backups to CD or DVD can probably be read
by any user which has permissions to mount the CD or DVD drive. If you
intend to leave the backup disc in the drive at all times, you may want to
-consider this when setting up device permissions on your machine.
+consider this when setting up device permissions on your machine. You might
+also want to investigate the encrypt extension.
.SH FILES
.TP
\fI/etc/cback.conf\fR - Default configuration file
Modified: cedar-backup2/trunk/manual/src/commandline.xml
===================================================================
--- cedar-backup2/trunk/manual/src/commandline.xml 2007-12-16 16:55:27 UTC (rev 813)
+++ cedar-backup2/trunk/manual/src/commandline.xml 2007-12-16 17:50:28 UTC (rev 814)
@@ -95,29 +95,31 @@
The following switches are accepted:
- -h, --help Display this usage/help listing
- -V, --version Display version information
- -b, --verbose Print verbose output as well as logging to disk
- -q, --quiet Run quietly (display no output to the screen)
- -c, --config Path to config file (default: /etc/cback.conf)
- -f, --full Perform a full backup, regardless of configuration
- -l, --logfile Path to logfile (default: /var/log/cback.log)
- -o, --owner Logfile ownership, user:group (default: root:adm)
- -m, --mode Octal logfile permissions mode (default: 640)
- -O, --output Record some sub-command (i.e. cdrecord) output to the log
- -d, --debug Write debugging information to the log (implies --output)
- -s, --stack Dump a Python stack trace instead of swallowing exceptions
+ -h, --help Display this usage/help listing
+ -V, --version Display version information
+ -b, --verbose Print verbose output as well as logging to disk
+ -q, --quiet Run quietly (display no output to the screen)
+ -c, --config Path to config file (default: /etc/cback.conf)
+ -f, --full Perform a full backup, regardless of configuration
+ -M, --managed Include managed clients when executing actions
+ -N, --managed-only Include ONLY managed clients when executing actions
+ -l, --logfile Path to logfile (default: /var/log/cback.log)
+ -o, --owner Logfile ownership, user:group (default: root:adm)
+ -m, --mode Octal logfile permissions mode (default: 640)
+ -O, --output Record some sub-command (i.e. cdrecord) output to the log
+ -d, --debug Write debugging information to the log (implies --output)
+ -s, --stack Dump a Python stack trace instead of swallowing exceptions
The following actions may be specified:
- all Take all normal actions (collect, stage, store, purge)
- collect Take the collect action
- stage Take the stage action
- store Take the store action
- purge Take the purge action
- rebuild Rebuild "this week's" disc if possible
- validate Validate configuration only
- initialize Initialize media for use with Cedar Backup
+ all Take all normal actions (collect, stage, store, purge)
+ collect Take the collect action
+ stage Take the stage action
+ store Take the store action
+ purge Take the purge action
+ rebuild Rebuild "this week's" disc if possible
+ validate Validate configuration only
+ initialize Initialize media for use with Cedar Backup
You may also specify extended actions that have been defined in
configuration.
@@ -208,6 +210,31 @@
</varlistentry>
<varlistentry>
+ <term><option>-M</option>, <option>--managed</option></term>
+ <listitem>
+ <para>
+ Include managed clients when executing actions. If the
+ action being executed is listed as a managed action for a
+ managed client, execute the action on that client after
+ executing the action locally.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>-N</option>, <option>--managed-only</option></term>
+ <listitem>
+ <para>
+ Include <emphasis>only</emphasis> managed clients when
+ executing actions. If the action being executed is listed
+ as a managed action for a managed client, execute the action
+ on that client — but <emphasis>do not</emphasis>
+ execute the action locally.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><option>-l</option>, <option>--logfile</option></term>
<listitem>
<para>
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|