Add "backup-audit" script

[backup-script.git] / README.md

diff --git a/README.md b/README.md
index c6602d818e80eec8bc4549b88a1fccefaed1b018..db48806cbbfc2979a5882c97b1253b5f2043f7e0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -24,7 +24,7 @@ When no *system* is given, all defined systems are backed up.
 
 Backup all systems and mail the report to "root".
 
-Usage: `backup-script-wrapper`
+Usage: `backup-script-wrapper [<backup-script-options-and-systems ...>]`
 
 ### backup-status
 
@@ -36,6 +36,17 @@ Options:
 
 - `-q`: *quick mode*, don't calculate backup sizes.
 
+### backup-audit
+
+Show "relevant" differences in system configuration between backup generations.
+
+Usage: `backup-audit [-q] [-v] [<system> [<system> [...]]]`
+
+Options:
+
+- `-q`: *quiet mode*, don't show systems without "relevant" changes.
+- `-v`: *verbose mode*, show all checks that are run.
+
 
 ## Configuration
 
@@ -83,6 +94,9 @@ Backup type to use. Default: `rsync`.
 - `scp`: file backup using scp(1).
   Use `files` to specify the files to copy.
 
+- `disabled`: job is disabled and will not be run. This becomes accounted as
+  "success" in the summary and exit code of the backup script.
+
 Please note that neither `ssh_args_add`, `rsync_args_add`, `compress`, nor any
 "exclude" parameters are supported when using the "scp" backup type! And There
 "scp" backup type never _deletes_ files from the backup store; so if you reduce