Write more information to "stamp file"

[backup-script.git] / README.md

diff --git a/README.md b/README.md
index 23bfbfe8bdeea3358c1f5fd7c91882fe50014ed6..e0595ce4739a330289c029e70e907c509f08849f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -38,17 +38,24 @@ Options:
 
 ## Configuration
 
-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, as well as
-files named `backup-script.conf`). Please avoid spaces and other "special"
-characters!
+All default configuration variables are read from the first file found of this
+list: `/usr/local/etc/backup-scrupt.conf`, `/etc/backup-script.conf` or
+from `/etc/backup-script.d/backup-script.conf` (deprecated).
+
+All systems which should be backed-up are configured using  individual files
+in the configuration directory, which is `/usr/local/etc/backup-script.d/` or
+`/etc/backup-script.d/` by default (whichever is found first), and can be
+specified using the `conf_d` variable in the main configuration file.
+
+The must be one file 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! The filename is used as hostname for the system by
+default, but this can be overwritten using the `system` configuration variable.
 
 Variables in `backup-script.conf` must be prefixed with `default_` to define
 default values for all systems.
 
-All defaults can be overwritten in individual system configuration files.
+All defaults can be overwritten in the individual system configuration files.
 
 For example:
 
@@ -65,6 +72,22 @@ System host name. Default: file name.
 
 *Note:* There is no `default_system` variable!
 
+### [default_]backup_type
+
+Backup type to use. Default: `rsync`.
+
+- `rsync`: system backup using rsync(1).
+  Use `source_root` to specify the root directory to save.
+
+- `scp`: file backup using scp(1).
+  Use `files` to specify the files to copy.
+
+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
+the list of files to backup, old files will still be kept, because they were
+already saved in an older generation (but no longer updated).
+
 ### [default_]user
 
 Remote user. Default: `root`.
@@ -76,6 +99,11 @@ 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
+
+Space separated list of files to copy when using the "scp" `backup_type`.
+Default: "running-config".
+
 ### [default_]target
 
 Local backup directory. The backup of each system is stored in a folder named
@@ -96,9 +124,16 @@ Additional parameters for `rsync`. Default: none.
 
 Additional (exclude) parameters for `rsync`. Default: none.
 
+*Deprecated! Use "exclude_dirs_add" instead!*
+
+### [default_]exclude_dirs_add
+
+Additional directory path names to exclude from the backup. Use full path names
+separated by spaces. Default: none.
+
 ### [default_]compress
 
-Enable (1) or disable (0) compression. Default: 1 (on).
+Enable (1) or disable (0) rsync transfer compression. Default: 1 (on).
 
 ### [default_]ping