20524211 update rsync to 3.1.1
19495794 too aggressive keep-alive messages causing a problem for older rsync
Remove groffisms from the man page. This changes "\(dq" to a double-quote
character ("), "\(cq" to a single-quote character ('), and eliminates the
use of "\&" except where it's needed at the beginning of the line.
--- rsync-3.1.1/rsyncd.conf.5.orig 2014-06-22 10:07:36.000000000 -0700
+++ rsync-3.1.1/rsyncd.conf.5 2014-08-27 11:32:28.266744772 -0700
@@ -20,7 +20,7 @@
.PP
The file consists of modules and parameters. A module begins with the
name of the module in square brackets and continues until the next
-module begins. Modules contain parameters of the form \(dq\&name = value\(dq\&.
+module begins. Modules contain parameters of the form "name = value".
.PP
The file is line\-based \-\- that is, each newline\-terminated line represents
either a comment, a module name or a parameter.
@@ -33,9 +33,9 @@
.PP
Any line \fBbeginning\fP with a hash (#) is ignored, as are lines containing
only whitespace. (If a hash occurs after anything other than leading
-whitespace, it is considered a part of the line\(cq\&s content.)
+whitespace, it is considered a part of the line's content.)
.PP
-Any line ending in a \e is \(dq\&continued\(dq\& on the next line in the
+Any line ending in a \e is "continued" on the next line in the
customary UNIX fashion.
.PP
The values following the equals sign in parameters are all either a string
@@ -56,7 +56,7 @@
.PP
You can launch it either via inetd, as a stand\-alone daemon, or from
an rsync client via a remote shell. If run as a stand\-alone daemon then
-just run the command \(dq\&\fBrsync \-\-daemon\fP\(dq\& from a suitable startup script.
+just run the command "\fBrsync \-\-daemon\fP" from a suitable startup script.
.PP
When run via inetd you should add a line like this to /etc/services:
.PP
@@ -72,7 +72,7 @@
.fi
.PP
-Replace \(dq\&/usr/bin/rsync\(dq\& with the path to where you have rsync installed on
+Replace "/usr/bin/rsync" with the path to where you have rsync installed on
your system. You will then need to send inetd a HUP signal to tell it to
reread its config file.
.PP
@@ -104,7 +104,7 @@
.PP
.IP "\fBmotd file\fP"
This parameter allows you to specify a
-\(dq\&message of the day\(dq\& to display to clients on each connect. This
+"message of the day" to display to clients on each connect. This
usually contains site information and any legal notices. The default
is no motd file.
This can be overridden by the \fB\-\-dparam=motdfile=FILE\fP
@@ -163,14 +163,14 @@
of available modules. The default is no comment.
.IP
.IP "\fBpath\fP"
-This parameter specifies the directory in the daemon\(cq\&s
+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 \f(CWrsyncd.conf\fP.
.IP
-You may base the path\(cq\&s value off of an environment variable by surrounding
+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\(cq\&s name in the path:
+For example, this would use the authorizing user's name in the path:
.IP
.nf
path = /home/%RSYNC_USER_NAME%
@@ -178,40 +178,40 @@
.IP
It is fine if the path includes internal spaces \-\- they will be retained
-verbatim (which means that you shouldn\(cq\&t try to escape them). If your final
+verbatim (which means that you shouldn't try to escape them). If your final
directory has a trailing space (and this is somehow not something you wish to
fix), append a trailing slash to the path to avoid losing the trailing
whitespace.
.IP
.IP "\fBuse chroot\fP"
-If \(dq\&use chroot\(dq\& is true, the rsync daemon will chroot
-to the \(dq\&path\(dq\& before starting the file transfer with the client. This has
+If "use chroot" is true, the rsync daemon will chroot
+to the "path" before starting the file transfer with the client. This has
the advantage of extra protection against possible implementation security
holes, but it has the disadvantages of requiring super\-user privileges,
of not being able to follow symbolic links that are either absolute or outside
of the new root path, and of complicating the preservation of users and groups
by name (see below).
.IP
-As an additional safety feature, you can specify a dot\-dir in the module\(cq\&s
-\(dq\&path\(dq\& to indicate the point where the chroot should occur. This allows rsync
-to run in a chroot with a non\-\(dq\&/\(dq\& path for the top of the transfer hierarchy.
+As an additional safety feature, you can specify a dot\-dir in the module's
+"path" to indicate the point where the chroot should occur. This allows rsync
+to run in a chroot with a non\-"/" path for the top of the transfer hierarchy.
Doing this guards against unintended library loading (since those absolute
paths will not be inside the transfer hierarchy unless you have used an unwise
pathname), and lets you setup libraries for the chroot that are outside of the
-transfer. For example, specifying \(dq\&/var/rsync/./module1\(dq\& will chroot to the
-\(dq\&/var/rsync\(dq\& directory and set the inside\-chroot path to \(dq\&/module1\(dq\&. If you
+transfer. For example, specifying "/var/rsync/./module1" will chroot to the
+"/var/rsync" directory and set the inside\-chroot path to "/module1". If you
had omitted the dot\-dir, the chroot would have used the whole path, and the
-inside\-chroot path would have been \(dq\&/\(dq\&.
+inside\-chroot path would have been "/".
.IP
-When \(dq\&use chroot\(dq\& is false or the inside\-chroot path is not \(dq\&/\(dq\&, rsync will:
+When "use chroot" is false or the inside\-chroot path is not "/", rsync will:
(1) munge symlinks by
-default for security reasons (see \(dq\&munge symlinks\(dq\& for a way to turn this
+default for security reasons (see "munge symlinks" for a way to turn this
off, but only if you trust your users), (2) substitute leading slashes in
-absolute paths with the module\(cq\&s path (so that options such as
+absolute paths with the module's path (so that options such as
\fB\-\-backup\-dir\fP, \fB\-\-compare\-dest\fP, etc. interpret an absolute path as
-rooted in the module\(cq\&s \(dq\&path\(dq\& dir), and (3) trim \(dq\&..\(dq\& path elements from
+rooted in the module's "path" dir), and (3) trim ".." path elements from
args if rsync believes they would escape the module hierarchy.
-The default for \(dq\&use chroot\(dq\& is true, and is the safer choice (especially
+The default for "use chroot" is true, and is the safer choice (especially
if the module is not read\-only).
.IP
When this parameter is enabled, rsync will not attempt to map users and groups
@@ -231,12 +231,12 @@
used by these library functions (traditionally /etc/passwd and
/etc/group, but perhaps additional dynamic libraries as well).
.IP
-If you copy the necessary resources into the module\(cq\&s chroot area, you
-should protect them through your OS\(cq\&s normal user/group or ACL settings (to
-prevent the rsync module\(cq\&s user from being able to change them), and then
-hide them from the user\(cq\&s view via \(dq\&exclude\(dq\& (see how in the discussion of
+If you copy the necessary resources into the module's chroot area, you
+should protect them through your OS's normal user/group or ACL settings (to
+prevent the rsync module's user from being able to change them), and then
+hide them from the user's view via "exclude" (see how in the discussion of
that parameter). At that point it will be safe to enable the mapping of users
-and groups by name using the \(dq\&numeric ids\(dq\& daemon parameter (see below).
+and groups by name using the "numeric ids" daemon parameter (see below).
.IP
Note also that you are free to setup custom user/group information in the
chroot area that is different from your normal system. For example, you
@@ -250,7 +250,7 @@
the \fB\-\-numeric\-ids\fP command\-line option. By default, this parameter is
enabled for chroot modules and disabled for non\-chroot modules.
.IP
-A chroot\-enabled module should not have this parameter enabled unless you\(cq\&ve
+A chroot\-enabled module should not have this parameter enabled unless you've
taken steps to ensure that the module has the necessary resources it needs
to translate names, and that it is not possible for a user to change those
resources.
@@ -260,52 +260,52 @@
all symlinks in the same way as the (non\-daemon\-affecting)
\fB\-\-munge\-links\fP command\-line option (using a method described below).
This should help protect your files from user trickery when
-your daemon module is writable. The default is disabled when \(dq\&use chroot\(dq\&
-is on and the inside\-chroot path is \(dq\&/\(dq\&, otherwise it is enabled.
+your daemon module is writable. The default is disabled when "use chroot"
+is on and the inside\-chroot path is "/", otherwise it is enabled.
.IP
If you disable this parameter on a daemon that is not read\-only, there
are tricks that a user can play with uploaded symlinks to access
-daemon\-excluded items (if your module has any), and, if \(dq\&use chroot\(dq\&
+daemon\-excluded items (if your module has any), and, if "use chroot"
is off, rsync can even be tricked into showing or changing data that
-is outside the module\(cq\&s path (as access\-permissions allow).
+is outside the module's path (as access\-permissions allow).
.IP
The way rsync disables the use of symlinks is to prefix each one with
-the string \(dq\&/rsyncd\-munged/\(dq\&. This prevents the links from being used
+the string "/rsyncd\-munged/". This prevents the links from being used
as long as that directory does not exist. When this parameter is enabled,
rsync will refuse to run if that path is a directory or a symlink to
-a directory. When using the \(dq\&munge symlinks\(dq\& parameter in a chroot area
-that has an inside\-chroot path of \(dq\&/\(dq\&, you should add \(dq\&/rsyncd\-munged/\(dq\&
+a directory. When using the "munge symlinks" parameter in a chroot area
+that has an inside\-chroot path of "/", you should add "/rsyncd\-munged/"
to the exclude setting for the module so that
-a user can\(cq\&t try to create it.
+a user can't try to create it.
.IP
Note: rsync makes no attempt to verify that any pre\-existing symlinks in
-the module\(cq\&s hierarchy are as safe as you want them to be (unless, of
+the module's hierarchy are as safe as you want them to be (unless, of
course, it just copied in the whole hierarchy). If you setup an rsync
daemon on a new area or locally add symlinks, you can manually protect your
-symlinks from being abused by prefixing \(dq\&/rsyncd\-munged/\(dq\& to the start of
-every symlink\(cq\&s value. There is a perl script in the support directory
-of the source code named \(dq\&munge\-symlinks\(dq\& that can be used to add or remove
+symlinks from being abused by prefixing "/rsyncd\-munged/" to the start of
+every symlink's value. There is a perl script in the support directory
+of the source code named "munge\-symlinks" that can be used to add or remove
this prefix from your symlinks.
.IP
-When this parameter is disabled on a writable module and \(dq\&use chroot\(dq\& is off
-(or the inside\-chroot path is not \(dq\&/\(dq\&),
-incoming symlinks will be modified to drop a leading slash and to remove \(dq\&..\(dq\&
-path elements that rsync believes will allow a symlink to escape the module\(cq\&s
+When this parameter is disabled on a writable module and "use chroot" is off
+(or the inside\-chroot path is not "/"),
+incoming symlinks will be modified to drop a leading slash and to remove ".."
+path elements that rsync believes will allow a symlink to escape the module's
hierarchy. There are tricky ways to work around this, though, so you had
better trust your users if you choose this combination of parameters.
.IP
.IP "\fBcharset\fP"
This specifies the name of the character set in which the
-module\(cq\&s filenames are stored. If the client uses an \fB\-\-iconv\fP option,
-the daemon will use the value of the \(dq\&charset\(dq\& parameter regardless of the
+module's filenames are stored. If the client uses an \fB\-\-iconv\fP option,
+the daemon will use the value of the "charset" parameter regardless of the
character set the client actually passed. This allows the daemon to
support charset conversion in a chroot module without extra files in the
chroot area, and also ensures that name\-translation is done in a consistent
-manner. If the \(dq\&charset\(dq\& parameter is not set, the \fB\-\-iconv\fP option is
-refused, just as if \(dq\&iconv\(dq\& had been specified via \(dq\&refuse options\(dq\&.
+manner. If the "charset" parameter is not set, the \fB\-\-iconv\fP option is
+refused, just as if "iconv" had been specified via "refuse options".
.IP
If you wish to force users to always use \fB\-\-iconv\fP for a particular
-module, add \(dq\&no\-iconv\(dq\& to the \(dq\&refuse options\(dq\& parameter. Keep in mind
+module, add "no\-iconv" to the "refuse options" parameter. Keep in mind
that this will restrict access to your module to very new rsync clients.
.IP
.IP "\fBmax connections\fP"
@@ -314,15 +314,15 @@
Any clients connecting when the maximum has been reached will receive a
message telling them to try later. The default is 0, which means no limit.
A negative value disables the module.
-See also the \(dq\&lock file\(dq\& parameter.
+See also the "lock file" parameter.
.IP
.IP "\fBlog file\fP"
-When the \(dq\&log file\(dq\& parameter is set to a non\-empty
+When the "log file" parameter is set to a non\-empty
string, the rsync daemon will log messages to the indicated file rather
than using syslog. This is particularly useful on systems (such as AIX)
where
\f(CWsyslog()\fP
-doesn\(cq\&t work for chrooted programs. The file is
+doesn't work for chrooted programs. The file is
opened before
\f(CWchroot()\fP
is called, allowing it to be placed outside
@@ -337,7 +337,7 @@
This setting can be overridden by using the \fB\-\-log\-file=FILE\fP or
\fB\-\-dparam=logfile=FILE\fP command\-line options. The former overrides
all the log\-file parameters of the daemon and all module settings.
-The latter sets the daemon\(cq\&s log file and the default for all the
+The latter sets the daemon's log file and the default for all the
modules, which still allows modules to override the default setting.
.IP
.IP "\fBsyslog facility\fP"
@@ -347,43 +347,43 @@
defined on your system. Common names are auth, authpriv, cron, daemon,
ftp, kern, lpr, mail, news, security, syslog, user, uucp, local0,
local1, local2, local3, local4, local5, local6 and local7. The default
-is daemon. This setting has no effect if the \(dq\&log file\(dq\& setting is a
+is daemon. This setting has no effect if the "log file" setting is a
non\-empty string (either set in the per\-modules settings, or inherited
from the global settings).
.IP
.IP "\fBmax verbosity\fP"
This parameter allows you to control
-the maximum amount of verbose information that you\(cq\&ll allow the daemon to
+the maximum amount of verbose information that you'll allow the daemon to
generate (since the information goes into the log file). The default is 1,
which allows the client to request one level of verbosity.
.IP
-This also affects the user\(cq\&s ability to request higher levels of \fB\-\-info\fP and
+This also affects the user's ability to request higher levels of \fB\-\-info\fP and
\fB\-\-debug\fP logging. If the max value is 2, then no info and/or debug value
that is higher than what would be set by \fB\-vv\fP will be honored by the daemon
in its logging. To see how high of a verbosity level you need to accept for a
-particular info/debug level, refer to \(dq\&rsync \-\-info=help\(dq\& and \(dq\&rsync \-\-debug=help\(dq\&.
+particular info/debug level, refer to "rsync \-\-info=help" and "rsync \-\-debug=help".
For instance, it takes max\-verbosity 4 to be able to output debug TIME2 and FLIST3.
.IP
.IP "\fBlock file\fP"
This parameter specifies the file to use to
-support the \(dq\&max connections\(dq\& parameter. The rsync daemon uses record
+support the "max connections" parameter. The rsync daemon uses record
locking on this file to ensure that the max connections limit is not
exceeded for the modules sharing the lock file.
The default is \f(CW/var/run/rsyncd.lock\fP.
.IP
.IP "\fBread only\fP"
This parameter determines whether clients
-will be able to upload files or not. If \(dq\&read only\(dq\& is true then any
-attempted uploads will fail. If \(dq\&read only\(dq\& is false then uploads will
+will be able to upload files or not. If "read only" is true then any
+attempted uploads will fail. If "read only" is false then uploads will
be possible if file permissions on the daemon side allow them. The default
is for all modules to be read only.
.IP
-Note that \(dq\&auth users\(dq\& can override this setting on a per\-user basis.
+Note that "auth users" can override this setting on a per\-user basis.
.IP
.IP "\fBwrite only\fP"
This parameter determines whether clients
-will be able to download files or not. If \(dq\&write only\(dq\& is true then any
-attempted downloads will fail. If \(dq\&write only\(dq\& is false then downloads
+will be able to download files or not. If "write only" is true then any
+attempted downloads will fail. If "write only" is false then downloads
will be possible if file permissions on the daemon side allow them. The
default is for this parameter to be disabled.
.IP
@@ -391,8 +391,8 @@
This parameter determines whether this module is
listed when the client asks for a listing of available modules. In addition,
if this is false, the daemon will pretend the module does not exist
-when a client denied by \(dq\&hosts allow\(dq\& or \(dq\&hosts deny\(dq\& attempts to access it.
-Realize that if \(dq\&reverse lookup\(dq\& is disabled globally but enabled for the
+when a client denied by "hosts allow" or "hosts deny" attempts to access it.
+Realize that if "reverse lookup" is disabled globally but enabled for the
module, the resulting reverse lookup to a potentially client\-controlled DNS
server may still reveal to the client that it hit an existing module.
The default is for modules to be listable.
@@ -400,10 +400,10 @@
.IP "\fBuid\fP"
This parameter specifies the user name or user ID that
file transfers to and from that module should take place as when the daemon
-was run as root. In combination with the \(dq\&gid\(dq\& parameter this determines what
+was run as root. In combination with the "gid" parameter this determines what
file permissions are available. The default when run by a super\-user is to
-switch to the system\(cq\&s \(dq\&nobody\(dq\& user. The default for a non\-super\-user is to
-not try to change the user. See also the \(dq\&gid\(dq\& parameter.
+switch to the system's "nobody" user. The default for a non\-super\-user is to
+not try to change the user. See also the "gid" parameter.
.IP
The RSYNC_USER_NAME environment variable may be used to request that rsync run
as the authorizing user. For example, if you want a rsync to run as the same
@@ -418,16 +418,16 @@
.IP "\fBgid\fP"
This parameter specifies one or more group names/IDs that will be
used when accessing the module. The first one will be the default group, and
-any extra ones be set as supplemental groups. You may also specify a \(dq\&*\(dq\& as
+any extra ones be set as supplemental groups. You may also specify a "*" as
the first gid in the list, which will be replaced by all the normal groups for
-the transfer\(cq\&s user (see \(dq\&uid\(dq\&). The default when run by a super\-user is to
-switch to your OS\(cq\&s \(dq\&nobody\(dq\& (or perhaps \(dq\&nogroup\(dq\&) group with no other
+the transfer's user (see "uid"). The default when run by a super\-user is to
+switch to your OS's "nobody" (or perhaps "nogroup") group with no other
supplementary groups. The default for a non\-super\-user is to not change any
group attributes (and indeed, your OS may not allow a non\-super\-user to try to
change their group settings).
.IP
.IP "\fBfake super\fP"
-Setting \(dq\&fake super = yes\(dq\& for a module causes the
+Setting "fake super = yes" for a module causes the
daemon side to behave as if the \fB\-\-fake\-super\fP command\-line option had
been specified. This allows the full attributes of a file to be stored
without having to have the daemon actually running as root.
@@ -443,17 +443,17 @@
tampering with private administrative files, such as files you may add to
support uid/gid name translations.
.IP
-The daemon filter chain is built from the \(dq\&filter\(dq\&, \(dq\&include from\(dq\&, \(dq\&include\(dq\&,
-\(dq\&exclude from\(dq\&, and \(dq\&exclude\(dq\& parameters, in that order of priority. Anchored
+The daemon filter chain is built from the "filter", "include from", "include",
+"exclude from", and "exclude" parameters, in that order of priority. Anchored
patterns are anchored at the root of the module. To prevent access to an
-entire subtree, for example, \(dq\&/secret\(dq\&, you \fImust\fP exclude everything in the
+entire subtree, for example, "/secret", you \fImust\fP exclude everything in the
subtree; the easiest way to do this is with a triple\-star pattern like
-\(dq\&/secret/***\(dq\&.
+"/secret/***".
.IP
-The \(dq\&filter\(dq\& parameter takes a space\-separated list of daemon filter rules,
+The "filter" parameter takes a space\-separated list of daemon filter rules,
though it is smart enough to know not to split a token at an internal space in
-a rule (e.g. \(dq\&\- /foo \- /bar\(dq\& is parsed as two rules). You may specify one or
-more merge\-file rules using the normal syntax. Only one \(dq\&filter\(dq\& parameter can
+a rule (e.g. "\- /foo \- /bar" is parsed as two rules). You may specify one or
+more merge\-file rules using the normal syntax. Only one "filter" parameter can
apply to a given module in the config file, so put all the rules you want in a
single parameter. Note that per\-directory merge\-file rules do not provide as
much protection as global rules, but they can be used to make \fB\-\-delete\fP work
@@ -463,27 +463,27 @@
.IP "\fBexclude\fP"
This parameter takes a space\-separated list of daemon
exclude patterns. As with the client \fB\-\-exclude\fP option, patterns can be
-qualified with \(dq\&\- \(dq\& or \(dq\&+ \(dq\& to explicitly indicate exclude/include. Only one
-\(dq\&exclude\(dq\& parameter can apply to a given module. See the \(dq\&filter\(dq\& parameter
+qualified with "\- " or "+ " to explicitly indicate exclude/include. Only one
+"exclude" parameter can apply to a given module. See the "filter" parameter
for a description of how excluded files affect the daemon.
.IP
.IP "\fBinclude\fP"
-Use an \(dq\&include\(dq\& to override the effects of the \(dq\&exclude\(dq\&
-parameter. Only one \(dq\&include\(dq\& parameter can apply to a given module. See the
-\(dq\&filter\(dq\& parameter for a description of how excluded files affect the daemon.
+Use an "include" to override the effects of the "exclude"
+parameter. Only one "include" parameter can apply to a given module. See the
+"filter" parameter for a description of how excluded files affect the daemon.
.IP
.IP "\fBexclude from\fP"
This parameter specifies the name of a file
on the daemon that contains daemon exclude patterns, one per line. Only one
-\(dq\&exclude from\(dq\& parameter can apply to a given module; if you have multiple
-exclude\-from files, you can specify them as a merge file in the \(dq\&filter\(dq\&
-parameter. See the \(dq\&filter\(dq\& parameter for a description of how excluded files
+"exclude from" parameter can apply to a given module; if you have multiple
+exclude\-from files, you can specify them as a merge file in the "filter"
+parameter. See the "filter" parameter for a description of how excluded files
affect the daemon.
.IP
.IP "\fBinclude from\fP"
-Analogue of \(dq\&exclude from\(dq\& for a file of daemon include
-patterns. Only one \(dq\&include from\(dq\& parameter can apply to a given module. See
-the \(dq\&filter\(dq\& parameter for a description of how excluded files affect the
+Analogue of "exclude from" for a file of daemon include
+patterns. Only one "include from" parameter can apply to a given module. See
+the "filter" parameter for a description of how excluded files affect the
daemon.
.IP
.IP "\fBincoming chmod\fP"
@@ -514,23 +514,23 @@
this module. The usernames do not need to exist on the local
system. The rules may contain shell wildcard characters that will be matched
against the username provided by the client for authentication. If
-\(dq\&auth users\(dq\& is set then the client will be challenged to supply a
+"auth users" is set then the client will be challenged to supply a
username and password to connect to the module. A challenge response
authentication protocol is used for this exchange. The plain text
usernames and passwords are stored in the file specified by the
-\(dq\&secrets file\(dq\& parameter. The default is for all users to be able to
-connect without a password (this is called \(dq\&anonymous rsync\(dq\&).
+"secrets file" parameter. The default is for all users to be able to
+connect without a password (this is called "anonymous rsync").
.IP
-In addition to username matching, you can specify groupname matching via a \(cq\&@\(cq\&
+In addition to username matching, you can specify groupname matching via a '@'
prefix. When using groupname matching, the authenticating username must be a
real user on the system, or it will be assumed to be a member of no groups.
-For example, specifying \(dq\&@rsync\(dq\& will match the authenticating user if the
+For example, specifying "@rsync" will match the authenticating user if the
named user is a member of the rsync group.
.IP
Finally, options may be specified after a colon (:). The options allow you to
-\(dq\&deny\(dq\& a user or a group, set the access to \(dq\&ro\(dq\& (read\-only), or set the access
-to \(dq\&rw\(dq\& (read/write). Setting an auth\-rule\-specific ro/rw setting overrides
-the module\(cq\&s \(dq\&read only\(dq\& setting.
+"deny" a user or a group, set the access to "ro" (read\-only), or set the access
+to "rw" (read/write). Setting an auth\-rule\-specific ro/rw setting overrides
+the module's "read only" setting.
.IP
Be sure to put the rules in the order you want them to be matched, because the
checking stops at the first matching user or group, and that is the only auth
@@ -542,54 +542,54 @@
.IP
In the above rule, user joe will be denied access no matter what. Any user
-that is in the group \(dq\&guest\(dq\& is also denied access. The user \(dq\&admin\(dq\& gets
-access in read/write mode, but only if the admin user is not in group \(dq\&guest\(dq\&
+that is in the group "guest" is also denied access. The user "admin" gets
+access in read/write mode, but only if the admin user is not in group "guest"
(because the admin user\-matching rule would never be reached if the user is in
-group \(dq\&guest\(dq\&). Any other user who is in group \(dq\&rsync\(dq\& will get read\-only
+group "guest"). Any other user who is in group "rsync" will get read\-only
access. Finally, users susan, joe, and sam get the ro/rw setting of the
-module, but only if the user didn\(cq\&t match an earlier group\-matching rule.
+module, but only if the user didn't match an earlier group\-matching rule.
.IP
See the description of the secrets file for how you can have per\-user passwords
as well as per\-group passwords. It also explains how a user can authenticate
using their user password or (when applicable) a group password, depending on
what rule is being authenticated.
.IP
-See also the section entitled \(dq\&USING RSYNC\-DAEMON FEATURES VIA A REMOTE
-SHELL CONNECTION\(dq\& in \fBrsync\fP(1) for information on how handle an
+See also the section entitled "USING RSYNC\-DAEMON FEATURES VIA A REMOTE
+SHELL CONNECTION" in \fBrsync\fP(1) for information on how handle an
rsyncd.conf\-level username that differs from the remote\-shell\-level
username when using a remote shell to connect to an rsync daemon.
.IP
.IP "\fBsecrets file\fP"
This parameter specifies the name of a file that contains
the username:password and/or @groupname:password pairs used for authenticating
-this module. This file is only consulted if the \(dq\&auth users\(dq\& parameter is
+this module. This file is only consulted if the "auth users" parameter is
specified. The file is line\-based and contains one name:password pair per
line. Any line has a hash (#) as the very first character on the line is
considered a comment and is skipped. The passwords can contain any characters
but be warned that many operating systems limit the length of passwords that
can be typed at the client end, so you may find that passwords longer than 8
-characters don\(cq\&t work.
+characters don't work.
.IP
The use of group\-specific lines are only relevant when the module is being
-authorized using a matching \(dq\&@groupname\(dq\& rule. When that happens, the user
-can be authorized via either their \(dq\&username:password\(dq\& line or the
-\(dq\&@groupname:password\(dq\& line for the group that triggered the authentication.
+authorized using a matching "@groupname" rule. When that happens, the user
+can be authorized via either their "username:password" line or the
+"@groupname:password" line for the group that triggered the authentication.
.IP
It is up to you what kind of password entries you want to include, either
-users, groups, or both. The use of group rules in \(dq\&auth users\(dq\& does not
+users, groups, or both. The use of group rules in "auth users" does not
require that you specify a group password if you do not want to use shared
passwords.
.IP
-There is no default for the \(dq\&secrets file\(dq\& parameter, you must choose a name
+There is no default for the "secrets file" parameter, you must choose a name
(such as \f(CW/etc/rsyncd.secrets\fP). The file must normally not be readable
-by \(dq\&other\(dq\&; see \(dq\&strict modes\(dq\&. If the file is not found or is rejected, no
-logins for a \(dq\&user auth\(dq\& module will be possible.
+by "other"; see "strict modes". If the file is not found or is rejected, no
+logins for a "user auth" module will be possible.
.IP
.IP "\fBstrict modes\fP"
This parameter determines whether or not
-the permissions on the secrets file will be checked. If \(dq\&strict modes\(dq\& is
+the permissions on the secrets file will be checked. If "strict modes" is
true, then the secrets file must not be readable by any user ID other
-than the one that the rsync daemon is running under. If \(dq\&strict modes\(dq\& is
+than the one that the rsync daemon is running under. If "strict modes" is
false, the check is not performed. The default is true. This parameter
was added to accommodate rsync running on the Windows operating system.
.IP
@@ -604,7 +604,7 @@
.RS
.IP o
a dotted decimal IPv4 address of the form a.b.c.d, or an IPv6 address
-of the form a:b:c::d:e:f. In this case the incoming machine\(cq\&s IP address
+of the form a:b:c::d:e:f. In this case the incoming machine's IP address
must match exactly.
.IP o
an address/mask in the form ipaddr/n where ipaddr is the IP address
@@ -619,11 +619,11 @@
a hostname pattern using wildcards. If the hostname of the connecting IP
(as determined by a reverse lookup) matches the wildcarded name (using the
same rules as normal unix filename matching), the client is allowed in. This
-only works if \(dq\&reverse lookup\(dq\& is enabled (the default).
+only works if "reverse lookup" is enabled (the default).
.IP o
a hostname. A plain hostname is matched against the reverse DNS of the
-connecting IP (if \(dq\&reverse lookup\(dq\& is enabled), and/or the IP of the given
-hostname is matched against the connecting IP (if \(dq\&forward lookup\(dq\& is
+connecting IP (if "reverse lookup" is enabled), and/or the IP of the given
+hostname is matched against the connecting IP (if "forward lookup" is
enabled, as it is by default). Any match will be allowed in.
.RE
@@ -640,31 +640,31 @@
.RE
.IP
-You can also combine \(dq\&hosts allow\(dq\& with a separate \(dq\&hosts deny\(dq\&
-parameter. If both parameters are specified then the \(dq\&hosts allow\(dq\& parameter is
+You can also combine "hosts allow" with a separate "hosts deny"
+parameter. If both parameters are specified then the "hosts allow" parameter is
checked first and a match results in the client being able to
-connect. The \(dq\&hosts deny\(dq\& parameter is then checked and a match means
+connect. The "hosts deny" parameter is then checked and a match means
that the host is rejected. If the host does not match either the
-\(dq\&hosts allow\(dq\& or the \(dq\&hosts deny\(dq\& patterns then it is allowed to
+"hosts allow" or the "hosts deny" patterns then it is allowed to
connect.
.IP
-The default is no \(dq\&hosts allow\(dq\& parameter, which means all hosts can connect.
+The default is no "hosts allow" parameter, which means all hosts can connect.
.IP
.IP "\fBhosts deny\fP"
This parameter allows you to specify a
list of patterns that are matched against a connecting clients
hostname and IP address. If the pattern matches then the connection is
-rejected. See the \(dq\&hosts allow\(dq\& parameter for more information.
+rejected. See the "hosts allow" parameter for more information.
.IP
-The default is no \(dq\&hosts deny\(dq\& parameter, which means all hosts can connect.
+The default is no "hosts deny" parameter, which means all hosts can connect.
.IP
.IP "\fBreverse lookup\fP"
Controls whether the daemon performs a reverse lookup
-on the client\(cq\&s IP address to determine its hostname, which is used for
-\(dq\&hosts allow\(dq\&/\(dq\&hosts deny\(dq\& checks and the \(dq\&%h\(dq\& log escape. This is enabled by
+on the client's IP address to determine its hostname, which is used for
+"hosts allow"/"hosts deny" checks and the "%h" log escape. This is enabled by
default, but you may wish to disable it to save time if you know the lookup will
not return a useful result, in which case the daemon will use the name
-\(dq\&UNDETERMINED\(dq\& instead.
+"UNDETERMINED" instead.
.IP
If this parameter is enabled globally (even by default), rsync performs the
lookup as soon as a client connects, so disabling it for a module will not
@@ -690,7 +690,7 @@
This tells the rsync daemon to completely
ignore files that are not readable by the user. This is useful for
public archives that may have some non\-readable files among the
-directories, and the sysadmin doesn\(cq\&t want those files to be seen at all.
+directories, and the sysadmin doesn't want those files to be seen at all.
.IP
.IP "\fBtransfer logging\fP"
This parameter enables per\-file
@@ -698,7 +698,7 @@
used by ftp daemons. The daemon always logs the transfer at the end, so
if a transfer is aborted, no mention will be made in the log file.
.IP
-If you want to customize the log lines, see the \(dq\&log format\(dq\& parameter.
+If you want to customize the log lines, see the "log format" parameter.
.IP
.IP "\fBlog format\fP"
This parameter allows you to specify the
@@ -706,17 +706,17 @@
The format is a text string containing embedded single\-character escape
sequences prefixed with a percent (%) character. An optional numeric
field width may also be specified between the percent and the escape
-letter (e.g. \(dq\&\fB%\-50n %8l %07p\fP\(dq\&).
+letter (e.g. "\fB%\-50n %8l %07p\fP").
In addition, one or more apostrophes may be specified prior to a numerical
escape to indicate that the numerical value should be made more human\-readable.
The 3 supported levels are the same as for the \fB\-\-human\-readable\fP
command\-line option, though the default is for human\-readability to be off.
-Each added apostrophe increases the level (e.g. \(dq\&\fB%'\&'\&l %'\&b %f\fP\(dq\&).
+Each added apostrophe increases the level (e.g. "\fB%''l %'b %f\fP").
.IP
-The default log format is \(dq\&%o %h [%a] %m (%u) %f %l\(dq\&, and a \(dq\&%t [%p] \(dq\&
-is always prefixed when using the \(dq\&log file\(dq\& parameter.
+The default log format is "%o %h [%a] %m (%u) %f %l", and a "%t [%p] "
+is always prefixed when using the "log file" parameter.
(A perl script that will summarize this default log format is included
-in the rsync source code distribution in the \(dq\&support\(dq\& subdirectory:
+in the rsync source code distribution in the "support" subdirectory:
rsyncstats.)
.IP
The single\-character escapes that are understood are as follows:
@@ -733,9 +733,9 @@
.IP o
%C the full\-file MD5 checksum if \fB\-\-checksum\fP is enabled or a file was transferred (only for protocol 30 or above).
.IP o
-%f the filename (long form on sender; no trailing \(dq\&/\(dq\&)
+%f the filename (long form on sender; no trailing "/")
.IP o
-%G the gid of the file (decimal) or \(dq\&DEFAULT\(dq\&
+%G the gid of the file (decimal) or "DEFAULT"
.IP o
%h the remote host name (only available for a daemon)
.IP o
@@ -743,15 +743,15 @@
.IP o
%l the length of the file in bytes
.IP o
-%L the string \(dq\& \-> SYMLINK\(dq\&, \(dq\& => HARDLINK\(dq\&, or \(dq\&\(dq\& (where \fBSYMLINK\fP or \fBHARDLINK\fP is a filename)
+%L the string " \-> SYMLINK", " => HARDLINK", or "" (where \fBSYMLINK\fP or \fBHARDLINK\fP is a filename)
.IP o
%m the module name
.IP o
%M the last\-modified time of the file
.IP o
-%n the filename (short form; trailing \(dq\&/\(dq\& on dir)
+%n the filename (short form; trailing "/" on dir)
.IP o
-%o the operation, which is \(dq\&send\(dq\&, \(dq\&recv\(dq\&, or \(dq\&del.\(dq\& (the latter includes the trailing period)
+%o the operation, which is "send", "recv", or "del." (the latter includes the trailing period)
.IP o
%p the process ID of this rsync session
.IP o
@@ -765,7 +765,7 @@
.RE
.IP
-For a list of what the characters mean that are output by \(dq\&%i\(dq\&, see the
+For a list of what the characters mean that are output by "%i", see the
\fB\-\-itemize\-changes\fP option in the rsync manpage.
.IP
Note that some of the logged output changes when talking with older
@@ -775,7 +775,7 @@
.IP "\fBtimeout\fP"
This parameter allows you to override the
clients choice for I/O timeout for this module. Using this parameter you
-can ensure that rsync won\(cq\&t wait on a dead client forever. The timeout
+can ensure that rsync won't wait on a dead client forever. The timeout
is specified in seconds. A value of zero means no timeout and is the
default. A good choice for anonymous rsync daemons may be 600 (giving
a 10 minute timeout).
@@ -796,15 +796,15 @@
.IP
The reason the above refuses all delete options is that the options imply
\fB\-\-delete\fP, and implied options are refused just like explicit options.
-As an additional safety feature, the refusal of \(dq\&delete\(dq\& also refuses
+As an additional safety feature, the refusal of "delete" also refuses
\fBremove\-source\-files\fP when the daemon is the sender; if you want the latter
-without the former, instead refuse \(dq\&delete\-*\(dq\& \-\- that refuses all the
+without the former, instead refuse "delete\-*" \-\- that refuses all the
delete modes without affecting \fB\-\-remove\-source\-files\fP.
.IP
When an option is refused, the daemon prints an error message and exits.
To prevent all compression when serving files,
-you can use \(dq\&dont compress = *\(dq\& (see below)
-instead of \(dq\&refuse options = compress\(dq\& to avoid returning an error to a
+you can use "dont compress = *" (see below)
+instead of "refuse options = compress" to avoid returning an error to a
client that requests compression.
.IP
.IP "\fBdont compress\fP"
@@ -813,16 +813,16 @@
when pulling files from the daemon (no analogous parameter exists to
govern the pushing of files to a daemon).
Compression is expensive in terms of CPU usage, so it
-is usually good to not try to compress files that won\(cq\&t compress well,
+is usually good to not try to compress files that won't compress well,
such as already compressed files.
.IP
-The \(dq\&dont compress\(dq\& parameter takes a space\-separated list of
+The "dont compress" parameter takes a space\-separated list of
case\-insensitive wildcard patterns. Any source filename matching one
of the patterns will not be compressed during transfer.
.IP
See the \fB\-\-skip\-compress\fP parameter in the \fBrsync\fP(1) manpage for the list
of file suffixes that are not compressed by default. Specifying a value
-for the \(dq\&dont compress\(dq\& parameter changes the default when the daemon is
+for the "dont compress" parameter changes the default when the daemon is
the sender.
.IP
.IP "\fBpre\-xfer exec\fP, \fBpost\-xfer exec\fP"
@@ -831,7 +831,7 @@
transfer is aborted before it begins. Any output from the script on stdout (up
to several KB) will be displayed to the user when aborting, but is NOT
displayed if the script returns success. Any output from the script on stderr
-goes to the daemon\(cq\&s stderr, which is typically discarded (though see
+goes to the daemon's stderr, which is typically discarded (though see
\-\-no\-detatch option for a way to see the stderr output, which can assist with
debugging).
.IP
@@ -844,26 +844,26 @@
.IP o
\fBRSYNC_MODULE_PATH\fP: The path configured for the module.
.IP o
-\fBRSYNC_HOST_ADDR\fP: The accessing host\(cq\&s IP address.
+\fBRSYNC_HOST_ADDR\fP: The accessing host's IP address.
.IP o
-\fBRSYNC_HOST_NAME\fP: The accessing host\(cq\&s name.
+\fBRSYNC_HOST_NAME\fP: The accessing host's name.
.IP o
-\fBRSYNC_USER_NAME\fP: The accessing user\(cq\&s name (empty if no user).
+\fBRSYNC_USER_NAME\fP: The accessing user's name (empty if no user).
.IP o
\fBRSYNC_PID\fP: A unique number for this transfer.
.IP o
\fBRSYNC_REQUEST\fP: (pre\-xfer only) The module/path info specified
by the user. Note that the user can specify multiple source files,
-so the request can be something like \(dq\&mod/path1 mod/path2\(dq\&, etc.
+so the request can be something like "mod/path1 mod/path2", etc.
.IP o
\fBRSYNC_ARG#\fP: (pre\-xfer only) The pre\-request arguments are set
-in these numbered values. RSYNC_ARG0 is always \(dq\&rsyncd\(dq\&, followed by
+in these numbered values. RSYNC_ARG0 is always "rsyncd", followed by
the options that were used in RSYNC_ARG1, and so on. There will be a
-value of \(dq\&.\(dq\& indicating that the options are done and the path args
+value of "." indicating that the options are done and the path args
are beginning \-\- these contain similar information to RSYNC_REQUEST,
but with values separated and the module name stripped off.
.IP o
-\fBRSYNC_EXIT_STATUS\fP: (post\-xfer only) the server side\(cq\&s exit value.
+\fBRSYNC_EXIT_STATUS\fP: (post\-xfer only) the server side's exit value.
This will be 0 for a successful run, a positive value for an error that the
server generated, or a \-1 if rsync failed to exit properly. Note that an
error that occurs on the client side does not currently get sent to the
@@ -877,7 +877,7 @@
.IP
Even though the commands can be associated with a particular module, they
are run using the permissions of the user that started the daemon (not the
-module\(cq\&s uid/gid setting) without any chroot restrictions.
+module's uid/gid setting) without any chroot restrictions.
.IP
.SH "CONFIG DIRECTIVES"
@@ -885,14 +885,14 @@
There are currently two config directives available that allow a config file to
incorporate the contents of other files: \fB&include\fP and \fB&merge\fP. Both
allow a reference to either a file or a directory. They differ in how
-segregated the file\(cq\&s contents are considered to be.
+segregated the file's contents are considered to be.
.PP
The \fB&include\fP directive treats each file as more distinct, with each one
inheriting the defaults of the parent file, starting the parameter parsing
as globals/defaults, and leaving the defaults unchanged for the parsing of
the rest of the parent file.
.PP
-The \fB&merge\fP directive, on the other hand, treats the file\(cq\&s contents as
+The \fB&merge\fP directive, on the other hand, treats the file's contents as
if it were simply inserted in place of the directive, and thus it can set
parameters in a module started in another file, can affect the defaults for
other files, etc.
@@ -901,8 +901,8 @@
in all the \fB*.conf\fP or \fB*.inc\fP files (respectively) that are contained inside
that directory (without any
recursive scanning), with the files sorted into alpha order. So, if you have a
-directory named \(dq\&rsyncd.d\(dq\& with the files \(dq\&foo.conf\(dq\&, \(dq\&bar.conf\(dq\&, and
-\(dq\&baz.conf\(dq\& inside it, this directive:
+directory named "rsyncd.d" with the files "foo.conf", "bar.conf", and
+"baz.conf" inside it, this directive:
.PP
.nf
&include /path/rsyncd.d