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

diff --git a/examples/example.rdiff b/examples/example.rdiff
index dd2ac5e..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)
@@ -34,11 +41,20 @@ type = local
 keep = 60
 
 # 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.
+# 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