(no commit message)

[matthijs/upstream/backupninja.git] / README

diff --git a/README b/README
index e361ba74773da467b8834bac812d94a200a5f615..f50f127561eb5634814b79c87bf489a7587d5398 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).
+ - works with linux-vservers
  
+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
 ===================
@@ -43,9 +50,11 @@ 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
+  .svn     --  subversion repository backups
 
 Support for additional configuration types can be added by dropping
 bash scripts with the name of the suffix into /usr/share/backupninja. 
@@ -163,10 +172,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