aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorintrigeri <intrigeri@boum.org>2012-05-15 17:55:51 +0200
committerintrigeri <intrigeri@boum.org>2012-05-15 17:55:51 +0200
commitad63b8a78b728bf7e2c479e5e26fb4ed9b6d66bf (patch)
tree392f8d082fb3fc26e1ea30c483c0e19a90f5f7f7 /README
parent1b2dc55cb82d790eca8ea1c2b325a755db75a91a (diff)
parent13edaf0912f8b36d5035b5ebdbbc28fd0d498427 (diff)
downloadbackupninja-ad63b8a78b728bf7e2c479e5e26fb4ed9b6d66bf.tar.gz
backupninja-ad63b8a78b728bf7e2c479e5e26fb4ed9b6d66bf.tar.bz2
Merge tag 'backupninja_upstream/1.0_rc1' into debian
Upstream version 1.0~rc1 Conflicts: Makefile.in aclocal.m4 configure etc/Makefile.in examples/Makefile.in handlers/Makefile.in install-sh lib/Makefile.in man/Makefile.in missing src/Makefile.in
Diffstat (limited to 'README')
-rw-r--r--README20
1 files changed, 20 insertions, 0 deletions
diff --git a/README b/README
index 8b138cf..9f296fb 100644
--- a/README
+++ b/README
@@ -239,3 +239,23 @@ VSERVERINFO (default: /usr/sbin/vserver-info)
VSERVER (default: /usr/sbin/vserver)
VROOTDIR (default: `$VSERVERINFO info SYSINFO |grep vserver-Rootdir | awk '{print $2}'`)
+
+.sh CONFIGURATION FILES
+=======================
+
+Shell jobs may use the following features:
+
+ * logging and control flow functions:
+ halt, fatal, error, warning, info, debug, passthru.
+ All such functions take a list of strings a parameters.
+ Those strings are passed to whatever logging mechanism is enabled,
+ and colored if relevant.
+
+ * Using "exit N" is useless, and has unspecified consequences.
+ Just don't do it.
+
+ * when=TIME works as documented above; at may also be written
+ "when = TIME".
+
+ * The $BACKUPNINJA_DEBUG environment variable is set when
+ backupninja is invoked with the -d option.