dup, rdiff: implemented and documented simpler and clearer symlinks/globbing

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

diff --git a/examples/example.dup b/examples/example.dup
index b90655140c1b56626eb3f6fc2fd6ea82f11d9a66..457883c35166fcd8087bdca984754bc4b7297484 100644 (file)
--- a/examples/example.dup
+++ b/examples/example.dup
@@ -55,9 +55,23 @@ password = a_very_complicated_passphrase
 
 [source]
 
-# files to include in the backup
-# (supports globbing with '*')
+# A few notes about includes and excludes:
+# 1. include, exclude and vsinclude statements support globbing with '*'
+# 2. Symlinks are not dereferenced. Moreover, an include line whose path
+#    contains, at any level, a symlink to a directory, will only have the
+#    symlink backed-up, not the target directory's content. Yes, you have to
+#    dereference yourself the symlinks, or to use 'mount --bind' instead.
+#    Example: let's say /home is a symlink to /mnt/crypt/home ; the following
+#    line will only backup a "/home" symlink ; neither /home/user nor
+#    /home/user/Mail will be backed-up :
+#      include = /home/user/Mail
+#    A workaround is to 'mount --bind /mnt/crypt/home /home' ; another one is to
+#    write :
+#      include = /mnt/crypt/home/user/Mail
+# 3. All the excludes come after all the includes. The order is not otherwise
+#    taken into account.
 
+# files to include in the backup
 include = /var/spool/cron/crontabs
 include = /var/backups
 include = /etc
@@ -82,10 +96,8 @@ include = /var/lib/dpkg/status-old
 # vsinclude will add to the include list /vservers/foo/home, /vservers/bar/home
 # and /vservers/baz/home.
 # Vservers paths are derived from $VROOTDIR.
-# vsinclude supports globbing with '*'.
 
 # files to exclude from the backup
-# (supports globbing with '*')
 exclude = /home/*/.gnupg
 
 ######################################################