name of the module in square brackets and continues until the next
module begins. Modules contain parameters of the form 'name = value'.
-The file is line-based - that is, each newline-terminated line represents
+The file is line-based -- that is, each newline-terminated line represents
either a comment, a module name or a parameter.
Only the first equals sign in a parameter is significant. Whitespace before
manpagesection(LAUNCHING THE RSYNC DAEMON)
-The rsync daemon is launched by specifying the --daemon option to
+The rsync daemon is launched by specifying the bf(--daemon) option to
rsync.
The daemon must run with root privileges if you wish to use chroot, to
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 "rsync --daemon" from a suitable startup script.
+just run the command "bf(rsync --daemon)" from a suitable startup script.
If run from an rsync client via a remote shell (by specifying both the
-"-e/--rsh" option and server mode with "::" or "rsync://"), the --daemon
+bf(--rsh) (bf(-e)) option and server mode with "::" or "rsync://"), the bf(--daemon)
option is automatically passed to the remote side.
When run via inetd you should add a line like this to /etc/services:
-quote(rsync 873/tcp)
+verb( rsync 873/tcp)
and a single line something like this to /etc/inetd.conf:
-quote(rsync stream tcp nowait root /usr/bin/rsync rsyncd --daemon)
+verb( rsync stream tcp nowait root /usr/bin/rsync rsyncd --daemon)
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
(see below). When "use chroot" is false, for security reasons,
symlinks may only be relative paths pointing to other files within the root
path, and leading slashes are removed from most absolute paths (options
-such as --backup-dir, --compare-dest, etc. interpret an absolute path as
+such as bf(--backup-dir), bf(--compare-dest), etc. interpret an absolute path as
rooted in the module's "path" dir, just as if chroot was specified).
The default for "use chroot" is true.
process in the chroot namespace will need to have access to the resources
used by these library functions (traditionally /etc/passwd and
/etc/group). If these resources are not available, rsync will only be
-able to copy the IDs, just as if the --numeric-ids option had been
+able to copy the IDs, just as if the bf(--numeric-ids) option had been
specified.
Note that you are free to setup user/group information in the chroot area
dit(bf(port)) You can override the default port the daemon will listen on
by specifying this value (defaults to 873). This is ignored if the daemon
-is being run by inetd, and is superseded by the --port command-line option.
+is being run by inetd, and is superseded by the bf(--port) command-line option.
dit(bf(address)) You can override the default IP address the daemon
will listen on by specifying this value. This is ignored if the daemon is
-being run by inetd, and is superseded by the --address command-line option.
+being run by inetd, and is superseded by the bf(--address) command-line option.
dit(bf(max connections)) The "max connections" option allows you to
specify the maximum number of simultaneous connections you will allow.
dit(bf(filter)) The "filter" option allows you to specify a space-separated
list of filter rules that the server will not allow to be read or written.
This is only superficially equivalent to the client specifying these
-patterns with the --filter option. Only one "filter" option may be
+patterns with the bf(--filter) option. Only one "filter" option may be
specified, but it may contain as many rules as you like, including
merge-file rules. Note that per-directory merge-file rules do not provide
-as much protection as global rules, but they can be used to make --delete
+as much protection as global rules, but they can be used to make bf(--delete)
work better when a client downloads the server's files (if the per-dir
merge files are included in the transfer).
dit(bf(exclude)) The "exclude" option allows you to specify a
space-separated list of patterns that the server will not allow to be read
or written. This is only superficially equivalent to the client
-specifying these patterns with the --exclude option. Only one "exclude"
+specifying these patterns with the bf(--exclude) option. Only one "exclude"
option may be specified, but you can use "-" and "+" before patterns to
specify exclude/include.
dit(bf(exclude from)) The "exclude from" option specifies a filename
on the server that contains exclude patterns, one per line.
This is only superficially equivalent
-to the client specifying the --exclude-from option with an equivalent file.
+to the client specifying the bf(--exclude-from) option with an equivalent file.
See the "exclude" option above.
dit(bf(include)) The "include" option allows you to specify a
space-separated list of patterns which rsync should not exclude. This is
only superficially equivalent to the client specifying these patterns with
-the --include option because it applies only on the server. This is
+the bf(--include) option because it applies only on the server. This is
useful as it allows you to build up quite complex exclude/include rules.
Only one "include" option may be specified, but you can use "+" and "-"
before patterns to switch include/exclude. See the "exclude" option
dit(bf(include from)) The "include from" option specifies a filename
on the server that contains include patterns, one per line. This is
only superficially equivalent to the client specifying the
---include-from option with a equivalent file.
+bf(--include-from) option with a equivalent file.
See the "exclude" option above.
dit(bf(auth users)) The "auth users" option specifies a comma and
Each pattern can be in one of five forms:
-itemize(
+quote(itemize(
it() 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's IP address
must match exactly.
-
it() an address/mask in the form ipaddr/n where ipaddr is the IP address
and n is the number of one bits in the netmask. All IP addresses which
match the masked IP address will be allowed in.
-
it() an address/mask in the form ipaddr/maskaddr where ipaddr is the
IP address and maskaddr is the netmask in dotted decimal notation for IPv4,
or similar for IPv6, e.g. ffff:ffff:ffff:ffff:: instead of /64. All IP
addresses which match the masked IP address will be allowed in.
-
it() a hostname. The hostname as determined by a reverse lookup will
be matched (case insensitive) against the pattern. Only an exact
match is allowed in.
-
it() a hostname pattern using wildcards. These are matched using the
same rules as normal unix filename matching. If the pattern matches
then the client is allowed in.
-)
+))
Note IPv6 link-local addresses can have a scope in the address specification:
-quote(fe80::1%link1)
-quote(fe80::%link1/64)
-quote(fe80::%link1/ffff:ffff:ffff:ffff::)
+quote(
+tt( fe80::1%link1)nl()
+tt( fe80::%link1/64)nl()
+tt( fe80::%link1/ffff:ffff:ffff:ffff::)nl()
+)
You can also combine "hosts allow" with a separate "hosts deny"
option. If both options are specified then the "hosts allow" option s
dit(bf(ignore errors)) The "ignore errors" option tells rsyncd to
ignore I/O errors on the server when deciding whether to run the delete
-phase of the transfer. Normally rsync skips the --delete step if any
+phase of the transfer. Normally rsync skips the bf(--delete) step if any
I/O errors have occurred in order to prevent disastrous deletion due
to a temporary resource shortage or other I/O error. In some cases this
test is counter productive so you can use this option to turn off this
The prefixes that are understood are:
-itemize(
+quote(itemize(
it() %h for the remote host name
it() %a for the remote IP address
it() %l for the length of the file in bytes
it() %b for the number of bytes actually transferred
it() %c when sending files this gives the number of checksum bytes
received for this file
-)
+))
The default log format is "%o %h [%a] %m (%u) %f %l", and a "%t [%p] "
is always added to the beginning when using the "log file" option.
be refused by your rsync server.
You may specify the full option name, its one-letter abbreviation, or a
wild-card string that matches multiple options.
-For example, this would refuse --checksum (-c) and all the options that
+For example, this would refuse bf(--checksum) (bf(-c)) and all the options that
start with "delete":
-quote(refuse options = c delete*)
+quote(tt( refuse options = c delete*))
When an option is refused, the server prints an error message and exits.
To prevent all compression, you can use "dont compress = *" (see below)
instead of "refuse options = compress" to avoid returning an error to a
client that requests compression.
-Note that rsync's --del option is implemented as a popt alias, so there
+Note that rsync's bf(--del) option is implemented as a popt alias, so there
is no need (an indeed, no way) to refuse "del" by name -- just matching
-the --delete-during option (e.g. "delete*") will refuse --del as well.
+the bf(--delete-during) option (e.g. "delete*") will refuse bf(--del) as well.
dit(bf(dont compress)) The "dont compress" option allows you to select
filenames based on wildcard patterns that should not be compressed
case-insensitive wildcard patterns. Any source filename matching one
of the patterns will not be compressed during transfer.
-The default setting is verb(*.gz *.tgz *.zip *.z *.rpm *.deb *.iso *.bz2 *.tbz)
+The default setting is tt(*.gz *.tgz *.zip *.z *.rpm *.deb *.iso *.bz2 *.tbz)
enddit()
manpagesection(RUNNING AN RSYNC SERVER OVER A REMOTE SHELL PROGRAM)
-If rsync is run with both the --daemon and --rsh (-e) options, it will
+If rsync is run with both the bf(--daemon) and bf(--rsh) (bf(-e)) options, it will
spawn an rsync daemon using a remote shell connection. Several
configuration options will not be available unless the remote user is
root (e.g. chroot, setuid/setgid, etc.). There is no need to configure
"command=em(COMMAND)" syntax in the remote user's authorized_keys entry,
where command would be
-quote(rsync --server --daemon .)
+quote(tt(rsync --server --daemon .))
NOTE: rsync's argument parsing expects the trailing ".", so make sure
that it's there. If you want to use an rsyncd.conf(5)-style
configuration file other than the default, you can added a
---config option to the em(command):
+bf(--config) option to the em(command):
-quote(rsync --server --daemon --config=em(file) .)
+quote(tt(rsync --server --daemon --config=em(file) .))
Note that the "--server" here is the internal option that rsync uses to
run the remote version of rsync that it communicates with, and thus you
-should not be using the --server option under normal circumstances.
+should not be using the bf(--server) option under normal circumstances.
manpagesection(EXAMPLES)
comment = ftp export area
)
-
A more sophisticated example would be:
-uid = nobody nl()
-gid = nobody nl()
-use chroot = no nl()
-max connections = 4 nl()
-syslog facility = local5 nl()
+verb(
+uid = nobody
+gid = nobody
+use chroot = no
+max connections = 4
+syslog facility = local5
pid file = /var/run/rsyncd.pid
-verb([ftp]
+[ftp]
path = /var/ftp/pub
comment = whole ftp area (approx 6.1 GB)
The /etc/rsyncd.secrets file would look something like this:
-tridge:mypass nl()
-susan:herpass
+quote(
+tt(tridge:mypass)nl()
+tt(susan:herpass)nl()
+)
manpagefiles()
Matt McCutchen's Web Site / rsync / rsync.git / blobdiff