Implement job tagging

[backup-script.git] / README.md

diff --git a/README.md b/README.md
index 8fcdf38db41546c378687d3db4f1c69a5ab004a9..de10ad2ee87b7e2b3af35d0e4da3652232b1ffc9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -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.
 
@@ -166,6 +167,17 @@ Supported file systems are:
 The latest snapshot is always reachable using a symlink named `latest`
 inside the system directory.
 
+### [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.