Implement new "backup_type": "disabled"

[backup-script.git] / README.md

diff --git a/README.md b/README.md
index e0595ce4739a330289c029e70e907c509f08849f..893344cfbf5c3d43dc3525a4e33a6fd4e6c87278 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
 # Backup Script
 
 A script for cloning systems using rsync.  
-Copyright (c)2008-2015 Alexander Barton <alex@barton.de>
+Copyright (c)2008-2016 Alexander Barton <alex@barton.de>
 
 
 ## Usage
@@ -14,8 +14,9 @@ Usage: `backup-script [<options>] [<system> [<system> [...]]]`
 
 Options:
 
-- `-p`, `--progress`: Show progress, see rsync(1).
 - `-n`, `--dry-run`: Test run only, don't copy any data.
+- `-p`, `--progress`: Show progress, see rsync(1).
+- `-t TAG`, `--tag TAG`: Only run jobs with tag TAG (see "tags" variable below).
 
 When no *system* is given, all defined systems are backed up.
 
@@ -82,6 +83,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
@@ -99,7 +103,7 @@ Remote *root* directory, must end with a slash ("/") character! Default: "/".
 When saving the whole (remote) system ("/"), default excludes are set up
 automatically, which exclude standard system directories like /sys and /proc.
 
-### [default_]file
+### [default_]files
 
 Space separated list of files to copy when using the "scp" `backup_type`.
 Default: "running-config".
@@ -166,6 +170,22 @@ Supported file systems are:
 The latest snapshot is always reachable using a symlink named `latest`
 inside the system directory.
 
+### [default_]io_timeout
+
+The maximum I/O timeout in seconds. If no data is transferred for the specified
+time then rsync will abort. Default: 1800 (30 minutes).
+
+### [default_]tags
+
+Comma-separated list of tags of this job. All uppercase tag names are reserved
+and become set automatically on runtime:
+
+- NONE: Jobs with no other tags at all.
+- ALL: Matches all jobs, regardless of their tags (see `-t`/`--tags` option).
+- LOCAL: All jobs running on "localhost".
+
+Default: NONE.
+
 ### [default_]job_pre_exec
 
 Optional script to execute before `rsync` starts. Default: none.