Added example file for rsnap, it needs some documentation to make it more clear

[matthijs/upstream/backupninja.git] / examples / example.rdiff

diff --git a/examples/example.rdiff b/examples/example.rdiff
index 8878ad0a45328db5f8d9ed6e0943c2c59dbe0e86..dd2ac5e4825bc3d4c52c430fc464638993b186e2 100644 (file)
--- a/examples/example.rdiff
+++ b/examples/example.rdiff
@@ -33,15 +33,14 @@ type = local
 # (you can also use the time format of rdiff-backup, e.g. 6D5h)
 keep = 60
 
-# a note about includes and excludes:
-# All the excludes come after all the includes. The order is
-# not otherwise taken into account. Symlinks are backed up as
-# symlinks, they are not followed! This means you must specify
-# the real canonical path of a directory for it to actually
-# get included.
+# A few notes about includes and excludes:
+#   - include, exclude and vsinclude statements support EITHER globbing with '*'
+#     OR symlinks in the path; usage of both in the same statement is *not*
+#     supported and will lead to weird behaviour.
+#   - All the excludes come after all the includes. The order is not otherwise
+#     taken into account.
 
 # files to include in the backup
-# (supports globbing with '*')
 include = /var/spool/cron/crontabs
 include = /var/backups
 include = /etc
@@ -52,14 +51,22 @@ include = /usr/local/sbin
 include = /var/lib/dpkg/status
 include = /var/lib/dpkg/status-old
 
-# If vservers = yes in /etc/backupninja.conf then vsinclude
-# may be used. Any path specified in vsinclude is added to
-# the include list for each vserver on the system. e.g.
-# vsinclude = /home will backup /vservers/v1/home,
-# /vservers/v2/home, etc.
+# If vservers = yes in /etc/backupninja.conf then the following variables can
+# be used:
+# vsnames = all | <vserver1> <vserver2> ... (default = all)
+# vsinclude = <path>
+# vsinclude = <path>
+# ...
+# Any path specified in vsinclude is added to the include list for each vserver
+# listed in vsnames (or all if vsnames = all, which is the default).
+#
+# For example, vsinclude = /home will backup the /home directory in every
+# vserver listed in vsnames. If you have 'vsnames = foo bar baz', this
+# vsinclude will add to the include list /vservers/foo/home, /vservers/bar/home
+# and /vservers/baz/home.
+# Vservers paths are derived from $VROOTDIR.
 
 # files to exclude from the backup
-# (supports globbing with '*')
 #exclude = /home/*/.gnupg
 
 ######################################################
@@ -79,7 +86,7 @@ directory = /backups
 host = backuphost
 
 # make the files owned by this user. you must be able to
-# `su -c ssh backupuser@backhost` without specifying a password.
+# `su -c "ssh backupuser@backhost"` without specifying a password.
 # only use if "[dest] type = remote"
 user = backupuser