--- a/components/rsync/patches/rsync.1.patch Sun Apr 06 17:51:44 2014 -0700
+++ b/components/rsync/patches/rsync.1.patch Mon Apr 07 12:48:54 2014 -0700
@@ -1,122 +1,66 @@
---- rsync-3.0.9/rsync.1.orig 2011-09-23 09:42:26.000000000 -0700
-+++ rsync-3.0.9/rsync.1 2013-04-19 14:14:00.348176963 -0700
[email protected]@ -1,6 +1,6 @@
- .TH "rsync" "1" "23 Sep 2011" "" ""
- .SH "NAME"
--rsync \- a fast, versatile, remote (and local) file\-copying tool
-+rsync \(em a fast, versatile, remote (and local) file-copying tool
- .SH "SYNOPSIS"
-
- .PP
[email protected]@ -29,30 +29,30 @@
- copy locally, to/from another host over any remote shell, or to/from a
- remote rsync daemon. It offers a large number of options that control
- every aspect of its behavior and permit very flexible specification of the
--set of files to be copied. It is famous for its delta\-transfer algorithm,
-+set of files to be copied. It is famous for its delta-transfer algorithm,
- which reduces the amount of data sent over the network by sending only the
- differences between the source files and the existing files in the
+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.0/rsync.1.orig Sat Sep 28 20:01:03 2013
++++ rsync-3.1.0/rsync.1 Mon Mar 17 15:51:13 2014
[email protected]@ -35,11 +35,11 @@
destination. Rsync is widely used for backups and mirroring and as an
improved copy command for everyday use.
.PP
-Rsync finds files that need to be transferred using a \(dq\&quick check\(dq\&
-+Rsync finds files that need to be transferred using a \(lqquick check\(rq
++Rsync finds files that need to be transferred using a "quick check"
algorithm (by default) that looks for files that have changed in size or
--in last\-modified time. Any changes in the other preserved attributes (as
-+in last-modified time. Any changes in the other preserved attributes (as
+ in last\-modified time. Any changes in the other preserved attributes (as
requested by options) are made on the destination file directly when the
-quick check indicates that the file\(cq\&s data does not need to be updated.
+quick check indicates that the file's data does not need to be updated.
.PP
Some of the additional features of rsync are:
.PP
- .IP o
- support for copying links, devices, owners, groups, and permissions
- .IP o
--exclude and exclude\-from options similar to GNU tar
-+exclude and exclude-from options similar to GNU tar
- .IP o
- a CVS exclude mode for ignoring the same files that CVS would ignore
- .IP o
- can use any transparent remote shell, including ssh or rsh
- .IP o
--does not require super\-user privileges
-+does not require super-user privileges
- .IP o
- pipelining of file transfers to minimize latency costs
- .IP o
[email protected]@ -67,24 +67,25 @@
- current host (it does not support copying files between two remote hosts).
- .PP
- There are two different ways for rsync to contact a remote system: using a
--remote\-shell program as the transport (such as ssh or rsh) or contacting an
--rsync daemon directly via TCP. The remote\-shell transport is used whenever
-+remote-shell program as the transport (such as ssh or rsh) or contacting an
-+rsync daemon directly via TCP. The remote-shell transport is used whenever
- the source or destination path contains a single colon (:) separator after
[email protected]@ -73,17 +73,17 @@
a host specification. Contacting an rsync daemon directly happens when the
source or destination path contains a double colon (::) separator after a
host specification, OR when an rsync:// URL is specified (see also the
-\(dq\&USING RSYNC\-DAEMON FEATURES VIA A REMOTE\-SHELL CONNECTION\(dq\& section for
-+\(lqUSING RSYNC-DAEMON FEATURES VIA A REMOTE-SHELL CONNECTION\(rq section for
-+\(lqUSING RSYNC-DAEMON FEATURES VIA A REMOTE-SHELL CONNECTION\(rq section for
++"USING RSYNC\-DAEMON FEATURES VIA A REMOTE\-SHELL CONNECTION" section for
an exception to this latter rule).
.PP
As a special case, if a single source arg is specified without a
-destination, the files are listed in an output format similar to \(dq\&ls \-l\(dq\&.
-+destination, the files are listed in an output format similar to \(lqls \-l\(rq.
++destination, the files are listed in an output format similar to "ls \-l".
.PP
As expected, if neither the source or destination path specify a remote
host, the copy occurs locally (see also the \fB\-\-list\-only\fP option).
.PP
-Rsync refers to the local side as the \(dq\&client\(dq\& and the remote side as the
-\(dq\&server\(dq\&. Don\(cq\&t confuse \(dq\&server\(dq\& with an rsync daemon \-\- a daemon is always a
--server, but a server can be either a daemon or a remote\-shell spawned process.
-+Rsync refers to the local side as the \(lqclient\(rq and the remote side as the
-+\(lqserver\(rq. Don't confuse \(lqserver\(rq with an rsync daemon \(em a daemon is always a
-+server, but a server can be either a daemon or a remote-shell spawned process.
++Rsync refers to the local side as the "client" and the remote side as the
++"server". Don't confuse "server" with an rsync daemon \-\- a daemon is always a
+ server, but a server can be either a daemon or a remote\-shell spawned process.
.PP
.SH "SETUP"
-
[email protected]@ -93,7 +94,7 @@
- .PP
- Once installed, you can use rsync to any machine that you can access via
- a remote shell (as well as some that you can access using the rsync
--daemon\-mode protocol). For remote transfers, a modern rsync uses ssh
-+daemon-mode protocol). For remote transfers, a modern rsync uses ssh
- for its communications, but it may have been configured to use a
- different remote shell by default, such as rsh or remsh.
- .PP
[email protected]@ -119,7 +120,7 @@
- This would transfer all files matching the pattern *.c from the
- current directory to the directory src on the machine foo. If any of
- the files already exist on the remote system then the rsync
--remote\-update protocol is used to update the file by sending only the
-+remote-update protocol is used to update the file by sending only the
- differences. See the tech report for details.
- .PP
- .RS
[email protected]@ -129,7 +130,7 @@
[email protected]@ -129,7 +129,7 @@
.PP
This would recursively transfer all files from the directory src/bar on the
machine foo into the /data/tmp/bar directory on the local machine. The
-files are transferred in \(dq\&archive\(dq\& mode, which ensures that symbolic
-+files are transferred in \(lqarchive\(rq mode, which ensures that symbolic
++files are transferred in "archive" mode, which ensures that symbolic
links, devices, attributes, permissions, ownerships, etc. are preserved
in the transfer. Additionally, compression will be used to reduce the
size of data portions of the transfer.
[email protected]@ -141,8 +142,8 @@
[email protected]@ -141,8 +141,8 @@
.PP
A trailing slash on the source changes this behavior to avoid creating an
additional directory level at the destination. You can think of a trailing
-/ on a source as meaning \(dq\© the contents of this directory\(dq\& as opposed
-to \(dq\© the directory by name\(dq\&, but in both cases the attributes of the
-+/ on a source as meaning \(lqcopy the contents of this directory\(rq as opposed
-+to \(lqcopy the directory by name\(rq, but in both cases the attributes of the
++/ on a source as meaning "copy the contents of this directory" as opposed
++to "copy the directory by name", but in both cases the attributes of the
containing directory are transferred to the containing directory on the
destination. In other words, each of the following commands copies the
files in the same way, including their setting of the attributes of
[email protected]@ -156,9 +157,9 @@
[email protected]@ -156,9 +156,9 @@
.RE
.PP
@@ -124,31 +68,20 @@
+Note also that host and module references don't require a trailing slash to
copy the contents of the default directory. For example, both of these
-copy the remote directory\(cq\&s contents into \(dq\&/dest\(dq\&:
-+copy the remote directory's contents into \(lq/dest\(rq:
++copy the remote directory's contents into "/dest":
.PP
.RS
\f(CWrsync \-av host: /dest\fP
[email protected]@ -168,8 +169,8 @@
- .RE
[email protected]@ -169,7 +169,7 @@
.PP
--You can also use rsync in local\-only mode, where both the source and
+ You can also use rsync in local\-only mode, where both the source and
-destination don\(cq\&t have a \(cq\&:\(cq\& in the name. In this case it behaves like
-+You can also use rsync in local-only mode, where both the source and
-+destination don't have a \(oq:\(cq in the name. In this case it behaves like
++destination don't have a ':' in the name. In this case it behaves like
an improved copy command.
.PP
Finally, you can list all the (listable) modules available from a
[email protected]@ -186,7 +187,7 @@
-
- .PP
- The syntax for requesting multiple files from a remote host is done by
--specifying additional remote\-host args in the same style as the first,
-+specifying additional remote-host args in the same style as the first,
- or with the hostname omitted. For instance, all these work:
- .PP
- .RS
[email protected]@ -202,22 +203,22 @@
[email protected]@ -202,9 +202,9 @@
examples:
.PP
.RS
@@ -160,8 +93,7 @@
.RE
.PP
--This word\-splitting still works (by default) in the latest rsync, but is
-+This word-splitting still works (by default) in the latest rsync, but is
[email protected]@ -212,12 +212,12 @@
not as easy to use as the first method.
.PP
If you need to transfer a filename that contains whitespace, you can either
@@ -176,25 +108,25 @@
.RE
.PP
[email protected]@ -237,7 +238,7 @@
[email protected]@ -237,7 +237,7 @@
you either use a double colon :: instead of a single colon to
separate the hostname from the path, or you use an rsync:// URL.
.IP o
-the first word of the \(dq\&path\(dq\& is actually a module name.
-+the first word of the \(lqpath\(rq is actually a module name.
++the first word of the "path" is actually a module name.
.IP o
the remote daemon may print a message of the day when you
connect.
[email protected]@ -251,7 +252,7 @@
[email protected]@ -251,7 +251,7 @@
you must not specify the \fB\-\-rsh\fP (\fB\-e\fP) option.
.PP
-An example that copies all the files in a remote module named \(dq\&src\(dq\&:
-+An example that copies all the files in a remote module named \(lqsrc\(rq:
++An example that copies all the files in a remote module named "src":
.PP
.nf
rsync \-av host::src /dest
[email protected]@ -269,18 +270,18 @@
[email protected]@ -269,18 +269,18 @@
.PP
You may establish the connection via a web proxy by setting the
environment variable RSYNC_PROXY to a hostname:port pair pointing to
@@ -207,8 +139,8 @@
wish to run in place of making a direct socket connection. The string may
-contain the escape \(dq\&%H\(dq\& to represent the hostname specified in the rsync
-command (so use \(dq\&%%\(dq\& if you need a single \(dq\&%\(dq\& in your string). For
-+contain the escape \(lq%H\(rq to represent the hostname specified in the rsync
-+command (so use \(lq%%\(rq if you need a single \(lq%\(rq in your string). For
++contain the escape "%H" to represent the hostname specified in the rsync
++command (so use "%%" if you need a single "%" in your string). For
example:
.PP
.nf
@@ -217,105 +149,74 @@
rsync \-av targethost1::module/src/ /dest/
rsync \-av rsync:://targethost2/module/src/ /dest/
.fi
[email protected]@ -290,26 +291,26 @@
- which forwards all data to port 873 (the rsync daemon) on the targethost
- (%H).
- .PP
--.SH "USING RSYNC\-DAEMON FEATURES VIA A REMOTE\-SHELL CONNECTION"
-+.SH "USING RSYNC-DAEMON FEATURES VIA A REMOTE-SHELL CONNECTION"
-
- .PP
- It is sometimes useful to use various features of an rsync daemon (such as
[email protected]@ -297,16 +297,16 @@
named modules) without actually allowing any new socket connections into a
--system (other than what is already required to allow remote\-shell access).
-+system (other than what is already required to allow remote-shell access).
+ system (other than what is already required to allow remote\-shell access).
Rsync supports connecting to a host using a remote shell and then spawning
-a single\-use \(dq\&daemon\(dq\& server that expects to read its config file in the
-+a single-use \(lqdaemon\(rq server that expects to read its config file in the
++a single\-use "daemon" server that expects to read its config file in the
home dir of the remote user. This can be useful if you want to encrypt a
-daemon\-style transfer\(cq\&s data, but since the daemon is started up fresh by
-+daemon-style transfer's data, but since the daemon is started up fresh by
++daemon\-style transfer's data, but since the daemon is started up fresh by
the remote user, you may not be able to use features such as chroot or
change the uid used by the daemon. (For another way to encrypt a daemon
transfer, consider using ssh to tunnel a local port to a remote machine and
configure a normal rsync daemon on that remote host to only allow
-connections from \(dq\&localhost\(dq\&.)
-+connections from \(lqlocalhost\(rq.)
++connections from "localhost".)
.PP
-From the user\(cq\&s perspective, a daemon transfer via a remote\-shell
--connection uses nearly the same command\-line syntax as a normal
--rsync\-daemon transfer, with the only exception being that you must
--explicitly set the remote shell program on the command\-line with the
-+From the user's perspective, a daemon transfer via a remote-shell
-+connection uses nearly the same command-line syntax as a normal
-+rsync-daemon transfer, with the only exception being that you must
-+explicitly set the remote shell program on the command-line with the
- \fB\-\-rsh=COMMAND\fP option. (Setting the RSYNC_RSH in the environment
- will not turn on this functionality.) For example:
- .PP
[email protected]@ -318,32 +319,36 @@
- .fi
-
- .PP
--If you need to specify a different remote\-shell user, keep in mind that the
[email protected] prefix in front of the host is specifying the rsync\-user value (for a
--module that requires user\-based authentication). This means that you must
++From the user's perspective, a daemon transfer via a remote\-shell
+ connection uses nearly the same command\-line syntax as a normal
+ rsync\-daemon transfer, with the only exception being that you must
+ explicitly set the remote shell program on the command\-line with the
[email protected]@ -321,19 +321,23 @@
+ If you need to specify a different remote\-shell user, keep in mind that the
+ [email protected] prefix in front of the host is specifying the rsync\-user value (for a
+ module that requires user\-based authentication). This means that you must
-give the \(cq\&\-l user\(cq\& option to ssh when specifying the remote\-shell, as in
-+If you need to specify a different remote-shell user, keep in mind that the
[email protected] prefix in front of the host is specifying the rsync-user value (for a
-+module that requires user-based authentication). This means that you must
-+give the '\-l user' option to ssh when specifying the remote-shell, as in
++give the '\-l user' option to ssh when specifying the remote\-shell, as in
this example that uses the short version of the \fB\-\-rsh\fP option:
.PP
.nf
- rsync \-av \-e \(dq\&ssh \-l ssh\-user\(dq\& rsync\[email protected]::module /dest
-+ rsync \-av \-e "ssh \-l ssh-user" [email protected]::module /dest
++ rsync \-av \-e "ssh \-l ssh\-user" rsync\[email protected]::module /dest
.fi
.PP
-The \(dq\&ssh\-user\(dq\& will be used at the ssh level; the \(dq\&rsync\-user\(dq\& will be
-used to log\-in to the \(dq\&module\(dq\&.
-+The \(lqssh-user\(rq will be used at the ssh level; the \(lqrsync-user\(rq will be
-+used to log-in to the \(lqmodule\(rq.
++The "ssh\-user" will be used at the ssh level; the "rsync\-user" will be
++used to log\-in to the "module".
.PP
.SH "STARTING AN RSYNC DAEMON TO ACCEPT CONNECTIONS"
- .PP
-+WARNING: Daemon mode does not participate in the core Solaris security
++.PP
++WARNING: Daemon mode does not participate in the core Solaris security
+policies, including Authentication, limit of privileges, Audit and Audit
+of any subprocessing.
-+.PP
+ .PP
In order to connect to an rsync daemon, the remote system needs to have a
daemon already running (or it needs to have configured something like inetd
- to spawn an rsync daemon for incoming connections on a particular port).
- For full information on how to start a daemon that will handling incoming
--socket connections, see the \fBrsyncd.conf\fP(5) man page \-\- that is the config
-+socket connections, see the \fBrsyncd.conf\fP(5) man page \(em that is the config
[email protected]@ -343,7 +347,7 @@
file for the daemon, and it contains the full details for how to run the
--daemon (including stand\-alone and inetd configurations).
-+daemon (including stand-alone and inetd configurations).
+ daemon (including stand\-alone and inetd configurations).
.PP
-If you\(cq\&re using one of the remote\-shell transports for the transfer, there is
-+If you're using one of the remote-shell transports for the transfer, there is
++If you're using one of the remote\-shell transports for the transfer, there is
no need to manually start an rsync daemon.
.PP
.SH "SORTED TRANSFER ORDER"
[email protected]@ -353,19 +358,19 @@
- This handles the merging together of the contents of identically named
- directories, makes it easy to remove duplicate filenames, and may confuse
- someone when the files are transferred in a different order than what was
--given on the command\-line.
-+given on the command-line.
[email protected]@ -357,7 +361,7 @@
.PP
If you need a particular file to be transferred prior to another, either
separate the files into different rsync calls, or consider using
-\fB\-\-delay\-updates\fP (which doesn\(cq\&t affect the sorted transfer order, but
--does make the final file\-updating phase happen much more rapidly).
-+\fB\-\-delay-updates\fP (which doesn't affect the sorted transfer order, but
-+does make the final file-updating phase happen much more rapidly).
++\fB\-\-delay\-updates\fP (which doesn't affect the sorted transfer order, but
+ does make the final file\-updating phase happen much more rapidly).
.PP
.SH "EXAMPLES"
-
[email protected]@ -365,7 +369,7 @@
.PP
Here are some examples of how I use rsync.
.PP
@@ -324,15 +225,16 @@
files and mail folders, I use a cron job that runs
.PP
.RS
[email protected]@ -374,14 +379,14 @@
[email protected]@ -374,7 +378,7 @@
.PP
each night over a PPP connection to a duplicate directory on my machine
-\(dq\&arvidsjaur\(dq\&.
-+\(lqarvidsjaur\(rq.
++"arvidsjaur".
.PP
To synchronize my samba source trees I use the following Makefile
targets:
[email protected]@ -381,7 +385,7 @@
.PP
.nf
get:
@@ -341,7 +243,7 @@
put:
rsync \-Cavuzb . samba:samba/
sync: get put
[email protected]@ -390,12 +395,12 @@
[email protected]@ -390,12 +394,12 @@
.PP
this allows me to sync with a CVS directory at the other end of the
connection. I then do CVS operations on the remote machine, which saves a
@@ -349,7 +251,7 @@
+lot of time as the remote CVS protocol isn't very efficient.
.PP
-I mirror a directory between my \(dq\&old\(dq\& and \(dq\&new\(dq\& ftp sites with the
-+I mirror a directory between my \(lqold\(rq and \(lqnew\(rq ftp sites with the
++I mirror a directory between my "old" and "new" ftp sites with the
command:
.PP
-\f(CWrsync \-az \-e ssh \-\-delete ~ftp/pub/samba nimbus:\(dq\&~ftp/pub/tridge\(dq\&\fP
@@ -357,17 +259,7 @@
.PP
This is launched from cron every few hours.
.PP
[email protected]@ -407,25 +412,25 @@
- .nf
-
- \-v, \-\-verbose increase verbosity
-- \-q, \-\-quiet suppress non\-error messages
-- \-\-no\-motd suppress daemon\-mode MOTD (see caveat)
-- \-c, \-\-checksum skip based on checksum, not mod\-time & size
-+ \-q, \-\-quiet suppress non-error messages
-+ \-\-no\-motd suppress daemon-mode MOTD (see caveat)
-+ \-c, \-\-checksum skip based on checksum, not mod-time & size
- \-a, \-\-archive archive mode; equals \-rlptgoD (no \-H,\-A,\-X)
[email protected]@ -417,7 +421,7 @@
\-\-no\-OPTION turn off an implied OPTION (e.g. \-\-no\-D)
\-r, \-\-recursive recurse into directories
\-R, \-\-relative use relative path names
@@ -376,54 +268,26 @@
\-b, \-\-backup make backups (see \-\-suffix & \-\-backup\-dir)
\-\-backup\-dir=DIR make backups into hierarchy based in DIR
\-\-suffix=SUFFIX backup suffix (default ~ w/o \-\-backup\-dir)
- \-u, \-\-update skip files that are newer on the receiver
-- \-\-inplace update destination files in\-place
-+ \-\-inplace update destination files in-place
- \-\-append append data onto shorter files
- \-\-append\-verify \-\-append w/old data in file checksum
[email protected]@ -428,7 +432,7 @@
\-d, \-\-dirs transfer directories without recursing
\-l, \-\-links copy symlinks as symlinks
\-L, \-\-copy\-links transform symlink into referent file/dir
- \-\-copy\-unsafe\-links only \(dq\&unsafe\(dq\& symlinks are transformed
+ \-\-copy\-unsafe\-links only "unsafe" symlinks are transformed
\-\-safe\-links ignore symlinks that point outside the tree
+ \-\-munge\-links munge symlinks to make them safer
\-k, \-\-copy\-dirlinks transform symlink to dir into referent dir
- \-K, \-\-keep\-dirlinks treat symlinked dir on receiver as dir
[email protected]@ -435,25 +440,25 @@
- \-\-chmod=CHMOD affect file and/or directory permissions
- \-A, \-\-acls preserve ACLs (implies \-p)
- \-X, \-\-xattrs preserve extended attributes
-- \-o, \-\-owner preserve owner (super\-user only)
-+ \-o, \-\-owner preserve owner (super-user only)
- \-g, \-\-group preserve group
-- \-\-devices preserve device files (super\-user only)
-+ \-\-devices preserve device files (super-user only)
- \-\-specials preserve special files
- \-D same as \-\-devices \-\-specials
- \-t, \-\-times preserve modification times
- \-O, \-\-omit\-dir\-times omit directories from \-\-times
-- \-\-super receiver attempts super\-user activities
-+ \-\-super receiver attempts super-user activities
- \-\-fake\-super store/recover privileged attrs using xattrs
- \-S, \-\-sparse handle sparse files efficiently
[email protected]@ -453,7 +457,7 @@
+ \-\-preallocate allocate dest files before writing
\-n, \-\-dry\-run perform a trial run with no changes made
-- \-W, \-\-whole\-file copy files whole (w/o delta\-xfer algorithm)
+ \-W, \-\-whole\-file copy files whole (w/o delta\-xfer algorithm)
- \-x, \-\-one\-file\-system don'\&t cross filesystem boundaries
-- \-B, \-\-block\-size=SIZE force a fixed checksum block\-size
-+ \-W, \-\-whole\-file copy files whole (w/o delta-xfer algorithm)
+ \-x, \-\-one\-file\-system don't cross filesystem boundaries
-+ \-B, \-\-block\-size=SIZE force a fixed checksum block-size
+ \-B, \-\-block\-size=SIZE force a fixed checksum block\-size
\-e, \-\-rsh=COMMAND specify the remote shell to use
\-\-rsync\-path=PROGRAM specify the rsync to run on remote machine
- \-\-existing skip creating new files on receiver
- \-\-ignore\-existing skip updating files that exist on receiver
-- \-\-remove\-source\-files sender removes synchronized files (non\-dir)
-+ \-\-remove\-source\-files sender removes synchronized files (non-dir)
- \-\-del an alias for \-\-delete\-during
- \-\-delete delete extraneous files from dest dirs
- \-\-delete\-before receiver deletes before xfer, not during
[email protected]@ -463,19 +468,19 @@
- \-\-delete\-excluded also delete excluded files from dest dirs
[email protected]@ -471,20 +475,20 @@
+ \-\-delete\-missing\-args delete missing source args from destination
\-\-ignore\-errors delete even if there are I/O errors
\-\-force force deletion of dirs even if not empty
- \-\-max\-delete=NUM don'\&t delete more than NUM files
@@ -435,65 +299,45 @@
\-\-partial keep partially transferred files
\-\-partial\-dir=DIR put a partially transferred file into DIR
\-\-delay\-updates put all updated files into place at end
-- \-m, \-\-prune\-empty\-dirs prune empty directory chains from file\-list
+ \-m, \-\-prune\-empty\-dirs prune empty directory chains from file\-list
- \-\-numeric\-ids don'\&t map uid/gid values by user/group name
-+ \-m, \-\-prune\-empty\-dirs prune empty directory chains from file-list
+ \-\-numeric\-ids don't map uid/gid values by user/group name
+ \-\-usermap=STRING custom username mapping
+ \-\-groupmap=STRING custom groupname mapping
+ \-\-chown=USER:GROUP simple username/groupname mapping
\-\-timeout=SECONDS set I/O timeout in seconds
\-\-contimeout=SECONDS set daemon connection timeout in seconds
- \-I, \-\-ignore\-times don'\&t skip files that match size and time
+ \-I, \-\-ignore\-times don't skip files that match size and time
\-\-size\-only skip files that match in size
-- \-\-modify\-window=NUM compare mod\-times with reduced accuracy
-+ \-\-modify\-window=NUM compare mod-times with reduced accuracy
+ \-\-modify\-window=NUM compare mod\-times with reduced accuracy
\-T, \-\-temp\-dir=DIR create temporary files in directory DIR
- \-y, \-\-fuzzy find similar file for basis if no dest file
- \-\-compare\-dest=DIR also compare received files relative to DIR
[email protected]@ -484,29 +489,29 @@
- \-z, \-\-compress compress file data during the transfer
- \-\-compress\-level=NUM explicitly set compression level
[email protected]@ -497,11 +501,11 @@
\-\-skip\-compress=LIST skip compressing files with suffix in LIST
-- \-C, \-\-cvs\-exclude auto\-ignore files in the same way CVS does
-- \-f, \-\-filter=RULE add a file\-filtering RULE
+ \-C, \-\-cvs\-exclude auto\-ignore files in the same way CVS does
+ \-f, \-\-filter=RULE add a file\-filtering RULE
- \-F same as \-\-filter='\&dir\-merge /.rsync\-filter'\&
- repeated: \-\-filter='\&\- .rsync\-filter'\&
-+ \-C, \-\-cvs\-exclude auto-ignore files in the same way CVS does
-+ \-f, \-\-filter=RULE add a file-filtering RULE
-+ \-F same as \-\-filter='dir-merge /.rsync\-filter'
-+ repeated: \-\-filter='\- .rsync-filter
++ \-F same as \-\-filter='dir\-merge /.rsync\-filter'
++ repeated: \-\-filter='\- .rsync\-filter'
\-\-exclude=PATTERN exclude files matching PATTERN
\-\-exclude\-from=FILE read exclude patterns from FILE
- \-\-include=PATTERN don'\&t exclude files matching PATTERN
+ \-\-include=PATTERN don't exclude files matching PATTERN
\-\-include\-from=FILE read include patterns from FILE
-- \-\-files\-from=FILE read list of source\-file names from FILE
-+ \-\-files\-from=FILE read list of source-file names from FILE
+ \-\-files\-from=FILE read list of source\-file names from FILE
\-0, \-\-from0 all *from/filter files are delimited by 0s
-- \-s, \-\-protect\-args no space\-splitting; wildcard chars only
-+ \-s, \-\-protect\-args no space-splitting; wildcard chars only
- \-\-address=ADDRESS bind address for outgoing socket to daemon
-- \-\-port=PORT specify double\-colon alternate port number
-+ \-\-port=PORT specify double-colon alternate port number
- \-\-sockopts=OPTIONS specify custom TCP options
- \-\-blocking\-io use blocking I/O for the remote shell
-- \-\-stats give some file\-transfer stats
-- \-8, \-\-8\-bit\-output leave high\-bit chars unescaped in output
-- \-h, \-\-human\-readable output numbers in a human\-readable format
-+ \-\-stats give some file-transfer stats
-+ \-8, \-\-8\-bit\-output leave high-bit chars unescaped in output
-+ \-h, \-\-human\-readable output numbers in a human-readable format
- \-\-progress show progress during transfer
- \-P same as \-\-partial \-\-progress
-- \-i, \-\-itemize\-changes output a change\-summary for all updates
-+ \-i, \-\-itemize\-changes output a change-summary for all updates
[email protected]@ -519,7 +523,7 @@
+ \-i, \-\-itemize\-changes output a change\-summary for all updates
+ \-M, \-\-remote\-option=OPTION send OPTION to the remote side only
\-\-out\-format=FORMAT output updates using the specified FORMAT
- \-\-log\-file=FILE log what we'\&re doing to the specified FILE
+ \-\-log\-file=FILE log what we're doing to the specified FILE
\-\-log\-file\-format=FMT log updates using the specified FMT
\-\-password\-file=FILE read daemon\-access password from FILE
\-\-list\-only list the files instead of copying them
[email protected]@ -534,8 +539,8 @@
- \-\-config=FILE specify alternate rsyncd.conf file
[email protected]@ -548,8 +552,8 @@
+ \-M, \-\-dparam=OVERRIDE override global daemon config parameter
\-\-no\-detach do not detach from the parent
\-\-port=PORT listen on alternate port number
- \-\-log\-file=FILE override the \(dq\&log file\(dq\& setting
@@ -503,14 +347,7 @@
\-\-sockopts=OPTIONS specify custom TCP options
\-v, \-\-verbose increase verbosity
\-4, \-\-ipv4 prefer IPv4
[email protected]@ -547,21 +552,21 @@
- .SH "OPTIONS"
-
- .PP
--Rsync accepts both long (double\-dash + word) and short (single\-dash + letter)
-+Rsync accepts both long (double-dash + word) and short (single\-dash + letter)
- options. The full list of the available options are described below. If an
- option can be specified in more than one way, the choices are comma\-separated.
[email protected]@ -567,11 +571,11 @@
Some options only have a long variant, not a short. If the option takes a
parameter, the parameter is only listed after the long variant, even though it
must also be specified for the short. When specifying a parameter, you can
@@ -525,79 +362,49 @@
.PP
.IP "\fB\-\-help\fP"
Print a short help page describing the options
--available in rsync and exit. For backward\-compatibility with older
-+available in rsync and exit. For backward-compatibility with older
- versions of rsync, the help will also be output if you use the \fB\-h\fP
- option without any other args.
- .IP
[email protected]@ -578,11 +583,11 @@
- you are debugging rsync.
[email protected]@ -615,7 +619,7 @@
+ .fi
+
.IP
- Note that the names of the transferred files that are output are done using
--a default \fB\-\-out\-format\fP of \(dq\&%n%L\(dq\&, which tells you just the name of the
-+a default \fB\-\-out\-format\fP of \(lq%n%L\(rq, which tells you just the name of the
- file and, if the item is a link, where it points. At the single \fB\-v\fP
- level of verbosity, this does not mention when a file gets its attributes
- changed. If you ask for an itemized list of changed attributes (either
--\fB\-\-itemize\-changes\fP or adding \(dq\&%i\(dq\& to the \fB\-\-out\-format\fP setting), the
-+\fB\-\-itemize\-changes\fP or adding \(lq%i\(rq to the \fB\-\-out\-format\fP setting), the
- output (on the client) increases to mention all items that are changed in
- any way. See the \fB\-\-out\-format\fP option for more details.
+-Note that \fB\-\-info=name\fP\(cq\&s output is affected by the \fB\-\-out\-format\fP and
++Note that \fB\-\-info=name\fP's output is affected by the \fB\-\-out\-format\fP and
+ \fB\-\-itemize\-changes\fP (\fB\-i\fP) options. See those options for more
+ information on what is output and when.
.IP
[email protected]@ -595,56 +600,56 @@
- .IP "\fB\-\-no\-motd\fP"
[email protected]@ -670,7 +674,7 @@
This option affects the information that is output
by the client at the start of a daemon transfer. This suppresses the
--message\-of\-the\-day (MOTD) text, but it also affects the list of modules
+ message\-of\-the\-day (MOTD) text, but it also affects the list of modules
-that the daemon sends in response to the \(dq\&rsync host::\(dq\& request (due to
-+message-of-the-day (MOTD) text, but it also affects the list of modules
-+that the daemon sends in response to the \(lqrsync host::\(rq request (due to
++that the daemon sends in response to the "rsync host::" request (due to
a limitation in the rsync protocol), so omit this option if you want to
request the list of modules from the daemon.
.IP
[email protected]@ -677,11 +681,11 @@
.IP "\fB\-I, \-\-ignore\-times\fP"
Normally rsync will skip any files that are
already the same size and have the same modification timestamp.
-This option turns off this \(dq\&quick check\(dq\& behavior, causing all files to
-+This option turns off this \(lqquick check\(rq behavior, causing all files to
++This option turns off this "quick check" behavior, causing all files to
be updated.
.IP
.IP "\fB\-\-size\-only\fP"
-This modifies rsync\(cq\&s \(dq\&quick check\(dq\& algorithm for
-+This modifies rsync's \(lqquick check\(rq algorithm for
++This modifies rsync's "quick check" algorithm for
finding files that need to be transferred, changing it from the default of
--transferring files with either a changed size or a changed last\-modified
-+transferring files with either a changed size or a changed last-modified
+ transferring files with either a changed size or a changed last\-modified
time to just looking for files that have changed in size. This is useful
- when starting to use rsync after using another mirroring system which may
- not preserve timestamps exactly.
- .IP
- .IP "\fB\-\-modify\-window\fP"
- When comparing two timestamps, rsync treats the
--timestamps as being equal if they differ by no more than the modify\-window
-+timestamps as being equal if they differ by no more than the modify-window
- value. This is normally 0 (for an exact match), but you may find it useful
- to set this to a larger value in some situations. In particular, when
- transferring to or from an MS Windows FAT filesystem (which represents
--times with a 2\-second resolution), \fB\-\-modify\-window=1\fP is useful
-+times with a 2-second resolution), \fB\-\-modify\-window=1\fP is useful
- (allowing times to differ by up to 1 second).
- .IP
[email protected]@ -700,7 +704,7 @@
.IP "\fB\-c, \-\-checksum\fP"
This changes the way rsync checks if the files have
been changed and are in need of a transfer. Without this option, rsync
-uses a \(dq\&quick check\(dq\& that (by default) checks if each file\(cq\&s size and time
-+uses a \(lqquick check\(rq that (by default) checks if each file's size and time
++uses a "quick check" that (by default) checks if each file's size and time
of last modification match between the sender and receiver. This option
--changes this to compare a 128\-bit checksum for each file that has a
-+changes this to compare a 128-bit checksum for each file that has a
+ changes this to compare a 128\-bit checksum for each file that has a
matching size. Generating the checksums means that both sides will expend
- a lot of disk I/O reading all the data in the files in the transfer (and
- this is prior to any reading that will be done to transfer changed files),
- so this can slow things down significantly.
- .IP
--The sending side generates its checksums while it is doing the file\-system
-+The sending side generates its checksums while it is doing the file-system
[email protected]@ -711,7 +715,7 @@
+ The sending side generates its checksums while it is doing the file\-system
scan that builds the list of the available files. The receiver generates
its checksums when it is scanning for changed files, and will checksum any
-file that has the same size as the corresponding sender\(cq\&s file: files with
@@ -605,33 +412,26 @@
either a changed size or a changed checksum are selected for transfer.
.IP
Note that rsync always verifies that each \fItransferred\fP file was
--correctly reconstructed on the receiving side by checking a whole\-file
-+correctly reconstructed on the receiving side by checking a whole-file
[email protected]@ -718,7 +722,7 @@
+ correctly reconstructed on the receiving side by checking a whole\-file
checksum that is generated as the file is transferred, but that
--automatic after\-the\-transfer verification has nothing to do with this
+ automatic after\-the\-transfer verification has nothing to do with this
-option\(cq\&s before\-the\-transfer \(dq\&Does this file need to be updated?\(dq\& check.
-+automatic after-the-transfer verification has nothing to do with this
-+option's before-the-transfer \(lqDoes this file need to be updated?\(rq check.
++option's before\-the\-transfer "Does this file need to be updated?" check.
.IP
For protocol 30 and beyond (first supported in 3.0.0), the checksum used is
MD5. For older protocols, the checksum used is MD4.
[email protected]@ -657,25 +662,25 @@
- specified, in which case \fB\-r\fP is not implied.
- .IP
- Note that \fB\-a\fP \fBdoes not preserve hardlinks\fP, because
--finding multiply\-linked files is expensive. You must separately
-+finding multiply-linked files is expensive. You must separately
- specify \fB\-H\fP.
[email protected]@ -736,14 +740,14 @@
.IP
.IP "\-\-no\-OPTION"
You may turn off one or more implied options by prefixing
-the option name with \(dq\&no\-\(dq\&. Not all options may be prefixed with a \(dq\&no\-\(dq\&:
-+the option name with \(lqno\-\(rq. Not all options may be prefixed with a \(lqno\-\(rq:
++the option name with "no\-". Not all options may be prefixed with a "no\-":
only options that are implied by other options (e.g. \fB\-\-no\-D\fP,
\fB\-\-no\-perms\fP) or have different defaults in various circumstances
(e.g. \fB\-\-no\-whole\-file\fP, \fB\-\-no\-blocking\-io\fP, \fB\-\-no\-dirs\fP). You may
-specify either the short or the long option name after the \(dq\&no\-\(dq\& prefix
-+specify either the short or the long option name after the \(lqno\-\(rq prefix
++specify either the short or the long option name after the "no\-" prefix
(e.g. \fB\-\-no\-R\fP is the same as \fB\-\-no\-relative\fP).
.IP
-For example: if you want to use \fB\-a\fP (\fB\-\-archive\fP) but don\(cq\&t want
@@ -639,64 +439,44 @@
\fB\-o\fP (\fB\-\-owner\fP), instead of converting \fB\-a\fP into \fB\-rlptgD\fP, you
could specify \fB\-a \-\-no\-o\fP (or \fB\-a \-\-no\-owner\fP).
.IP
- The order of the options is important: if you specify \fB\-\-no\-r \-a\fP, the
- \fB\-r\fP option would end up being turned on, the opposite of \fB\-a \-\-no\-r\fP.
--Note also that the side\-effects of the \fB\-\-files\-from\fP option are NOT
-+Note also that the side-effects of the \fB\-\-files\-from\fP option are NOT
- positional, as it affects the default state of several options and slightly
- changes the meaning of \fB\-a\fP (see the \fB\-\-files\-from\fP option for more
- details).
[email protected]@ -688,7 +693,7 @@
- incremental scan that uses much less memory than before and begins the
- transfer after the scanning of the first few directories have been
- completed. This incremental scan only affects our recursion algorithm, and
--does not change a non\-recursive transfer. It is also only possible when
-+does not change a non-recursive transfer. It is also only possible when
- both ends of the transfer are at least version 3.0.0.
- .IP
- Some options require rsync to know the full file list, so these options
[email protected]@ -725,16 +730,16 @@
[email protected]@ -799,16 +803,16 @@
.IP
then a file named /tmp/foo/bar/baz.c would be created on the remote
machine, preserving its full path. These extra path elements are called
-\(dq\&implied directories\(dq\& (i.e. the \(dq\&foo\(dq\& and the \(dq\&foo/bar\(dq\& directories in the
-+\(lqimplied directories\(rq (i.e. the \(lqfoo\(rq and the \(lqfoo/bar\(rq directories in the
++"implied directories" (i.e. the "foo" and the "foo/bar" directories in the
above example).
.IP
Beginning with rsync 3.0.0, rsync always sends these implied directories as
real directories in the file list, even if a path element is really a
symlink on the sending side. This prevents some really unexpected
-behaviors when copying the full path of a file that you didn\(cq\&t realize had
--a symlink in its path. If you want to duplicate a server\-side symlink,
+behaviors when copying the full path of a file that you didn't realize had
-+a symlink in its path. If you want to duplicate a server-side symlink,
+ a symlink in its path. If you want to duplicate a server\-side symlink,
include both the symlink via its path, and referent directory via its real
-path. If you\(cq\&re dealing with an older rsync on the sending side, you may
+path. If you're dealing with an older rsync on the sending side, you may
need to use the \fB\-\-no\-implied\-dirs\fP option.
.IP
It is also possible to limit the amount of path information that is sent as
[email protected]@ -748,7 +753,7 @@
[email protected]@ -822,7 +826,7 @@
.IP
That would create /tmp/bar/baz.c on the remote machine. (Note that the
-dot must be followed by a slash, so \(dq\&/foo/.\(dq\& would not be abbreviated.)
-+dot must be followed by a slash, so \(lq/foo/.\(rq would not be abbreviated.)
++dot must be followed by a slash, so "/foo/." would not be abbreviated.)
For older rsync versions, you would need to use a chdir to limit the
source path. For example, when pushing files:
.IP
[email protected]@ -757,13 +762,13 @@
- .RE
[email protected]@ -832,12 +836,12 @@
.IP
--(Note that the parens put the two commands into a sub\-shell, so that the
+ (Note that the parens put the two commands into a sub\-shell, so that the
-\(dq\&cd\(dq\& command doesn\(cq\&t remain in effect for future commands.)
-If you\(cq\&re pulling files from an older rsync, use this idiom (but only
--for a non\-daemon transfer):
-+(Note that the parens put the two commands into a sub-shell, so that the
-+\(lqcd\(rq command doesn't remain in effect for future commands.)
++"cd" command doesn't remain in effect for future commands.)
+If you're pulling files from an older rsync, use this idiom (but only
-+for a non-daemon transfer):
+ for a non\-daemon transfer):
.IP
.RS
-\f(CW rsync \-avR \-\-rsync\-path=\(dq\&cd /foo; rsync\(dq\& \e \fP
@@ -704,29 +484,27 @@
.br
\f(CW remote:bar/baz.c /tmp/\fP
.RE
[email protected]@ -779,14 +784,14 @@
- elements to have big differences, such as being a symlink to a directory on
[email protected]@ -854,13 +858,13 @@
the receiving side.
.IP
--For instance, if a command\-line arg or a files\-from entry told rsync to
+ For instance, if a command\-line arg or a files\-from entry told rsync to
-transfer the file \(dq\&path/foo/file\(dq\&, the directories \(dq\&path\(dq\& and \(dq\&path/foo\(dq\&
-are implied when \fB\-\-relative\fP is used. If \(dq\&path/foo\(dq\& is a symlink to
-\(dq\&bar\(dq\& on the destination system, the receiving rsync would ordinarily
-delete \(dq\&path/foo\(dq\&, recreate it as a directory, and receive the file into
-+For instance, if a command-line arg or a files-from entry told rsync to
-+transfer the file \(lqpath/foo/file\(rq, the directories \(lqpath\(rq and \(lqpath/foo\(rq
-+are implied when \fB\-\-relative\fP is used. If \(lqpath/foo\(rq is a symlink to
-+\(lqbar\(rq on the destination system, the receiving rsync would ordinarily
-+delete \(lqpath/foo\(rq, recreate it as a directory, and receive the file into
++transfer the file "path/foo/file", the directories "path" and "path/foo"
++are implied when \fB\-\-relative\fP is used. If "path/foo" is a symlink to
++"bar" on the destination system, the receiving rsync would ordinarily
++delete "path/foo", recreate it as a directory, and receive the file into
the new directory. With \fB\-\-no\-implied\-dirs\fP, the receiving rsync updates
-\(dq\&path/foo/file\(dq\& using the existing path elements, which means that the file
-ends up being created in \(dq\&path/bar\(dq\&. Another way to accomplish this link
-+\(lqpath/foo/file\(rq using the existing path elements, which means that the file
-+ends up being created in \(lqpath/bar\(rq. Another way to accomplish this link
++"path/foo/file" using the existing path elements, which means that the file
++ends up being created in "path/bar". Another way to accomplish this link
preservation is to use the \fB\-\-keep\-dirlinks\fP option (which will also
affect symlinks to directories in the rest of the transfer).
.IP
[email protected]@ -800,15 +805,15 @@
[email protected]@ -874,15 +878,15 @@
backup file goes and what (if any) suffix gets appended using the
\fB\-\-backup\-dir\fP and \fB\-\-suffix\fP options.
.IP
@@ -734,36 +512,30 @@
+Note that if you don't specify \fB\-\-backup\-dir\fP, (1) the
\fB\-\-omit\-dir\-times\fP option will be implied, and (2) if \fB\-\-delete\fP is
-also in effect (without \fB\-\-delete\-excluded\fP), rsync will add a \(dq\&protect\(dq\&
--filter\-rule for the backup suffix to the end of all your existing excludes
++also in effect (without \fB\-\-delete\-excluded\fP), rsync will add a "protect"
+ filter\-rule for the backup suffix to the end of all your existing excludes
-(e.g. \fB\-f \(dq\&P *~\(dq\&\fP). This will prevent previously backed\-up files from being
-+also in effect (without \fB\-\-delete\-excluded\fP), rsync will add a \(lqprotect\(rq
-+filter-rule for the backup suffix to the end of all your existing excludes
-+(e.g. \fB\-f "P *~"\fP). This will prevent previously backed-up files from being
++(e.g. \fB\-f "P *~"\fP). This will prevent previously backed\-up files from being
deleted. Note that if you are supplying your own filter rules, you may
need to manually insert your own exclude/protect rule somewhere higher up
in the list so that it has a high enough priority to be effective (e.g., if
-your rules specify a trailing inclusion/exclusion of \(cq\&*\(cq\&, the auto\-added
-+your rules specify a trailing inclusion/exclusion of \(oq*\(cq, the auto-added
++your rules specify a trailing inclusion/exclusion of '*', the auto\-added
rule would never be reached).
.IP
.IP "\fB\-\-backup\-dir=DIR\fP"
[email protected]@ -821,20 +826,20 @@
[email protected]@ -895,8 +899,8 @@
.IP
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 \(dq\&../\(dq\&. If an rsync
-daemon is the receiver, the backup dir cannot go outside the module\(cq\&s path
-+either an absolute path or a path that starts with \(lq../\(rq. If an rsync
++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.
.IP
.IP "\fB\-\-suffix=SUFFIX\fP"
- This option allows you to override the default
- backup suffix used with the \fB\-\-backup\fP (\fB\-b\fP) option. The default suffix is a ~
--if no \-\fB\-backup\-dir\fP was specified, otherwise it is an empty string.
-+if no \-\fB\-backup-dir\fP was specified, otherwise it is an empty string.
- .IP
- .IP "\fB\-u, \-\-update\fP"
[email protected]@ -908,7 +912,7 @@
This forces rsync to skip any files which exist on
the destination and have a modified time that is newer than the source
file. (If an existing destination file has a modification time equal to the
@@ -772,29 +544,26 @@
.IP
Note that this does not affect the copying of symlinks or other special
files. Also, a difference of file format between the sender and receiver
[email protected]@ -843,8 +848,8 @@
[email protected]@ -917,8 +921,8 @@
where the destination has a file, the transfer would occur regardless of
the timestamps.
.IP
-This option is a transfer rule, not an exclude, so it doesn\(cq\&t affect the
-data that goes into the file\-lists, and thus it doesn\(cq\&t affect deletions.
+This option is a transfer rule, not an exclude, so it doesn't affect the
-+data that goes into the file-lists, and thus it doesn't affect deletions.
++data that goes into the file\-lists, and thus it doesn't affect deletions.
It just limits the files that the receiver requests to be transferred.
.IP
.IP "\fB\-\-inplace\fP"
[email protected]@ -859,14 +864,14 @@
- .IP o
[email protected]@ -934,13 +938,13 @@
Hard links are not broken. This means the new data will be visible
through other hard links to the destination file. Moreover, attempts to
--copy differing source files onto a multiply\-linked destination file will
+ copy differing source files onto a multiply\-linked destination file will
-result in a \(dq\&tug of war\(dq\& with the destination data changing back and forth.
-+copy differing source files onto a multiply-linked destination file will
-+result in a \(lqtug of war\(rq with the destination data changing back and forth.
++result in a "tug of war" with the destination data changing back and forth.
.IP o
In\-use binaries cannot be updated (either the OS will prevent this from
--happening, or binaries that attempt to swap\-in their data will misbehave or
-+happening, or binaries that attempt to swap-in their data will misbehave or
+ happening, or binaries that attempt to swap\-in their data will misbehave or
crash).
.IP o
-The file\(cq\&s data will be in an inconsistent state during the transfer
@@ -802,36 +571,23 @@
and will be left that way if the transfer is interrupted or if an update
fails.
.IP o
[email protected]@ -874,7 +879,7 @@
[email protected]@ -948,7 +952,7 @@
can update any file, a normal user needs to be granted write permission for
the open of the file for writing to be successful.
.IP o
-The efficiency of rsync\(cq\&s delta\-transfer algorithm may be reduced if
-+The efficiency of rsync's delta-transfer algorithm may be reduced if
++The efficiency of rsync's delta\-transfer algorithm may be reduced if
some data in the destination file is overwritten before it can be copied to
a position later in the file. This does not apply if you use \fB\-\-backup\fP,
since rsync is smart enough to use the backup file as the basis file for the
[email protected]@ -885,9 +890,9 @@
- WARNING: you should not use this option to update files that are being
- accessed by others, so be careful when choosing to use this for a copy.
- .IP
--This option is useful for transferring large files with block\-based changes
-+This option is useful for transferring large files with block-based changes
- or appended data, and also on systems that are disk bound, not network
--bound. It can also help keep a copy\-on\-write filesystem snapshot from
-+bound. It can also help keep a copy-on-write filesystem snapshot from
- diverging the entire contents of a file that only has minor changes.
- .IP
- The option implies \fB\-\-partial\fP (since an interrupted transfer does not delete
[email protected]@ -901,18 +906,18 @@
[email protected]@ -975,12 +979,12 @@
the receiving side is identical with the start of the file on the sending
side. If a file needs to be transferred and its size on the receiver is
the same or longer than the size on the sender, the file is skipped. This
-does not interfere with the updating of a file\(cq\&s non\-content attributes
-+does not interfere with the updating of a file's non-content attributes
++does not interfere with the updating of a file's non\-content attributes
(e.g. permissions, ownership, etc.) when the file does not need to be
--transferred, nor does it affect the updating of any non\-regular files.
-+transferred, nor does it affect the updating of any non-regular files.
+ transferred, nor does it affect the updating of any non\-regular files.
Implies \fB\-\-inplace\fP,
but does not conflict with \fB\-\-sparse\fP (since it is always extending a
-file\(cq\&s length).
@@ -839,15 +595,7 @@
.IP
.IP "\fB\-\-append\-verify\fP"
This works just like the \fB\-\-append\fP option, but
--the existing data on the receiving side is included in the full\-file
-+the existing data on the receiving side is included in the full-file
- checksum verification step, which will cause a file to be resent if the
--final verification step fails (rsync uses a normal, non\-appending
-+final verification step fails (rsync uses a normal, non-appending
- \fB\-\-inplace\fP transfer for the resend).
- .IP
- Note: prior to rsync 3.0.0, the \fB\-\-append\fP option worked like
[email protected]@ -922,21 +927,21 @@
[email protected]@ -996,9 +1000,9 @@
.IP
.IP "\fB\-d, \-\-dirs\fP"
Tell the sending side to include any directories that
@@ -855,11 +603,12 @@
-unless the directory name specified is \(dq\&.\(dq\& or ends with a trailing slash
-(e.g. \(dq\&.\(dq\&, \(dq\&dir/.\(dq\&, \(dq\&dir/\(dq\&, etc.). Without this option or the
+are encountered. Unlike \fB\-\-recursive\fP, a directory's contents are not copied
-+unless the directory name specified is \(lq.\(rq or ends with a trailing slash
-+(e.g. \(lq.\(rq, \(lqdir/.\(rq, \(lqdir/\(rq, etc.). Without this option or the
++unless the directory name specified is "." or ends with a trailing slash
++(e.g. ".", "dir/.", "dir/", etc.). Without this option or the
\fB\-\-recursive\fP option, rsync will skip all directories it encounters (and
output a message to that effect for each one). If you specify both
\fB\-\-dirs\fP and \fB\-\-recursive\fP, \fB\-\-recursive\fP takes precedence.
[email protected]@ -1005,12 +1009,12 @@
.IP
The \fB\-\-dirs\fP option is implied by the \fB\-\-files\-from\fP option
or the \fB\-\-list\-only\fP option (including an implied
@@ -868,52 +617,58 @@
directories are seen in the listing). Specify \fB\-\-no\-dirs\fP (or \fB\-\-no\-d\fP)
if you want to turn this off.
.IP
--There is also a backward\-compatibility helper option, \fB\-\-old\-dirs\fP (or
+ There is also a backward\-compatibility helper option, \fB\-\-old\-dirs\fP (or
-\fB\-\-old\-d\fP) that tells rsync to use a hack of \(dq\&\-r \-\-exclude=\(cq\&/*/*\(cq\&\(dq\& to get
-+There is also a backward-compatibility helper option, \fB\-\-old\-dirs\fP (or
-+\fB\-\-old\-d\fP) that tells rsync to use a hack of \(lq\-r \-\-exclude='/*/*'\(rq to get
++\fB\-\-old\-d\fP) that tells rsync to use a hack of "\-r \-\-exclude='/*/*'" to get
an older rsync to list a single directory without recursing.
.IP
.IP "\fB\-l, \-\-links\fP"
[email protected]@ -946,12 +951,12 @@
- .IP "\fB\-L, \-\-copy\-links\fP"
- When symlinks are encountered, the item that
[email protected]@ -1022,7 +1026,7 @@
they point to (the referent) is copied, rather than the symlink. In older
--versions of rsync, this option also had the side\-effect of telling the
-+versions of rsync, this option also had the side-effect of telling the
+ versions of rsync, this option also had the side\-effect of telling the
receiving side to follow symlinks, such as symlinks to directories. In a
-modern rsync such as this one, you\(cq\&ll need to specify \fB\-\-keep\-dirlinks\fP (\fB\-K\fP)
+modern rsync such as this one, you'll need to specify \fB\-\-keep\-dirlinks\fP (\fB\-K\fP)
to get this extra behavior. The only exception is when sending files to
--an rsync that is too old to understand \fB\-K\fP \-\- in that case, the \fB\-L\fP option
--will still have the side\-effect of \fB\-K\fP on that older receiving rsync.
-+an rsync that is too old to understand \fB\-K\fP \(em in that case, the \fB\-L\fP option
-+will still have the side-effect of \fB\-K\fP on that older receiving rsync.
+ an rsync that is too old to understand \fB\-K\fP \-\- in that case, the \fB\-L\fP option
+ will still have the side\-effect of \fB\-K\fP on that older receiving rsync.
[email protected]@ -1044,11 +1048,11 @@
+ This option tells rsync to (1) modify all symlinks on
+ the receiving side in a way that makes them unusable but recoverable (see
+ below), or (2) to unmunge symlinks on the sending side that had been stored in
+-a munged state. This is useful if you don\(cq\&t quite trust the source of the data
++a munged state. This is useful if you don't quite trust the source of the data
+ to not try to slip in a symlink to a unexpected place.
.IP
- .IP "\fB\-\-copy\-unsafe\-links\fP"
- This tells rsync to copy the referent of
[email protected]@ -969,7 +974,7 @@
+ 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 as long as
++string "/rsyncd\-munged/". This prevents the links from being used as long as
+ that directory does not exist. When this option is enabled, rsync will refuse
+ to run if that path is a directory or a symlink to a directory.
+ .IP
[email protected]@ -1057,13 +1061,13 @@
+ transfer, the client side is the sender.)
+ .IP
+ This option has no affect on a daemon, since the daemon configures whether it
+-wants munged symlinks via its \(dq\&munge symlinks\(dq\& parameter. See also the
+-\(dq\&munge\-symlinks\(dq\& perl script in the support directory of the source code.
++wants munged symlinks via its "munge symlinks" parameter. See also the
++"munge\-symlinks" perl script in the support directory of the source code.
+ .IP
.IP "\fB\-k, \-\-copy\-dirlinks\fP"
This option causes the sending side to treat
a symlink to a directory as though it were a real directory. This is
-useful if you don\(cq\&t want symlinks to non\-directories to be affected, as
-+useful if you don't want symlinks to non-directories to be affected, as
++useful if you don't want symlinks to non\-directories to be affected, as
they would be using \fB\-\-copy\-links\fP.
.IP
Without this option, if the sending side has replaced a directory with a
[email protected]@ -986,26 +991,26 @@
- to make the paths match up right. For example:
- .IP
- .RS
--\f(CWrsync \-r \-\-relative src/./ src/./follow\-me/ dest/\fP
-+\f(CWrsync \-r \-\-relative src/./ src/./follo-me/ dest/\fP
- .RE
-
[email protected]@ -1086,20 +1090,20 @@
.IP
This works because rsync calls \fBlstat\fP(2) on the source arg as given, and the
trailing slash makes \fBlstat\fP(2) follow the symlink, giving rise to a directory
-in the file\-list which overrides the symlink found during the scan of \(dq\&src/./\(dq\&.
-+in the file-list which overrides the symlink found during the scan of \(lqsrc/./\(rq.
++in the file\-list which overrides the symlink found during the scan of "src/./".
.IP
.IP "\fB\-K, \-\-keep\-dirlinks\fP"
This option causes the receiving side to treat
@@ -925,65 +680,18 @@
-For example, suppose you transfer a directory \(dq\&foo\(dq\& that contains a file
-\(dq\&file\(dq\&, but \(dq\&foo\(dq\& is a symlink to directory \(dq\&bar\(dq\& on the receiver. Without
-\fB\-\-keep\-dirlinks\fP, the receiver deletes symlink \(dq\&foo\(dq\&, recreates it as a
-+For example, suppose you transfer a directory \(lqfoo\(rq that contains a file
-+\(lqfile\(rq, but \(lqfoo\(rq is a symlink to directory \(lqbar\(rq on the receiver. Without
-+\fB\-\-keep\-dirlinks\fP, the receiver deletes symlink \(lqfoo\(rq, recreates it as a
++For example, suppose you transfer a directory "foo" that contains a file
++"file", but "foo" is a symlink to directory "bar" on the receiver. Without
++\fB\-\-keep\-dirlinks\fP, the receiver deletes symlink "foo", recreates it as a
directory, and receives the file into the new directory. With
-\fB\-\-keep\-dirlinks\fP, the receiver keeps the symlink and \(dq\&file\(dq\& ends up in
-\(dq\&bar\(dq\&.
-+\fB\-\-keep\-dirlinks\fP, the receiver keeps the symlink and \(lqfile\(rq ends up in
-+\(lqbar\(rq.
++\fB\-\-keep\-dirlinks\fP, the receiver keeps the symlink and "file" ends up in
++"bar".
.IP
One note of caution: if you use \fB\-\-keep\-dirlinks\fP, you must trust all
the symlinks in the copy! If it is possible for an untrusted user to
[email protected]@ -1018,7 +1023,7 @@
- See also \fB\-\-copy\-dirlinks\fP for an analogous option for the sending side.
- .IP
- .IP "\fB\-H, \-\-hard\-links\fP"
--This tells rsync to look for hard\-linked files in
-+This tells rsync to look for hard-linked files in
- the source and link together the corresponding files on the destination.
- Without this option, hard\-linked files in the source are treated
- as though they were separate files.
[email protected]@ -1029,10 +1034,10 @@
- .IP
- .RS
- .IP o
--If the destination contains extraneous hard\-links (more linking than
-+If the destination contains extraneous hard-links (more linking than
- what is present in the source file list), the copying algorithm will not
- break them explicitly. However, if one or more of the paths have content
--differences, the normal file\-update process will break those extra links
-+differences, the normal file-update process will break those extra links
- (unless you are using the \fB\-\-inplace\fP option).
- .IP o
- If you specify a \fB\-\-link\-dest\fP directory that contains hard links,
[email protected]@ -1043,7 +1048,7 @@
-
- .IP
- Note that rsync can only detect hard links between files that are inside
--the transfer set. If rsync updates a file that has extra hard\-link
-+the transfer set. If rsync updates a file that has extra hard-link
- connections to files outside the transfer, that linkage will be broken. If
- you are tempted to use the \fB\-\-inplace\fP option to avoid this breakage, be
- very careful that you know how your files are being updated so that you are
[email protected]@ -1051,11 +1056,11 @@
- see the \fB\-\-inplace\fP option for more caveats).
- .IP
- If incremental recursion is active (see \fB\-\-recursive\fP), rsync may transfer
--a missing hard\-linked file before it finds that another link for that contents
-+a missing hard-linked file before it finds that another link for that contents
- exists elsewhere in the hierarchy. This does not affect the accuracy of
--the transfer (i.e. which files are hard\-linked together), just its efficiency
--(i.e. copying the data for a new, early copy of a hard\-linked file that could
--have been found later in the transfer in another member of the hard\-linked
-+the transfer (i.e. which files are hard-linked together), just its efficiency
-+(i.e. copying the data for a new, early copy of a hard-linked file that could
-+have been found later in the transfer in another member of the hard-linked
- set of files). One way to avoid this inefficiency is to disable
- incremental recursion using the \fB\-\-no\-inc\-recursive\fP option.
- .IP
[email protected]@ -1073,24 +1078,24 @@
[email protected]@ -1167,10 +1171,10 @@
permissions, though the \fB\-\-executability\fP option might change just
the execute permission for the file.
.IP o
@@ -991,60 +699,54 @@
-file\(cq\&s permissions masked with the receiving directory\(cq\&s default
-permissions (either the receiving process\(cq\&s umask, or the permissions
-specified via the destination directory\(cq\&s default ACL), and
-+New files get their \(lqnormal\(rq permission bits set to the source
++New files get their "normal" permission bits set to the source
+file's permissions masked with the receiving directory's default
+permissions (either the receiving process's umask, or the permissions
+specified via the destination directory's default ACL), and
their special permission bits disabled except in the case where a new
directory inherits a setgid bit from its parent directory.
.RE
[email protected]@ -1177,7 +1181,7 @@
.IP
Thus, when \fB\-\-perms\fP and \fB\-\-executability\fP are both disabled,
-rsync\(cq\&s behavior is the same as that of other file\-copy utilities,
-+rsync's behavior is the same as that of other file-copy utilities,
++rsync's behavior is the same as that of other file\-copy utilities,
such as \fBcp\fP(1) and \fBtar\fP(1).
.IP
In summary: to give destination files (both old and new) the source
--permissions, use \fB\-\-perms\fP. To give new files the destination\-default
-+permissions, use \fB\-\-perms\fP. To give new files the destination-default
[email protected]@ -1184,7 +1188,7 @@
+ permissions, use \fB\-\-perms\fP. To give new files the destination\-default
permissions (while leaving existing files unchanged), make sure that the
\fB\-\-perms\fP option is off and use \fB\-\-chmod=ugo=rwX\fP (which ensures that
-all non\-masked bits get enabled). If you\(cq\&d care to make this latter
-+all non-masked bits get enabled). If you'd care to make this latter
++all non\-masked bits get enabled). If you'd care to make this latter
behavior easier to type, you could define a popt alias for it, such as
putting this line in the file ~/.popt (the following defines the \fB\-Z\fP option,
and includes \-\-no\-g to use the default group of the destination dir):
[email protected]@ -1107,34 +1112,34 @@
- .RE
[email protected]@ -1202,13 +1206,13 @@
.IP
--(Caveat: make sure that \fB\-a\fP does not follow \fB\-Z\fP, or it will re\-enable
+ (Caveat: make sure that \fB\-a\fP does not follow \fB\-Z\fP, or it will re\-enable
-the two \(dq\&\-\-no\-*\(dq\& options mentioned above.)
-+(Caveat: make sure that \fB\-a\fP does not follow \fB\-Z\fP, or it will re-enable
-+the two \(lq\-\-no\-*\(rq options mentioned above.)
++the two "\-\-no\-*" options mentioned above.)
.IP
-The preservation of the destination\(cq\&s setgid bit on newly\-created
-+The preservation of the destination's setgid bit on newly-created
++The preservation of the destination's setgid bit on newly\-created
directories when \fB\-\-perms\fP is off was added in rsync 2.6.7. Older rsync
versions erroneously preserved the three special permission bits for
--newly\-created files when \fB\-\-perms\fP was off, while overriding the
+ newly\-created files when \fB\-\-perms\fP was off, while overriding the
-destination\(cq\&s setgid bit setting on a newly\-created directory. Default ACL
-+newly-created files when \fB\-\-perms\fP was off, while overriding the
-+destination's setgid bit setting on a newly-created directory. Default ACL
++destination's setgid bit setting on a newly\-created directory. Default ACL
observance was added to the ACL patch for rsync 2.6.7, so older (or
--non\-ACL\-enabled) rsyncs use the umask even if default ACLs are present.
-+non-ACL-enabled) rsyncs use the umask even if default ACLs are present.
+ non\-ACL\-enabled) rsyncs use the umask even if default ACLs are present.
(Keep in mind that it is the version of the receiving rsync that affects
- these behaviors.)
- .IP
- .IP "\fB\-E, \-\-executability\fP"
[email protected]@ -1218,17 +1222,17 @@
This option causes rsync to preserve the
--executability (or non\-executability) of regular files when \fB\-\-perms\fP is
-+executability (or non-executability) of regular files when \fB\-\-perms\fP is
+ executability (or non\-executability) of regular files when \fB\-\-perms\fP is
not enabled. A regular file is considered to be executable if at least one
-\(cq\&x\(cq\& is turned on in its permissions. When an existing destination file\(cq\&s
-+\(oqx\(cq is turned on in its permissions. When an existing destination file's
++'x' is turned on in its permissions. When an existing destination file's
executability differs from that of the corresponding source file, rsync
-modifies the destination file\(cq\&s permissions as follows:
+modifies the destination file's permissions as follows:
@@ -1052,165 +754,88 @@
.RS
.IP o
-To make a file non\-executable, rsync turns off all its \(cq\&x\(cq\&
-+To make a file non-executable, rsync turns off all its \(oqx\(cq
++To make a file non\-executable, rsync turns off all its 'x'
permissions.
.IP o
-To make a file executable, rsync turns on each \(cq\&x\(cq\& permission that
-has a corresponding \(cq\&r\(cq\& permission enabled.
-+To make a file executable, rsync turns on each \(oqx\(cq permission that
-+has a corresponding \(oqr\(cq permission enabled.
++To make a file executable, rsync turns on each 'x' permission that
++has a corresponding 'r' permission enabled.
.RE
.IP
[email protected]@ -1153,32 +1158,32 @@
- This option causes rsync to update the destination
- extended attributes to be the same as the source ones.
- .IP
--For systems that support extended\-attribute namespaces, a copy being done by a
--super\-user copies all namespaces except system.*. A normal user only copies
--the user.* namespace. To be able to backup and restore non\-user namespaces as
-+For systems that support extended-attribute namespaces, a copy being done by a
-+super-user copies all namespaces except system.*. A normal user only copies
-+the user.* namespace. To be able to backup and restore non-user namespaces as
- a normal user, see the \fB\-\-fake\-super\fP option.
[email protected]@ -1254,11 +1258,11 @@
.IP
Note that this option does not copy rsyncs special xattr values (e.g. those
used by \fB\-\-fake\-super\fP) unless you repeat the option (e.g. \-XX). This
-\(dq\© all xattrs\(dq\& mode cannot be used with \fB\-\-fake\-super\fP.
-+\(lqcopy all xattrs\(rq mode cannot be used with \fB\-\-fake\-super\fP.
++"copy all xattrs" mode cannot be used with \fB\-\-fake\-super\fP.
.IP
.IP "\fB\-\-chmod\fP"
This option tells rsync to apply one or more
-comma\-separated \(dq\&chmod\(dq\& modes to the permission of the files in the
-+comma-separated \(lqchmod\(rq modes to the permission of the files in the
++comma\-separated "chmod" modes to the permission of the files in the
transfer. The resulting value is treated as though it were the permissions
that the sending side supplied for the file, which means that this option
can seem to have no effect on existing files if \fB\-\-perms\fP is not enabled.
[email protected]@ -1265,8 +1269,8 @@
.IP
In addition to the normal parsing rules specified in the \fBchmod\fP(1)
manpage, you can specify an item that should only apply to a directory by
-prefixing it with a \(cq\&D\(cq\&, or specify an item that should only apply to a
-file by prefixing it with a \(cq\&F\(cq\&. For example, the following will ensure
--that all directories get marked set\-gid, that no files are other\-writable,
--that both are user\-writable and group\-writable, and that both have
+prefixing it with a 'D', or specify an item that should only apply to a
+file by prefixing it with a 'F'. For example, the following will ensure
-+that all directories get marked set-gid, that no files are other-writable,
-+that both are user\-writable and group-writable, and that both have
+ that all directories get marked set\-gid, that no files are other\-writable,
+ that both are user\-writable and group\-writable, and that both have
consistent executability across all bits:
- .IP
- .RS
--\-\-chmod=Dg+s,ug+w,Fo\-w,+X
-+\-\-chmod=Dg+s,ug+w,Fo-w,+X
- .RE
-
- .IP
[email protected]@ -1191,7 +1196,7 @@
- .IP "\fB\-o, \-\-owner\fP"
- This option causes rsync to set the owner of the
- destination file to be the same as the source file, but only if the
--receiving rsync is being run as the super\-user (see also the \fB\-\-super\fP
-+receiving rsync is being run as the super-user (see also the \fB\-\-super\fP
- and \fB\-\-fake\-super\fP options).
- Without this option, the owner of new and/or transferred files are set to
- the invoking user on the receiving side.
[email protected]@ -1203,7 +1208,7 @@
- .IP "\fB\-g, \-\-group\fP"
- This option causes rsync to set the group of the
- destination file to be the same as the source file. If the receiving
--program is not running as the super\-user (or if \fB\-\-no\-super\fP was
-+program is not running as the super-user (or if \fB\-\-no\-super\fP was
- specified), only groups that the invoking user on the receiving side
- is a member of will be preserved.
- Without this option, the group is set to the default group of the invoking
[email protected]@ -1217,7 +1222,7 @@
- This option causes rsync to transfer character and
- block device files to the remote system to recreate these devices.
- This option has no effect if the receiving rsync is not run as the
--super\-user (see also the \fB\-\-super\fP and \fB\-\-fake\-super\fP options).
-+super-user (see also the \fB\-\-super\fP and \fB\-\-fake\-super\fP options).
- .IP
- .IP "\fB\-\-specials\fP"
- This option causes rsync to transfer special files
[email protected]@ -1232,8 +1237,8 @@
[email protected]@ -1333,8 +1337,8 @@
option is not used, the optimization that excludes files that have not been
modified cannot be effective; in other words, a missing \fB\-t\fP or \fB\-a\fP will
cause the next transfer to behave as if it used \fB\-I\fP, causing all files to be
-updated (though rsync\(cq\&s delta\-transfer algorithm will make the update fairly efficient
-if the files haven\(cq\&t actually changed, you\(cq\&re much better off using \fB\-t\fP).
-+updated (though rsync's delta-transfer algorithm will make the update fairly efficient
++updated (though rsync's delta\-transfer algorithm will make the update fairly efficient
+if the files haven't actually changed, you're much better off using \fB\-t\fP).
.IP
.IP "\fB\-O, \-\-omit\-dir\-times\fP"
This tells rsync to omit directories when
[email protected]@ -1242,58 +1247,58 @@
- This option is inferred if you use \fB\-\-backup\fP without \fB\-\-backup\-dir\fP.
[email protected]@ -1348,12 +1352,12 @@
.IP
.IP "\fB\-\-super\fP"
--This tells the receiving side to attempt super\-user
+ This tells the receiving side to attempt super\-user
-activities even if the receiving rsync wasn\(cq\&t run by the super\-user. These
-+This tells the receiving side to attempt super-user
-+activities even if the receiving rsync wasn't run by the super-user. These
++activities even if the receiving rsync wasn't run by the super\-user. These
activities include: preserving users via the \fB\-\-owner\fP option, preserving
-all groups (not just the current user\(cq\&s groups) via the \fB\-\-groups\fP
+all groups (not just the current user's groups) via the \fB\-\-groups\fP
option, and copying devices via the \fB\-\-devices\fP option. This is useful
--for systems that allow such activities without being the super\-user, and
+ for systems that allow such activities without being the super\-user, and
-also for ensuring that you will get errors if the receiving side isn\(cq\&t
--being run as the super\-user. To turn off super\-user activities, the
--super\-user can use \fB\-\-no\-super\fP.
-+for systems that allow such activities without being the super-user, and
+also for ensuring that you will get errors if the receiving side isn't
-+being run as the super-user. To turn off super-user activities, the
-+super-user can use \fB\-\-no\-super\fP.
+ being run as the super\-user. To turn off super\-user activities, the
+ super\-user can use \fB\-\-no\-super\fP.
.IP
- .IP "\fB\-\-fake\-super\fP"
[email protected]@ -1361,10 +1365,10 @@
When this option is enabled, rsync simulates
--super\-user activities by saving/restoring the privileged attributes via
-+super-user activities by saving/restoring the privileged attributes via
+ super\-user activities by saving/restoring the privileged attributes via
special extended attributes that are attached to each file (as needed). This
-includes the file\(cq\&s owner and group (if it is not the default), the file\(cq\&s
+includes the file's owner and group (if it is not the default), the file's
device info (device & special files are created as empty text files), and
-any permission bits that we won\(cq\&t allow to be set on the real file (e.g.
-the real file gets u\-s,g\-s,o\-t for safety) or that would limit the owner\(cq\&s
--access (since the real super\-user can always access/change a file, the
+any permission bits that we won't allow to be set on the real file (e.g.
-+the real file gets u-s,g-s,o-t for safety) or that would limit the owner's
-+access (since the real super-user can always access/change a file, the
++the real file gets u\-s,g\-s,o\-t for safety) or that would limit the owner's
+ access (since the real super\-user can always access/change a file, the
files we create can always be accessed/changed by the creating user).
--This option also handles ACLs (if \fB\-\-acls\fP was specified) and non\-user
-+This option also handles ACLs (if \fB\-\-acls\fP was specified) and non-user
- extended attributes (if \fB\-\-xattrs\fP was specified).
- .IP
--This is a good way to backup data without using a super\-user, and to store
-+This is a good way to backup data without using a super-user, and to store
- ACLs from incompatible systems.
- .IP
- The \fB\-\-fake\-super\fP option only affects the side where the option is used.
--To affect the remote side of a remote\-shell connection, specify an rsync
-+To affect the remote side of a remote-shell connection, specify an rsync
- path:
- .IP
- .RS
--\f(CW rsync \-av \-\-rsync\-path=\(dq\&rsync \-\-fake\-super\(dq\& /src/ host:/dest/\fP
-+\f(CW rsync \-av \-\-rsync\-path="rsync \-\-fake\-super" /src/ host:/dest/\fP
- .RE
-
- .IP
--Since there is only one \(dq\&side\(dq\& in a local copy, this option affects both
--the sending and receiving of files. You\(cq\&ll need to specify a copy using
--\(dq\&localhost\(dq\& if you need to avoid this, possibly using the \(dq\&lsh\(dq\& shell
-+Since there is only one \(lqside\(rq in a local copy, this option affects both
-+the sending and receiving of files. You'll need to specify a copy using
-+\(lqlocalhost\(rq if you need to avoid this, possibly using the \(lqlsh\(rq shell
- script (from the support directory) as a substitute for an actual remote
- shell (see \fB\-\-rsh\fP).
+ This option also handles ACLs (if \fB\-\-acls\fP was specified) and non\-user
[email protected]@ -1390,18 +1394,18 @@
.IP
This option is overridden by both \fB\-\-super\fP and \fB\-\-no\-super\fP.
.IP
-See also the \(dq\&fake super\(dq\& setting in the daemon\(cq\&s rsyncd.conf file.
-+See also the \(lqfake super\(rq setting in the daemon's rsyncd.conf file.
++See also the "fake super" setting in the daemon's rsyncd.conf file.
.IP
.IP "\fB\-S, \-\-sparse\fP"
Try to handle sparse files efficiently so they take
@@ -1218,13 +843,26 @@
+up less space on the destination. Conflicts with \fB\-\-inplace\fP because it's
not possible to overwrite data in a sparse fashion.
.IP
+ .IP "\fB\-\-preallocate\fP"
+ This tells the receiver to allocate each destination
+ file to its eventual size before writing data to the file. Rsync will only use
+-the real filesystem\-level preallocation support provided by Linux\(cq\&s
+-\fBfallocate\fP(2) system call or Cygwin\(cq\&s \fBposix_fallocate\fP(3), not the slow
++the real filesystem\-level preallocation support provided by Linux's
++\fBfallocate\fP(2) system call or Cygwin's \fBposix_fallocate\fP(3), not the slow
+ glibc implementation that writes a zero byte into each block.
+ .IP
+ Without this option, larger files may not be entirely contiguous on the
[email protected]@ -1410,7 +1414,7 @@
+ etc.), this option may have no positive effect at all.
+ .IP
.IP "\fB\-n, \-\-dry\-run\fP"
-This makes rsync perform a trial run that doesn\(cq\&t
+This makes rsync perform a trial run that doesn't
make any changes (and produces mostly the same output as a real run). It
is most commonly used in combination with the \fB\-v, \-\-verbose\fP and/or
\fB\-i, \-\-itemize\-changes\fP options to see what an rsync command is going
[email protected]@ -1301,50 +1306,50 @@
[email protected]@ -1418,29 +1422,29 @@
.IP
The output of \fB\-\-itemize\-changes\fP is supposed to be exactly the same on a
dry run and a subsequent real run (barring intentional trickery and system
@@ -1234,22 +872,20 @@
send the actual data for file transfers, so \fB\-\-progress\fP has no effect,
-the \(dq\&bytes sent\(dq\&, \(dq\&bytes received\(dq\&, \(dq\&literal data\(dq\&, and \(dq\&matched data\(dq\&
-statistics are too small, and the \(dq\&speedup\(dq\& value is equivalent to a run
-+the \(lqbytes sent\(rq, \(lqbytes received\(rq, \(lqliteral data\(rq, and \(lqmatched data\(rq
-+statistics are too small, and the \(lqspeedup\(rq value is equivalent to a run
++the "bytes sent", "bytes received", "literal data", and "matched data"
++statistics are too small, and the "speedup" value is equivalent to a run
where no file transfers were needed.
.IP
.IP "\fB\-W, \-\-whole\-file\fP"
-With this option rsync\(cq\&s delta\-transfer algorithm
--is not used and the whole file is sent as\-is instead. The transfer may be
-+With this option rsync's delta-transfer algorithm
-+is not used and the whole file is sent as-is instead. The transfer may be
++With this option rsync's delta\-transfer algorithm
+ is not used and the whole file is sent as\-is instead. The transfer may be
faster if this option is used when the bandwidth between the source and
destination machines is higher than the bandwidth to disk (especially when the
-\(dq\&disk\(dq\& is actually a networked filesystem). This is the default when both
-+\(lqdisk\(rq is actually a networked filesystem). This is the default when both
++"disk" is actually a networked filesystem). This is the default when both
the source and destination are specified as local paths, but only if no
--batch\-writing option is in effect.
-+batch-writing option is in effect.
+ batch\-writing option is in effect.
.IP
.IP "\fB\-x, \-\-one\-file\-system\fP"
This tells rsync to avoid crossing a
@@ -1260,63 +896,42 @@
through the hierarchy of each directory that the user specified, and also
the analogous recursion on the receiving side during deletion. Also keep
-in mind that rsync treats a \(dq\&bind\(dq\& mount to the same device as being on the
-+in mind that rsync treats a \(lqbind\(rq mount to the same device as being on the
++in mind that rsync treats a "bind" mount to the same device as being on the
same filesystem.
.IP
--If this option is repeated, rsync omits all mount\-point directories from
--the copy. Otherwise, it includes an empty directory at each mount\-point it
-+If this option is repeated, rsync omits all mount-point directories from
-+the copy. Otherwise, it includes an empty directory at each mount-point it
- encounters (using the attributes of the mounted directory because those of
--the underlying mount\-point directory are inaccessible).
-+the underlying mount-point directory are inaccessible).
- .IP
- If rsync has been told to collapse symlinks (via \fB\-\-copy\-links\fP or
- \fB\-\-copy\-unsafe\-links\fP), a symlink to a directory on another device is
--treated like a mount\-point. Symlinks to non\-directories are unaffected
-+treated like a mount-point. Symlinks to non-directories are unaffected
- by this option.
- .IP
--.IP "\fB\-\-existing, \-\-ignore\-non\-existing\fP"
-+.IP "\fB\-\-existing, \-\-ignore-non-existing\fP"
- This tells rsync to skip
- creating files (including directories) that do not exist
- yet on the destination. If this option is
+ If this option is repeated, rsync omits all mount\-point directories from
[email protected]@ -1460,8 +1464,8 @@
combined with the \fB\-\-ignore\-existing\fP option, no files will be updated
(which can be useful if all you want to do is delete extraneous files).
.IP
-This option is a transfer rule, not an exclude, so it doesn\(cq\&t affect the
-data that goes into the file\-lists, and thus it doesn\(cq\&t affect deletions.
+This option is a transfer rule, not an exclude, so it doesn't affect the
-+data that goes into the file-lists, and thus it doesn't affect deletions.
++data that goes into the file\-lists, and thus it doesn't affect deletions.
It just limits the files that the receiver requests to be transferred.
.IP
.IP "\fB\-\-ignore\-existing\fP"
[email protected]@ -1352,41 +1357,41 @@
[email protected]@ -1469,8 +1473,8 @@
already exist on the destination (this does \fInot\fP ignore existing
directories, or nothing would get done). See also \fB\-\-existing\fP.
.IP
-This option is a transfer rule, not an exclude, so it doesn\(cq\&t affect the
-data that goes into the file\-lists, and thus it doesn\(cq\&t affect deletions.
+This option is a transfer rule, not an exclude, so it doesn't affect the
-+data that goes into the file-lists, and thus it doesn't affect deletions.
++data that goes into the file\-lists, and thus it doesn't affect deletions.
It just limits the files that the receiver requests to be transferred.
.IP
This option can be useful for those doing backups using the \fB\-\-link\-dest\fP
[email protected]@ -1477,7 +1481,7 @@
option when they need to continue a backup run that got interrupted. Since
a \fB\-\-link\-dest\fP run is copied into a new directory hierarchy (when it is
used properly), using \fB\-\-ignore existing\fP will ensure that the
-already\-handled files don\(cq\&t get tweaked (which avoids a change in
-+already-handled files don't get tweaked (which avoids a change in
++already\-handled files don't get tweaked (which avoids a change in
permissions on the hard\-linked files). This does mean that this option
is only looking at the existing files in the destination hierarchy itself.
.IP
- .IP "\fB\-\-remove\-source\-files\fP"
- This tells rsync to remove from the sending
--side the files (meaning non\-directories) that are a part of the transfer
-+side the files (meaning non-directories) that are a part of the transfer
- and have been successfully duplicated on the receiving side.
- .IP
[email protected]@ -1489,24 +1493,24 @@
Note that you should only use this option on source files that are quiescent.
If you are using this to move files that show up in a particular directory over
to another host, make sure that the finished files get renamed into the source
@@ -1327,9 +942,14 @@
a different directory, you should use a naming idiom that lets rsync avoid
-transferring files that are not yet finished (e.g. name the file \(dq\&foo.new\(dq\& when
-it is written, rename it to \(dq\&foo\(dq\& when it is done, and then use the option
-+transferring files that are not yet finished (e.g. name the file \(lqfoo.new\(rq when
-+it is written, rename it to \(lqfoo\(rq when it is done, and then use the option
- \fB\-\-exclude='\&*.new'\&\fP for the rsync transfer).
+-\fB\-\-exclude='\&*.new'\&\fP for the rsync transfer).
++transferring files that are not yet finished (e.g. name the file "foo.new" when
++it is written, rename it to "foo" when it is done, and then use the option
++\fB\-\-exclude='*.new'\fP for the rsync transfer).
+ .IP
+ Starting with 3.1.0, rsync will skip the sender\-side removal (and output an
+-error) if the file\(cq\&s size or modify time has not stayed unchanged.
++error) if the file's size or modify time has not stayed unchanged.
.IP
.IP "\fB\-\-delete\fP"
This tells rsync to delete extraneous files from the
@@ -1338,53 +958,15 @@
directories that are being synchronized. You must have asked rsync to
-send the whole directory (e.g. \(dq\&dir\(dq\& or \(dq\&dir/\(dq\&) without using a wildcard
-for the directory\(cq\&s contents (e.g. \(dq\&dir/*\(dq\&) since the wildcard is expanded
-+send the whole directory (e.g. \(lqdir\(rq or \(lqdir/\(rq) without using a wildcard
-+for the directory's contents (e.g. \(lqdir/*\(rq) since the wildcard is expanded
++send the whole directory (e.g. "dir" or "dir/") without using a wildcard
++for the directory's contents (e.g. "dir/*") since the wildcard is expanded
by the shell and rsync thus gets a request to transfer individual files, not
-the files\(cq\& parent directory. Files that are excluded from the transfer are
+the files' parent directory. Files that are excluded from the transfer are
also excluded from being deleted unless you use the \fB\-\-delete\-excluded\fP
option or mark the rules as only matching on the sending side (see the
include/exclude modifiers in the FILTER RULES section).
[email protected]@ -1413,29 +1418,29 @@
- \fB\-\-delete\-delay\fP and \fB\-\-delete\-after\fP.
- .IP
- .IP "\fB\-\-delete\-before\fP"
--Request that the file\-deletions on the receiving
-+Request that the file-deletions on the receiving
- side be done before the transfer starts.
--See \fB\-\-delete\fP (which is implied) for more details on file\-deletion.
-+See \fB\-\-delete\fP (which is implied) for more details on file-deletion.
- .IP
- Deleting before the transfer is helpful if the filesystem is tight for space
- and removing extraneous files would help to make the transfer possible.
- However, it does introduce a delay before the start of the transfer,
- and this delay might cause the transfer to timeout (if \fB\-\-timeout\fP was
--specified). It also forces rsync to use the old, non\-incremental recursion
-+specified). It also forces rsync to use the old, non-incremental recursion
- algorithm that requires rsync to scan all the files in the transfer into
- memory at once (see \fB\-\-recursive\fP).
- .IP
- .IP "\fB\-\-delete\-during, \-\-del\fP"
--Request that the file\-deletions on the
-+Request that the file-deletions on the
- receiving side be done incrementally as the transfer happens. The
--per\-directory delete scan is done right before each directory is checked
-+per-directory delete scan is done right before each directory is checked
- for updates, so it behaves like a more efficient \fB\-\-delete\-before\fP,
--including doing the deletions prior to any per\-directory filter files
-+including doing the deletions prior to any per-directory filter files
- being updated. This option was first added in rsync version 2.6.4.
--See \fB\-\-delete\fP (which is implied) for more details on file\-deletion.
-+See \fB\-\-delete\fP (which is implied) for more details on file-deletion.
- .IP
- .IP "\fB\-\-delete\-delay\fP"
--Request that the file\-deletions on the receiving
-+Request that the file-deletions on the receiving
- side be computed during the transfer (like \fB\-\-delete\-during\fP), and then
- removed after the transfer completes. This is useful when combined with
- \fB\-\-delay\-updates\fP and/or \fB\-\-fuzzy\fP, and is more efficient than using
[email protected]@ -1443,21 +1448,21 @@
[email protected]@ -1563,7 +1567,7 @@
computes the deletions in a separate pass after all updates are done).
If the number of removed files overflows an internal buffer, a
temporary file will be created on the receiving side to hold the names (it
@@ -1393,118 +975,74 @@
the creation of the temporary file fails, rsync will try to fall back to
using \fB\-\-delete\-after\fP (which it cannot do if \fB\-\-recursive\fP is doing an
incremental scan).
--See \fB\-\-delete\fP (which is implied) for more details on file\-deletion.
-+See \fB\-\-delete\fP (which is implied) for more details on file-deletion.
[email protected]@ -1605,7 +1609,7 @@
+ that, this option is independent of any other type of delete processing.
.IP
- .IP "\fB\-\-delete\-after\fP"
--Request that the file\-deletions on the receiving
-+Request that the file-deletions on the receiving
- side be done after the transfer has completed. This is useful if you
--are sending new per\-directory merge files as a part of the transfer and
-+are sending new per-directory merge files as a part of the transfer and
- you want their exclusions to take effect for the delete phase of the
--current transfer. It also forces rsync to use the old, non\-incremental
-+current transfer. It also forces rsync to use the old, non-incremental
- recursion algorithm that requires rsync to scan all the files in the
- transfer into memory at once (see \fB\-\-recursive\fP).
--See \fB\-\-delete\fP (which is implied) for more details on file\-deletion.
-+See \fB\-\-delete\fP (which is implied) for more details on file-deletion.
- .IP
- .IP "\fB\-\-delete\-excluded\fP"
- In addition to deleting the files on the
[email protected]@ -1466,19 +1471,19 @@
- See the FILTER RULES section for a way to make individual exclusions behave
- this way on the receiver, and for a way to protect files from
- \fB\-\-delete\-excluded\fP.
--See \fB\-\-delete\fP (which is implied) for more details on file\-deletion.
-+See \fB\-\-delete\fP (which is implied) for more details on file-deletion.
+ The missing source files are represented by special file\-list entries which
+-display as a \(dq\&*missing\(dq\& entry in the \fB\-\-list\-only\fP output.
++display as a "*missing" entry in the \fB\-\-list\-only\fP output.
.IP
.IP "\fB\-\-ignore\-errors\fP"
Tells \fB\-\-delete\fP to go ahead and delete files
- even when there are I/O errors.
- .IP
- .IP "\fB\-\-force\fP"
--This option tells rsync to delete a non\-empty directory
--when it is to be replaced by a non\-directory. This is only relevant if
-+This option tells rsync to delete a non-empty directory
-+when it is to be replaced by a non-directory. This is only relevant if
- deletions are not active (see \fB\-\-delete\fP for details).
[email protected]@ -1629,27 +1633,27 @@
.IP
- Note for older rsync versions: \fB\-\-force\fP used to still be required when
--using \fB\-\-delete\-after\fP, and it used to be non\-functional unless the
-+using \fB\-\-delete\-after\fP, and it used to be non-functional unless the
- \fB\-\-recursive\fP option was also enabled.
- .IP
- .IP "\fB\-\-max\-delete=NUM\fP"
[email protected]@ -1488,27 +1493,27 @@
- .IP
- Also new for version 3.0.0, you may specify \fB\-\-max\-delete=0\fP to be warned
+ Beginning with version 3.0.0, you may specify \fB\-\-max\-delete=0\fP to be warned
about any extraneous files in the destination without removing any of them.
-Older clients interpreted this as \(dq\&unlimited\(dq\&, so if you don\(cq\&t know what
-+Older clients interpreted this as \(lqunlimited\(rq, so if you don't know what
++Older clients interpreted this as "unlimited", so if you don't know what
version the client is, you can use the less obvious \fB\-\-max\-delete=\-1\fP as
--a backward\-compatible way to specify that no deletions be allowed (though
--older versions didn\(cq\&t warn when the limit was exceeded).
-+a backward-compatible way to specify that no deletions be allowed (though
-+older versions didn't warn when the limit was exceeded).
+ a backward\-compatible way to specify that no deletions be allowed (though
+-really old versions didn\(cq\&t warn when the limit was exceeded).
++really old versions didn't warn when the limit was exceeded).
.IP
.IP "\fB\-\-max\-size=SIZE\fP"
This tells rsync to avoid transferring any
file that is larger than the specified SIZE. The SIZE value can be
suffixed with a string to indicate a size multiplier, and
-may be a fractional value (e.g. \(dq\&\fB\-\-max\-size=1.5m\fP\(dq\&).
-+may be a fractional value (e.g. \(lq\fB\-\-max\-size=1.5m\fP\(rq).
++may be a fractional value (e.g. "\fB\-\-max\-size=1.5m\fP").
.IP
-This option is a transfer rule, not an exclude, so it doesn\(cq\&t affect the
-data that goes into the file\-lists, and thus it doesn\(cq\&t affect deletions.
+This option is a transfer rule, not an exclude, so it doesn't affect the
-+data that goes into the file-lists, and thus it doesn't affect deletions.
++data that goes into the file\-lists, and thus it doesn't affect deletions.
It just limits the files that the receiver requests to be transferred.
.IP
-The suffixes are as follows: \(dq\&K\(dq\& (or \(dq\&KiB\(dq\&) is a kibibyte (1024),
-\(dq\&M\(dq\& (or \(dq\&MiB\(dq\&) is a mebibyte (1024*1024), and \(dq\&G\(dq\& (or \(dq\&GiB\(dq\&) is a
-+The suffixes are as follows: \(lqK\(rq (or \(lqKiB\(rq) is a kibibyte (1024),
-+\(lqM\(rq (or \(lqMiB\(rq) is a mebibyte (1024*1024), and \(lqG\(rq (or \(lqGiB\(rq) is a
++The suffixes are as follows: "K" (or "KiB") is a kibibyte (1024),
++"M" (or "MiB") is a mebibyte (1024*1024), and "G" (or "GiB") is a
gibibyte (1024*1024*1024).
-If you want the multiplier to be 1000 instead of 1024, use \(dq\&KB\(dq\&,
-\(dq\&MB\(dq\&, or \(dq\&GB\(dq\&. (Note: lower\-case is also accepted for all values.)
-Finally, if the suffix ends in either \(dq\&+1\(dq\& or \(dq\&\-1\(dq\&, the value will
-+If you want the multiplier to be 1000 instead of 1024, use \(lqKB\(rq,
-+\(lqMB\(rq, or \(lqGB\(rq. (Note: lower-case is also accepted for all values.)
-+Finally, if the suffix ends in either \(lq+1\(rq or \(lq\-1\(rq, the value will
++If you want the multiplier to be 1000 instead of 1024, use "KB",
++"MB", or "GB". (Note: lower\-case is also accepted for all values.)
++Finally, if the suffix ends in either "+1" or "\-1", the value will
be offset by one byte in the indicated direction.
.IP
Examples: \-\-max\-size=1.5mb\-1 is 1499999 bytes, and \-\-max\-size=2g+1 is
[email protected]@ -1522,7 +1527,7 @@
[email protected]@ -1667,7 +1671,7 @@
.IP
.IP "\fB\-B, \-\-block\-size=BLOCKSIZE\fP"
This forces the block size used in
-rsync\(cq\&s delta\-transfer algorithm to a fixed value. It is normally selected based on
-+rsync's delta-transfer algorithm to a fixed value. It is normally selected based on
++rsync's delta\-transfer algorithm to a fixed value. It is normally selected based on
the size of each file being updated. See the technical report for details.
.IP
.IP "\fB\-e, \-\-rsh=COMMAND\fP"
[email protected]@ -1535,27 +1540,27 @@
[email protected]@ -1680,8 +1684,8 @@
remote shell \fICOMMAND\fP will be used to run an rsync daemon on the
remote host, and all data will be transmitted through that remote
shell connection, rather than through a direct socket connection to a
-running rsync daemon on the remote host. See the section \(dq\&USING
-RSYNC\-DAEMON FEATURES VIA A REMOTE\-SHELL CONNECTION\(dq\& above.
-+running rsync daemon on the remote host. See the section \(lqUSING
-+RSYNC-DAEMON FEATURES VIA A REMOTE-SHELL CONNECTION\(rq above.
++running rsync daemon on the remote host. See the section "USING
++RSYNC\-DAEMON FEATURES VIA A REMOTE\-SHELL CONNECTION" above.
.IP
--Command\-line arguments are permitted in COMMAND provided that COMMAND is
-+Command-line arguments are permitted in COMMAND provided that COMMAND is
+ Command\-line arguments are permitted in COMMAND provided that COMMAND is
presented to rsync as a single argument. You must use spaces (not tabs
- or other whitespace) to separate the command and args from each other,
--and you can use single\- and/or double\-quotes to preserve spaces in an
--argument (but not backslashes). Note that doubling a single\-quote
--inside a single\-quoted string gives you a single\-quote; likewise for
--double\-quotes (though you need to pay attention to which quotes your
-+and you can use single- and/or double-quotes to preserve spaces in an
-+argument (but not backslashes). Note that doubling a single-quote
-+inside a single\-quoted string gives you a single-quote; likewise for
-+double-quotes (though you need to pay attention to which quotes your
[email protected]@ -1693,9 +1697,9 @@
shell is parsing and which quotes rsync is parsing). Some examples:
.IP
.RS
@@ -1516,28 +1054,19 @@
.br
.RE
- .IP
--(Note that ssh users can alternately customize site\-specific connect
-+(Note that ssh users can alternately customize site-specific connect
- options in their .ssh/config file.)
- .IP
- You can also choose the remote shell program using the RSYNC_RSH
[email protected]@ -1565,29 +1570,29 @@
- .IP
[email protected]@ -1711,9 +1715,9 @@
.IP "\fB\-\-rsync\-path=PROGRAM\fP"
Use this to specify what program is to be run
--on the remote machine to start\-up rsync. Often used when rsync is not in
+ on the remote machine to start\-up rsync. Often used when rsync is not in
-the default remote\-shell\(cq\&s path (e.g. \-\-rsync\-path=/usr/local/bin/rsync).
-+on the remote machine to start-up rsync. Often used when rsync is not in
-+the default remote-shell's path (e.g. \-\-rsync\-path=/usr/local/bin/rsync).
++the default remote\-shell's path (e.g. \-\-rsync\-path=/usr/local/bin/rsync).
Note that PROGRAM is run with the help of a shell, so it can be any
-program, script, or command sequence you\(cq\&d care to run, so long as it does
--not corrupt the standard\-in & standard\-out that rsync is using to
+program, script, or command sequence you'd care to run, so long as it does
-+not corrupt the standard-in & standard-out that rsync is using to
+ not corrupt the standard\-in & standard\-out that rsync is using to
communicate.
.IP
- One tricky example is to set a different default directory on the remote
[email protected]@ -1721,7 +1725,7 @@
machine for use with the \fB\-\-relative\fP option. For instance:
.IP
.RS
@@ -1546,6 +1075,19 @@
.RE
.IP
[email protected]@ -1754,8 +1758,8 @@
+ option. If that option is off, any spaces in your remote options will be split
+ by the remote shell unless you take steps to protect them.
+ .IP
+-When performing a local transfer, the \(dq\&local\(dq\& side is the sender and the
+-\(dq\&remote\(dq\& side is the receiver.
++When performing a local transfer, the "local" side is the sender and the
++"remote" side is the receiver.
+ .IP
+ Note some versions of the popt option\-parsing library have a bug in them that
+ prevents you from using an adjacent arg with an equal in it next to a short
[email protected]@ -1764,7 +1768,7 @@
+ .IP
.IP "\fB\-C, \-\-cvs\-exclude\fP"
This is a useful shorthand for excluding a
-broad range of files that you often don\(cq\&t want to transfer between
@@ -1553,13 +1095,7 @@
systems. It uses a similar algorithm to CVS to determine if
a file should be ignored.
.IP
- The exclude list is initialized to exclude the following items (these
--initial items are marked as perishable \-\- see the FILTER RULES section):
-+initial items are marked as perishable \(em see the FILTER RULES section):
- .IP
- .RS
- .RS
[email protected]@ -1604,19 +1609,19 @@
[email protected]@ -1786,10 +1790,10 @@
.IP
Finally, any file is ignored if it is in the same directory as a
\&.cvsignore file and matches one of the patterns listed therein. Unlike
@@ -1570,24 +1106,18 @@
-If you\(cq\&re combining \fB\-C\fP with your own \fB\-\-filter\fP rules, you should
+If you're combining \fB\-C\fP with your own \fB\-\-filter\fP rules, you should
note that these CVS excludes are appended at the end of your own rules,
--regardless of where the \fB\-C\fP was placed on the command\-line. This makes them
-+regardless of where the \fB\-C\fP was placed on the command-line. This makes them
+ regardless of where the \fB\-C\fP was placed on the command\-line. This makes them
a lower priority than any rules you specified explicitly. If you want to
[email protected]@ -1796,7 +1800,7 @@
control where these CVS excludes get inserted into your filter rules, you
--should omit the \fB\-C\fP as a command\-line option and use a combination of
--\fB\-\-filter=:C\fP and \fB\-\-filter=\-C\fP (either on your command\-line or by
+ should omit the \fB\-C\fP as a command\-line option and use a combination of
+ \fB\-\-filter=:C\fP and \fB\-\-filter=\-C\fP (either on your command\-line or by
-putting the \(dq\&:C\(dq\& and \(dq\&\-C\(dq\& rules into a filter file with your other rules).
--The first option turns on the per\-directory scanning for the .cvsignore
--file. The second option does a one\-time import of the CVS excludes
-+should omit the \fB\-C\fP as a command-line option and use a combination of
-+\fB\-\-filter=:C\fP and \fB\-\-filter=\-C\fP (either on your command-line or by
-+putting the \(lq:C\(rq and \(lq\-C\(rq rules into a filter file with your other rules).
-+The first option turns on the per-directory scanning for the .cvsignore
-+file. The second option does a one-time import of the CVS excludes
++putting the ":C" and "\-C" rules into a filter file with your other rules).
+ The first option turns on the per\-directory scanning for the .cvsignore
+ file. The second option does a one\-time import of the CVS excludes
mentioned above.
- .IP
- .IP "\fB\-f, \-\-filter=RULE\fP"
[email protected]@ -1637,17 +1642,17 @@
[email protected]@ -1819,7 +1823,7 @@
your command. The first time it is used is a shorthand for this rule:
.IP
.RS
@@ -1596,10 +1126,7 @@
.RE
.IP
--This tells rsync to look for per\-directory .rsync\-filter files that have
-+This tells rsync to look for per-directory .rsync-filter files that have
- been sprinkled through the hierarchy and use their rules to filter the
- files in the transfer. If \fB\-F\fP is repeated, it is a shorthand for this
[email protected]@ -1829,7 +1833,7 @@
rule:
.IP
.RS
@@ -1608,39 +1135,25 @@
.RE
.IP
[email protected]@ -1659,27 +1664,27 @@
- .IP "\fB\-\-exclude=PATTERN\fP"
- This option is a simplified form of the
- \fB\-\-filter\fP option that defaults to an exclude rule and does not allow
--the full rule\-parsing syntax of normal filter rules.
-+the full rule-parsing syntax of normal filter rules.
- .IP
- See the FILTER RULES section for detailed information on this option.
- .IP
[email protected]@ -1848,7 +1852,7 @@
.IP "\fB\-\-exclude\-from=FILE\fP"
This option is related to the \fB\-\-exclude\fP
option, but it specifies a FILE that contains exclude patterns (one per line).
-Blank lines in the file and lines starting with \(cq\&;\(cq\& or \(cq\&#\(cq\& are ignored.
-+Blank lines in the file and lines starting with \(oq;\(cq or \(oq#\(cq are ignored.
++Blank lines in the file and lines starting with ';' or '#' are ignored.
If \fIFILE\fP is \fB\-\fP, the list will be read from standard input.
.IP
.IP "\fB\-\-include=PATTERN\fP"
- This option is a simplified form of the
- \fB\-\-filter\fP option that defaults to an include rule and does not allow
--the full rule\-parsing syntax of normal filter rules.
-+the full rule-parsing syntax of normal filter rules.
- .IP
- See the FILTER RULES section for detailed information on this option.
- .IP
[email protected]@ -1861,7 +1865,7 @@
.IP "\fB\-\-include\-from=FILE\fP"
This option is related to the \fB\-\-include\fP
option, but it specifies a FILE that contains include patterns (one per line).
-Blank lines in the file and lines starting with \(cq\&;\(cq\& or \(cq\&#\(cq\& are ignored.
-+Blank lines in the file and lines starting with \(oq;\(cq or \(oq#\(cq are ignored.
++Blank lines in the file and lines starting with ';' or '#' are ignored.
If \fIFILE\fP is \fB\-\fP, the list will be read from standard input.
.IP
.IP "\fB\-\-files\-from=FILE\fP"
[email protected]@ -1698,18 +1703,18 @@
[email protected]@ -1880,7 +1884,7 @@
specified in the list on the destination rather than noisily skipping
them (use \fB\-\-no\-dirs\fP or \fB\-\-no\-d\fP if you want to turn that off).
.IP o
@@ -1648,64 +1161,52 @@
+The \fB\-\-archive\fP (\fB\-a\fP) option's behavior does not imply \fB\-\-recursive\fP
(\fB\-r\fP), so specify it explicitly, if you want it.
.IP o
--These side\-effects change the default state of rsync, so the position
--of the \fB\-\-files\-from\fP option on the command\-line has no bearing on how
-+These side-effects change the default state of rsync, so the position
-+of the \fB\-\-files\-from\fP option on the command-line has no bearing on how
- other options are parsed (e.g. \fB\-a\fP works the same before or after
- \fB\-\-files\-from\fP, as does \fB\-\-no\-R\fP and all other options).
- .RE
+ These side\-effects change the default state of rsync, so the position
[email protected]@ -1891,7 +1895,7 @@
.IP
The filenames that are read from the FILE are all relative to the
-source dir \-\- any leading slashes are removed and no \(dq\&..\(dq\& references are
-+source dir \(em any leading slashes are removed and no \(lq..\(rq references are
++source dir \-\- any leading slashes are removed and no ".." references are
allowed to go higher than the source dir. For example, take this
command:
.IP
[email protected]@ -1718,47 +1723,47 @@
[email protected]@ -1900,12 +1904,12 @@
.RE
.IP
-If /tmp/foo contains the string \(dq\&bin\(dq\& (or even \(dq\&/bin\(dq\&), the /usr/bin
-+If /tmp/foo contains the string \(lqbin\(rq (or even \(lq/bin\(rq), the /usr/bin
++If /tmp/foo contains the string "bin" (or even "/bin"), the /usr/bin
directory will be created as /backup/bin on the remote host. If it
-contains \(dq\&bin/\(dq\& (note the trailing slash), the immediate contents of
-+contains \(lqbin/\(rq (note the trailing slash), the immediate contents of
++contains "bin/" (note the trailing slash), the immediate contents of
the directory would also be sent (without needing to be explicitly
--mentioned in the file \-\- this began in version 2.6.4). In both cases,
+ mentioned in the file \-\- this began in version 2.6.4). In both cases,
-if the \fB\-r\fP option was enabled, that dir\(cq\&s entire hierarchy would
-+mentioned in the file \(em this began in version 2.6.4). In both cases,
+if the \fB\-r\fP option was enabled, that dir's entire hierarchy would
also be transferred (keep in mind that \fB\-r\fP needs to be specified
explicitly with \fB\-\-files\-from\fP, since it is not implied by \fB\-a\fP).
Also note
- that the effect of the (enabled by default) \fB\-\-relative\fP option is to
--duplicate only the path info that is read from the file \-\- it does not
--force the duplication of the source\-spec path (/usr in this case).
-+duplicate only the path info that is read from the file \(em it does not
-+force the duplication of the source-spec path (/usr in this case).
[email protected]@ -1914,10 +1918,10 @@
+ force the duplication of the source\-spec path (/usr in this case).
.IP
In addition, the \fB\-\-files\-from\fP file can be read from the remote host
-instead of the local host if you specify a \(dq\&host:\(dq\& in front of the file
--(the host must match one end of the transfer). As a short\-cut, you can
++instead of the local host if you specify a "host:" in front of the file
+ (the host must match one end of the transfer). As a short\-cut, you can
-specify just a prefix of \(dq\&:\(dq\& to mean \(dq\&use the remote end of the
-transfer\(dq\&. For example:
-+instead of the local host if you specify a \(lqhost:\(rq in front of the file
-+(the host must match one end of the transfer). As a short-cut, you can
-+specify just a prefix of \(lq:\(rq to mean \(lquse the remote end of the
-+transfer\(rq. For example:
++specify just a prefix of ":" to mean "use the remote end of the
++transfer". For example:
.IP
.RS
--\f(CW rsync \-a \-\-files\-from=:/path/file\-list src:/ /tmp/copy\fP
-+\f(CW rsync \-a \-\-files\-from=:/path/file-list src:/ /tmp/copy\fP
- .RE
+ \f(CW rsync \-a \-\-files\-from=:/path/file\-list src:/ /tmp/copy\fP
[email protected]@ -1925,12 +1929,12 @@
.IP
--This would copy all the files specified in the /path/file\-list file that
+ This would copy all the files specified in the /path/file\-list file that
-was located on the remote \(dq\&src\(dq\& host.
-+This would copy all the files specified in the /path/file-list file that
-+was located on the remote \(lqsrc\(rq host.
++was located on the remote "src" host.
.IP
If the \fB\-\-iconv\fP and \fB\-\-protect\-args\fP options are specified and the
\fB\-\-files\-from\fP filenames are being sent from one host to another, the
@@ -1716,10 +1217,7 @@
.IP
NOTE: sorting the list of files in the \-\-files\-from input helps rsync to be
more efficient, as it will avoid re\-visiting the path elements that are shared
- between adjacent entries. If the input is not sorted, some path elements
- (implied directories) may end up being scanned multiple times, and rsync will
--eventually unduplicate them after they get turned into file\-list elements.
-+eventually unduplicate them after they get turned into file-list elements.
[email protected]@ -1940,7 +1944,7 @@
.IP
.IP "\fB\-0, \-\-from0\fP"
This tells rsync that the rules/filenames it reads from a
@@ -1728,25 +1226,16 @@
This affects \fB\-\-exclude\-from\fP, \fB\-\-include\-from\fP, \fB\-\-files\-from\fP, and any
merged files specified in a \fB\-\-filter\fP rule.
It does not affect \fB\-\-cvs\-exclude\fP (since all names read from a .cvsignore
[email protected]@ -1767,14 +1772,14 @@
- .IP "\fB\-s, \-\-protect\-args\fP"
- This option sends all filenames and most options to
- the remote rsync without allowing the remote shell to interpret them. This
--means that spaces are not split in names, and any non\-wildcard special
-+means that spaces are not split in names, and any non-wildcard special
- characters are not translated (such as ~, $, ;, &, etc.). Wildcards are
- expanded on the remote host by rsync (instead of the shell doing it).
[email protected]@ -1963,7 +1967,7 @@
+ by default, otherwise it will be disabled by default. Either state is
+ overridden by a manually specified positive or negative version of this option
+ (note that \fB\-\-no\-s\fP and \fB\-\-no\-protect\-args\fP are the negative versions).
+-Since this option was first introduced in 3.0.0, you\(cq\&ll need to make sure it\(cq\&s
++Since this option was first introduced in 3.0.0, you'll need to make sure it's
+ disabled if you ever need to interact with a remote rsync that is older than
+ that.
.IP
- If you use this option with \fB\-\-iconv\fP, the args related to the remote
- side will also be translated
--from the local to the remote character\-set. The translation happens before
--wild\-cards are expanded. See also the \fB\-\-files\-from\fP option.
-+from the local to the remote character-set. The translation happens before
-+wild-cards are expanded. See also the \fB\-\-files\-from\fP option.
- .IP
- .IP "\fB\-T, \-\-temp\-dir=DIR\fP"
- This option instructs rsync to use DIR as a
[email protected]@ -1799,25 +1804,25 @@
[email protected]@ -1995,9 +1999,9 @@
If you are using this option for reasons other than a shortage of disk
space, you may wish to combine it with the \fB\-\-delay\-updates\fP option,
which will ensure that all copied files get put into subdirectories in the
@@ -1758,27 +1247,7 @@
about disk space is to use the \fB\-\-partial\-dir\fP option with a relative
path; because this tells rsync that it is OK to stash off a copy of a
single file in a subdir in the destination hierarchy, rsync will use the
--partial\-dir as a staging area to bring over the copied file, and then
-+partial-dir as a staging area to bring over the copied file, and then
- rename it into place from there. (Specifying a \fB\-\-partial\-dir\fP with
--an absolute path does not have this side\-effect.)
-+an absolute path does not have this side-effect.)
- .IP
- .IP "\fB\-y, \-\-fuzzy\fP"
- This option tells rsync that it should look for a
- basis file for any destination file that is missing. The current algorithm
- looks in the same directory as the destination file for either a file that
--has an identical size and modified\-time, or a similarly\-named file. If
-+has an identical size and modified-time, or a similarly-named file. If
- found, rsync uses the fuzzy basis file to try to speed up the transfer.
- .IP
- Note that the use of the \fB\-\-delete\fP option might get rid of any potential
--fuzzy\-match files, so either use \fB\-\-delete\-after\fP or specify some
-+fuzzy-match files, so either use \fB\-\-delete\-after\fP or specify some
- filename exclusions if you need to prevent this.
- .IP
- .IP "\fB\-\-compare\-dest=DIR\fP"
[email protected]@ -1825,7 +1830,7 @@
[email protected]@ -2025,7 +2029,7 @@
the destination machine as an additional hierarchy to compare destination
files against doing transfers (if the files are missing in the destination
directory). If a file is found in \fIDIR\fP that is identical to the
@@ -1786,124 +1255,94 @@
+sender's file, the file will NOT be transferred to the destination
directory. This is useful for creating a sparse backup of just files that
have changed from an earlier backup.
- .IP
[email protected]@ -1845,7 +1850,7 @@
- rsync will also copy unchanged files found in \fIDIR\fP to the destination
- directory using a local copy.
- This is useful for doing transfers to a new destination while leaving
--existing files intact, and then doing a flash\-cutover when all files have
-+existing files intact, and then doing a flash-cutover when all files have
- been successfully transferred.
- .IP
- Multiple \fB\-\-copy\-dest\fP directories may be provided, which will cause
[email protected]@ -1868,10 +1873,10 @@
+ This option is typically used to copy into an empty (or newly created)
[email protected]@ -2074,10 +2078,10 @@
.RE
.IP
-If file\(cq\&s aren\(cq\&t linking, double\-check their attributes. Also check if some
-attributes are getting forced outside of rsync\(cq\&s control, such a mount option
-+If file's aren't linking, double-check their attributes. Also check if some
++If file's aren't linking, double\-check their attributes. Also check if some
+attributes are getting forced outside of rsync's control, such a mount option
that squishes root to a single user, or mounts a removable drive with generic
-ownership (such as OS X\(cq\&s \(dq\&Ignore ownership on this volume\(dq\& option).
-+ownership (such as OS X's \(lqIgnore ownership on this volume\(rq option).
++ownership (such as OS X's "Ignore ownership on this volume" option).
.IP
Beginning in version 2.6.4, multiple \fB\-\-link\-dest\fP directories may be
provided, which will cause rsync to search the list in the order specified
[email protected]@ -1882,9 +1887,9 @@
- selected to try to speed up the transfer.
- .IP
- This option works best when copying into an empty destination hierarchy, as
--rsync treats existing files as definitive (so it never looks in the link\-dest
-+rsync treats existing files as definitive (so it never looks in the link-dest
- dirs when a destination file already exists), and as malleable (so it might
--change the attributes of a destination file, which affects all the hard\-linked
-+change the attributes of a destination file, which affects all the hard-linked
- versions).
- .IP
- Note that if you combine this option with \fB\-\-ignore\-times\fP, rsync will not
[email protected]@ -1896,14 +1901,14 @@
- See also \fB\-\-compare\-dest\fP and \fB\-\-copy\-dest\fP.
- .IP
- Note that rsync versions prior to 2.6.1 had a bug that could prevent
--\fB\-\-link\-dest\fP from working properly for a non\-super\-user when \fB\-o\fP was
--specified (or implied by \fB\-a\fP). You can work\-around this bug by avoiding
-+\fB\-\-link\-dest\fP from working properly for a non-super-user when \fB\-o\fP was
-+specified (or implied by \fB\-a\fP). You can work-around this bug by avoiding
- the \fB\-o\fP option when sending to an old rsync.
[email protected]@ -2134,11 +2138,11 @@
.IP
- .IP "\fB\-z, \-\-compress\fP"
- With this option, rsync compresses the file data
- as it is sent to the destination machine, which reduces the amount of data
--being transmitted \-\- something that is useful over a slow connection.
-+being transmitted \(em something that is useful over a slow connection.
- .IP
- Note that this option typically achieves better compression ratios than can
- be achieved by using a compressing remote shell or a compressing transport
[email protected]@ -1915,7 +1920,7 @@
- .IP
- .IP "\fB\-\-compress\-level=NUM\fP"
- Explicitly set the compression level to use
--(see \fB\-\-compress\fP) instead of letting it default. If NUM is non\-zero,
-+(see \fB\-\-compress\fP) instead of letting it default. If NUM is non-zero,
- the \fB\-\-compress\fP option is implied.
- .IP
- .IP "\fB\-\-skip\-compress=LIST\fP"
[email protected]@ -1925,13 +1930,13 @@
- .IP
- You may specify an empty string to indicate that no file should be skipped.
- .IP
--Simple character\-class matching is supported: each must consist of a list
-+Simple character-class matching is supported: each must consist of a list
+ Simple character\-class matching is supported: each must consist of a list
of letters inside the square brackets (e.g. no special classes, such as
-\(dq\&[:alpha:]\(dq\&, are supported, and \(cq\&\-\(cq\& has no special meaning).
-+\(lq[:alpha:]\(rq, are supported, and '\-' has no special meaning).
++"[:alpha:]", are supported, and '\-' has no special meaning).
.IP
--The characters asterisk (*) and question\-mark (?) have no special meaning.
-+The characters asterisk (*) and question-mark (?) have no special meaning.
+ The characters asterisk (*) and question\-mark (?) have no special meaning.
.IP
-Here\(cq\&s an example that specifies 6 suffixes to skip (since 1 of the 5 rules
+Here's an example that specifies 6 suffixes to skip (since 1 of the 5 rules
matches 2 suffixes):
.IP
.nf
[email protected]@ -1962,7 +1967,7 @@
- .IP
- This list will be replaced by your \fB\-\-skip\-compress\fP list in all but one
- situation: a copy from a daemon rsync will add your skipped suffixes to
--its list of non\-compressing files (and its list may be configured to a
-+its list of non-compressing files (and its list may be configured to a
- different default).
- .IP
- .IP "\fB\-\-numeric\-ids\fP"
[email protected]@ -1978,8 +1983,8 @@
[email protected]@ -2196,8 +2200,8 @@
If a user or group has no name on the source system or it has no match
on the destination system, then the numeric ID
from the source system is used instead. See also the comments on the
-\(dq\&use chroot\(dq\& setting in the rsyncd.conf manpage for information on how
-the chroot setting affects rsync\(cq\&s ability to look up the names of the
-+\(lquse chroot\(rq setting in the rsyncd.conf manpage for information on how
++"use chroot" setting in the rsyncd.conf manpage for information on how
+the chroot setting affects rsync's ability to look up the names of the
users and groups and what you can do about it.
.IP
+ .IP "\fB\-\-usermap=STRING, \-\-groupmap=STRING\fP"
[email protected]@ -2207,9 +2211,9 @@
+ values separated by commas. Any matching \fBFROM\fP value from the sender is
+ replaced with a \fBTO\fP value from the receiver. You may specify usernames
+ or user IDs for the \fBFROM\fP and \fBTO\fP values, and the \fBFROM\fP value may
+-also be a wild\-card string, which will be matched against the sender\(cq\&s
++also be a wild\-card string, which will be matched against the sender's
+ names (wild\-cards do NOT match against ID numbers, though see below for
+-why a \(cq\&*\(cq\& matches everything). You may instead specify a range of ID
++why a '*' matches everything). You may instead specify a range of ID
+ numbers via an inclusive range: LOW\-HIGH. For example:
+ .IP
+ .nf
[email protected]@ -2221,15 +2225,15 @@
+ all your user mappings using a single \fB\-\-usermap\fP option, and/or all
+ your group mappings using a single \fB\-\-groupmap\fP option.
+ .IP
+-Note that the sender\(cq\&s name for the 0 user and group are not transmitted
++Note that the sender's name for the 0 user and group are not transmitted
+ to the receiver, so you should either match these values using a 0, or use
+-the names in effect on the receiving side (typically \(dq\&root\(dq\&). All other
++the names in effect on the receiving side (typically "root"). All other
+ \fBFROM\fP names match those in use on the sending side. All \fBTO\fP names
+ match those in use on the receiving side.
+ .IP
+ Any IDs that do not have a name on the sending side are treated as having an
+ empty name for the purpose of matching. This allows them to be matched via
+-a \(dq\&*\(dq\& or using an empty name. For instance:
++a "*" or using an empty name. For instance:
+ .IP
+ .nf
+ \-\-usermap=:nobody \-\-groupmap=*:nobody
[email protected]@ -2256,8 +2260,8 @@
+ the omitted user/group will occur. If GROUP is empty, the trailing colon may
+ be omitted, but if USER is empty, a leading colon must be supplied.
+ .IP
+-If you specify \(dq\&\-\-chown=foo:bar, this is exactly the same as specifying
+-\(dq\&\-\-usermap=*:foo \-\-groupmap=*:bar\(dq\&, only easier.
++If you specify "\-\-chown=foo:bar, this is exactly the same as specifying
++"\-\-usermap=*:foo \-\-groupmap=*:bar", only easier.
+ .IP
.IP "\fB\-\-timeout=TIMEOUT\fP"
[email protected]@ -2001,7 +2006,7 @@
- .IP "\fB\-\-port=PORT\fP"
- This specifies an alternate TCP port number to use
- rather than the default of 873. This is only needed if you are using the
--double\-colon (::) syntax to connect with an rsync daemon (since the URL
-+double-colon (::) syntax to connect with an rsync daemon (since the URL
- syntax has a way to specify the port as a part of the URL). See also this
- option in the \fB\-\-daemon\fP mode section.
+ This option allows you to set a maximum I/O
[email protected]@ -2307,18 +2311,18 @@
+ as a single letter for the mode, and use upper or lower case.
.IP
[email protected]@ -2021,21 +2026,21 @@
- This tells rsync to use blocking I/O when launching
- a remote shell transport. If the remote shell is either rsh or remsh,
- rsync defaults to using
--blocking I/O, otherwise it defaults to using non\-blocking I/O. (Note that
--ssh prefers non\-blocking I/O.)
-+blocking I/O, otherwise it defaults to using non-blocking I/O. (Note that
-+ssh prefers non-blocking I/O.)
+ The main use of this option is to change Full buffering to Line buffering
+-when rsync\(cq\&s output is going to a file or pipe.
++when rsync's output is going to a file or pipe.
.IP
.IP "\fB\-i, \-\-itemize\-changes\fP"
Requests a simple itemized list of the
@@ -1916,49 +1355,34 @@
verbose messages).
.IP
-The \(dq\&%i\(dq\& escape has a cryptic output that is 11 letters long. The general
-+The \(lq%i\(rq escape has a cryptic output that is 11 letters long. The general
++The "%i" escape has a cryptic output that is 11 letters long. The general
format is like the string \fBYXcstpoguax\fP, where \fBY\fP is replaced by the
--type of update being done, \fBX\fP is replaced by the file\-type, and the
-+type of update being done, \fBX\fP is replaced by the file-type, and the
+ type of update being done, \fBX\fP is replaced by the file\-type, and the
other letters represent attributes that may be output if they are being
- modified.
- .IP
[email protected]@ -2058,21 +2063,21 @@
- A \fB.\fP means that the item is not being updated (though it might
[email protected]@ -2344,7 +2348,7 @@
have attributes that are being modified).
.IP o
--A \fB*\fP means that the rest of the itemized\-output area contains
+ A \fB*\fP means that the rest of the itemized\-output area contains
-a message (e.g. \(dq\&deleting\(dq\&).
-+A \fB*\fP means that the rest of the itemized-output area contains
-+a message (e.g. \(lqdeleting\(rq).
++a message (e.g. "deleting").
.RE
.IP
--The file\-types that replace the \fBX\fP are: \fBf\fP for a file, a \fBd\fP for a
-+The file-types that replace the \fBX\fP are: \fBf\fP for a file, a \fBd\fP for a
- directory, an \fBL\fP for a symlink, a \fBD\fP for a device, and a \fBS\fP for a
- special file (e.g. named sockets and fifos).
[email protected]@ -2354,10 +2358,10 @@
.IP
The other letters in the string above are the actual letters that
will be output if the associated attribute for the item is being updated or
-a \(dq\&.\(dq\& for no change. Three exceptions to this are: (1) a newly created
-item replaces each letter with a \(dq\&+\(dq\&, (2) an identical item replaces the
-+a \(lq.\(rq for no change. Three exceptions to this are: (1) a newly created
-+item replaces each letter with a \(lq+\(rq, (2) an identical item replaces the
++a "." for no change. Three exceptions to this are: (1) a newly created
++item replaces each letter with a "+", (2) an identical item replaces the
dots with spaces, and (3) an unknown attribute replaces each letter with
-a \(dq\&?\(dq\& (this can happen when talking to an older rsync).
-+a \(lq?\(rq (this can happen when talking to an older rsync).
++a "?" (this can happen when talking to an older rsync).
.IP
The attribute that is associated with each letter is as follows:
.IP
[email protected]@ -2082,27 +2087,27 @@
- (requires \fB\-\-checksum\fP) or that a symlink, device, or special file has
- a changed value.
- Note that if you are sending files to an rsync prior to 3.0.1, this
--change flag will be present only for checksum\-differing regular files.
-+change flag will be present only for checksum-differing regular files.
- .IP o
- A \fBs\fP means the size of a regular file is different and will be updated
[email protected]@ -2373,21 +2377,21 @@
by the file transfer.
.IP o
A \fBt\fP means the modification time is different and is being updated
@@ -1969,8 +1393,7 @@
-symlink is changed and the receiver can\(cq\&t set its time.
+symlink is changed and the receiver can't set its time.
(Note: when using an rsync 3.0.0 client, you might see the \fBs\fP flag combined
--with \fBt\fP instead of the proper \fBT\fP flag for this time\-setting failure.)
-+with \fBt\fP instead of the proper \fBT\fP flag for this time-setting failure.)
+ with \fBt\fP instead of the proper \fBT\fP flag for this time\-setting failure.)
.IP o
A \fBp\fP means the permissions are different and are being updated to
-the sender\(cq\&s value (requires \fB\-\-perms\fP).
@@ -1978,7 +1401,7 @@
.IP o
An \fBo\fP means the owner is different and is being updated to the
-sender\(cq\&s value (requires \fB\-\-owner\fP and super\-user privileges).
-+sender's value (requires \fB\-\-owner\fP and super-user privileges).
++sender's value (requires \fB\-\-owner\fP and super\-user privileges).
.IP o
A \fBg\fP means the group is different and is being updated to the
-sender\(cq\&s value (requires \fB\-\-group\fP and the authority to set the group).
@@ -1986,61 +1409,51 @@
.IP o
The \fBu\fP slot is reserved for future use.
.IP o
[email protected]@ -2112,80 +2117,80 @@
[email protected]@ -2397,8 +2401,8 @@
.RE
.IP
-One other output is possible: when deleting files, the \(dq\&%i\(dq\& will output
-the string \(dq\&*deleting\(dq\& for each item that is being removed (assuming that
-+One other output is possible: when deleting files, the \(lq%i\(rq will output
-+the string \(lq*deleting\(rq for each item that is being removed (assuming that
++One other output is possible: when deleting files, the "%i" will output
++the string "*deleting" for each item that is being removed (assuming that
you are talking to a recent enough rsync that it logs deletions instead of
outputting them as a verbose message).
.IP
- .IP "\fB\-\-out\-format=FORMAT\fP"
[email protected]@ -2406,10 +2410,10 @@
This allows you to specify exactly what the
--rsync client outputs to the user on a per\-update basis. The format is a
--text string containing embedded single\-character escape sequences prefixed
+ rsync client outputs to the user on a per\-update basis. The format is a
+ text string containing embedded single\-character escape sequences prefixed
-with a percent (%) character. A default format of \(dq\&%n%L\(dq\& is assumed if
-+rsync client outputs to the user on a per-update basis. The format is a
-+text string containing embedded single-character escape sequences prefixed
-+with a percent (%) character. A default format of \(lq%n%L\(rq is assumed if
- \fB\-v\fP is specified (which reports the name
++with a percent (%) character. A default format of "%n%L" is assumed if
+ either \fB\-\-info=name\fP or \fB\-v\fP is specified (this tells you just the name
of the file and, if the item is a link, where it points). For a full list
-of the possible escape characters, see the \(dq\&log format\(dq\& setting in the
-+of the possible escape characters, see the \(lqlog format\(rq setting in the
++of the possible escape characters, see the "log format" setting in the
rsyncd.conf manpage.
.IP
- Specifying the \fB\-\-out\-format\fP option
- will mention each file, dir, etc. that gets updated in a significant
- way (a transferred file, a recreated symlink/device, or a touched
--directory). In addition, if the itemize\-changes escape (%i) is included in
-+directory). In addition, if the itemize-changes escape (%i) is included in
+ Specifying the \fB\-\-out\-format\fP option implies the \fB\-\-info=name\fP option,
[email protected]@ -2419,11 +2423,11 @@
the string (e.g. if the \fB\-\-itemize\-changes\fP option was used), the logging
of names increases to mention any item that is changed in any way (as long
as the receiving side is at least 2.6.4). See the \fB\-\-itemize\-changes\fP
-option for a description of the output of \(dq\&%i\(dq\&.
-+option for a description of the output of \(lq%i\(rq.
++option for a description of the output of "%i".
.IP
-Rsync will output the out\-format string prior to a file\(cq\&s transfer unless
--one of the transfer\-statistic escapes is requested, in which case the
++Rsync will output the out\-format string prior to a file's transfer unless
+ one of the transfer\-statistic escapes is requested, in which case the
-logging is done at the end of the file\(cq\&s transfer. When this late logging
-+Rsync will output the out-format string prior to a file's transfer unless
-+one of the transfer-statistic escapes is requested, in which case the
+logging is done at the end of the file's transfer. When this late logging
is in effect and \fB\-\-progress\fP is also specified, rsync will also output
the name of the file being transferred prior to its progress information
--(followed, of course, by the out\-format output).
-+(followed, of course, by the out-format output).
- .IP
- .IP "\fB\-\-log\-file=FILE\fP"
- This option causes rsync to log what it is doing
+ (followed, of course, by the out\-format output).
[email protected]@ -2433,10 +2437,10 @@
to a file. This is similar to the logging that a daemon does, but can be
--requested for the client side and/or the server side of a non\-daemon
-+requested for the client side and/or the server side of a non-daemon
+ requested for the client side and/or the server side of a non\-daemon
transfer. If specified as a client option, transfer logging will be
-enabled with a default format of \(dq\&%i %n%L\(dq\&. See the \fB\-\-log\-file\-format\fP
-+enabled with a default format of \(lq%i %n%L\(rq. See the \fB\-\-log\-file-format\fP
++enabled with a default format of "%i %n%L". See the \fB\-\-log\-file\-format\fP
option if you wish to override this.
.IP
-Here\(cq\&s a example command that requests the remote side to log what is
@@ -2048,23 +1461,12 @@
happening:
.IP
.nf
-- rsync \-av \-\-rsync\-path=\(dq\&rsync \-\-log\-file=/tmp/rlog\(dq\& src/ dest/
-+ rsync \-av \-\-rsync\-path="rsync \-\-log\-file=/tmp/rlog" src/ dest/
- .fi
-
- .IP
- This is very useful if you need to debug why a connection is closing
- unexpectedly.
- .IP
--.IP "\fB\-\-log\-file\-format=FORMAT\fP"
-+.IP "\fB\-\-log\-file-format=FORMAT\fP"
- This allows you to specify exactly what
--per\-update logging is put into the file specified by the \fB\-\-log\-file\fP option
-+per-update logging is put into the file specified by the \fB\-\-log\-file\fP option
[email protected]@ -2452,15 +2456,15 @@
+ per\-update logging is put into the file specified by the \fB\-\-log\-file\fP option
(which must also be specified for this option to have any effect). If you
specify an empty string, updated files will not be mentioned in the log file.
-For a list of the possible escape characters, see the \(dq\&log format\(dq\& setting
-+For a list of the possible escape characters, see the \(lqlog format\(rq setting
++For a list of the possible escape characters, see the "log format" setting
in the rsyncd.conf manpage.
.IP
The default FORMAT used if \fB\-\-log\-file\fP is specified and this option is not
@@ -2074,58 +1476,61 @@
.IP "\fB\-\-stats\fP"
This tells rsync to print a verbose set of statistics
-on the file transfer, allowing you to tell how effective rsync\(cq\&s delta\-transfer
-+on the file transfer, allowing you to tell how effective rsync's delta-transfer
- algorithm is for your data.
- .IP
++on the file transfer, allowing you to tell how effective rsync's delta\-transfer
+ algorithm is for your data. This option is equivalent to \fB\-\-info=stats2\fP
+ if combined with 0 or 1 \fB\-v\fP options, or \fB\-\-info=stats3\fP if combined
+ with 2 or more \fB\-v\fP options.
[email protected]@ -2468,18 +2472,18 @@
The current statistics are as follows:
.RS
.IP o
-\fBNumber of files\fP is the count of all \(dq\&files\(dq\& (in the generic
-+\fBNumber of files\fP is the count of all \(lqfiles\(rq (in the generic
- sense), which includes directories, symlinks, etc.
++\fBNumber of files\fP is the count of all "files" (in the generic
+ sense), which includes directories, symlinks, etc. The total count will
+ be followed by a list of counts by filetype (if the total is non\-zero).
+-For example: \(dq\&(reg: 5, dir: 3, link: 2, dev: 1, special: 1)\(dq\& lists the
++For example: "(reg: 5, dir: 3, link: 2, dev: 1, special: 1)" lists the
+ totals for regular files, directories, symlinks, devices, and special
+ files. If any of value is 0, it is completely omitted from the list.
+ .IP o
+-\fBNumber of created files\fP is the count of how many \(dq\&files\(dq\& (generic
++\fBNumber of created files\fP is the count of how many "files" (generic
+ sense) were created (as opposed to updated). The total count will be
+ followed by a list of counts by filetype (if the total is non\-zero).
.IP o
- \fBNumber of files transferred\fP is the count of normal files that
--were updated via rsync\(cq\&s delta\-transfer algorithm, which does not include created
-+were updated via rsync's delta-transfer algorithm, which does not include created
- dirs, symlinks, etc.
+-\fBNumber of deleted files\fP is the count of how many \(dq\&files\(dq\& (generic
++\fBNumber of deleted files\fP is the count of how many "files" (generic
+ sense) were created (as opposed to updated). The total count will be
+ followed by a list of counts by filetype (if the total is non\-zero).
+ Note that this line is only output if deletions are in effect, and only
[email protected]@ -2486,9 +2490,9 @@
+ if protocol 31 is being used (the default for rsync 3.1.x).
+ .IP o
+ \fBNumber of regular files transferred\fP is the count of normal files
+-that were updated via rsync\(cq\&s delta\-transfer algorithm, which does not
++that were updated via rsync's delta\-transfer algorithm, which does not
+ include dirs, symlinks, etc. Note that rsync 3.1.0 added the word
+-\(dq\®ular\(dq\& into this heading.
++"regular" into this heading.
.IP o
\fBTotal file size\fP is the total sum of all file sizes in the transfer.
[email protected]@ -2195,14 +2200,14 @@
- \fBTotal transferred file size\fP is the total sum of all files sizes
- for just the transferred files.
- .IP o
--\fBLiteral data\fP is how much unmatched file\-update data we had to
-+\fBLiteral data\fP is how much unmatched file-update data we had to
- send to the receiver for it to recreate the updated files.
- .IP o
- \fBMatched data\fP is how much data the receiver got locally when
- recreating the updated files.
- .IP o
--\fBFile list size\fP is how big the file\-list data was when the sender
--sent it to the receiver. This is smaller than the in\-memory size for the
-+\fBFile list size\fP is how big the file-list data was when the sender
-+sent it to the receiver. This is smaller than the in-memory size for the
- file list due to some compressing of duplicated data when rsync sends the
- list.
- .IP o
[email protected]@ -2216,27 +2221,27 @@
- \fBTotal bytes sent\fP is the count of all the bytes that rsync sent
+ This does not count any size for directories or special files, but does
[email protected]@ -2519,8 +2523,8 @@
from the client side to the server side.
.IP o
--\fBTotal bytes received\fP is the count of all non\-message bytes that
+ \fBTotal bytes received\fP is the count of all non\-message bytes that
-rsync received by the client side from the server side. \(dq\&Non\-message\(dq\&
-bytes means that we don\(cq\&t count the bytes for a verbose message that the
-+\fBTotal bytes received\fP is the count of all non-message bytes that
-+rsync received by the client side from the server side. \(lqNon-message\(rq
++rsync received by the client side from the server side. "Non\-message"
+bytes means that we don't count the bytes for a verbose message that the
server sent to us, which makes the stats more consistent.
.RE
[email protected]@ -2527,14 +2531,14 @@
.IP
.IP "\fB\-8, \-\-8\-bit\-output\fP"
--This tells rsync to leave all high\-bit characters
+ This tells rsync to leave all high\-bit characters
-unescaped in the output instead of trying to test them to see if they\(cq\&re
-+This tells rsync to leave all high-bit characters
+unescaped in the output instead of trying to test them to see if they're
valid in the current locale and escaping the invalid ones. All control
-characters (but never tabs) are always escaped, regardless of this option\(cq\&s
@@ -2135,100 +1540,90 @@
The escape idiom that started in 2.6.7 is to output a literal backslash (\e)
and a hash (#), followed by exactly 3 octal digits. For example, a newline
-would output as \(dq\&\e#012\(dq\&. A literal backslash that is in a filename is not
-+would output as \(lq\e#012\(rq. A literal backslash that is in a filename is not
++would output as "\e#012". A literal backslash that is in a filename is not
escaped unless it is followed by a hash and 3 digits (0\-9).
.IP
.IP "\fB\-h, \-\-human\-readable\fP"
--Output numbers in a more human\-readable format.
-+Output numbers in a more human-readable format.
- This makes big numbers output using larger units, with a K, M, or G suffix. If
- this option was specified once, these units are K (1000), M (1000*1000), and
- G (1000*1000*1000); if the option is repeated, the units are powers of 1024
[email protected]@ -2257,39 +2262,39 @@
- dir as data to speed up the resumption of the transfer and then delete it
- after it has served its purpose.
[email protected]@ -2556,7 +2560,7 @@
+ Backward compatibility note: versions of rsync prior to 3.1.0 do not support
+ human\-readable level 1, and they default to level 0. Thus, specifying one or
+ two \fB\-h\fP options will behave in a comparable manner in old and new versions
+-as long as you didn\(cq\&t specify a \fB\-\-no\-h\fP option prior to one or more \fB\-h\fP
++as long as you didn't specify a \fB\-\-no\-h\fP option prior to one or more \fB\-h\fP
+ options. See the \fB\-\-list\-only\fP option for one difference.
.IP
--Note that if \fB\-\-whole\-file\fP is specified (or implied), any partial\-dir
-+Note that if \fB\-\-whole\-file\fP is specified (or implied), any partial-dir
+ .IP "\fB\-\-partial\fP"
[email protected]@ -2577,12 +2581,12 @@
+ Note that if \fB\-\-whole\-file\fP is specified (or implied), any partial\-dir
file that is found for a file that is being updated will simply be removed
(since
-rsync is sending files without using rsync\(cq\&s delta\-transfer algorithm).
-+rsync is sending files without using rsync's delta-transfer algorithm).
++rsync is sending files without using rsync's delta\-transfer algorithm).
.IP
--Rsync will create the \fIDIR\fP if it is missing (just the last dir \-\- not
-+Rsync will create the \fIDIR\fP if it is missing (just the last dir \(em not
+ Rsync will create the \fIDIR\fP if it is missing (just the last dir \-\- not
the whole path). This makes it easy to use a relative path (such as
-\(dq\&\fB\-\-partial\-dir=.rsync\-partial\fP\(dq\&) to have rsync create the
-partial\-directory in the destination file\(cq\&s directory when needed, and then
-+\(lq\fB\-\-partial\-dir=.rsync\-partial\fP\(rq) to have rsync create the
-+partial-directory in the destination file's directory when needed, and then
++"\fB\-\-partial\-dir=.rsync\-partial\fP") to have rsync create the
++partial\-directory in the destination file's directory when needed, and then
remove it again when the partial file is deleted.
.IP
--If the partial\-dir value is not an absolute path, rsync will add an exclude
-+If the partial-dir value is not an absolute path, rsync will add an exclude
- rule at the end of all your existing excludes. This will prevent the
--sending of any partial\-dir files that may exist on the sending side, and
--will also prevent the untimely deletion of partial\-dir items on the
-+sending of any partial-dir files that may exist on the sending side, and
-+will also prevent the untimely deletion of partial-dir items on the
+ If the partial\-dir value is not an absolute path, rsync will add an exclude
[email protected]@ -2590,21 +2594,21 @@
+ sending of any partial\-dir files that may exist on the sending side, and
+ will also prevent the untimely deletion of partial\-dir items on the
receiving side. An example: the above \fB\-\-partial\-dir\fP option would add
-the equivalent of \(dq\&\fB\-f '\&\-p .rsync\-partial/'\&\fP\(dq\& at the end of any other
-+the equivalent of \(lq\fB\-f '\-p .rsync\-partial/'\fP\(rq at the end of any other
++the equivalent of "\fB\-f '\-p .rsync\-partial/'\fP" at the end of any other
filter rules.
.IP
If you are supplying your own exclude rules, you may need to add your own
--exclude/hide/protect rule for the partial\-dir because (1) the auto\-added
-+exclude/hide/protect rule for the partial-dir because (1) the auto-added
+ exclude/hide/protect rule for the partial\-dir because (1) the auto\-added
rule may be ineffective at the end of your other rules, or (2) you may wish
-to override rsync\(cq\&s exclude choice. For instance, if you want to make
--rsync clean\-up any left\-over partial\-dirs that may be lying around, you
++to override rsync's exclude choice. For instance, if you want to make
+ rsync clean\-up any left\-over partial\-dirs that may be lying around, you
-should specify \fB\-\-delete\-after\fP and add a \(dq\&risk\(dq\& filter rule, e.g.
-\fB\-f '\&R .rsync\-partial/'\&\fP. (Avoid using \fB\-\-delete\-before\fP or
-\fB\-\-delete\-during\fP unless you don\(cq\&t need rsync to use any of the
--left\-over partial\-dir data during the current run.)
-+to override rsync's exclude choice. For instance, if you want to make
-+rsync clean-up any left-over partial-dirs that may be lying around, you
-+should specify \fB\-\-delete\-after\fP and add a \(lqrisk\(rq filter rule, e.g.
++should specify \fB\-\-delete\-after\fP and add a "risk" filter rule, e.g.
+\fB\-f 'R .rsync\-partial/'\fP. (Avoid using \fB\-\-delete\-before\fP or
+\fB\-\-delete\-during\fP unless you don't need rsync to use any of the
-+left-over partial-dir data during the current run.)
+ left\-over partial\-dir data during the current run.)
.IP
IMPORTANT: the \fB\-\-partial\-dir\fP should not be writable by other users or it
-is a security risk. E.g. AVOID \(dq\&/tmp\(dq\&.
-+is a security risk. E.g. AVOID \(lq/tmp\(rq.
++is a security risk. E.g. AVOID "/tmp".
.IP
--You can also set the partial\-dir value the RSYNC_PARTIAL_DIR environment
-+You can also set the partial-dir value the RSYNC_PARTIAL_DIR environment
+ You can also set the partial\-dir value the RSYNC_PARTIAL_DIR environment
variable. Setting this in the environment does not force \fB\-\-partial\fP to be
- enabled, but rather it affects where partial files go when \fB\-\-partial\fP is
- specified. For instance, instead of using \fB\-\-partial\-dir=.rsync\-tmp\fP
[email protected]@ -2300,7 +2305,7 @@
[email protected]@ -2617,7 +2621,7 @@
specified (since \fB\-\-inplace\fP conflicts with \fB\-\-partial\-dir\fP), and (2) when
\fB\-\-delay\-updates\fP was specified (see below).
.IP
-For the purposes of the daemon\-config\(cq\&s \(dq\&refuse options\(dq\& setting,
-+For the purposes of the daemon-config's \(lqrefuse options\(rq setting,
++For the purposes of the daemon\-config's "refuse options" setting,
\fB\-\-partial\-dir\fP does \fInot\fP imply \fB\-\-partial\fP. This is so that a
refusal of the \fB\-\-partial\fP option can be used to disallow the overwriting
of destination files with a partial transfer, while still allowing the
[email protected]@ -2311,12 +2316,12 @@
[email protected]@ -2628,12 +2632,12 @@
updated file into a holding directory until the end of the
transfer, at which time all the files are renamed into place in rapid
succession. This attempts to make the updating of the files a little more
-atomic. By default the files are placed into a directory named \(dq\&.~tmp~\(dq\& in
-each file\(cq\&s destination directory, but if you\(cq\&ve specified the
-+atomic. By default the files are placed into a directory named \(lq.~tmp~\(rq in
++atomic. By default the files are placed into a directory named ".~tmp~" in
+each file's destination directory, but if you've specified the
\fB\-\-partial\-dir\fP option, that directory will be used instead. See the
comments in the \fB\-\-partial\-dir\fP section for a discussion of how this
-\(dq\&.~tmp~\(dq\& dir will be excluded from the transfer, and what you can do if
-you want rsync to cleanup old \(dq\&.~tmp~\(dq\& dirs that might be lying around.
-+\(lq.~tmp~\(rq dir will be excluded from the transfer, and what you can do if
-+you want rsync to cleanup old \(lq.~tmp~\(rq dirs that might be lying around.
++".~tmp~" dir will be excluded from the transfer, and what you can do if
++you want rsync to cleanup old ".~tmp~" dirs that might be lying around.
Conflicts with \fB\-\-inplace\fP and \fB\-\-append\fP.
.IP
This option uses more memory on the receiving side (one bit per file
[email protected]@ -2328,16 +2333,16 @@
[email protected]@ -2645,9 +2649,9 @@
the updated files will be put into a single directory if the path is
absolute)
and (2) there are no mount points in the hierarchy (since the
@@ -2236,38 +1631,18 @@
+delayed updates will fail if they can't be renamed into place).
.IP
-See also the \(dq\&atomic\-rsync\(dq\& perl script in the \(dq\&support\(dq\& subdir for an
-+See also the \(lqatomic-rsync\(rq perl script in the \(lqsupport\(rq subdir for an
++See also the "atomic\-rsync" perl script in the "support" subdir for an
update algorithm that is even more atomic (it uses \fB\-\-link\-dest\fP and a
parallel hierarchy of files).
.IP
- .IP "\fB\-m, \-\-prune\-empty\-dirs\fP"
- This option tells the receiving rsync to get
--rid of empty directories from the file\-list, including nested directories
--that have no non\-directory children. This is useful for avoiding the
-+rid of empty directories from the file-list, including nested directories
-+that have no non-directory children. This is useful for avoiding the
- creation of a bunch of useless directories when the sending rsync is
- recursively scanning a hierarchy of files using include/exclude/filter
- rules.
[email protected]@ -2346,41 +2351,41 @@
- not affect what goes into the file list, and thus does not leave directories
- empty, even if none of the files in a directory match the transfer rule.
- .IP
--Because the file\-list is actually being pruned, this option also affects
-+Because the file-list is actually being pruned, this option also affects
- what directories get deleted when a delete is active. However, keep in
- mind that excluded files and directories can prevent existing items from
- being deleted due to an exclude both hiding source files and protecting
--destination files. See the perishable filter\-rule option for how to avoid
-+destination files. See the perishable filter-rule option for how to avoid
[email protected]@ -2671,26 +2675,26 @@
this.
.IP
--You can prevent the pruning of certain empty directories from the file\-list
+ You can prevent the pruning of certain empty directories from the file\-list
-by using a global \(dq\&protect\(dq\& filter. For instance, this option would ensure
-that the directory \(dq\&emptydir\(dq\& was kept in the file\-list:
-+You can prevent the pruning of certain empty directories from the file-list
-+by using a global \(lqprotect\(rq filter. For instance, this option would ensure
-+that the directory \(lqemptydir\(rq was kept in the file-list:
++by using a global "protect" filter. For instance, this option would ensure
++that the directory "emptydir" was kept in the file\-list:
.IP
.RS
-\-\-filter \(cq\&protect emptydir/\(cq\&
@@ -2279,8 +1654,7 @@
+Here's an example that copies all .pdf files in a hierarchy, only creating
the necessary destination directories to hold the .pdf files, and ensures
that any superfluous files and directories in the destination are removed
--(note the hide filter of non\-directories being used instead of an exclude):
-+(note the hide filter of non-directories being used instead of an exclude):
+ (note the hide filter of non\-directories being used instead of an exclude):
.IP
.RS
-rsync \-avm \-\-del \-\-include=\(cq\&*.pdf\(cq\& \-f \(cq\&hide,! */\(cq\& src/ dest
@@ -2290,21 +1664,21 @@
.IP
-If you didn\(cq\&t want to remove superfluous destination files, the more
-time\-honored options of \(dq\&\fB\-\-include='\&*/'\& \-\-exclude='\&*'\&\fP\(dq\& would work fine
--in place of the hide\-filter (if that is more natural to you).
+If you didn't want to remove superfluous destination files, the more
-+time-honored options of \(lq\fB\-\-include='*/' \-\-exclude='*'\fP\(rq would work fine
-+in place of the hide-filter (if that is more natural to you).
++time\-honored options of "\fB\-\-include='*/' \-\-exclude='*'\fP" would work fine
+ in place of the hide\-filter (if that is more natural to you).
.IP
.IP "\fB\-\-progress\fP"
- This option tells rsync to print information
- showing the progress of the transfer. This gives a bored user
[email protected]@ -2699,7 +2703,7 @@
something to watch.
--Implies \fB\-\-verbose\fP if it wasn\(cq\&t already specified.
-+Implies \fB\-\-verbose\fP if it wasn't already specified.
+ With a modern rsync this is the same as specifying
+ \fB\-\-info=flist2,name,progress\fP, but any user\-supplied settings for those
+-info flags takes precedence (e.g. \(dq\&\-\-info=flist0 \-\-progress\(dq\&).
++info flags takes precedence (e.g. "\-\-info=flist0 \-\-progress").
.IP
While rsync is transferring a regular file, it updates a progress line that
looks like this:
[email protected]@ -2391,12 +2396,12 @@
[email protected]@ -2710,12 +2714,12 @@
.IP
In this example, the receiver has reconstructed 782448 bytes or 63% of the
@@ -2315,33 +1689,39 @@
.IP
-These statistics can be misleading if rsync\(cq\&s delta\-transfer algorithm is
-in use. For example, if the sender\(cq\&s file consists of the basis file
-+These statistics can be misleading if rsync's delta-transfer algorithm is
++These statistics can be misleading if rsync's delta\-transfer algorithm is
+in use. For example, if the sender's file consists of the basis file
followed by additional data, the reported rate will probably drop
dramatically when the receiver gets to the literal data, and the transfer
will probably take much longer to finish than the receiver estimated as it
[email protected]@ -2406,7 +2411,7 @@
- summary line that looks like this:
- .IP
- .nf
-- 1238099 100% 146.38kB/s 0:00:08 (xfer#5, to\-check=169/396)
-+ 1238099 100% 146.38kB/s 0:00:08 (xfer#5, to-check=169/396)
- .fi
-
[email protected]@ -2736,12 +2740,12 @@
+ receiver to check (to see if they are up\-to\-date or not) remaining out of
+ the 396 total files in the file\-list.
.IP
[email protected]@ -2414,8 +2419,8 @@
- of transfer for the whole file was 146.38 kilobytes per second over the 8
- seconds that it took to complete, it was the 5th transfer of a regular file
- during the current rsync session, and there are 169 more files for the
--receiver to check (to see if they are up\-to\-date or not) remaining out of
--the 396 total files in the file\-list.
-+receiver to check (to see if they are up-to-date or not) remaining out of
-+the 396 total files in the file-list.
+-In an incremental recursion scan, rsync won\(cq\&t know the total number of files
++In an incremental recursion scan, rsync won't know the total number of files
+ in the file\-list until it reaches the ends of the scan, but since it starts to
+-transfer files during the scan, it will display a line with the text \(dq\&ir\-chk\(dq\&
+-(for incremental recursion check) instead of \(dq\&to\-chk\(dq\& until the point that it
++transfer files during the scan, it will display a line with the text "ir\-chk"
++(for incremental recursion check) instead of "to\-chk" until the point that it
+ knows the full size of the list, at which point it will switch to using
+-\(dq\&to\-chk\(dq\&. Thus, seeing \(dq\&ir\-chk\(dq\& lets you know that the total count of files
++"to\-chk". Thus, seeing "ir\-chk" lets you know that the total count of files
+ in the file list is still going to increase (and each time it does, the count
+ of files left to check will increase by the number of the files added to the
+ list).
[email protected]@ -2755,7 +2759,7 @@
+ on the whole transfer, rather than individual files. Use this flag without
+ outputting a filename (e.g. avoid \fB\-v\fP or specify \fB\-\-info=name0\fP if you
+ want to see how the transfer is doing without scrolling the screen with a
+-lot of names. (You don\(cq\&t need to specify the \fB\-\-progress\fP option in
++lot of names. (You don't need to specify the \fB\-\-progress\fP option in
+ order to use \fB\-\-info=progress2\fP.)
.IP
- .IP "\fB\-P\fP"
- The \fB\-P\fP option is equivalent to \fB\-\-partial\fP \fB\-\-progress\fP. Its
[email protected]@ -2429,10 +2434,10 @@
- other lines are ignored).
+ .IP "\fB\-\-password\-file=FILE\fP"
[email protected]@ -2766,10 +2770,10 @@
+ readable or if a root\-run rsync command finds a non\-root\-owned file.
.IP
This option does not supply a password to a remote shell transport such as
-ssh; to learn how to do that, consult the remote shell\(cq\&s documentation.
@@ -2353,54 +1733,58 @@
config file).
.IP
.IP "\fB\-\-list\-only\fP"
[email protected]@ -2440,9 +2445,9 @@
- instead of transferred. This option is inferred if there is a single source
- arg and no destination specified, so its main uses are: (1) to turn a copy
- command that includes a
--destination arg into a file\-listing command, or (2) to be able to specify
-+destination arg into a file-listing command, or (2) to be able to specify
- more than one source arg (note: be sure to include the destination).
--Caution: keep in mind that a source arg with a wild\-card is expanded by the
-+Caution: keep in mind that a source arg with a wild-card is expanded by the
- shell into multiple args, so it is never safe to try to list such an arg
- without using this option. For example:
- .IP
[email protected]@ -2453,11 +2458,11 @@
- .IP
[email protected]@ -2799,17 +2803,17 @@
Compatibility note: when requesting a remote listing of files from an rsync
that is version 2.6.3 or older, you may encounter an error if you ask for a
--non\-recursive listing. This is because a file listing implies the \fB\-\-dirs\fP
+ non\-recursive listing. This is because a file listing implies the \fB\-\-dirs\fP
-option w/o \fB\-\-recursive\fP, and older rsyncs don\(cq\&t have that option. To
-avoid this problem, either specify the \fB\-\-no\-dirs\fP option (if you don\(cq\&t
-need to expand a directory\(cq\&s content), or turn on recursion and exclude
-the content of subdirectories: \fB\-r \-\-exclude='\&/*/*'\&\fP.
-+non-recursive listing. This is because a file listing implies the \fB\-\-dirs\fP
+option w/o \fB\-\-recursive\fP, and older rsyncs don't have that option. To
+avoid this problem, either specify the \fB\-\-no\-dirs\fP option (if you don't
+need to expand a directory's content), or turn on recursion and exclude
+the content of subdirectories: \fB\-r \-\-exclude='/*/*'\fP.
.IP
- .IP "\fB\-\-bwlimit=KBPS\fP"
- This option allows you to specify a maximum
[email protected]@ -2470,7 +2475,7 @@
+ .IP "\fB\-\-bwlimit=RATE\fP"
+ This option allows you to specify the maximum transfer
+ rate for the data sent over the socket, specified in units per second. The
+ RATE value can be suffixed with a string to indicate a size multiplier, and may
+-be a fractional value (e.g. \(dq\&\fB\-\-bwlimit=1.5m\fP\(dq\&). If no suffix is specified,
+-the value will be assumed to be in units of 1024 bytes (as if \(dq\&K\(dq\& or \(dq\&KiB\(dq\& had
++be a fractional value (e.g. "\fB\-\-bwlimit=1.5m\fP"). If no suffix is specified,
++the value will be assumed to be in units of 1024 bytes (as if "K" or "KiB" had
+ been appended). See the \fB\-\-max\-size\fP option for a description of all the
+ available suffixes. A value of zero specifies no limit.
+ .IP
[email protected]@ -2818,7 +2822,7 @@
+ .IP
+ Rsync writes data over the socket in blocks, and this option both limits the
+ size of the blocks that rsync writes, and tries to keep the average transfer
+-rate at the requested limit. Some \(dq\&burstiness\(dq\& may be seen where rsync writes
++rate at the requested limit. Some "burstiness" may be seen where rsync writes
+ out a block of data and then sleeps to bring the average rate into compliance.
+ .IP
+ Due to the internal buffering of data, the \fB\-\-progress\fP option may not be an
[email protected]@ -2829,7 +2833,7 @@
.IP
.IP "\fB\-\-write\-batch=FILE\fP"
Record a file that can later be applied to
-another identical destination with \fB\-\-read\-batch\fP. See the \(dq\&BATCH MODE\(dq\&
-+another identical destination with \fB\-\-read\-batch\fP. See the \(lqBATCH MODE\(rq
++another identical destination with \fB\-\-read\-batch\fP. See the "BATCH MODE"
section for details, and also the \fB\-\-only\-write\-batch\fP option.
.IP
.IP "\fB\-\-only\-write\-batch=FILE\fP"
[email protected]@ -2482,58 +2487,58 @@
[email protected]@ -2841,7 +2845,7 @@
Note that you can feel free to write the batch directly to some portable
media: if this media fills to capacity before the end of the transfer, you
can just apply that partial transfer to the destination and repeat the
-whole process to get the rest of the changes (as long as you don\(cq\&t mind a
--partially updated destination system while the multi\-update cycle is
+whole process to get the rest of the changes (as long as you don't mind a
-+partially updated destination system while the multi-update cycle is
+ partially updated destination system while the multi\-update cycle is
happening).
.IP
[email protected]@ -2848,13 +2852,13 @@
Also note that you only save bandwidth when pushing changes to a remote
system because this allows the batched data to be diverted from the sender
into the batch file without having to flow over the wire to the receiver
@@ -2412,15 +1796,16 @@
file previously generated by \fB\-\-write\-batch\fP.
If \fIFILE\fP is \fB\-\fP, the batch data will be read from standard input.
-See the \(dq\&BATCH MODE\(dq\& section for details.
-+See the \(lqBATCH MODE\(rq section for details.
++See the "BATCH MODE" section for details.
.IP
.IP "\fB\-\-protocol=NUM\fP"
Force an older protocol version to be used. This
[email protected]@ -2861,25 +2865,25 @@
is useful for creating a batch file that is compatible with an older
version of rsync. For instance, if rsync 2.6.4 is being used with the
\fB\-\-write\-batch\fP option, but rsync 2.6.3 is what will be used to run the
-\fB\-\-read\-batch\fP option, you should use \(dq\&\-\-protocol=28\(dq\& when creating the
-+\fB\-\-read\-batch\fP option, you should use \(lq\-\-protocol=28\(rq when creating the
++\fB\-\-read\-batch\fP option, you should use "\-\-protocol=28" when creating the
batch file to force the older protocol version to be used in the batch
-file (assuming you can\(cq\&t upgrade the rsync on the reading system).
+file (assuming you can't upgrade the rsync on the reading system).
@@ -2428,28 +1813,26 @@
.IP "\fB\-\-iconv=CONVERT_SPEC\fP"
Rsync can convert filenames between character
-sets using this option. Using a CONVERT_SPEC of \(dq\&.\(dq\& tells rsync to look up
--the default character\-set via the locale setting. Alternately, you can
-+sets using this option. Using a CONVERT_SPEC of \(lq.\(rq tells rsync to look up
-+the default character-set via the locale setting. Alternately, you can
++sets using this option. Using a CONVERT_SPEC of "." tells rsync to look up
+ the default character\-set via the locale setting. Alternately, you can
fully specify what conversion to do by giving a local and a remote charset
separated by a comma in the order \fB\-\-iconv=LOCAL,REMOTE\fP, e.g.
\fB\-\-iconv=utf8,iso88591\fP. This order ensures that the option
-will stay the same whether you\(cq\&re pushing or pulling files.
-Finally, you can specify either \fB\-\-no\-iconv\fP or a CONVERT_SPEC of \(dq\&\-\(dq\&
+will stay the same whether you're pushing or pulling files.
-+Finally, you can specify either \fB\-\-no\-iconv\fP or a CONVERT_SPEC of \(lq\-\(rq
++Finally, you can specify either \fB\-\-no\-iconv\fP or a CONVERT_SPEC of "\-"
to turn off any conversion.
--The default setting of this option is site\-specific, and can also be
-+The default setting of this option is site-specific, and can also be
+ The default setting of this option is site\-specific, and can also be
affected via the RSYNC_ICONV environment variable.
.IP
For a list of what charset names your local iconv library supports, you can
-run \(dq\&iconv \-\-list\(dq\&.
-+run \(lqiconv \-\-list\(rq.
++run "iconv \-\-list".
.IP
If you specify the \fB\-\-protect\-args\fP option (\fB\-s\fP), rsync will translate
--the filenames you specify on the command\-line that are being sent to the
-+the filenames you specify on the command-line that are being sent to the
+ the filenames you specify on the command\-line that are being sent to the
[email protected]@ -2886,13 +2890,13 @@
remote host. See also the \fB\-\-files\-from\fP option.
.IP
Note that rsync does not do any conversion of names in filter files
@@ -2461,29 +1844,38 @@
.IP
When you pass an \fB\-\-iconv\fP option to an rsync daemon that allows it, the
-daemon uses the charset specified in its \(dq\&charset\(dq\& configuration parameter
-+daemon uses the charset specified in its \(lqcharset\(rq configuration parameter
++daemon uses the charset specified in its "charset" configuration parameter
regardless of the remote charset you actually pass. Thus, you may feel free to
specify just the local charset for a daemon transfer (e.g. \fB\-\-iconv=utf8\fP).
.IP
[email protected]@ -2584,7 +2589,7 @@
[email protected]@ -2909,7 +2913,7 @@
+ .IP "\fB\-\-checksum\-seed=NUM\fP"
+ Set the checksum seed to the integer NUM. This 4
+ byte checksum seed is included in each block and MD4 file checksum calculation
+-(the more modern MD5 file checksums don\(cq\&t use a seed). By default the checksum
++(the more modern MD5 file checksums don't use a seed). By default the checksum
+ seed is generated by the server and defaults to the current
+ \f(CWtime()\fP
+ \&. This
[email protected]@ -2942,7 +2946,7 @@
run as a daemon with the \fB\-\-daemon\fP option. The \fB\-\-address\fP option
allows you to specify a specific IP address (or hostname) to bind to. This
makes virtual hosting possible in conjunction with the \fB\-\-config\fP option.
-See also the \(dq\&address\(dq\& global option in the rsyncd.conf manpage.
-+See also the \(lqaddress\(rq global option in the rsyncd.conf manpage.
++See also the "address" global option in the rsyncd.conf manpage.
.IP
- .IP "\fB\-\-bwlimit=KBPS\fP"
- This option allows you to specify a maximum
[email protected]@ -2597,7 +2602,7 @@
- This specifies an alternate config file than
- the default. This is only relevant when \fB\-\-daemon\fP is specified.
- The default is /etc/rsyncd.conf unless the daemon is running over
--a remote shell program and the remote user is not the super\-user; in that case
-+a remote shell program and the remote user is not the super-user; in that case
- the default is rsyncd.conf in the current directory (typically $HOME).
+ .IP "\fB\-\-bwlimit=RATE\fP"
+ This option allows you to specify the maximum transfer
[email protected]@ -2960,7 +2964,7 @@
+ .IP "\fB\-M, \-\-dparam=OVERRIDE\fP"
+ This option can be used to set a daemon\-config
+ parameter when starting up rsync in daemon mode. It is equivalent to adding
+-the parameter at the end of the global settings prior to the first module\(cq\&s
++the parameter at the end of the global settings prior to the first module's
+ definition. The parameter names can be specified without spaces, if you so
+ desire. For instance:
.IP
- .IP "\fB\-\-no\-detach\fP"
[email protected]@ -2605,25 +2610,25 @@
[email protected]@ -2974,7 +2978,7 @@
rsync to not detach itself and become a background process. This
option is required when running as a service on Cygwin, and may also
be useful when rsync is supervised by a program such as
@@ -2492,178 +1884,150 @@
\fB\-\-no\-detach\fP is also recommended when rsync is run under a
debugger. This option has no effect if rsync is run from inetd or
sshd.
[email protected]@ -2981,18 +2985,18 @@
.IP
.IP "\fB\-\-port=PORT\fP"
This specifies an alternate TCP port number for the
-daemon to listen on rather than the default of 873. See also the \(dq\&port\(dq\&
-+daemon to listen on rather than the default of 873. See also the \(lqport\(rq
++daemon to listen on rather than the default of 873. See also the "port"
global option in the rsyncd.conf manpage.
.IP
.IP "\fB\-\-log\-file=FILE\fP"
This option tells the rsync daemon to use the
-given log\-file name instead of using the \(dq\&log file\(dq\& setting in the config
-+given log-file name instead of using the \(lqlog file\(rq setting in the config
++given log\-file name instead of using the "log file" setting in the config
file.
.IP
.IP "\fB\-\-log\-file\-format=FORMAT\fP"
This option tells the rsync daemon to use the
-given FORMAT string instead of using the \(dq\&log format\(dq\& setting in the config
-file. It also enables \(dq\&transfer logging\(dq\& unless the string is empty, in which
-+given FORMAT string instead of using the \(lqlog format\(rq setting in the config
-+file. It also enables \(lqtransfer logging\(rq unless the string is empty, in which
++given FORMAT string instead of using the "log format" setting in the config
++file. It also enables "transfer logging" unless the string is empty, in which
case transfer logging is turned off.
.IP
.IP "\fB\-\-sockopts\fP"
[email protected]@ -2633,15 +2638,15 @@
[email protected]@ -3002,8 +3006,8 @@
.IP "\fB\-v, \-\-verbose\fP"
This option increases the amount of information the
daemon logs during its startup phase. After the client connects, the
-daemon\(cq\&s verbosity level will be controlled by the options that the client
-used and the \(dq\&max verbosity\(dq\& setting in the module\(cq\&s config section.
+daemon's verbosity level will be controlled by the options that the client
-+used and the \(lqmax verbosity\(rq setting in the module's config section.
++used and the "max verbosity" setting in the module's config section.
.IP
.IP "\fB\-4, \-\-ipv4\fP or \fB\-6, \-\-ipv6\fP"
Tells rsync to prefer IPv4/IPv6
[email protected]@ -3010,7 +3014,7 @@
when creating the incoming sockets that the rsync daemon will use to
listen for connections. One of these options may be required in older
versions of Linux to work around an IPv6 bug in the kernel (if you see
-an \(dq\&address already in use\(dq\& error when nothing else is using the port,
-+an \(lqaddress already in use\(rq error when nothing else is using the port,
++an "address already in use" error when nothing else is using the port,
try specifying \fB\-\-ipv6\fP or \fB\-\-ipv4\fP when starting the daemon).
.IP
If rsync was complied without support for IPv6, the \fB\-\-ipv6\fP option
[email protected]@ -2669,7 +2674,7 @@
- filename is not skipped.
- .PP
- Rsync builds an ordered list of filter rules as specified on the
--command\-line. Filter rules have the following syntax:
-+command-line. Filter rules have the following syntax:
- .PP
- .RS
- \f(CWRULE [PATTERN_OR_FILENAME]\fP
[email protected]@ -2680,7 +2685,7 @@
[email protected]@ -3049,7 +3053,7 @@
.PP
You have your choice of using either short or long RULE names, as described
-below. If you use a short\-named rule, the \(cq\&,\(cq\& separating the RULE from the
-+below. If you use a short-named rule, the \(oq,\(cq separating the RULE from the
++below. If you use a short\-named rule, the ',' separating the RULE from the
MODIFIERS is optional. The PATTERN or FILENAME that follows (when present)
must come after either a single space or an underscore (_).
Here are the available rule prefixes:
[email protected]@ -2690,9 +2695,9 @@
- .br
- \fBinclude, +\fP specifies an include pattern.
- .br
--\fBmerge, .\fP specifies a merge\-file to read for more rules.
-+\fBmerge, .\fP specifies a merge-file to read for more rules.
- .br
--\fBdir\-merge, :\fP specifies a per\-directory merge\-file.
-+\fBdir-merge, :\fP specifies a per-directory merge-file.
- .br
- \fBhide, H\fP specifies a pattern for hiding files from the transfer.
- .br
[email protected]@ -2708,29 +2713,29 @@
[email protected]@ -3077,15 +3081,15 @@
.PP
When rules are being read from a file, empty lines are ignored, as are
-comment lines that start with a \(dq\&#\(dq\&.
-+comment lines that start with a \(lq#\(rq.
++comment lines that start with a "#".
.PP
--Note that the \fB\-\-include\fP/\fB\-\-exclude\fP command\-line options do not allow the
--full range of rule parsing as described above \-\- they only allow the
+ Note that the \fB\-\-include\fP/\fB\-\-exclude\fP command\-line options do not allow the
+ full range of rule parsing as described above \-\- they only allow the
-specification of include/exclude patterns plus a \(dq\&!\(dq\& token to clear the
-+Note that the \fB\-\-include\fP/\fB\-\-exclude\fP command-line options do not allow the
-+full range of rule parsing as described above \(em they only allow the
-+specification of include/exclude patterns plus a \(lq!\(rq token to clear the
++specification of include/exclude patterns plus a "!" token to clear the
list (and the normal comment parsing when rules are read from a file).
If a pattern
-does not begin with \(dq\&\- \(dq\& (dash, space) or \(dq\&+ \(dq\& (plus, space), then the
-rule will be interpreted as if \(dq\&+ \(dq\& (for an include option) or \(dq\&\- \(dq\& (for
-+does not begin with \(lq\- \(rq (dash, space) or \(lq+ \(rq (plus, space), then the
-+rule will be interpreted as if \(lq+ \(rq (for an include option) or \(lq\- \(rq (for
++does not begin with "\- " (dash, space) or "+ " (plus, space), then the
++rule will be interpreted as if "+ " (for an include option) or "\- " (for
an exclude option) were prefixed to the string. A \fB\-\-filter\fP option, on
the other hand, must always contain either a short or long rule name at the
start of the rule.
- .PP
- Note also that the \fB\-\-filter\fP, \fB\-\-include\fP, and \fB\-\-exclude\fP options take one
- rule/pattern each. To add multiple ones, you can repeat the options on
--the command\-line, use the merge\-file syntax of the \fB\-\-filter\fP option, or
-+the command-line, use the merge-file syntax of the \fB\-\-filter\fP option, or
- the \fB\-\-include\-from\fP/\fB\-\-exclude\-from\fP options.
- .PP
[email protected]@ -3098,8 +3102,8 @@
.SH "INCLUDE/EXCLUDE PATTERN RULES"
.PP
-You can include and exclude files by specifying patterns using the \(dq\&+\(dq\&,
-\(dq\&\-\(dq\&, etc. filter rules (as introduced in the FILTER RULES section above).
-+You can include and exclude files by specifying patterns using the \(lq+\(rq,
-+\(lq\-\(rq, etc. filter rules (as introduced in the FILTER RULES section above).
++You can include and exclude files by specifying patterns using the "+",
++"\-", etc. filter rules (as introduced in the FILTER RULES section above).
The include/exclude rules each specify a pattern that is matched against
the names of the files that are going to be transferred. These patterns
can take several forms:
[email protected]@ -2740,15 +2745,15 @@
[email protected]@ -3109,15 +3113,15 @@
particular spot in the hierarchy of files, otherwise it is matched
against the end of the pathname. This is similar to a leading ^ in
regular expressions.
-Thus \(dq\&/foo\(dq\& would match a name of \(dq\&foo\(dq\& at either the \(dq\&root of the
-transfer\(dq\& (for a global rule) or in the merge\-file\(cq\&s directory (for a
--per\-directory rule).
++Thus "/foo" would match a name of "foo" at either the "root of the
++transfer" (for a global rule) or in the merge\-file's directory (for a
+ per\-directory rule).
-An unqualified \(dq\&foo\(dq\& would match a name of \(dq\&foo\(dq\& anywhere in the
-+Thus \(lq/foo\(rq would match a name of \(lqfoo\(rq at either the \(lqroot of the
-+transfer\(rq (for a global rule) or in the merge-file's directory (for a
-+per-directory rule).
-+An unqualified \(lqfoo\(rq would match a name of \(lqfoo\(rq anywhere in the
++An unqualified "foo" would match a name of "foo" anywhere in the
tree because the algorithm is applied recursively from the
top down; it behaves as if each path component gets a turn at being the
-end of the filename. Even the unanchored \(dq\&sub/foo\(dq\& would match at
-any point in the hierarchy where a \(dq\&foo\(dq\& was found within a directory
-named \(dq\&sub\(dq\&. See the section on ANCHORING INCLUDE/EXCLUDE PATTERNS for
-+end of the filename. Even the unanchored \(lqsub/foo\(rq would match at
-+any point in the hierarchy where a \(lqfoo\(rq was found within a directory
-+named \(lqsub\(rq. See the section on ANCHORING INCLUDE/EXCLUDE PATTERNS for
++end of the filename. Even the unanchored "sub/foo" would match at
++any point in the hierarchy where a "foo" was found within a directory
++named "sub". See the section on ANCHORING INCLUDE/EXCLUDE PATTERNS for
a full discussion of how to specify a pattern that matches at the root
of the transfer.
.IP o
[email protected]@ -2757,44 +2762,44 @@
[email protected]@ -3126,44 +3130,44 @@
.IP o
rsync chooses between doing a simple string match and wildcard
matching by checking if the pattern contains one of these three wildcard
-characters: \(cq\&*\(cq\&, \(cq\&?\(cq\&, and \(cq\&[\(cq\& .
-+characters: \(oq*\(cq, \(oq?\(cq, and \(oq[\(cq .
++characters: '*', '?', and '[' .
.IP o
-a \(cq\&*\(cq\& matches any path component, but it stops at slashes.
-+a \(oq*\(cq matches any path component, but it stops at slashes.
++a '*' matches any path component, but it stops at slashes.
.IP o
-use \(cq\&**\(cq\& to match anything, including slashes.
-+use \(oq**\(cq to match anything, including slashes.
++use '**' to match anything, including slashes.
.IP o
-a \(cq\&?\(cq\& matches any character except a slash (/).
-+a \(oq?\(cq matches any character except a slash (/).
++a '?' matches any character except a slash (/).
.IP o
-a \(cq\&[\(cq\& introduces a character class, such as [a\-z] or [[:alpha:]].
-+a \(oq[\(cq introduces a character class, such as [a\-z] or [[:alpha:]].
++a '[' introduces a character class, such as [a\-z] or [[:alpha:]].
.IP o
in a wildcard pattern, a backslash can be used to escape a wildcard
character, but it is matched literally when no wildcards are present.
.IP o
-if the pattern contains a / (not counting a trailing /) or a \(dq\&**\(dq\&,
-+if the pattern contains a / (not counting a trailing /) or a \(lq**\(rq,
++if the pattern contains a / (not counting a trailing /) or a "**",
then it is matched against the full pathname, including any leading
-directories. If the pattern doesn\(cq\&t contain a / or a \(dq\&**\(dq\&, then it is
-+directories. If the pattern doesn't contain a / or a \(lq**\(rq, then it is
++directories. If the pattern doesn't contain a / or a "**", then it is
matched only against the final component of the filename.
-(Remember that the algorithm is applied recursively so \(dq\&full filename\(dq\&
-+(Remember that the algorithm is applied recursively so \(lqfull filename\(rq
++(Remember that the algorithm is applied recursively so "full filename"
can actually be any portion of a path from the starting directory on
down.)
.IP o
-a trailing \(dq\&dir_name/***\(dq\& will match both the directory (as if
-\(dq\&dir_name/\(dq\& had been specified) and everything in the directory
-(as if \(dq\&dir_name/**\(dq\& had been specified). This behavior was added in
-+a trailing \(lqdir_name/***\(rq will match both the directory (as if
-+\(lqdir_name/\(rq had been specified) and everything in the directory
-+(as if \(lqdir_name/**\(rq had been specified). This behavior was added in
++a trailing "dir_name/***" will match both the directory (as if
++"dir_name/" had been specified) and everything in the directory
++(as if "dir_name/**" had been specified). This behavior was added in
version 2.6.7.
.PP
@@ -2672,76 +2036,72 @@
-include/exclude patterns get applied recursively to each subcomponent\(cq\&s
-full name (e.g. to include \(dq\&/foo/bar/baz\(dq\& the subcomponents \(dq\&/foo\(dq\& and
-\(dq\&/foo/bar\(dq\& must not be excluded).
--The exclude patterns actually short\-circuit the directory traversal stage
+include/exclude patterns get applied recursively to each subcomponent's
-+full name (e.g. to include \(lq/foo/bar/baz\(rq the subcomponents \(lq/foo\(rq and
-+\(lq/foo/bar\(rq must not be excluded).
-+The exclude patterns actually short-circuit the directory traversal stage
++full name (e.g. to include "/foo/bar/baz" the subcomponents "/foo" and
++"/foo/bar" must not be excluded).
+ The exclude patterns actually short\-circuit the directory traversal stage
when rsync finds the files to send. If a pattern excludes a particular
parent directory, it can render a deeper include pattern ineffectual
because rsync did not descend through that excluded section of the
-hierarchy. This is particularly important when using a trailing \(cq\&*\(cq\& rule.
-For instance, this won\(cq\&t work:
-+hierarchy. This is particularly important when using a trailing \(oq*\(cq rule.
++hierarchy. This is particularly important when using a trailing '*' rule.
+For instance, this won't work:
.PP
.RS
\f(CW+ /some/path/this\-file\-will\-not\-be\-found\fP
[email protected]@ -2806,11 +2811,11 @@
[email protected]@ -3175,11 +3179,11 @@
.RE
.PP
-This fails because the parent directory \(dq\&some\(dq\& is excluded by the \(cq\&*\(cq\&
-rule, so rsync never visits any of the files in the \(dq\&some\(dq\& or \(dq\&some/path\(dq\&
-+This fails because the parent directory \(lqsome\(rq is excluded by the \(oq*\(cq
-+rule, so rsync never visits any of the files in the \(lqsome\(rq or \(lqsome/path\(rq
++This fails because the parent directory "some" is excluded by the '*'
++rule, so rsync never visits any of the files in the "some" or "some/path"
directories. One solution is to ask for all directories in the hierarchy
-to be included by using a single rule: \(dq\&+ */\(dq\& (put it somewhere before the
-\(dq\&\- *\(dq\& rule), and perhaps use the \fB\-\-prune\-empty\-dirs\fP option. Another
-+to be included by using a single rule: \(lq+ */\(rq (put it somewhere before the
-+\(lq\- *\(rq rule), and perhaps use the \fB\-\-prune\-empty\-dirs\fP option. Another
++to be included by using a single rule: "+ */" (put it somewhere before the
++"\- *" rule), and perhaps use the \fB\-\-prune\-empty\-dirs\fP option. Another
solution is to add specific include rules for all
the parent dirs that need to be visited. For instance, this set of rules
works fine:
[email protected]@ -2832,83 +2837,83 @@
[email protected]@ -3201,44 +3205,44 @@
Here are some examples of exclude/include matching:
.PP
.IP o
-\(dq\&\- *.o\(dq\& would exclude all names matching *.o
-+\(lq\- *.o\(rq would exclude all names matching *.o
++"\- *.o" would exclude all names matching *.o
.IP o
-\(dq\&\- /foo\(dq\& would exclude a file (or directory) named foo in the
--transfer\-root directory
-+\(lq\- /foo\(rq would exclude a file (or directory) named foo in the
-+transfer-root directory
++"\- /foo" would exclude a file (or directory) named foo in the
+ transfer\-root directory
.IP o
-\(dq\&\- foo/\(dq\& would exclude any directory named foo
-+\(lq\- foo/\(rq would exclude any directory named foo
++"\- foo/" would exclude any directory named foo
.IP o
-\(dq\&\- /foo/*/bar\(dq\& would exclude any file named bar which is at two
--levels below a directory named foo in the transfer\-root directory
-+\(lq\- /foo/*/bar\(rq would exclude any file named bar which is at two
-+levels below a directory named foo in the transfer-root directory
++"\- /foo/*/bar" would exclude any file named bar which is at two
+ levels below a directory named foo in the transfer\-root directory
.IP o
-\(dq\&\- /foo/**/bar\(dq\& would exclude any file named bar two
--or more levels below a directory named foo in the transfer\-root directory
-+\(lq\- /foo/**/bar\(rq would exclude any file named bar two
-+or more levels below a directory named foo in the transfer-root directory
++"\- /foo/**/bar" would exclude any file named bar two
+ or more levels below a directory named foo in the transfer\-root directory
.IP o
-The combination of \(dq\&+ */\(dq\&, \(dq\&+ *.c\(dq\&, and \(dq\&\- *\(dq\& would include all
-+The combination of \(lq+ */\(rq, \(lq+ *.c\(rq, and \(lq\- *\(rq would include all
++The combination of "+ */", "+ *.c", and "\- *" would include all
directories and C source files but nothing else (see also the
\fB\-\-prune\-empty\-dirs\fP option)
.IP o
-The combination of \(dq\&+ foo/\(dq\&, \(dq\&+ foo/bar.c\(dq\&, and \(dq\&\- *\(dq\& would include
-+The combination of \(lq+ foo/\(rq, \(lq+ foo/bar.c\(rq, and \(lq\- *\(rq would include
++The combination of "+ foo/", "+ foo/bar.c", and "\- *" would include
only the foo directory and foo/bar.c (the foo directory must be
-explicitly included or it would be excluded by the \(dq\&*\(dq\&)
-+explicitly included or it would be excluded by the \(lq*\(rq)
++explicitly included or it would be excluded by the "*")
.PP
-The following modifiers are accepted after a \(dq\&+\(dq\& or \(dq\&\-\(dq\&:
-+The following modifiers are accepted after a \(lq+\(rq or \(lq\-\(rq:
++The following modifiers are accepted after a "+" or "\-":
.PP
.IP o
A \fB/\fP specifies that the include/exclude rule should be matched
@@ -2750,163 +2110,111 @@
-was sending files from the \(dq\&/etc\(dq\& directory, and \(dq\&\-/ subdir/foo\(dq\&
-would always exclude \(dq\&foo\(dq\& when it is in a dir named \(dq\&subdir\(dq\&, even
-if \(dq\&foo\(dq\& is at the root of the current transfer.
-+\(lq\-/ /etc/passwd\(rq would exclude the passwd file any time the transfer
-+was sending files from the \(lq/etc\(rq directory, and \(lq\-/ subdir/foo\(rq
-+would always exclude \(lqfoo\(rq when it is in a dir named \(lqsubdir\(rq, even
-+if \(lqfoo\(rq is at the root of the current transfer.
++"\-/ /etc/passwd" would exclude the passwd file any time the transfer
++was sending files from the "/etc" directory, and "\-/ subdir/foo"
++would always exclude "foo" when it is in a dir named "subdir", even
++if "foo" is at the root of the current transfer.
.IP o
A \fB!\fP specifies that the include/exclude should take effect if
-the pattern fails to match. For instance, \(dq\&\-! */\(dq\& would exclude all
--non\-directories.
-+the pattern fails to match. For instance, \(lq\-! */\(rq would exclude all
-+non-directories.
++the pattern fails to match. For instance, "\-! */" would exclude all
+ non\-directories.
.IP o
--A \fBC\fP is used to indicate that all the global CVS\-exclude rules
+ A \fBC\fP is used to indicate that all the global CVS\-exclude rules
-should be inserted as excludes in place of the \(dq\&\-C\(dq\&. No arg should
-+A \fBC\fP is used to indicate that all the global CVS-exclude rules
-+should be inserted as excludes in place of the \(lq\-C\(rq. No arg should
++should be inserted as excludes in place of the "\-C". No arg should
follow.
.IP o
An \fBs\fP is used to indicate that the rule applies to the sending
- side. When a rule affects the sending side, it prevents files from
- being transferred. The default is for a rule to affect both sides
- unless \fB\-\-delete\-excluded\fP was specified, in which case default rules
--become sender\-side only. See also the hide (H) and show (S) rules,
--which are an alternate way to specify sending\-side includes/excludes.
-+become sender-side only. See also the hide (H) and show (S) rules,
-+which are an alternate way to specify sending-side includes/excludes.
- .IP o
- An \fBr\fP is used to indicate that the rule applies to the receiving
- side. When a rule affects the receiving side, it prevents files from
- being deleted. See the \fBs\fP modifier for more info. See also the
- protect (P) and risk (R) rules, which are an alternate way to
--specify receiver\-side includes/excludes.
-+specify receiver-side includes/excludes.
[email protected]@ -3256,7 +3260,7 @@
.IP o
A \fBp\fP indicates that a rule is perishable, meaning that it is
ignored in directories that are being deleted. For instance, the \fB\-C\fP
-option\(cq\&s default rules that exclude things like \(dq\&CVS\(dq\& and \(dq\&*.o\(dq\& are
-+option's default rules that exclude things like \(lqCVS\(rq and \(lq*.o\(rq are
++option's default rules that exclude things like "CVS" and "*.o" are
marked as perishable, and will not prevent a directory that was removed
on the source from being deleted on the destination.
- .PP
--.SH "MERGE\-FILE FILTER RULES"
-+.SH "MERGE-FILE FILTER RULES"
-
- .PP
- You can merge whole files into your filter rules by specifying either a
--merge (.) or a dir\-merge (:) filter rule (as introduced in the FILTER RULES
-+merge (.) or a dir-merge (:) filter rule (as introduced in the FILTER RULES
[email protected]@ -3268,9 +3272,9 @@
+ merge (.) or a dir\-merge (:) filter rule (as introduced in the FILTER RULES
section above).
.PP
-There are two kinds of merged files \-\- single\-instance (\(cq\&.\(cq\&) and
-per\-directory (\(cq\&:\(cq\&). A single\-instance merge file is read one time, and
-its rules are incorporated into the filter list in the place of the \(dq\&.\(dq\&
--rule. For per\-directory merge files, rsync will scan every directory that
-+There are two kinds of merged files \(em single-instance (\(oq.\(cq) and
-+per-directory (\(oq:\(cq). A single-instance merge file is read one time, and
-+its rules are incorporated into the filter list in the place of the \(lq.\(rq
-+rule. For per-directory merge files, rsync will scan every directory that
++There are two kinds of merged files \-\- single\-instance ('.') and
++per\-directory (':'). A single\-instance merge file is read one time, and
++its rules are incorporated into the filter list in the place of the "."
+ rule. For per\-directory merge files, rsync will scan every directory that
it traverses for the named file, merging its contents when the file exists
--into the current list of inherited rules. These per\-directory rule files
-+into the current list of inherited rules. These per-directory rule files
+ into the current list of inherited rules. These per\-directory rule files
[email protected]@ -3277,7 +3281,7 @@
must be created on the sending side because it is the sending side that is
being scanned for the available files to transfer. These rule files may
also need to be transferred to the receiving side if you want them to
-affect what files don\(cq\&t get deleted (see PER\-DIRECTORY RULES AND DELETE
-+affect what files don't get deleted (see PER-DIRECTORY RULES AND DELETE
++affect what files don't get deleted (see PER\-DIRECTORY RULES AND DELETE
below).
.PP
Some examples:
[email protected]@ -2920,67 +2925,67 @@
- .br
- \f(CWdir\-merge .per\-dir\-filter\fP
- .br
--\f(CWdir\-merge,n\- .non\-inherited\-per\-dir\-excludes\fP
-+\f(CWdir\-merge,n\- .non-inherited\-per\-dir\-excludes\fP
- .br
--\f(CW:n\- .non\-inherited\-per\-dir\-excludes\fP
-+\f(CW:n\- .non-inherited\-per\-dir\-excludes\fP
- .br
- .RE
-
- .PP
--The following modifiers are accepted after a merge or dir\-merge rule:
-+The following modifiers are accepted after a merge or dir-merge rule:
- .PP
- .IP o
- A \fB\-\fP specifies that the file should consist of only exclude
--patterns, with no other rule\-parsing except for in\-file comments.
-+patterns, with no other rule-parsing except for in-file comments.
- .IP o
- A \fB+\fP specifies that the file should consist of only include
--patterns, with no other rule\-parsing except for in\-file comments.
-+patterns, with no other rule-parsing except for in-file comments.
[email protected]@ -3306,12 +3310,12 @@
+ patterns, with no other rule\-parsing except for in\-file comments.
.IP o
A \fBC\fP is a way to specify that the file should be read in a
-CVS\-compatible manner. This turns on \(cq\&n\(cq\&, \(cq\&w\(cq\&, and \(cq\&\-\(cq\&, but also
-+CVS-compatible manner. This turns on \(oqn\(cq, \(oqw\(cq, and '\-', but also
++CVS\-compatible manner. This turns on 'n', 'w', and '\-', but also
allows the list\-clearing token (!) to be specified. If no filename is
-provided, \(dq\&.cvsignore\(dq\& is assumed.
-+provided, \(lq.cvsignore\(rq is assumed.
++provided, ".cvsignore" is assumed.
.IP o
--A \fBe\fP will exclude the merge\-file name from the transfer; e.g.
+ A \fBe\fP will exclude the merge\-file name from the transfer; e.g.
-\(dq\&dir\-merge,e .rules\(dq\& is like \(dq\&dir\-merge .rules\(dq\& and \(dq\&\- .rules\(dq\&.
-+A \fBe\fP will exclude the merge-file name from the transfer; e.g.
-+\(lqdir-merge,e .rules\(rq is like \(lqdir-merge .rules\(rq and \(lq\- .rules\(rq.
++"dir\-merge,e .rules" is like "dir\-merge .rules" and "\- .rules".
.IP o
An \fBn\fP specifies that the rules are not inherited by subdirectories.
.IP o
--A \fBw\fP specifies that the rules are word\-split on whitespace instead
--of the normal line\-splitting. This also turns off comments. Note: the
-+A \fBw\fP specifies that the rules are word-split on whitespace instead
-+of the normal line-splitting. This also turns off comments. Note: the
[email protected]@ -3318,15 +3322,15 @@
+ A \fBw\fP specifies that the rules are word\-split on whitespace instead
+ of the normal line\-splitting. This also turns off comments. Note: the
space that separates the prefix from the rule is treated specially, so
-\(dq\&\- foo + bar\(dq\& is parsed as two rules (assuming that prefix\-parsing wasn\(cq\&t
-+\(lq\- foo + bar\(rq is parsed as two rules (assuming that prefix-parsing wasn't
++"\- foo + bar" is parsed as two rules (assuming that prefix\-parsing wasn't
also disabled).
.IP o
-You may also specify any of the modifiers for the \(dq\&+\(dq\& or \(dq\&\-\(dq\& rules
-+You may also specify any of the modifiers for the \(lq+\(rq or \(lq\-\(rq rules
++You may also specify any of the modifiers for the "+" or "\-" rules
(above) in order to have the rules that are read in from the file
default to having that modifier set (except for the \fB!\fP modifier, which
-would not be useful). For instance, \(dq\&merge,\-/ .excl\(dq\& would
--treat the contents of .excl as absolute\-path excludes,
++would not be useful). For instance, "merge,\-/ .excl" would
+ treat the contents of .excl as absolute\-path excludes,
-while \(dq\&dir\-merge,s .filt\(dq\& and \(dq\&:sC\(dq\& would each make all their
--per\-directory rules apply only on the sending side. If the merge rule
-+would not be useful). For instance, \(lqmerge,\-/ .excl\(rq would
-+treat the contents of .excl as absolute-path excludes,
-+while \(lqdir-merge,s .filt\(rq and \(lq:sC\(rq would each make all their
-+per-directory rules apply only on the sending side. If the merge rule
++while "dir\-merge,s .filt" and ":sC" would each make all their
+ per\-directory rules apply only on the sending side. If the merge rule
specifies sides to affect (via the \fBs\fP or \fBr\fP modifier or both),
then the rules in the file must not specify sides (via a modifier or
- a rule prefix such as \fBhide\fP).
[email protected]@ -3334,22 +3338,22 @@
.PP
--Per\-directory rules are inherited in all subdirectories of the directory
+ Per\-directory rules are inherited in all subdirectories of the directory
-where the merge\-file was found unless the \(cq\&n\(cq\& modifier was used. Each
-subdirectory\(cq\&s rules are prefixed to the inherited per\-directory rules
-+Per-directory rules are inherited in all subdirectories of the directory
-+where the merge-file was found unless the \(oqn\(cq modifier was used. Each
-+subdirectory's rules are prefixed to the inherited per-directory rules
++where the merge\-file was found unless the 'n' modifier was used. Each
++subdirectory's rules are prefixed to the inherited per\-directory rules
from its parents, which gives the newest rules a higher priority than the
--inherited rules. The entire set of dir\-merge rules are grouped together in
--the spot where the merge\-file was specified, so it is possible to override
--dir\-merge rules via a rule that got specified earlier in the list of global
+ inherited rules. The entire set of dir\-merge rules are grouped together in
+ the spot where the merge\-file was specified, so it is possible to override
+ dir\-merge rules via a rule that got specified earlier in the list of global
-rules. When the list\-clearing rule (\(dq\&!\(dq\&) is read from a per\-directory
-+inherited rules. The entire set of dir-merge rules are grouped together in
-+the spot where the merge-file was specified, so it is possible to override
-+dir-merge rules via a rule that got specified earlier in the list of global
-+rules. When the list-clearing rule (\(lq!\(rq) is read from a per-directory
++rules. When the list\-clearing rule ("!") is read from a per\-directory
file, it only clears the inherited rules for the current merge file.
.PP
Another way to prevent a single rule from a dir\-merge file from being inherited is to
anchor it with a leading slash. Anchored rules in a per\-directory
-merge\-file are relative to the merge\-file\(cq\&s directory, so a pattern \(dq\&/foo\(dq\&
-would only match the file \(dq\&foo\(dq\& in the directory where the dir\-merge filter
-+merge\-file are relative to the merge\-file's directory, so a pattern \(lq/foo\(rq
-+would only match the file \(lqfoo\(rq in the directory where the dir\-merge filter
++merge\-file are relative to the merge\-file's directory, so a pattern "/foo"
++would only match the file "foo" in the directory where the dir\-merge filter
file was found.
.PP
-Here\(cq\&s an example filter file which you\(cq\&d specify via \fB\-\-filter=\(dq\&. file\(dq\&:\fP
@@ -2914,80 +2222,67 @@
.PP
.RS
\f(CWmerge /home/user/.global\-filter\fP
[email protected]@ -2996,58 +3001,58 @@
- .RE
[email protected]@ -3366,7 +3370,7 @@
.PP
--This will merge the contents of the /home/user/.global\-filter file at the
+ This will merge the contents of the /home/user/.global\-filter file at the
-start of the list and also turns the \(dq\&.rules\(dq\& filename into a per\-directory
-+This will merge the contents of the /home/user/.global-filter file at the
-+start of the list and also turns the \(lq.rules\(rq filename into a per-directory
++start of the list and also turns the ".rules" filename into a per\-directory
filter file. All rules read in prior to the start of the directory scan
follow the global anchoring rules (i.e. a leading slash matches at the root
of the transfer).
- .PP
--If a per\-directory merge\-file is specified with a path that is a parent
-+If a per-directory merge-file is specified with a path that is a parent
- directory of the first transfer directory, rsync will scan all the parent
- dirs from that starting point to the transfer directory for the indicated
--per\-directory file. For instance, here is a common filter (see \fB\-F\fP):
-+per-directory file. For instance, here is a common filter (see \fB\-F\fP):
[email protected]@ -3377,7 +3381,7 @@
+ per\-directory file. For instance, here is a common filter (see \fB\-F\fP):
.PP
.RS
-\f(CW\-\-filter='\&: /.rsync\-filter'\&\fP
-+\f(CW\-\-filter=': /.rsync-filter'\fP
++\f(CW\-\-filter=': /.rsync\-filter'\fP
.RE
.PP
--That rule tells rsync to scan for the file .rsync\-filter in all
-+That rule tells rsync to scan for the file .rsync-filter in all
[email protected]@ -3385,7 +3389,7 @@
directories from the root down through the parent directory of the
transfer prior to the start of the normal directory scan of the file in
the directories that are sent as a part of the transfer. (Note: for an
-rsync daemon, the root is always the same as the module\(cq\&s \(dq\&path\(dq\&.)
-+rsync daemon, the root is always the same as the module's \(lqpath\(rq.)
++rsync daemon, the root is always the same as the module's "path".)
.PP
--Some examples of this pre\-scanning for per\-directory files:
-+Some examples of this pre-scanning for per-directory files:
+ Some examples of this pre\-scanning for per\-directory files:
.PP
[email protected]@ -3392,31 +3396,31 @@
.RS
\f(CWrsync \-avF /src/path/ /dest/dir\fP
.br
-\f(CWrsync \-av \-\-filter='\&: ../../.rsync\-filter'\& /src/path/ /dest/dir\fP
-+\f(CWrsync \-av \-\-filter=': ../../.rsync-filter' /src/path/ /dest/dir\fP
++\f(CWrsync \-av \-\-filter=': ../../.rsync\-filter' /src/path/ /dest/dir\fP
.br
-\f(CWrsync \-av \-\-filter='\&: .rsync\-filter'\& /src/path/ /dest/dir\fP
-+\f(CWrsync \-av \-\-filter=': .rsync-filter' /src/path/ /dest/dir\fP
++\f(CWrsync \-av \-\-filter=': .rsync\-filter' /src/path/ /dest/dir\fP
.br
.RE
.PP
-The first two commands above will look for \(dq\&.rsync\-filter\(dq\& in \(dq\&/\(dq\& and
-\(dq\&/src\(dq\& before the normal scan begins looking for the file in \(dq\&/src/path\(dq\&
--and its subdirectories. The last command avoids the parent\-dir scan
++The first two commands above will look for ".rsync\-filter" in "/" and
++"/src" before the normal scan begins looking for the file in "/src/path"
+ and its subdirectories. The last command avoids the parent\-dir scan
-and only looks for the \(dq\&.rsync\-filter\(dq\& files in each directory that is
-+The first two commands above will look for \(lq.rsync\-filter\(rq in \(lq/\(rq and
-+\(lq/src\(rq before the normal scan begins looking for the file in \(lq/src/path\(rq
-+and its subdirectories. The last command avoids the parent-dir scan
-+and only looks for the \(lq.rsync-filter\(rq files in each directory that is
++and only looks for the ".rsync\-filter" files in each directory that is
a part of the transfer.
.PP
-If you want to include the contents of a \(dq\&.cvsignore\(dq\& in your patterns,
-you should use the rule \(dq\&:C\(dq\&, which creates a dir\-merge of the .cvsignore
--file, but parsed in a CVS\-compatible manner. You can
++If you want to include the contents of a ".cvsignore" in your patterns,
++you should use the rule ":C", which creates a dir\-merge of the .cvsignore
+ file, but parsed in a CVS\-compatible manner. You can
-use this to affect where the \fB\-\-cvs\-exclude\fP (\fB\-C\fP) option\(cq\&s inclusion of the
--per\-directory .cvsignore file gets placed into your rules by putting the
++use this to affect where the \fB\-\-cvs\-exclude\fP (\fB\-C\fP) option's inclusion of the
+ per\-directory .cvsignore file gets placed into your rules by putting the
-\(dq\&:C\(dq\& wherever you like in your filter rules. Without this, rsync would
--add the dir\-merge rule for the .cvsignore file at the end of all your other
--rules (giving it a lower priority than your command\-line rules). For
-+If you want to include the contents of a \(lq.cvsignore\(rq in your patterns,
-+you should use the rule \(lq:C\(rq, which creates a dir-merge of the .cvsignore
-+file, but parsed in a CVS-compatible manner. You can
-+use this to affect where the \fB\-\-cvs\-exclude\fP (\fB\-C\fP) option's inclusion of the
-+per-directory .cvsignore file gets placed into your rules by putting the
-+\(lq:C\(rq wherever you like in your filter rules. Without this, rsync would
-+add the dir-merge rule for the .cvsignore file at the end of all your other
-+rules (giving it a lower priority than your command-line rules). For
++":C" wherever you like in your filter rules. Without this, rsync would
+ add the dir\-merge rule for the .cvsignore file at the end of all your other
+ rules (giving it a lower priority than your command\-line rules). For
example:
.PP
.RS
@@ -2996,7 +2291,7 @@
.br
\f(CW+ foo.o\fP
.br
[email protected]@ -3057,49 +3062,49 @@
[email protected]@ -3426,7 +3430,7 @@
.br
\f(CWEOT\fP
.br
@@ -3005,34 +2300,26 @@
.br
.RE
- .PP
- Both of the above rsync commands are identical. Each one will merge all
--the per\-directory .cvsignore rules in the middle of the list rather than
--at the end. This allows their dir\-specific rules to supersede the rules
-+the per-directory .cvsignore rules in the middle of the list rather than
-+at the end. This allows their dir-specific rules to supersede the rules
[email protected]@ -3437,25 +3441,25 @@
that follow the :C instead of being subservient to all your rules. To
affect the other CVS exclude rules (i.e. the default list of exclusions,
the contents of $HOME/.cvsignore, and the value of $CVSIGNORE) you should
-omit the \fB\-C\fP command\-line option and instead insert a \(dq\&\-C\(dq\& rule into
-your filter rules; e.g. \(dq\&\fB\-\-filter=\-C\fP\(dq\&.
-+omit the \fB\-C\fP command-line option and instead insert a \(lq\-C\(rq rule into
-+your filter rules; e.g. \(lq\fB\-\-filter=\-C\fP\(rq.
++omit the \fB\-C\fP command\-line option and instead insert a "\-C" rule into
++your filter rules; e.g. "\fB\-\-filter=\-C\fP".
.PP
--.SH "LIST\-CLEARING FILTER RULE"
-+.SH "LIST-CLEARING FILTER RULE"
+ .SH "LIST\-CLEARING FILTER RULE"
.PP
-You can clear the current include/exclude list by using the \(dq\&!\(dq\& filter
-rule (as introduced in the FILTER RULES section above). The \(dq\¤t\(dq\&
-+You can clear the current include/exclude list by using the \(lq!\(rq filter
-+rule (as introduced in the FILTER RULES section above). The \(lqcurrent\(rq
++You can clear the current include/exclude list by using the "!" filter
++rule (as introduced in the FILTER RULES section above). The "current"
list is either the global list of rules (if the rule is encountered while
--parsing the filter options) or a set of per\-directory rules (which are
--inherited in their own sub\-list, so a subdirectory can use this to clear
+ parsing the filter options) or a set of per\-directory rules (which are
+ inherited in their own sub\-list, so a subdirectory can use this to clear
-out the parent\(cq\&s rules).
-+parsing the filter options) or a set of per-directory rules (which are
-+inherited in their own sub-list, so a subdirectory can use this to clear
+out the parent's rules).
.PP
.SH "ANCHORING INCLUDE/EXCLUDE PATTERNS"
@@ -3041,57 +2328,49 @@
As mentioned earlier, global include/exclude patterns are anchored at the
-\(dq\&root of the transfer\(dq\& (as opposed to per\-directory patterns, which are
-anchored at the merge\-file\(cq\&s directory). If you think of the transfer as
-+\(lqroot of the transfer\(rq (as opposed to per-directory patterns, which are
-+anchored at the merge-file's directory). If you think of the transfer as
++"root of the transfer" (as opposed to per\-directory patterns, which are
++anchored at the merge\-file's directory). If you think of the transfer as
a subtree of names that are being sent from sender to receiver, the
--transfer\-root is where the tree starts to be duplicated in the destination
-+transfer-root is where the tree starts to be duplicated in the destination
+ transfer\-root is where the tree starts to be duplicated in the destination
directory. This root governs where patterns that start with a / match.
- .PP
--Because the matching is relative to the transfer\-root, changing the
-+Because the matching is relative to the transfer-root, changing the
- trailing slash on a source path or changing your use of the \fB\-\-relative\fP
- option affects the path you need to use in your matching (in addition to
[email protected]@ -3466,8 +3470,8 @@
changing how much of the file tree is duplicated on the destination
host). The following examples demonstrate this.
.PP
-Let\(cq\&s say that we want to match two source files, one with an absolute
-path of \(dq\&/home/me/foo/bar\(dq\&, and one with a path of \(dq\&/home/you/bar/baz\(dq\&.
--Here is how the various command choices differ for a 2\-source transfer:
+Let's say that we want to match two source files, one with an absolute
-+path of \(lq/home/me/foo/bar\(rq, and one with a path of \(lq/home/you/bar/baz\(rq.
-+Here is how the various command choices differ for a 2-source transfer:
++path of "/home/me/foo/bar", and one with a path of "/home/you/bar/baz".
+ Here is how the various command choices differ for a 2\-source transfer:
.PP
.RS
- Example cmd: rsync \-a /home/me /home/you /dest
[email protected]@ -3118,9 +3123,9 @@
[email protected]@ -3487,9 +3491,9 @@
.RS
Example cmd: rsync \-a /home/me/ /home/you/ /dest
.br
-+/\- pattern: /foo/bar (note missing \(dq\&me\(dq\&)
-++/\- pattern: /foo/bar (note missing \(lqme\(rq)
+++/\- pattern: /foo/bar (note missing "me")
.br
-+/\- pattern: /bar/baz (note missing \(dq\&you\(dq\&)
-++/\- pattern: /bar/baz (note missing \(lqyou\(rq)
+++/\- pattern: /bar/baz (note missing "you")
.br
Target file: /dest/foo/bar
.br
[email protected]@ -3159,28 +3164,28 @@
[email protected]@ -3528,7 +3532,7 @@
.PP
The easiest way to see what name you should filter is to just
look at the output when using \fB\-\-verbose\fP and put a / in front of the name
-(use the \fB\-\-dry\-run\fP option if you\(cq\&re not yet ready to copy any files).
+(use the \fB\-\-dry\-run\fP option if you're not yet ready to copy any files).
.PP
--.SH "PER\-DIRECTORY RULES AND DELETE"
-+.SH "PER-DIRECTORY RULES AND DELETE"
+ .SH "PER\-DIRECTORY RULES AND DELETE"
[email protected]@ -3535,19 +3539,19 @@
.PP
--Without a delete option, per\-directory rules are only relevant on the
-+Without a delete option, per-directory rules are only relevant on the
+ Without a delete option, per\-directory rules are only relevant on the
sending side, so you can feel free to exclude the merge files themselves
-without affecting the transfer. To make this easy, the \(cq\&e\(cq\& modifier adds
-+without affecting the transfer. To make this easy, the \(oqe\(cq modifier adds
++without affecting the transfer. To make this easy, the 'e' modifier adds
this exclude for you, as seen in these two equivalent commands:
.PP
.RS
@@ -3108,12 +2387,9 @@
-files to be excluded from being deleted, you\(cq\&ll need to be sure that the
+files to be excluded from being deleted, you'll need to be sure that the
receiving side knows what files to exclude. The easiest way is to include
--the per\-directory merge files in the transfer and use \fB\-\-delete\-after\fP,
-+the per-directory merge files in the transfer and use \fB\-\-delete\-after\fP,
+ the per\-directory merge files in the transfer and use \fB\-\-delete\-after\fP,
because this ensures that the receiving side gets all the same exclude
- rules as the sending side before it tries to delete anything:
- .PP
[email protected]@ -3189,14 +3194,14 @@
[email protected]@ -3558,14 +3562,14 @@
.RE
.PP
@@ -3121,7 +2397,7 @@
+However, if the merge files are not a part of the transfer, you'll need to
either specify some global exclude rules (i.e. specified on the command
-line), or you\(cq\&ll need to maintain your own per\-directory merge files on
-+line), or you'll need to maintain your own per-directory merge files on
++line), or you'll need to maintain your own per\-directory merge files on
the receiving side. An example of the first is this (assume that the
remote .rules files exclude themselves):
.PP
@@ -3131,20 +2407,12 @@
\-\-delete host:src/dir /dest
.fi
[email protected]@ -3204,17 +3209,17 @@
- In the above example the extra.rules file can affect both sides of the
- transfer, but (on the sending side) the rules are subservient to the rules
- merged from the .rules files because they were specified after the
--per\-directory merge rule.
-+per-directory merge rule.
- .PP
--In one final example, the remote side is excluding the .rsync\-filter
--files from the transfer, but we want to use our own .rsync\-filter files
-+In one final example, the remote side is excluding the .rsync-filter
-+files from the transfer, but we want to use our own .rsync-filter files
[email protected]@ -3578,12 +3582,12 @@
+ In one final example, the remote side is excluding the .rsync\-filter
+ files from the transfer, but we want to use our own .rsync\-filter files
to control what gets deleted on the receiving side. To do this we must
-specifically exclude the per\-directory merge files (so that they don\(cq\&t get
-+specifically exclude the per-directory merge files (so that they don't get
++specifically exclude the per\-directory merge files (so that they don't get
deleted) and then put rules into the local files to control what else
should not get deleted. Like one of these commands:
.PP
@@ -3154,63 +2422,44 @@
host:src/dir /dest
rsync \-avFF \-\-delete host:src/dir /dest
.fi
[email protected]@ -3228,9 +3233,9 @@
- number of hosts. Now suppose some changes have been made to this
- source tree and those changes need to be propagated to the other
[email protected]@ -3599,7 +3603,7 @@
hosts. In order to do this using batch mode, rsync is run with the
--write\-batch option to apply the changes made to the source tree to one
--of the destination trees. The write\-batch option causes the rsync
+ write\-batch option to apply the changes made to the source tree to one
+ of the destination trees. The write\-batch option causes the rsync
-client to store in a \(dq\&batch file\(dq\& all the information needed to repeat
-+write-batch option to apply the changes made to the source tree to one
-+of the destination trees. The write-batch option causes the rsync
-+client to store in a \(lqbatch file\(rq all the information needed to repeat
++client to store in a "batch file" all the information needed to repeat
this operation against other, identical destination trees.
.PP
Generating the batch file once saves having to perform the file
[email protected]@ -3240,15 +3245,15 @@
- at once, instead of sending the same data to every host individually.
- .PP
- To apply the recorded changes to another destination tree, run rsync
--with the read\-batch option, specifying the name of the same batch
-+with the read-batch option, specifying the name of the same batch
- file, and the destination tree. Rsync updates the destination tree
[email protected]@ -3614,7 +3618,7 @@
using the information stored in the batch file.
.PP
--For your convenience, a script file is also created when the write\-batch
+ For your convenience, a script file is also created when the write\-batch
-option is used: it will be named the same as the batch file with \(dq\&.sh\(dq\&
--appended. This script file contains a command\-line suitable for updating a
-+For your convenience, a script file is also created when the write-batch
-+option is used: it will be named the same as the batch file with \(lq.sh\(rq
-+appended. This script file contains a command-line suitable for updating a
++option is used: it will be named the same as the batch file with ".sh"
+ appended. This script file contains a command\-line suitable for updating a
destination tree using the associated batch file. It can be executed using
--a Bourne (or Bourne\-like) shell, optionally passing in an alternate
-+a Bourne (or Bourne-like) shell, optionally passing in an alternate
- destination tree pathname which is then used instead of the original
- destination path. This is useful when the destination tree path on the
- current host differs from the one used to create the batch file.
[email protected]@ -3274,68 +3279,68 @@
+ a Bourne (or Bourne\-like) shell, optionally passing in an alternate
[email protected]@ -3643,25 +3647,25 @@
.PP
In these examples, rsync is used to update /adest/dir/ from /source/dir/
-and the information to repeat this operation is stored in \(dq\&foo\(dq\& and
-\(dq\&foo.sh\(dq\&. The host \(dq\&remote\(dq\& is then updated with the batched data going
-+and the information to repeat this operation is stored in \(lqfoo\(rq and
-+\(lqfoo.sh\(rq. The host \(lqremote\(rq is then updated with the batched data going
++and the information to repeat this operation is stored in "foo" and
++"foo.sh". The host "remote" is then updated with the batched data going
into the directory /bdest/dir. The differences between the two examples
reveals some of the flexibility you have in how you deal with batches:
.PP
.IP o
-The first example shows that the initial copy doesn\(cq\&t have to be
--local \-\- you can push or pull data to/from a remote host using either the
--remote\-shell syntax or rsync daemon syntax, as desired.
+The first example shows that the initial copy doesn't have to be
-+local \(em you can push or pull data to/from a remote host using either the
-+remote-shell syntax or rsync daemon syntax, as desired.
+ local \-\- you can push or pull data to/from a remote host using either the
+ remote\-shell syntax or rsync daemon syntax, as desired.
.IP o
-The first example uses the created \(dq\&foo.sh\(dq\& file to get the right
--rsync options when running the read\-batch command on the remote host.
-+The first example uses the created \(lqfoo.sh\(rq file to get the right
-+rsync options when running the read-batch command on the remote host.
++The first example uses the created "foo.sh" file to get the right
+ rsync options when running the read\-batch command on the remote host.
.IP o
The second example reads the batch data via standard input so that
-the batch file doesn\(cq\&t need to be copied to the remote machine first.
@@ -3219,90 +2468,70 @@
\fB\-\-read\-batch\fP option, but you could edit the script file if you wished to
make use of it (just be sure that no other option is trying to use
-standard input, such as the \(dq\&\fB\-\-exclude\-from=\-\fP\(dq\& option).
-+standard input, such as the \(lq\fB\-\-exclude\-from=\-\fP\(rq option).
++standard input, such as the "\fB\-\-exclude\-from=\-\fP" option).
.PP
Caveats:
- .PP
--The read\-batch option expects the destination tree that it is updating
-+The read-batch option expects the destination tree that it is updating
- to be identical to the destination tree that was used to create the
- batch update fileset. When a difference between the destination trees
- is encountered the update might be discarded with a warning (if the file
--appears to be up\-to\-date already) or the file\-update may be attempted
-+appears to be up-to-date already) or the file-update may be attempted
[email protected]@ -3674,7 +3678,7 @@
and then, if the file fails to verify, the update discarded with an
--error. This means that it should be safe to re\-run a read\-batch operation
--if the command got interrupted. If you wish to force the batched\-update to
+ error. This means that it should be safe to re\-run a read\-batch operation
+ if the command got interrupted. If you wish to force the batched\-update to
-always be attempted regardless of the file\(cq\&s size and date, use the \fB\-I\fP
-+error. This means that it should be safe to re-run a read-batch operation
-+if the command got interrupted. If you wish to force the batched-update to
+always be attempted regardless of the file's size and date, use the \fB\-I\fP
option (when reading the batch).
If an error occurs, the destination tree will probably be in a
partially updated state. In that case, rsync can
--be used in its regular (non\-batch) mode of operation to fix up the
-+be used in its regular (non-batch) mode of operation to fix up the
- destination tree.
- .PP
- The rsync version used on all destinations must be at least as new as the
- one used to generate the batch file. Rsync will die with an error if the
--protocol version in the batch file is too new for the batch\-reading rsync
-+protocol version in the batch file is too new for the batch-reading rsync
- to handle. See also the \fB\-\-protocol\fP option for a way to have the
- creating rsync generate a batch file that an older rsync can understand.
- (Note that batch files changed format in version 2.6.3, so mixing versions
[email protected]@ -3690,7 +3694,7 @@
older than that with newer versions will not work.)
.PP
When reading a batch file, rsync will force the value of certain options
-to match the data in the batch file if you didn\(cq\&t set them to the same
--as the batch\-writing command. Other options can (and should) be changed.
+to match the data in the batch file if you didn't set them to the same
-+as the batch-writing command. Other options can (and should) be changed.
+ as the batch\-writing command. Other options can (and should) be changed.
For instance \fB\-\-write\-batch\fP changes to \fB\-\-read\-batch\fP,
\fB\-\-files\-from\fP is dropped, and the
- \fB\-\-filter\fP/\fB\-\-include\fP/\fB\-\-exclude\fP options are not needed unless
[email protected]@ -3698,13 +3702,13 @@
one of the \fB\-\-delete\fP options is specified.
.PP
The code that creates the BATCH.sh file transforms any filter/include/exclude
-options into a single list that is appended as a \(dq\&here\(dq\& document to the
-+options into a single list that is appended as a \(lqhere\(rq document to the
++options into a single list that is appended as a "here" document to the
shell script file. An advanced user can use this to modify the exclude
list if a change in what gets deleted by \fB\-\-delete\fP is desired. A normal
user can ignore this detail and just use the shell script as an easy way
to run the appropriate \fB\-\-read\-batch\fP command for the batched data.
.PP
-The original batch mode in rsync was based on \(dq\&rsync+\(dq\&, but the latest
-+The original batch mode in rsync was based on \(lqrsync+\(rq, but the latest
++The original batch mode in rsync was based on "rsync+", but the latest
version uses a new implementation.
.PP
.SH "SYMBOLIC LINKS"
[email protected]@ -3345,16 +3350,16 @@
[email protected]@ -3714,16 +3718,16 @@
link in the source directory.
.PP
By default, symbolic links are not transferred at all. A message
-\(dq\&skipping non\-regular\(dq\& file is emitted for any symlinks that exist.
-+\(lqskipping non-regular\(rq file is emitted for any symlinks that exist.
++"skipping non\-regular" file is emitted for any symlinks that exist.
.PP
If \fB\-\-links\fP is specified, then symlinks are recreated with the same
target on the destination. Note that \fB\-\-archive\fP implies
\fB\-\-links\fP.
.PP
-If \fB\-\-copy\-links\fP is specified, then symlinks are \(dq\&collapsed\(dq\& by
-+If \fB\-\-copy\-links\fP is specified, then symlinks are \(lqcollapsed\(rq by
++If \fB\-\-copy\-links\fP is specified, then symlinks are "collapsed" by
copying their referent, rather than the symlink.
.PP
-Rsync can also distinguish \(dq\&safe\(dq\& and \(dq\&unsafe\(dq\& symbolic links. An
-+Rsync can also distinguish \(lqsafe\(rq and \(lqunsafe\(rq symbolic links. An
++Rsync can also distinguish "safe" and "unsafe" symbolic links. An
example where this might be used is a web site mirror that wishes to
ensure that the rsync module that is copied does not include symbolic links to
\fB/etc/passwd\fP in the public section of the site. Using
[email protected]@ -3364,11 +3369,11 @@
[email protected]@ -3733,11 +3737,11 @@
\fB\-\-links\fP for \fB\-\-safe\-links\fP to have any effect.)
.PP
Symbolic links are considered unsafe if they are absolute symlinks
-(start with \fB/\fP), empty, or if they contain enough \(dq\&..\(dq\&
-+(start with \fB/\fP), empty, or if they contain enough \(lq..\(rq
++(start with \fB/\fP), empty, or if they contain enough ".."
components to ascend from the directory being copied.
.PP
-Here\(cq\&s a summary of how the symlink options are interpreted. The list is
@@ -3312,44 +2541,18 @@
use the first line that is a complete subset of your options:
.PP
.IP "\fB\-\-copy\-links\fP"
[email protected]@ -3394,8 +3399,8 @@
[email protected]@ -3763,8 +3767,8 @@
.PP
rsync occasionally produces error messages that may seem a little
-cryptic. The one that seems to cause the most confusion is \(dq\&protocol
-version mismatch \-\- is your shell clean?\(dq\&.
-+cryptic. The one that seems to cause the most confusion is \(lqprotocol
-+version mismatch \(em is your shell clean?\(rq.
++cryptic. The one that seems to cause the most confusion is "protocol
++version mismatch \-\- is your shell clean?".
.PP
This message is usually caused by your startup scripts or remote shell
facility producing unwanted garbage on the stream that rsync is using
[email protected]@ -3413,7 +3418,7 @@
- data. Look at the contents and try to work out what is producing
- it. The most common cause is incorrectly configured shell startup
- scripts (such as .cshrc or .profile) that contain output statements
--for non\-interactive logins.
-+for non-interactive logins.
- .PP
- If you are having trouble debugging filter patterns, then
- try specifying the \fB\-vv\fP option. At this level of verbosity rsync will
[email protected]@ -3432,13 +3437,13 @@
- Errors selecting input/output files, dirs
- .IP "\fB4\fP"
- Requested action not supported: an attempt
--was made to manipulate 64\-bit files on a platform that cannot support
-+was made to manipulate 64-bit files on a platform that cannot support
- them; or an option was specified that is supported by the client and
- not by the server.
- .IP "\fB5\fP"
--Error starting client\-server protocol
-+Error starting client-server protocol
- .IP "\fB6\fP"
--Daemon unable to append to log\-file
-+Daemon unable to append to log-file
- .IP "\fB10\fP"
- Error in socket I/O
- .IP "\fB11\fP"
[email protected]@ -3491,13 +3496,13 @@
[email protected]@ -3864,13 +3868,13 @@
password allows you to run authenticated rsync connections to an rsync
daemon without user intervention. Note that this does not supply a
password to a remote shell transport such as ssh; to learn how to do that,
@@ -3359,48 +2562,15 @@
The USER or LOGNAME environment variables
are used to determine the default username sent to an rsync daemon.
-If neither is set, the username defaults to \(dq\&nobody\(dq\&.
-+If neither is set, the username defaults to \(lqnobody\(rq.
++If neither is set, the username defaults to "nobody".
.IP "\fBHOME\fP"
-The HOME environment variable is used to find the user\(cq\&s
+The HOME environment variable is used to find the user's
default .cvsignore file.
.PP
[email protected]@ -3516,7 +3521,7 @@
- .PP
- times are transferred as *nix time_t values
- .PP
--When transferring to FAT filesystems rsync may re\-sync
-+When transferring to FAT filesystems rsync may re-sync
- unmodified files.
- See the comments on the \fB\-\-modify\-window\fP option.
- .PP
[email protected]@ -3552,27 +3557,27 @@
- .PP
- A WEB site is available at
- http://rsync.samba.org/. The site
--includes an FAQ\-O\-Matic which may cover questions unanswered by this
-+includes an FAQ-O-Matic which may cover questions unanswered by this
- manual page.
- .PP
- The primary ftp site for rsync is
- ftp://rsync.samba.org/pub/rsync.
- .PP
- We would be delighted to hear from you if you like this program.
--Please contact the mailing\-list at [email protected]
-+Please contact the mailing-list at [email protected]
- .PP
- This program uses the excellent zlib compression library written by
--Jean\-loup Gailly and Mark Adler.
-+Jean-loup Gailly and Mark Adler.
- .PP
- .SH "THANKS"
-
- .PP
- Special thanks go out to: John Van Essen, Matt McCutchen, Wesley W. Terpstra,
- David Dykstra, Jos Backus, Sebastian Krahmer, Martin Pool, and our
--gone\-but\-not\-forgotten compadre, J.W. Schultz.
-+gone-but-not-forgotten compadre, J.W. Schultz.
[email protected]@ -3945,7 +3949,7 @@
+ gone\-but\-not\-forgotten compadre, J.W. Schultz.
.PP
Thanks also to Richard Brent, Brendan Mackay, Bill Waite, Stephen Rothwell
-and David Bell. I\(cq\&ve probably missed some people, my apologies if I have.--- a/components/rsync/patches/rsyncd.conf.5.patch Sun Apr 06 17:51:44 2014 -0700
+++ b/components/rsync/patches/rsyncd.conf.5.patch Mon Apr 07 12:48:54 2014 -0700
@@ -1,96 +1,58 @@
---- rsync-3.0.9/rsyncd.conf.5.orig 2011-09-23 09:35:55.000000000 -0700
-+++ rsync-3.0.9/rsyncd.conf.5 2013-04-19 14:14:00.357311299 -0700
[email protected]@ -1,6 +1,6 @@
- .TH "rsyncd.conf" "5" "23 Sep 2011" "" ""
- .SH "NAME"
--rsyncd.conf \- configuration file for rsync in daemon mode
-+rsyncd.conf \(em configuration file for rsync in daemon mode
- .SH "SYNOPSIS"
-
- .PP
[email protected]@ -20,9 +20,9 @@
+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.0/rsyncd.conf.5.orig Sat Sep 28 19:57:23 2013
++++ rsync-3.1.0/rsyncd.conf.5 Mon Mar 17 15:52:51 2014
[email protected]@ -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 \(lqname = value\(rq.
++module begins. Modules contain parameters of the form "name = value".
.PP
--The file is line\-based \-\- that is, each newline\-terminated line represents
-+The file is line-based \(em 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.
[email protected]@ -33,9 +33,9 @@
.PP
- Only the first equals sign in a parameter is significant. Whitespace before
[email protected]@ -34,7 +34,7 @@
- Any line beginning with a hash (#) is ignored, as are lines containing
- only whitespace.
+ 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 \(lqcontinued\(rq 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
[email protected]@ -53,9 +53,9 @@
- file ownership. Otherwise, it must just have permission to read and
- write the appropriate data, log, and lock files.
[email protected]@ -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
+ 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.
-+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 \(lq\fBrsync \-\-daemon\fP\(rq 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
[email protected]@ -71,12 +71,12 @@
[email protected]@ -72,7 +72,7 @@
.fi
.PP
-Replace \(dq\&/usr/bin/rsync\(dq\& with the path to where you have rsync installed on
-+Replace \(lq/usr/bin/rsync\(rq 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
- Note that you should \fBnot\fP send the rsync daemon a HUP signal to force
--it to reread the \f(CWrsyncd.conf\fP file. The file is re\-read on each client
-+it to reread the \f(CWrsyncd.conf\fP file. The file is re-read on each client
- connection.
- .PP
- .SH "GLOBAL PARAMETERS"
[email protected]@ -91,7 +91,7 @@
[email protected]@ -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
-+\(lqmessage of the day\(rq 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.
- .IP
[email protected]@ -103,12 +103,12 @@
- .IP "\fBport\fP"
- 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 \fB\-\-port\fP command\-line option.
-+is being run by inetd, and is superseded by the \fB\-\-port\fP command-line option.
- .IP
- .IP "\fBaddress\fP"
- 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 \fB\-\-address\fP command\-line option.
-+being run by inetd, and is superseded by the \fB\-\-address\fP command-line option.
- .IP
- .IP "\fBsocket options\fP"
- This parameter can provide endless fun for people
[email protected]@ -119,7 +119,7 @@
- system call for
- details on some of the options you may be able to set. By default no
- special socket options are set. These settings can also be specified
--via the \fB\-\-sockopts\fP command\-line option.
-+via the \fB\-\-sockopts\fP command-line option.
- .IP
- .SH "MODULE PARAMETERS"
-
[email protected]@ -139,50 +139,50 @@
+ This can be overridden by the \fB\-\-dparam=motdfile=FILE\fP
[email protected]@ -163,14 +163,14 @@
of available modules. The default is no comment.
.IP
.IP "\fBpath\fP"
@@ -99,6 +61,18 @@
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%
[email protected]@ -178,14 +178,14 @@
+
+ .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
@@ -109,59 +83,50 @@
.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 \(lquse chroot\(rq is true, the rsync daemon will chroot
-+to the \(lqpath\(rq 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,
-+holes, but it has the disadvantages of requiring super-user privileges,
+ 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
[email protected]@ -192,26 +192,26 @@
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
-+\(lqpath\(rq to indicate the point where the chroot should occur. This allows rsync
-+to run in a chroot with a non\-"/\(rq 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
--had omitted the dot\-dir, the chroot would have used the whole path, and the
++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\&.
-+transfer. For example, specifying \(lq/var/rsync/./module1\(rq will chroot to the
-+\(lq/var/rsync\(rq directory and set the inside-chroot path to \(lq/module1\(rq. If you
-+had omitted the dot-dir, the chroot would have used the whole path, and the
-+inside-chroot path would have been \(lq/\(rq.
++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 \(lquse chroot\(rq is false or the inside-chroot path is not \(lq/\(rq, 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 \(lqmunge symlinks\(rq 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
--\fB\-\-backup\-dir\fP, \fB\-\-compare\-dest\fP, etc. interpret an absolute path 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
-+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's \(lqpath\(rq dir), and (3) trim \(lq..\(rq 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
--if the module is not read\-only).
-+The default for \(lquse chroot\(rq is true, and is the safer choice (especially
-+if the module is not read-only).
++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
- by name (by default), but instead copy IDs as though \fB\-\-numeric\-ids\fP had
--been specified. In order to enable name\-mapping, rsync needs to be able to
-+been specified. In order to enable name-mapping, rsync needs to be able to
- use the standard library functions for looking up names and IDs (i.e.
- \f(CWgetpwuid()\fP
- ,
[email protected]@ -197,12 +197,12 @@
[email protected]@ -231,12 +231,12 @@
used by these library functions (traditionally /etc/passwd and
/etc/group, but perhaps additional dynamic libraries as well).
.IP
@@ -172,82 +137,72 @@
+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 \(lqexclude\(rq (see how in the discussion of
++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 \(lqnumeric ids\(rq 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
[email protected]@ -211,12 +211,12 @@
- .IP "\fBnumeric ids\fP"
- Enabling this parameter disables the mapping
- of users and groups by name for the current daemon module. This prevents
--the daemon from trying to load any user/group\-related files or libraries.
-+the daemon from trying to load any user/group-related files or libraries.
- This enabling makes the transfer behave as if the client had passed
--the \fB\-\-numeric\-ids\fP command\-line option. By default, this parameter is
--enabled for chroot modules and disabled for non\-chroot modules.
-+the \fB\-\-numeric\-ids\fP command-line option. By default, this parameter is
-+enabled for chroot modules and disabled for non-chroot modules.
[email protected]@ -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
++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.
[email protected]@ -225,52 +225,52 @@
- This parameter tells rsync to modify
- all incoming symlinks in a way that makes them unusable but recoverable
- (see below). This should help protect your files from user trickery when
[email protected]@ -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 \(lquse chroot\(rq
-+is on and the inside-chroot path is \(lq/\(rq, 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
-+If you disable this parameter on a daemon that is not read-only, there
+ 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 \(lquse chroot\(rq
++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).
++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 \(lq/rsyncd-munged/\(rq. 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 \(lqmunge symlinks\(rq parameter in a chroot area
-+that has an inside-chroot path of \(lq/\(rq, you should add \(lq/rsyncd-munged/\(rq
++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
+ 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
-+Note: rsync makes no attempt to verify that any pre-existing symlinks in
+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 \(lq/rsyncd-munged/\(rq to the start of
++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 \(lqmunge-symlinks\(rq that can be used to add or remove
++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 \(lquse chroot\(rq is off
-+(or the inside-chroot path is not \(lq/\(rq),
-+incoming symlinks will be modified to drop a leading slash and to remove \(lq..\(rq
++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.
@@ -257,32 +212,31 @@
-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 \(lqcharset\(rq parameter regardless of the
++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
+ 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\&.
-+chroot area, and also ensures that name-translation is done in a consistent
-+manner. If the \(lqcharset\(rq parameter is not set, the \fB\-\-iconv\fP option is
-+refused, just as if \(lqiconv\(rq had been specified via \(lqrefuse options\(rq.
++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 \(lqno-iconv\(rq to the \(lqrefuse options\(rq 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"
[email protected]@ -279,21 +279,21 @@
[email protected]@ -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 \(lqlock file\(rq 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 \(lqlog file\(rq 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
@@ -292,22 +246,22 @@
opened before
\f(CWchroot()\fP
is called, allowing it to be placed outside
--the transfer. If this value is set on a per\-module basis instead of
-+the transfer. If this value is set on a per-module basis instead of
- globally, the global log will still contain any authorization failures
--or config\-file error messages.
-+or config-file error messages.
[email protected]@ -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
- If the daemon fails to open the specified file, it will fall back to
- using syslog and output an error about the failure. (Note that the
[email protected]@ -306,34 +306,34 @@
+ .IP "\fBsyslog facility\fP"
[email protected]@ -347,19 +347,19 @@
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
--non\-empty string (either set in the per\-modules settings, or inherited
-+is daemon. This setting has no effect if the \(lqlog file\(rq setting is a
-+non-empty string (either set in the per-modules settings, or inherited
++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"
@@ -320,111 +274,121 @@
.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 \(lqmax connections\(rq 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.
[email protected]@ -366,17 +366,17 @@
.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 \(lqread only\(rq is true then any
-+attempted uploads will fail. If \(lqread only\(rq 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 \(lqwrite only\(rq is true then any
-+attempted downloads will fail. If \(lqwrite only\(rq 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
[email protected]@ -346,19 +346,19 @@
[email protected]@ -384,8 +384,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.
[email protected]@ -393,10 +393,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 \(lqgid\(rq parameter this determines what
- file permissions are available. The default is uid \-2, which is normally
--the user \(dq\&nobody\(dq\&.
-+the user \(lqnobody\(rq.
++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
[email protected]@ -411,16 +411,16 @@
.IP "\fBgid\fP"
- This parameter specifies the group name or group ID that
- file transfers to and from that module should take place as when the daemon
--was run as root. This complements the \(dq\&uid\(dq\& parameter. The default is gid \-2,
--which is normally the group \(dq\&nobody\(dq\&.
-+was run as root. This complements the \(lquid\(rq parameter. The default is gid \-2,
-+which is normally the group \(lqnobody\(rq.
+ 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
--daemon side to behave as if the \fB\-\-fake\-super\fP command\-line option had
-+Setting \(lqfake super = yes\(rq for a module causes the
-+daemon side to behave as if the \fB\-\-fake\-super\fP command-line option had
++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.
- .IP
[email protected]@ -366,69 +366,69 @@
- The daemon has its own filter chain that determines what files
- it will let the client access. This chain is not sent to the client and is
- independent of any filters the client may have specified. Files excluded by
--the daemon filter chain (\fBdaemon\-excluded\fP files) are treated as non\-existent
-+the daemon filter chain (\fBdaemon-excluded\fP files) are treated as non-existent
- if the client tries to pull them, are skipped with an error message if the
- client tries to push them (triggering exit code 23), and are never deleted from
- the module. You can use daemon filters to prevent clients from downloading or
[email protected]@ -436,17 +436,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 \(lqfilter\(rq, \(lqinclude from\(rq, \(lqinclude\(rq,
-+\(lqexclude from\(rq, and \(lqexclude\(rq 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
--subtree; the easiest way to do this is with a triple\-star pattern like
++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\&.
-+entire subtree, for example, \(lq/secret\(rq, you \fImust\fP exclude everything in the
-+subtree; the easiest way to do this is with a triple-star pattern like
-+\(lq/secret/***\(rq.
++"/secret/***".
.IP
-The \(dq\&filter\(dq\& parameter takes a space\-separated list of daemon filter rules,
-+The \(lqfilter\(rq 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. \(lq- /foo \(em /bar\(rq is parsed as two rules). You may specify one or
-+more merge-file rules using the normal syntax. Only one \(lqfilter\(rq 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
-+single parameter. Note that per-directory merge-file rules do not provide as
+ 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
--better during a client download operation if the per\-dir merge files are
-+better during a client download operation if the per-dir merge files are
- included in the transfer and the client requests that they be used.
- .IP
[email protected]@ -456,27 +456,27 @@
.IP "\fBexclude\fP"
--This parameter takes a space\-separated list of daemon
-+This parameter takes a space-separated list of daemon
+ 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 \(lq\- \(rq or \(lq+ \(rq to explicitly indicate exclude/include. Only one
-+\(lqexclude\(rq parameter can apply to a given module. See the \(lqfilter\(rq 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 \(lqinclude\(rq to override the effects of the \(lqexclude\(rq
-+parameter. Only one \(lqinclude\(rq parameter can apply to a given module. See the
-+\(lqfilter\(rq 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
@@ -432,96 +396,128 @@
-\(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
-+\(lqexclude from\(rq parameter can apply to a given module; if you have multiple
-+exclude-from files, you can specify them as a merge file in the \(lqfilter\(rq
-+parameter. See the \(lqfilter\(rq 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 \(lqexclude from\(rq for a file of daemon include
-+patterns. Only one \(lqinclude from\(rq parameter can apply to a given module. See
-+the \(lqfilter\(rq 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"
- This parameter allows you to specify a set of
--comma\-separated chmod strings that will affect the permissions of all
-+comma-separated chmod strings that will affect the permissions of all
- incoming files (files that are being received by the daemon). These
- changes happen after all other permission calculations, and this will
--even override destination\-default and/or existing permissions when the
-+even override destination-default and/or existing permissions when the
- client does not specify \fB\-\-perms\fP.
- See the description of the \fB\-\-chmod\fP rsync option and the \fBchmod\fP(1)
- manpage for information on the format of this string.
- .IP
- .IP "\fBoutgoing chmod\fP"
- This parameter allows you to specify a set of
--comma\-separated chmod strings that will affect the permissions of all
-+comma-separated chmod strings that will affect the permissions of all
- outgoing files (files that are being sent out from the daemon). These
- changes happen first, making the sent permissions appear to be different
- than those stored in the filesystem itself. For instance, you could
[email protected]@ -439,41 +439,41 @@
- .IP
- .IP "\fBauth users\fP"
- This parameter specifies a comma and
--space\-separated list of usernames that will be allowed to connect to
-+space-separated list of usernames that will be allowed to connect to
[email protected]@ -507,23 +507,23 @@
this module. The usernames do not need to exist on the local
- system. The usernames may also contain shell wildcard characters. If
+ 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
-+\(lqauth users\(rq 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\&).
-+\(lqsecrets file\(rq parameter. The default is for all users to be able to
-+connect without a password (this is called \(lqanonymous rsync\(rq).
++"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
[email protected]@ -535,12 +535,12 @@
+
+ .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
[email protected]@ -547,8 +547,8 @@
+ 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
--rsyncd.conf\-level username that differs from the remote\-shell\-level
-+See also the section entitled \(lqUSING RSYNC-DAEMON FEATURES VIA A REMOTE
-+SHELL CONNECTION\(rq in \fBrsync\fP(1) for information on how handle an
-+rsyncd.conf-level username that differs from the remote-shell-level
++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
[email protected]@ -555,34 +555,34 @@
.IP "\fBsecrets file\fP"
- This parameter specifies the name of
- a file that contains the username:password pairs used for
--authenticating this module. This file is only consulted if the \(dq\&auth
--users\(dq\& parameter is specified. The file is line based and contains
-+authenticating this module. This file is only consulted if the \(lqauth
-+users\(rq parameter is specified. The file is line based and contains
- username:password pairs separated by a single colon. Any line starting
- with a hash (#) 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.
-+you may find that passwords longer than 8 characters don't work.
+ 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 \(lqsecrets file\(rq 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\&.
-+by \(lqother\(rq; see \(lqstrict modes\(rq.
+-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 \(lqstrict modes\(rq 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 \(lqstrict modes\(rq 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
[email protected]@ -488,7 +488,7 @@
[email protected]@ -597,7 +597,7 @@
.RS
.IP o
a dotted decimal IPv4 address of the form a.b.c.d, or an IPv6 address
@@ -530,131 +526,145 @@
must match exactly.
.IP o
an address/mask in the form ipaddr/n where ipaddr is the IP address
[email protected]@ -510,7 +510,7 @@
[email protected]@ -612,11 +612,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
- .IP
--Note IPv6 link\-local addresses can have a scope in the address specification:
-+Note IPv6 link-local addresses can have a scope in the address specification:
- .IP
- .RS
- \f(CW fe80::1%link1\fP
[email protected]@ -522,23 +522,23 @@
[email protected]@ -633,31 +633,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 \(lqhosts allow\(rq with a separate \(lqhosts deny\(rq
-+parameter. If both parameters are specified then the \(lqhosts allow\(rq 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 \(lqhosts deny\(rq 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
-+\(lqhosts allow\(rq or the \(lqhosts deny\(rq 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 \(lqhosts allow\(rq 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 \(lqhosts allow\(rq 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 \(lqhosts deny\(rq parameter, which means all hosts can connect.
++The default is no "hosts deny" parameter, which means all hosts can connect.
.IP
- .IP "\fBignore errors\fP"
- This parameter tells rsyncd to
[email protected]@ -552,32 +552,32 @@
- .IP "\fBignore nonreadable\fP"
+ .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
[email protected]@ -683,7 +683,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
+ 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.
-+public archives that may have some non-readable files among the
+directories, and the sysadmin doesn't want those files to be seen at all.
.IP
.IP "\fBtransfer logging\fP"
--This parameter enables per\-file
-+This parameter enables per-file
- logging of downloads and uploads in a format somewhat similar to that
+ This parameter enables per\-file
[email protected]@ -691,7 +691,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 \(lqlog format\(rq 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
- format used for logging file transfers when transfer logging is enabled.
--The format is a text string containing embedded single\-character escape
-+The format is a text string containing embedded single-character escape
[email protected]@ -699,17 +699,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. \(lq\fB%\-50n %8l %07p\fP\(rq).
++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 \(lq%o %h [%a] %m (%u) %f %l\(rq, and a \(lq%t [%p] \(rq
-+is always prefixed when using the \(lqlog file\(rq 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 \(lqsupport\(rq subdirectory:
++in the rsync source code distribution in the "support" subdirectory:
rsyncstats.)
.IP
--The single\-character escapes that are understood are as follows:
-+The single-character escapes that are understood are as follows:
- .IP
- .RS
+ The single\-character escapes that are understood are as follows:
[email protected]@ -726,9 +726,9 @@
.IP o
[email protected]@ -589,9 +589,9 @@
- .IP o
- %c the total size of the block checksums received for the basis file (only when sending)
+ %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 \(lq/\(rq)
++%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 \(lqDEFAULT\(rq
++%G the gid of the file (decimal) or "DEFAULT"
.IP o
- %h the remote host name
+ %h the remote host name (only available for a daemon)
.IP o
[email protected]@ -599,15 +599,15 @@
[email protected]@ -736,15 +736,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 \(lq \-> SYMLINK\(rq, \(lq => HARDLINK\(rq, or \(lq\(rq (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
-+%M the last-modified time of the file
+ %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 \(lq/\(rq 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 \(lqsend\(rq, \(lqrecv\(rq, or \(lqdel.\(rq (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
[email protected]@ -621,7 +621,7 @@
[email protected]@ -758,7 +758,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 \(lq%i\(rq, 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
[email protected]@ -631,17 +631,17 @@
[email protected]@ -768,7 +768,7 @@
.IP "\fBtimeout\fP"
This parameter allows you to override the
clients choice for I/O timeout for this module. Using this parameter you
@@ -663,42 +673,27 @@
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).
- .IP
- .IP "\fBrefuse options\fP"
- This parameter allows you to
--specify a space\-separated list of rsync command line options that will
-+specify a space-separated list of rsync command line options that will
- be refused by your rsync daemon.
--You may specify the full option name, its one\-letter abbreviation, or a
--wild\-card string that matches multiple options.
-+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 \fB\-\-checksum\fP (\fB\-c\fP) and all the various
- delete options:
- .IP
[email protected]@ -652,15 +652,15 @@
[email protected]@ -789,15 +789,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
--\fBremove\-source\-files\fP when the daemon is the sender; if you want the latter
++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
--delete modes without affecting \fB\-\-remove\-source\-files\fP.
-+As an additional safety feature, the refusal of \(lqdelete\(rq also refuses
-+\fBremove-source-files\fP when the daemon is the sender; if you want the latter
-+without the former, instead refuse \(lqdelete\-*\(rq \-\- that refuses all the
-+delete modes without affecting \fB\-\-remove-source-files\fP.
++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 \(lqdont compress = *\(rq (see below)
-+instead of \(lqrefuse options = compress\(rq 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"
[email protected]@ -669,25 +669,25 @@
[email protected]@ -806,16 +806,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
@@ -707,31 +702,27 @@
such as already compressed files.
.IP
-The \(dq\&dont compress\(dq\& parameter takes a space\-separated list of
--case\-insensitive wildcard patterns. Any source filename matching one
-+The \(lqdont compress\(rq parameter takes a space-separated list of
-+case-insensitive wildcard patterns. Any source filename matching one
++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 \(lqdont compress\(rq 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"
-+.IP "\fBpre-xfer exec\fP, \fBpost-xfer exec\fP"
- You may specify a command to be run
--before and/or after the transfer. If the \fBpre\-xfer exec\fP command fails, the
-+before and/or after the transfer. If the \fBpre-xfer exec\fP command fails, the
- transfer is aborted before it begins.
+ .IP "\fBpre\-xfer exec\fP, \fBpost\-xfer exec\fP"
[email protected]@ -824,7 +824,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
- The following environment variables will be set, though some are
--specific to the pre\-xfer or the post\-xfer environment:
-+specific to the pre-xfer or the post-xfer environment:
- .IP
- .RS
- .IP o
[email protected]@ -695,29 +695,29 @@
[email protected]@ -837,26 +837,26 @@
.IP o
\fBRSYNC_MODULE_PATH\fP: The path configured for the module.
.IP o
@@ -746,55 +737,60 @@
.IP o
\fBRSYNC_PID\fP: A unique number for this transfer.
.IP o
--\fBRSYNC_REQUEST\fP: (pre\-xfer only) The module/path info specified
-+\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 \(lqmod/path1 mod/path2\(rq, etc.).
+ \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\&, and the last
-+\fBRSYNC_ARG#\fP: (pre-xfer only) The pre-request arguments are set
-+in these numbered values. RSYNC_ARG0 is always \(lqrsyncd\(rq, and the last
- value contains a single period.
+ \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.
++\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
- server side, so this is not the final exit status for the whole transfer.
- .IP o
--\fBRSYNC_RAW_STATUS\fP: (post\-xfer only) the raw exit value from
-+\fBRSYNC_RAW_STATUS\fP: (post-xfer only) the raw exit value from
- \f(CWwaitpid()\fP
- \&.
- .RE
[email protected]@ -725,15 +725,15 @@
[email protected]@ -870,7 +870,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 "AUTHENTICATION STRENGTH"
+ .SH "CONFIG DIRECTIVES"
[email protected]@ -878,7 +878,7 @@
+ 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
[email protected]@ -885,7 +885,7 @@
+ as globals/defaults, and leaving the defaults unchanged for the parsing of
+ the rest of the parent file.
.PP
- The authentication protocol used in rsync is a 128 bit MD4 based
- challenge response system. This is fairly weak protection, though (with
--at least one brute\-force hash\-finding algorithm publicly available), so
--if you want really top\-quality security, then I recommend that you run
-+at least one brute-force hash-finding algorithm publicly available), so
-+if you want really top-quality security, then I recommend that you run
- rsync over ssh. (Yes, a future version of rsync will switch over to a
- stronger hashing method.)
+-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.
[email protected]@ -894,8 +894,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
[email protected]@ -844,7 +844,7 @@
- .PP
- We would be delighted to hear from you if you like this program.
- .PP
--This program uses the zlib compression library written by Jean\-loup
-+This program uses the zlib compression library written by Jean-loup
- Gailly and Mark Adler.
- .PP
- .SH "THANKS"
+ .nf
+ &include /path/rsyncd.d