From 52109733736bd4bc080330f10f33c47cf7a81c4d Mon Sep 17 00:00:00 2001 From: Stefan Huber Date: Mon, 21 May 2012 08:41:50 +0200 Subject: [PATCH] Updating usage text and man page --- shbackup | 4 ++-- shbackup.1 | 12 +++++++----- shbackup.docbook | 13 ++++++++----- 3 files changed, 17 insertions(+), 12 deletions(-) diff --git a/shbackup b/shbackup index cd24437..f8f8c26 100755 --- a/shbackup +++ b/shbackup @@ -597,8 +597,8 @@ def printUsage(): print(" -h, --help print this usage text") print(" -c, --conf use given configuration file") print(" default: /etc/shbackup.conf") - print(" -e, --epoch force to create backup for given epoch:") - print(" year, month, week, day, hour, sporadic") + print(" -e, --epoch force to create backup for given epoch, which") + print(" can be 'sporadic' or one of the configured epochs") print(" -m, --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") diff --git a/shbackup.1 b/shbackup.1 index 28efa25..e2b5fc6 100644 --- a/shbackup.1 +++ b/shbackup.1 @@ -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, diff --git a/shbackup.docbook b/shbackup.docbook index b3bc0a0..36741d9 100644 --- a/shbackup.docbook +++ b/shbackup.docbook @@ -38,14 +38,16 @@ shbackup 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. shbackup 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. + @@ -104,8 +106,9 @@ 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. -- 2.39.5