X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=README.md;h=c6602d818e80eec8bc4549b88a1fccefaed1b018;hb=51e8c14f812714bb1bdad1d119be56ca79cb2076;hp=2a1fca1676bc4581abe6583979c7f25efdbb5cb0;hpb=4c781b16f46a4d51eba2ffedb9d71d5618cac6c5;p=backup-script.git diff --git a/README.md b/README.md index 2a1fca1..c6602d8 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,9 @@ Usage: `backup-script [] [ [ [...]]]` 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. @@ -99,7 +100,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 +167,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.