Ignore generated files and dirs.
[rsync/rsync.git] / rsyncd.conf.yo
index 4c713a3..d442a27 100644 (file)
@@ -1,5 +1,5 @@
 mailto(rsync-bugs@samba.org)
-manpage(rsyncd.conf)(5)(11 Oct 2006)()()
+manpage(rsyncd.conf)(5)(8 Nov 2007)()()
 manpagename(rsyncd.conf)(configuration file for rsync in daemon mode)
 manpagesynopsis()
 
@@ -17,7 +17,7 @@ manpagesection(FILE FORMAT)
 
 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 'name = value'.
+module begins. Modules contain parameters of the form "name = value".
 
 The file is line-based -- that is, each newline-terminated line represents
 either a comment, a module name or a parameter.
@@ -85,7 +85,8 @@ usually contains site information and any legal notices. The default
 is no motd file.
 
 dit(bf(pid file)) The "pid file" option tells the rsync daemon to write
-its process ID to that file.
+its process ID to that file.  If the file already exists, the rsync
+daemon will abort rather than overwrite the file.
 
 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
@@ -149,7 +150,7 @@ Note that you are free to setup user/group information in the chroot area
 differently from your normal system.  For example, you could abbreviate
 the list of users and groups.  Also, you can protect this information from
 being downloaded/uploaded by adding an exclude rule to the rsyncd.conf file
-(e.g. "exclude = /etc/**").  Note that having the exclusion affect uploads
+(e.g. "bf(exclude = /etc/**)").  Note that having the exclusion affect uploads
 is a relatively new feature in rsync, so make sure your daemon is
 at least 2.6.3 to effect this.  Also note that it is safest to exclude a
 directory and all its contents combining the rule "/some/dir/" with the
@@ -161,7 +162,8 @@ sure).
 dit(bf(max connections)) The "max connections" option allows you to
 specify the maximum number of simultaneous connections you will allow.
 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.
+message telling them to try later.  The default is 0, which means no limit.
+A negative value disables the module.
 See also the "lock file" option.
 
 dit(bf(log file)) When the "log file" option is set to a non-empty
@@ -226,6 +228,11 @@ file transfers to and from that module should take place as when the daemon
 was run as root. This complements the "uid" option. The default is gid -2,
 which is normally the group "nobody".
 
+dit(bf(fake super)) Setting "fake super = yes" for a module causes the
+daemon side to behave as if the bf(--fake-user) 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.
+
 dit(bf(filter)) The "filter" option allows you to specify a space-separated
 list of filter rules that the daemon will not allow to be read or written.
 This is only superficially equivalent to the client specifying these
@@ -402,7 +409,7 @@ format used for logging file transfers when transfer logging is enabled.
 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. "%-50n %8l %07p").
+letter (e.g. "bf(%-50n %8l %07p)").
 
 The default log format is "%o %h [%a] %m (%u) %f %l", and a "%t [%p] "
 is always prefixed when using the "log file" option.
@@ -483,7 +490,10 @@ The "dont compress" option takes a space-separated list of
 case-insensitive wildcard patterns. Any source filename matching one
 of the patterns will not be compressed during transfer.
 
-The default setting is tt(*.gz *.tgz *.zip *.z *.rpm *.deb *.iso *.bz2 *.tbz)
+See the bf(--skip-compress) option in the bf(rsync)(1) manpage for the list
+of file suffixes that are not compressed by default.  Specifying a value
+for the bf(dont compress) option changes the default when the daemon is
+the sender.
 
 dit(bf(pre-xfer exec), bf(post-xfer exec)) You may specify a command to be run
 before and/or after the transfer.  If the bf(pre-xfer exec) command fails, the
@@ -604,7 +614,7 @@ url(http://rsync.samba.org/)(http://rsync.samba.org/)
 
 manpagesection(VERSION)
 
-This man page is current for version 2.6.9pre1 of rsync.
+This man page is current for version 3.0.0pre5 of rsync.
 
 manpagesection(CREDITS)