X-Git-Url: https://arthur.barton.de/gitweb/?a=blobdiff_plain;f=README.md;h=d5c6f5420f445148bdf5e48e897d58d9c2263e7a;hb=86140da3b0194043373d049da47f7d4808776c50;hp=3025b2eac8ff74e240a81914cc35b536ee8024f8;hpb=5ac4a5c047bedd51d9b9fc7400f033546ee776cb;p=backup-script.git

diff --git a/README.md b/README.md
index 3025b2e..d5c6f54 100644
--- a/README.md
+++ b/README.md
@@ -17,7 +17,7 @@ Options:
 - `-p`, `--progress`: Show progress, see rsync(1).
 - `-n`, `--dry-run`: Test run only, don't copy any data.
 
-When no *system* is given, all defined systems are used.
+When no *system* is given, all defined systems are backed up.
 
 ### backup-script-wrapper
 
@@ -38,15 +38,17 @@ Options:
 
 ## Configuration
 
-All defauklt configuration variables are read from `/etc/backup-script.conf`,
+All default configuration variables are read from `/etc/backup-script.conf` or
 from `/etc/backup-script.d/backup-script.conf` (deprecated). The individual
 systems are configured using individual files in `/etc/backup-script.d/`, one
-for each system to backup (files ending in `*.sh` are skipped).
+for each system to backup (files ending in `*.sh` are skipped, as well as
+files named `backup-script.conf`). Please avoid spaces and other "special"
+characters!
 
 Variables in `backup-script.conf` must be prefixed with `default_` to define
 default values for all systems.
 
-All default can be overwritten in individual system configuration files.
+All defaults can be overwritten in individual system configuration files.
 
 For example:
 
@@ -55,7 +57,7 @@ For example:
 - `/etc/backups-script.d/clientXY.example.com`: configuration for host 2
 
 
-## Configuration Variable
+## Configuration Variables
 
 ### system
 
@@ -67,6 +69,13 @@ System host name. Default: file name.
 
 Remote user. Default: `root`.
 
+### [default_]source_root
+
+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_]target
 
 Local backup directory. The backup of each system is stored in a folder named
@@ -106,11 +115,22 @@ Default: 0 (off; use ssh).
 
 Number of generations to keep. Default: 0 (none).
 
-On a *btrfs* target file systems (see `target` variable), this script can
-generate generations using *btrfs snapshots*: the script creates a new snapshot
-named with the timestamp for each generation inside of the system directory
+On a suitable target file systems (see `target` variable), this script can
+generate generations using snapshots: the script creates a new snapshot
+named with the time stamp for each generation inside of the system directory
 inside of the target directory.
 
+Supported file systems are:
+
+ * *btrfs*:
+   All generations are btrfs subvolumes and named after the date and time.
+ * *ZFS*:
+   All generations are ZFS file systems. Latest generation is named `current`,
+   elders are links to the ZFS snapshot directories.
+
+The latest snapshot is always reachable using a symlink named `latest`
+inside the system directory.
+
 ### [default_]job_pre_exec
 
 Optional script to execute before `rsync` starts. Default: none.
@@ -121,3 +141,13 @@ run is skipped!
 ### [default_]job_post_exec
 
 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:
+
+* host -> system
+* source -> source_root
+* pre_exec -> job_pre_exec
+* post_exec -> job_post_exec