]> arthur.barton.de Git - backup-script.git/blobdiff - README.md
backup-status: Reformat usage information
[backup-script.git] / README.md
index 23bfbfe8bdeea3358c1f5fd7c91882fe50014ed6..8c5340b99d964ce302bc6392cb8588d2c9bbacfb 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:
 
@@ -96,6 +103,13 @@ 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).