Unify and enhance usage information and script descriptions

diff --git a/README.md b/README.md
index ef3ee97214444940694a55124aafd802282213b3..f1c1e6ba66abaf294b5695375a70e01573818995 100644 (file)
--- a/README.md
+++ b/README.md
@@ -32,11 +32,19 @@ Usage: `backup-script-wrapper [<backup-script-options-and-job-names ...>]`
 
 Show information about backups.
 
-Usage: `backup-status [-q] [<job> [<job> [...]]]`
+Usage:
+
+- `backup-status [--errors|--latest] [--quick] [<job> [<job> [...]]]`
+- `backup-status --running`
 
 Options:
 
-- `-q`: *quick mode*, don't calculate backup sizes.
+- `-e`, `--errors`: only show current backups with errors (implies `--latest`).
+- `-l`, `--latest`: only show latest backup generations.
+- `-q`, `--quick`: *quick mode*, don't calculate backup sizes.
+- `-r`, `--running`: check if an `backup-script` task is currently running.
+
+When no *job* is given, all defined jobs are listed.
 
 ### backup-audit
 
@@ -46,8 +54,11 @@ Usage: `backup-audit [-q] [-v] [<job> [<job> [...]]]`
 
 Options:
 
-- `-q`: *quiet mode*, don't show jobs without "relevant" changes.
-- `-v`: *verbose mode*, show all checks that are run.
+- `-d`, `--dirs`: compare two backup directories (not jobs).
+- `-q`, `--quiet`: *quite mode*, only list jobs with changes or errors.
+- `-v`, `--verbose`: *verbose mode*, show all checks that are run.
+
+When no *job* is given, all defined jobs are checked.
 
 
 ## Configuration

diff --git a/bin/backup-audit b/bin/backup-audit
index 6785adc5e9089467cf3c4fc132a091de15b1c1b7..4f3358674f0ca5ca2dc7771909c366a3df32da8d 100755 (executable)
--- a/bin/backup-audit
+++ b/bin/backup-audit
@@ -42,9 +42,15 @@ for conf in \
 done
 
 Usage() {
-       echo "Usage: $NAME [-q|--quiet] [-v|--verbose] [<system> [<system> [...]]]"
+       echo "Usage: $NAME [-q|--quiet] [-v|--verbose] [<job> [<job> [...]]]"
        echo "       $NAME <-d|--dirs> <dir1> <dir2>"
        echo
+       echo "  -d, --dirs      Compare two backup directories (not jobs)."
+       echo "  -q, --quiet     Quite mode, only list jobs with changes or errors."
+       echo "  -v, --verbose   Verbose mode, show all checks that are run."
+       echo
+       echo "When no <job> is given, all defined jobs are checked."
+       echo
        exit 2
 }
 

diff --git a/bin/backup-script b/bin/backup-script
index 70173f05e5d6b6898d1a307752c7c3e148f8af4b..9530410dee0e8d85b7e7b18ad9cefdba4d6cc00f 100755 (executable)
--- a/bin/backup-script
+++ b/bin/backup-script
@@ -54,14 +54,14 @@ default_job_post_exec=""
 default_tags=""
 
 Usage() {
-       echo "Usage: $NAME [<options>] [<system> [<system> [...]]]"
+       echo "Usage: $NAME [<options>] [<job> [<job> [...]]]"
        echo
        echo "  -n, --dry-run       Test run only, don't copy any data."
        echo "  -p, --progress      Show progress, see rsync(1)."
        echo "  -t TAG, --tag TAG   Only run jobs with tag TAG."
        echo "  -x, --no-exec       Don't run global pre-/post-exec commands."
        echo
-       echo "When no <system> is given, all defined systems are used."
+       echo "When no <job> is given, all defined systems are used."
        echo
        # shellcheck disable=SC2086
        echo -e $config_info

diff --git a/bin/backup-status b/bin/backup-status
index a871c96c2ef18e3ff7b1c3516fad9cf153b8ebe6..1ed1b71558c49f4f6cf24b9319768ec50f55df9e 100755 (executable)
--- a/bin/backup-status
+++ b/bin/backup-status
@@ -43,13 +43,15 @@ for conf in \
 done
 
 Usage() {
-       echo "Usage: $NAME [--errors|--latest] [--quick] [<system> [<system> [...]]]"
+       echo "Usage: $NAME [--errors|--latest] [--quick] [<job> [<job> [...]]]"
        echo "       $NAME --running"
        echo
-       echo "  --errors, -e    Only show current backups with errors (implies \"--latest\")."
-       echo "  --latest, -l    Only show latest backup generations."
-       echo "  --quick, -q     Don't calculate backup sizes."
-       echo "  --running, -r   Check if an \"backup-script\" task is currently running."
+       echo "  -e, --errors    Only show current backups with errors (implies \"--latest\")."
+       echo "  -l, --latest    Only show latest backup generations."
+       echo "  -q, --quick     Don't calculate backup sizes."
+       echo "  -r, --running   Check if an \"backup-script\" task is currently running."
+       echo
+       echo "When no <job> is given, all defined jobs are listed."
        echo
        exit 2
 }