X-Git-Url: https://arthur.barton.de/gitweb/?a=blobdiff_plain;f=README.md;h=66d79aaa5d9cdc952fb1d1cae75af7d030dc5e22;hb=2d95d80b5fc36b694f672f25ab3ba8f49bbfc713;hp=d5c6f5420f445148bdf5e48e897d58d9c2263e7a;hpb=9f83e770e8ccdf43fa3b1e7c2281c4fe61252e08;p=backup-script.git diff --git a/README.md b/README.md index d5c6f54..66d79aa 100644 --- 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: @@ -151,3 +158,15 @@ definition files are automatically mapped to the new backup-script variables: * source -> source_root * pre_exec -> job_pre_exec * post_exec -> job_post_exec + + +## Exit codes + +- 1: Unspecific Error! +- 2: Usage information has been shown. +- 3: Can't read system definition +- 4: PID-file exists! +- 5: Pre-exec command failed! +- 6: There have been systems with errors! +- 7: Not all jobs were run! +- 9: Aborted (CTRL-C)!