Give the user an idea of how far along in the transfer we are
[rsync/rsync.git] / rsyncd.conf.yo
index a035b90..71ca460 100644 (file)
@@ -1,5 +1,5 @@
 mailto(rsync-bugs@samba.org)
-manpage(rsyncd.conf)(5)(26 Jan 2003)()()
+manpage(rsyncd.conf)(5)(1 Jan 2004)()()
 manpagename(rsyncd.conf)(configuration file for rsync server)
 manpagesynopsis()
 
@@ -176,15 +176,17 @@ was run as root. This complements the "uid" option. The default is gid -2,
 which is normally the group "nobody".
 
 dit(bf(exclude)) The "exclude" option allows you to specify a space
-separated list of patterns to add to the exclude list. This is equivalent
-to the client specifying these patterns with the --exclude option, except
-that the exclude list is not passed to the client and thus only applies on
+separated list of patterns to add to the exclude list.
+This is only superficially equivalent
+to the client specifying these patterns with the --exclude option.
+Only one "exclude" option may be specified, but
+you can use "-" and "+" before patterns to specify exclude/include.
+
+Because this exclude list is not passed to the client it only applies on
 the server: that is, it excludes files received by a client when receiving
 from a server and files deleted on a server when sending to a server, but
 it doesn't exclude files sent from a client when sending to a server or
 files deleted on a client when receiving from a server.  
-Only one "exclude" option may be specified, but
-you can use "-" and "+" before patterns to specify exclude/include.
 
 Note that this option is not designed with strong security in
 mind, it is quite possible that a client may find a way to bypass this
@@ -193,24 +195,25 @@ cannot be accessed then use the uid/gid options in combination with
 file permissions.
 
 dit(bf(exclude from)) The "exclude from" option specifies a filename
-on the server that contains exclude patterns, one per line. This is
-equivalent to the client specifying the --exclude-from option with a
-equivalent file except that it applies only on the server.  See also
-the "exclude" option above.
+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.
+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
-equivalent to the client specifying these patterns with the --include
-option except that it applies only on the server.  This is useful as it
+only superficially equivalent to the client specifying these patterns
+with the --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 also the "exclude" option above.
+patterns to switch include/exclude.  See the "exclude" option above.
 
 dit(bf(include from)) The "include from" option specifies a filename
 on the server that contains include patterns, one per line. This is
-equivalent to the client specifying the --include-from option with a
-equivalent file except that it applies only on the server.  See also
-the "exclude" option above.
+only superficially equivalent to the client specifying the
+--include-from option with a equivalent file.
+See the "exclude" option above.
 
 dit(bf(auth users)) The "auth users" option specifies a comma and
 space separated list of usernames that will be allowed to connect to
@@ -396,6 +399,32 @@ encryption.
 Future versions of rsync may support SSL for better authentication and
 encryption, but that is still being investigated.
 
+manpagesection(RUNNING AN RSYNC SERVER OVER A REMOTE SHELL PROGRAM)
+
+If rsync is run with both the --daemon and --rsh (-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
+inetd or the services map to include the rsync server port if you run an
+rsync server only via a remote shell program.
+
+ADVANCED: To run an rsync server out of a single-use ssh key, use the
+"command=em(COMMAND)" syntax in the remote user's authorized_keys entry,
+where command would be
+
+quote(rsync --server --daemon .)
+
+NOTE: rsync's argument parsing expects the trailing ".", so make sure
+that it's there.  If you want to use a rsyncd.conf(5)-style
+configuration file other than the default, you can added a
+--config option to the em(command):
+
+quote(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.
+
 manpagesection(EXAMPLES)
 
 A simple rsyncd.conf file that allow anonymous rsync to a ftp area at
@@ -465,7 +494,7 @@ Please report bugs! The rsync bug tracking system is online at
 url(http://rsync.samba.org/)(http://rsync.samba.org/)
 
 manpagesection(VERSION)
-This man page is current for version 2.0 of rsync
+This man page is current for version 2.x of rsync.
 
 manpagesection(CREDITS)