aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorintrigeri <intrigeri@boum.org>2012-02-25 14:18:30 +0100
committerintrigeri <intrigeri@boum.org>2012-02-25 14:18:30 +0100
commit312791481034e06b198e15d1ce7525f64fbfeb7c (patch)
treea81c91e707748776289c0971a0ef756f0d41bb91 /README
parenta74db16e51a057d665f7d8ee35733ffce12a4717 (diff)
downloadbackupninja-312791481034e06b198e15d1ce7525f64fbfeb7c.tar.gz
backupninja-312791481034e06b198e15d1ce7525f64fbfeb7c.tar.bz2
Document what features available to .sh jobs (Redmine #1558)
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.