X-Git-Url: https://git.stderr.nl/gitweb?a=blobdiff_plain;f=examples%2Fexample.rdiff;h=5ad700be624eb014e23c4d05c407054a8602afa9;hb=ea468148c55ce56e0c106f7e98ed249f8ffb388c;hp=198516c726cdc15339d4ede7c6b5d29dc3d29bc6;hpb=51d938cd68c7a2eeaca73de9e14c6c34efceca88;p=matthijs%2Fupstream%2Fbackupninja.git

diff --git a/examples/example.rdiff b/examples/example.rdiff
index 198516c..5ad700b 100644
--- a/examples/example.rdiff
+++ b/examples/example.rdiff
@@ -13,6 +13,13 @@
 ## default is yes. set to no to skip the test if the remote host is alive
 # testconnect = no
 
+## default is not to limit bandwidth. 
+## set to a number in bytes/second to limit bandwidth usage. Use a negative 
+## number to set a limit that will never be exceeded, or a positive number 
+## to set a target average bandwidth use. cstream is required. See cstream's 
+## -t option for more information. 62500 bytes = 500 Kb (.5 Mb)
+# bwlimit = 62500
+
 ######################################################
 ## source section
 ## (where the files to be backed up are coming from)
@@ -33,15 +40,23 @@ 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:
+# 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
-# (supports globbing with '*')
 include = /var/spool/cron/crontabs
 include = /var/backups
 include = /etc
@@ -66,10 +81,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
 
 ######################################################
@@ -89,7 +102,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