add support for 'when = manual' (Closes: #511299)

[matthijs/upstream/backupninja.git] / man / backup.d.5

diff --git a/man/backup.d.5 b/man/backup.d.5
index 34a2d9225e840c4dc5a13a9c3121f48f47450d46..fd5c9b2adca5335f97939afa875d09c3ffa63ffb 100644 (file)
--- a/man/backup.d.5
+++ b/man/backup.d.5
@@ -56,18 +56,18 @@ These files must be owned by root and must not be world or group readable/writab
 The configuration files are processed in alphabetical order. However, it is suggested that you name the config files in "sysvinit style." 
 .TP
 For example:
- 10-disabled.ldap.disabled
+ 10-local.ldap.disabled
  15-runthisfirst.sh
  20-runthisnext.mysql
  90-runthislast.rdiff
 .TP
-Typically, you will put a '.rdiff' config file last, so that any database dumps you make are included in the filesystem backup. Action configurations which begin end with .disabled are skipped.
+Typically, you will put a '.rdiff' config file last, so that any database dumps you make are included in the filesystem backup. Action configurations which end with .disabled are skipped.
 .TP
 Example templates for the action configuration files can be found in /usr/share/doc/backupninja/examples. You can also use \fBninjahelper(1)\fP, a console based "wizard" for creating backup actions.
 
 .SH 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 backup action's config file or in the global configuration file. 
+By default, each configuration file is processed everyday at 01:00 (1 AM). This can be changed by specifying the 'when' option in a backup action's config file or in the global configuration file. Special value 'manual' will disable scheduling for the backup action. It is possible to run the backup action manually by invoking \fBninjahelper(1)\fP with --run command line argument.
 
 For example:
   when = sundays at 02:00
@@ -76,6 +76,7 @@ For example:
   when = everyday at 01
   when = Tuesday at 05:00
   when = hourly
+  when = manual
 
 These values for "when" are invalid:
   when = tuesday at 2am