Allow the entire backup run to be halted by an action (Closes: #455836)

[matthijs/upstream/backupninja.git] / README

diff --git a/README b/README
index e3977bc55df13f7bbc17ae07715620a53883ee9e..03d96fe931ea217149793c53f7ab97b2c8ab4002 100644 (file)
--- a/README
+++ b/README
@@ -62,6 +62,7 @@ file in /etc/backup.d according to the file's suffix:
   .dup     --  filesystem backup (using duplicity)
   .mysql   --  backup mysql databases
   .ldap    --  backup ldap databases
+  .pgsql   --  backup PostgreSQL databases
   .sys     --  general hardware, partition, and system reports.
   .svn     --  backup subversion repositories
   .maildir --  incrementally backup maildirs (very specialized)
@@ -79,8 +80,9 @@ For example:
        90-runthislast.rdiff
 
 Typically, you will put a '.rdiff' config file last, so that any
-database dumps you make are included in the filesystem backup. 
-Configurations files which begin with 0 (zero) are skipped.
+database dumps you make are included in the filesystem backup.
+Configurations files with names beginning with 0 (zero) or ending with
+.disabled (preferred method) are skipped.
 
 Unless otherwise specified, the config file format is "ini style."
 
@@ -204,6 +206,7 @@ Installation:
   # tar xvzf backupninja.tar.gz
   # cd backupninja
   # mv backupninja /usr/sbin/backupninja
+  # mv ninjahelper /usr/sbin/ninjahelper
   # mv etc/logrotate.d/backupninja /etc/logrotate.d/backupninja
   # mv etc/cron.d/backupninja /etc/cron.d/backupninja
   # mkdir /etc/backup.d/
@@ -215,17 +218,19 @@ VSERVERS
 ========
 
 If you are using Linux-Vservers (http://linux-vserver.org/) there are some
-special capabilities that different handlers have to make vserver backups easier.
+special capabilities that different handlers have to make vserver 
+backups easier.
+
 Set the variable "vservers" to be "yes" in /etc/backupninja.conf and see the
 example configuration files for each handler to configure the vserver specific
 variables.
 
-Additional vserver variables that can be configured in /etc/backupninja.conf. but
-probably don't need to be changed:
+Additional vserver variables that can be configured in /etc/backupninja.conf, 
+but they probably don't need to be changed:
 
 VSERVERINFO (default: /usr/sbin/vserver-info)
 VSERVER (default: /usr/sbin/vserver)
-VROOTDIR (default: `$VSERVERINFO info SYSINFO |grep vserver-Rootdir | awk '{print $2}'; fi`)
+VROOTDIR (default: `$VSERVERINFO info SYSINFO |grep vserver-Rootdir | awk '{print $2}'`)
 
 NINJAHELPER
 ===========
@@ -248,6 +253,11 @@ To add an additional 'wizard' to ninjahelper, follow these steps:
          ... do work here ...
        }
 
-(3) check the examples of the included helpers to see how they are
-    written. The dialog functions are defined in easydialog.sh.
+(3) look at the existing helpers to see how they are written. Try to re-use
+    functions, such as the dialog functions that are defined in easydialog.sh,
+    or the vserver functions defined in lib/vserver.
 
+(4) test, re-test, and test again. Try to break the helper by going backwards,
+    try to think like someone who has no idea how to configure your handler
+    would think, try to make your helper as simple as possible. Walk like a cat,
+    become your shadow, don't let your senses betray you.