From 312791481034e06b198e15d1ce7525f64fbfeb7c Mon Sep 17 00:00:00 2001 From: intrigeri Date: Sat, 25 Feb 2012 14:18:30 +0100 Subject: Document what features available to .sh jobs (Redmine #1558) --- README | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) (limited to 'README') 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. -- cgit v1.2.3