More manpage improvements.
authorWayne Davison <wayned@samba.org>
Sat, 26 Jun 2010 17:52:04 +0000 (10:52 -0700)
committerWayne Davison <wayned@samba.org>
Sat, 26 Jun 2010 17:52:04 +0000 (10:52 -0700)
rsync.yo
rsyncd.conf.yo

index 708cfaf..5bee1e3 100644 (file)
--- a/rsync.yo
+++ b/rsync.yo
@@ -736,6 +736,12 @@ specify a backup suffix using the bf(--suffix) option
 (otherwise the files backed up in the specified directory
 will keep their original filenames).
 
+Note that if you specify a relative path, the backup directory will be
+relative to the destination directory, so you probably want to specify
+either an absolute path or a path that starts with "../".  If an rsync
+daemon is the receiver, the backup dir cannot go outside the module's path
+hierarchy, so take extra care not to delete it or copy into it.
+
 dit(bf(--suffix=SUFFIX)) This option allows you to override the default
 backup suffix used with the bf(--backup) (bf(-b)) option. The default suffix is a ~
 if no -bf(-backup-dir) was specified, otherwise it is an empty string.
index 65d0539..fa25d6d 100644 (file)
@@ -87,8 +87,8 @@ a variable does not exist in the environment, or if a sequence of characters is
 not a valid reference (such as an un-paired percent sign), the raw characters
 are passed through unchanged.  This helps with backward compatibility and
 safety (e.g. expanding a non-existent %VAR% to an empty string in a path could
-result in a very unsafe path).  Anyone that needs to insert a literal % string
-into a value should use %%.
+result in a very unsafe path).  The safest way to insert a literal % into a
+value is to use %%.
 
 startdit()
 dit(bf(motd file)) This parameter allows you to specify a
@@ -144,10 +144,12 @@ of available modules. The default is no comment.
 
 dit(bf(path)) This parameter specifies the directory in the daemon's
 filesystem to make available in this module.  You must specify this parameter
-for each module in tt(rsyncd.conf).  You may base the path's value off
-of an environment variable, even one that is set by rsync when the user
-connects.  For example, this would use the authorizing user's name in the
-path:
+for each module in tt(rsyncd.conf).
+
+You may base the path's value off of an environment variable by surrounding
+the variable name with percent signs.  You can even reference a variable
+that is set by rsync when the user connects.
+For example, this would use the authorizing user's name in the path:
 
 verb(    path = /home/%RSYNC_USER_NAME% )