mysql: No longer prepend vroot to the backupdir.

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

diff --git a/man/backup.d.5 b/man/backup.d.5
index 34a2d9225e840c4dc5a13a9c3121f48f47450d46..80f0ce890b7c8abd54fa66b92505fb1c317afd9e 100644 (file)
--- a/man/backup.d.5
+++ b/man/backup.d.5
@@ -56,12 +56,12 @@ 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.
 
@@ -97,6 +97,35 @@ The file format of the action configuration files is "ini style." Sections are c
    pear = no thanks \\
    i will not have a pear.
 
+.SH INTERPOLATION
+
+Some handlers will support path interpolation for some of their configuration variables. Interpolation allows you to give a config variable a different value, depending on the host or vserver it is used in. See the documentation for each handler for which variables are interpolated.
+
+The following interpolation variables are available:
+
+.IP %h
+The short hostname (output of `hostname -s`).
+
+.IP %h
+The full hostname (output of `hostname --fqdn`).
+
+.IP %n
+The name of the vserver running in, or the empty string when running on the host.
+
+.IP %N
+The name of the vserver running in, or "host" when running on the host.
+
+.IP %v
+The root direcotry of the vserver running in, or the empty string when running on the host.  
+
+.IP %%
+A literal %.
+
+For example, the following would backup the foo and bar vservers to /var/backups/foo and /var/backups/bar respectively.
+
+   backupdir = /var/backups/%n
+   vsnames   = foo bar
+
 .SH SEE ALSO
 .BR backupninja (1), 
 .BR ninjahelper (1),