minor spelling fix
[matthijs/upstream/backupninja.git] / examples / example.dup
index 50d957291247e63ea0cd5d498ab8791610a078b4..8a880f891c779b4d4342af7615c48a5ca7d94e34 100644 (file)
@@ -10,17 +10,17 @@ nicelevel = 19
 
 ######################################################
 ## gpg section
-## (how to encrypt and optionnally sign the backups)
+## (how to encrypt and optionally sign the backups)
 ##
 ## WARNING: old (pre-0.9.2) example.dup used to give wrong information about
-##          the way the following options are used. Please read ahead
+##          the way the following options are used. Please read the following
 ##          carefully.
 ##
 ## If the encryptkey variable is set:
 ##   - data is encrypted with the GnuPG public key specified by the encryptkey
 ##     variable
 ##   - if signing is enabled, the password variable is used to unlock the GnuPG
-##     private key used for signing; else, you do not need to set the password
+##     private key used for signing; otherwise, you do not need to set the password
 ##     variable
 ## If the encryptkey option is not set:
 ##   - data signing is not possible
@@ -29,10 +29,10 @@ nicelevel = 19
 
 [gpg]
 
-# when set to yes, encryptkey variable must be set bellow; if you want to use
+# when set to yes, encryptkey variable must be set below; if you want to use
 # two different keys for encryption and signing, you must also set the signkey
-# variable bellow.
-# default is no, for backward compatibility with backupninja <= 0.5.
+# variable below.
+# default is no, for backwards compatibility with backupninja <= 0.5.
 sign = yes
 
 # ID of the GnuPG public key used for data encryption.
@@ -44,7 +44,7 @@ encryptkey = 04D9EA79
 #signkey = 04D9EA79
 
 # password
-# NB: do not quote it, and it should not contain any quote
+# NB: neither quote this, nor should it contain any quotes
 password = a_very_complicated_passphrase
 
 ######################################################
@@ -55,20 +55,6 @@ password = a_very_complicated_passphrase
 
 # files to include in the backup
 # (supports globbing with '*')
-# BIG FAT WARNING
-# 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
 
 include = /var/spool/cron/crontabs
 include = /var/backups
@@ -87,15 +73,15 @@ include = /var/lib/dpkg/status-old
 # vsinclude = <path>
 # ...
 # Any path specified in vsinclude is added to the include list for each vserver
-# listed in vsnames (or all if vsnames = all).
+# 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.
+# vsinclude supports globbing with '*'.
 
-# rdiff-backup specific comment, TO ADAPT
 # files to exclude from the backup
 # (supports globbing with '*')
 exclude = /home/*/.gnupg