Improved duplicity handler: option to disable remote files cleaning, optionnal backup...

[matthijs/upstream/backupninja.git] / README

diff --git a/README b/README
index 5a5a2a828004a1e31f80de7ea948cfee67fa0e06..51e807aeafb72e59163bfcb2ad7dfb5f9cb8eba6 100644 (file)
--- a/README
+++ b/README
@@ -20,14 +20,21 @@ Features:
  - backup of ldap databases (via slapcat and ldapsearch).
  - passwords are never sent via the command line to helper programs.
  - you can drop in scripts to handle new types of backups.
-
-The following options are available:
--h         This help message
--d         Run in debug mode, where all log messages are output
-           to the current shell.
--f <file>  Use <file> for the main configuration instead of
-           /etc/backupninja.conf
+ - backup actions can be scheduled
+ - you can choose when status report emails are mailed to you
+   (always, on warning, on error, never).
  
+The following options are available:
+-h, --help           This usage message
+-d, --debug          Run in debug mode, where all log messages are
+                     output to the current shell.
+-f, --conffile FILE  Use FILE for the main configuration instead
+                     of /etc/backupninja.conf
+-t, --test           Run in test mode, no actions are actually taken.
+-n, --now            Perform actions now, instead of when they
+                     might be scheduled.
+--run FILE           runs the specified action FILE (e.g. one of the /etc/backup.d/ files)
+
 CONFIGURATION FILES
 ===================
 
@@ -42,6 +49,7 @@ file in /etc/backup.d according to the file's suffix:
   .sh      --  run this file as a shell script.
   .rdiff   --  this is a configuration for rdiff-backup
   .maildir --  this is a configuration to backup maildirs
+  .dup     --  this is a configuration for duplicity
   .mysql   --  mysql backup configuration
   .ldap    --  ldap backup configuration
   .sys     --  general system reports
@@ -77,6 +85,42 @@ For example:
    pear = no thanks \
    i will not have a pear.
 
+
+SCHEDULING
+==========
+
+By default, each configuration file is processed everyday at 01:00 (1
+AM). This can be changed by specifying the 'when' option in a config
+file.
+
+For example:
+
+  when = sundays at 02:00
+  when = 30th at 22
+  when = 30 at 22:00
+  when = everyday at 01            <-- the default
+  when = Tuesday at 05:00
+
+A configuration file will be processed at the time(s) specified by the
+"when" option. If multiple "when" options are present, then they all
+apply. If two configurations files are scheduled to run in the same
+hour, then we fall back on the alphabetical ordering specified above.
+If two configurations files are scheduled close to one another in
+time, it is possible to have multiple copies of backupninja running if
+the first instance is not finished before the next one starts.
+
+These values for 'when' are equivalent:
+
+  when = tuesday at 05:30
+  when = TUESDAYS at 05
+
+These values for 'when' are invalid:
+  
+  when = tuesday at 2am
+  when = tuesday at 2
+  when = tues at 02
+
+
 REAL WORLD USAGE
 ================
 
@@ -101,6 +145,7 @@ the backup server must have root on the production server, and (3)
 rdiff-backup is more space efficient and featureful than using rsync +
 hard links. 
 
+
 SSH KEYS
 ========
 
@@ -117,6 +162,7 @@ user 'backup' on desthost without specifying a password.
 Note: when prompted for a password by ssh-keygen, just leave it
 blank by hitting return.
 
+
 INSTALLATION
 ============
    
@@ -124,10 +170,7 @@ Requirements:
   apt-get install bash gawk
 
 Recommended: 
-  apt-get install rdiff-backup gzip
-
-Suggested:
-  apt-get install sfdisk discover  
+  apt-get install rdiff-backup gzip hwinfo
 
 Files:
   /usr/sbin/backupninja        -- main script