X-Git-Url: https://git.stderr.nl/gitweb?a=blobdiff_plain;f=examples%2Fexample.dup;h=f3d39812d2cdb57bb02870a27279928b58eb592c;hb=a65bc7af30e0ba963a007bc47b6287054bc2f276;hp=a5c1b67802824ba561aebcac0bd02172f86d101d;hpb=e94597ad053204c0a056505fe3f017ff325489fd;p=matthijs%2Fupstream%2Fbackupninja.git

diff --git a/examples/example.dup b/examples/example.dup
index a5c1b67..f3d3981 100644
--- a/examples/example.dup
+++ b/examples/example.dup
@@ -10,18 +10,20 @@ 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
+## WARNING: old (pre-0.9.4) example.dup used to give wrong information about
+##          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
-##     variable
+##   - if signing is enabled, data is signed with the GnuPG private
+##     key specified by the signkey variable
+##   - the password variable is used to unlock the GnuPG key(s) used
+##     for encryption and (optionnal) signing
+##
 ## If the encryptkey option is not set:
 ##   - data signing is not possible
 ##   - the password variable is used to encrypt the data with symmetric
@@ -29,10 +31,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 +46,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
 
 ######################################################
@@ -53,9 +55,11 @@ password = a_very_complicated_passphrase
 
 [source]
 
-# files to include in the backup
-# (supports globbing with '*')
+# WARNING: 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.
 
+# files to include in the backup
 include = /var/spool/cron/crontabs
 include = /var/backups
 include = /etc
@@ -80,10 +84,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
 
 ######################################################