Updating usage text and man page
authorStefan Huber <shuber2@gmx.at>
Mon, 21 May 2012 06:41:50 +0000 (08:41 +0200)
committerStefan Huber <shuber2@gmx.at>
Mon, 21 May 2012 06:41:50 +0000 (08:41 +0200)
shbackup
shbackup.1
shbackup.docbook

index cd2443727f6ddf851e25c12ded9f4cd9f4f85795..f8f8c26f324fe5cb4d830d553a086e8f0668f141 100755 (executable)
--- a/shbackup
+++ b/shbackup
@@ -597,8 +597,8 @@ def printUsage():
     print("  -h, --help                 print this usage text")
     print("  -c, --conf <configfile>    use given configuration file")
     print("                             default: /etc/shbackup.conf")
-    print("  -e, --epoch <epoch>        force to create backup for given epoch:")
-    print("                             year, month, week, day, hour, sporadic")
+    print("  -e, --epoch <epoch>        force to create backup for given epoch, which")
+    print("                             can be 'sporadic' or one of the configured epochs")
     print("  -m, --mode <mode>          override mode: full, diff, or incr")
     print("  -v, --verbose              be more verbose and interact with user")
     print("  --verbosity LEVEL          set verbosity to LEVEL, which can be")
index 28efa25f68c435eb5b3c5ca0b67ab174c1218deb..e2b5fc60b3c3771d3d803a5112e92a67e3a45b41 100644 (file)
@@ -22,11 +22,12 @@ shbackup \- a simple backup solution
 .SH DESCRIPTION
 \fBshbackup\fR is a simple backup solution
 which packs user-defined file sets with tar. Each
-backup belongs to an epoch, which can be year, month,
-week, day, hour or sporadic. The backup can be made
+backup belongs to an epoch, which is 'sporadic' or one
+of the user-defined epochs. Standard epochs are year,
+month, week, day, or hour. The backup can be made
 either full, differential or incremental.
 \fBshbackup\fR takes care for pruning old
-backups. The user defines for each epoch the number of
+backups. The user defines for every epoch the number of
 backups to keep, except for 'sporadic'. Sporadic
 backups need to be removed manually.
 .SH COMMANDS
@@ -50,8 +51,9 @@ Use given configuration file instead of
 .TP 
 \*(T<\fB\-e, \-\-epoch EPOCH\fR\*(T>
 Do not determine epoch automatically, but
-use EPOCH, which can be year, month,
-week, day, hour, sporadic.
+use EPOCH, which can be sporadic or one
+of the epochs defined in the
+configuration file.
 .TP 
 \*(T<\fB\-m, \-\-mode MODE\fR\*(T>
 Instead of configured mode use MODE,
index b3bc0a010a90fc0a1574db2b4fcf5bc2e4d3c38b..36741d98c4fb266bddd24fcc310830d971f9ba9d 100644 (file)
                <para>
                        <command>shbackup</command> is a simple backup solution
                        which packs user-defined file sets with tar. Each
-                       backup belongs to an epoch, which can be year, month,
-                       week, day, hour or sporadic. The backup can be made
+                       backup belongs to an epoch, which is 'sporadic' or one
+                       of the user-defined epochs. Standard epochs are year,
+                       month, week, day, or hour. The backup can be made
                        either full, differential or incremental.
 
                        <command>shbackup</command> takes care for pruning old
-                       backups. The user defines for each epoch the number of
+                       backups. The user defines for every epoch the number of
                        backups to keep, except for 'sporadic'. Sporadic
                        backups need to be removed manually.
+
                </para>
        
        </refsect1>
                        <term><option>-e, --epoch EPOCH</option></term>
                        <listitem>
                                <para>Do not determine epoch automatically, but
-                                       use EPOCH, which can be year, month,
-                                       week, day, hour, sporadic.</para>
+                                       use EPOCH, which can be sporadic or one
+                                       of the epochs defined in the
+                                       configuration file.</para>
                        </listitem>
                </varlistentry>