From 219a6eb958a6f8cc9dce34f9f87a95c02ef0c322 Mon Sep 17 00:00:00 2001
From: intrigeri <intrigeri@boum.org>
Date: Thu, 6 May 2010 19:47:54 +0200
Subject: Better example.dup documentation. Thanks, Alster!

---
 examples/example.dup | 24 +++++++++++++++---------
 1 file changed, 15 insertions(+), 9 deletions(-)

(limited to 'examples')

diff --git a/examples/example.dup b/examples/example.dup
index 53039f5..2c0c41d 100644
--- a/examples/example.dup
+++ b/examples/example.dup
@@ -19,7 +19,8 @@
 ## Default:
 # nicelevel = 0
 
-## test the connection? set to no to skip the test if the remote host is alive
+## test the connection? set to no to skip the test if the remote host is alive.
+## if 'desturl' is set below, 'testconnect' must be set to 'no' for now.
 ##
 ## Default:
 # testconnect = yes
@@ -169,6 +170,7 @@ exclude = /home/*/.gnupg
 ## desturl = file:///usr/local/backup
 ## desturl = rsync://user@other.host//var/backup/bla
 ## desturl = s3+http://
+## desturl = ftp://myftpuser[:myftppassword]@ftp.example.org/remote/ftp/path
 ## the default value of this configuration option is not set:
 ##
 ## Default:
@@ -183,8 +185,9 @@ exclude = /home/*/.gnupg
 # awsaccesskeyid = 
 # awssecretaccesskey = 
 
-## bandwith limit, in kbit/s ; default is 0, i.e. no limit an example
-## setting would be:
+## bandwith limit, in kbit/s ; default is 0, i.e. no limit
+## if using 'desturl' above, 'bandwidthlimit' must not be set
+## an example setting of 128 kbps would be:
 ## bandwidthlimit = 128
 ##
 ## Default:
@@ -199,14 +202,18 @@ exclude = /home/*/.gnupg
 ## Default:
 # sshoptions = 
 
-## put the backups under this directory, this must be set!
+## put the backups under this destination directory
+## if using 'desturl' above, this must not be set
+## in all other cases, this must be set!
 ## an example setting would be:
 ## destdir = /backups
 ## 
 ## Default:
 # destdir = 
 
-## the machine which will receive the backups, this must be set!
+## the machine which will receive the backups
+## if using 'desturl' above, this must not be set
+## in all other cases, this must be set!
 ## an example setting would be:
 ## desthost = backuphost
 ## 
@@ -214,12 +221,11 @@ exclude = /home/*/.gnupg
 # desthost = 
 
 ## make the files owned by this user
-## note: you must be able to ssh backupuser@backhost
-## without specifying a password (if type = remote).
+## if using 'desturl' above, this must not be set
+## note: if using an SSH based transport and 'type' is set to 'remote', you must
+##       be able to 'ssh backupuser@backuphost' without specifying a password.
 ## an example setting would be:
 ## destuser = backupuser
 ##
 ## Default:
 # destuser =
-
-
-- 
cgit v1.2.3