Fix and mark several notices & warnings of shellcheck(1)

[backup-script.git] / README.md

diff --git a/README.md b/README.md
index 893344cfbf5c3d43dc3525a4e33a6fd4e6c87278..6aa60264aadb33a77796ebdbf8781f93ff825ab8 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
 
@@ -65,6 +76,19 @@ For example:
 - `/etc/backups-script.d/clientXY.example.com`: configuration for host 2
 
 
+### Global Settings
+
+The following global configuration options exist:
+
+- `setup_exec`: Script to run _before_ creating the lock file etc.
+- `pre_exec`: Pre-execution script, run before all jobs.
+- `post_exec`: Post-execution script, run after all jobs.
+
+In Addition, all job configuration options (see below) that have a "default_XXX"
+variant can be used and define default values for all jobs that don't overwrite
+them individually.
+
+
 ## Configuration Variables
 
 ### system
@@ -199,8 +223,9 @@ Optional script to execute after `rsync` exited. Default: none.
 
 ### Compatibility Variables
 
-The following configurations variables used by the backup-pull(1) script in job
-definition files are automatically mapped to the new backup-script variables:
+The following job configurations variables used by the outdated backup-pull(1)
+script in job definition files are automatically mapped to the new backup-script
+variables:
 
 * host -> system
 * source -> source_root