96e26344ed984304d3abaf843f9f5ed3a01d9a70
[rsync.git] / rsync.yo
1 mailto(rsync-bugs@samba.org)
2 manpage(rsync)(1)(29 Jun 2008)()()
3 manpagename(rsync)(a fast, versatile, remote (and local) file-copying tool)
4 manpagesynopsis()
5
6 verb(Local:  rsync [OPTION...] SRC... [DEST]
7
8 Access via remote shell:
9   Pull: rsync [OPTION...] [USER@]HOST:SRC... [DEST]
10   Push: rsync [OPTION...] SRC... [USER@]HOST:DEST
11
12 Access via rsync daemon:
13   Pull: rsync [OPTION...] [USER@]HOST::SRC... [DEST]
14         rsync [OPTION...] rsync://[USER@]HOST[:PORT]/SRC... [DEST]
15   Push: rsync [OPTION...] SRC... [USER@]HOST::DEST
16         rsync [OPTION...] SRC... rsync://[USER@]HOST[:PORT]/DEST)
17
18 Usages with just one SRC arg and no DEST arg will list the source files
19 instead of copying.
20
21 manpagedescription()
22
23 Rsync is a fast and extraordinarily versatile file copying tool.  It can
24 copy locally, to/from another host over any remote shell, or to/from a
25 remote rsync daemon.  It offers a large number of options that control
26 every aspect of its behavior and permit very flexible specification of the
27 set of files to be copied.  It is famous for its delta-transfer algorithm,
28 which reduces the amount of data sent over the network by sending only the
29 differences between the source files and the existing files in the
30 destination.  Rsync is widely used for backups and mirroring and as an
31 improved copy command for everyday use.
32
33 Rsync finds files that need to be transferred using a "quick check"
34 algorithm (by default) that looks for files that have changed in size or
35 in last-modified time.  Any changes in the other preserved attributes (as
36 requested by options) are made on the destination file directly when the
37 quick check indicates that the file's data does not need to be updated.
38
39 Some of the additional features of rsync are:
40
41 itemization(
42   it() support for copying links, devices, owners, groups, and permissions
43   it() exclude and exclude-from options similar to GNU tar
44   it() a CVS exclude mode for ignoring the same files that CVS would ignore
45   it() can use any transparent remote shell, including ssh or rsh
46   it() does not require super-user privileges
47   it() pipelining of file transfers to minimize latency costs
48   it() support for anonymous or authenticated rsync daemons (ideal for
49        mirroring)
50 )
51
52 manpagesection(GENERAL)
53
54 Rsync copies files either to or from a remote host, or locally on the
55 current host (it does not support copying files between two remote hosts).
56
57 There are two different ways for rsync to contact a remote system: using a
58 remote-shell program as the transport (such as ssh or rsh) or contacting an
59 rsync daemon directly via TCP.  The remote-shell transport is used whenever
60 the source or destination path contains a single colon (:) separator after
61 a host specification.  Contacting an rsync daemon directly happens when the
62 source or destination path contains a double colon (::) separator after a
63 host specification, OR when an rsync:// URL is specified (see also the
64 "USING RSYNC-DAEMON FEATURES VIA A REMOTE-SHELL CONNECTION" section for
65 an exception to this latter rule).
66
67 As a special case, if a single source arg is specified without a
68 destination, the files are listed in an output format similar to "ls -l".
69
70 As expected, if neither the source or destination path specify a remote
71 host, the copy occurs locally (see also the bf(--list-only) option).
72
73 Rsync refers to the local side as the "client" and the remote side as the
74 "server".  Don't confuse "server" with an rsync daemon -- a daemon is always a
75 server, but a server can be either a daemon or a remote-shell spawned process.
76
77 manpagesection(SETUP)
78
79 See the file README for installation instructions.
80
81 Once installed, you can use rsync to any machine that you can access via
82 a remote shell (as well as some that you can access using the rsync
83 daemon-mode protocol).  For remote transfers, a modern rsync uses ssh
84 for its communications, but it may have been configured to use a
85 different remote shell by default, such as rsh or remsh.
86
87 You can also specify any remote shell you like, either by using the bf(-e)
88 command line option, or by setting the RSYNC_RSH environment variable.
89
90 Note that rsync must be installed on both the source and destination
91 machines.
92
93 manpagesection(USAGE)
94
95 You use rsync in the same way you use rcp. You must specify a source
96 and a destination, one of which may be remote.
97
98 Perhaps the best way to explain the syntax is with some examples:
99
100 quote(tt(rsync -t *.c foo:src/))
101
102 This would transfer all files matching the pattern *.c from the
103 current directory to the directory src on the machine foo. If any of
104 the files already exist on the remote system then the rsync
105 remote-update protocol is used to update the file by sending only the
106 differences. See the tech report for details.
107
108 quote(tt(rsync -avz foo:src/bar /data/tmp))
109
110 This would recursively transfer all files from the directory src/bar on the
111 machine foo into the /data/tmp/bar directory on the local machine. The
112 files are transferred in "archive" mode, which ensures that symbolic
113 links, devices, attributes, permissions, ownerships, etc. are preserved
114 in the transfer.  Additionally, compression will be used to reduce the
115 size of data portions of the transfer.
116
117 quote(tt(rsync -avz foo:src/bar/ /data/tmp))
118
119 A trailing slash on the source changes this behavior to avoid creating an
120 additional directory level at the destination.  You can think of a trailing
121 / on a source as meaning "copy the contents of this directory" as opposed
122 to "copy the directory by name", but in both cases the attributes of the
123 containing directory are transferred to the containing directory on the
124 destination.  In other words, each of the following commands copies the
125 files in the same way, including their setting of the attributes of
126 /dest/foo:
127
128 quote(
129 tt(rsync -av /src/foo /dest)nl()
130 tt(rsync -av /src/foo/ /dest/foo)nl()
131 )
132
133 Note also that host and module references don't require a trailing slash to
134 copy the contents of the default directory.  For example, both of these
135 copy the remote directory's contents into "/dest":
136
137 quote(
138 tt(rsync -av host: /dest)nl()
139 tt(rsync -av host::module /dest)nl()
140 )
141
142 You can also use rsync in local-only mode, where both the source and
143 destination don't have a ':' in the name. In this case it behaves like
144 an improved copy command.
145
146 Finally, you can list all the (listable) modules available from a
147 particular rsync daemon by leaving off the module name:
148
149 quote(tt(rsync somehost.mydomain.com::))
150
151 See the following section for more details.
152
153 manpagesection(ADVANCED USAGE)
154
155 The syntax for requesting multiple files from a remote host is done by
156 specifying additional remote-host args in the same style as the first,
157 or with the hostname omitted.  For instance, all these work:
158
159 quote(tt(rsync -av host:file1 :file2 host:file{3,4} /dest/)nl()
160 tt(rsync -av host::modname/file{1,2} host::modname/file3 /dest/)nl()
161 tt(rsync -av host::modname/file1 ::modname/file{3,4}))
162
163 Older versions of rsync required using quoted spaces in the SRC, like these
164 examples:
165
166 quote(tt(rsync -av host:'dir1/file1 dir2/file2' /dest)nl()
167 tt(rsync host::'modname/dir1/file1 modname/dir2/file2' /dest))
168
169 This word-splitting still works (by default) in the latest rsync, but is
170 not as easy to use as the first method.
171
172 If you need to transfer a filename that contains whitespace, you can either
173 specify the bf(--protect-args) (bf(-s)) option, or you'll need to escape
174 the whitespace in a way that the remote shell will understand.  For
175 instance:
176
177 quote(tt(rsync -av host:'file\ name\ with\ spaces' /dest))
178
179 manpagesection(CONNECTING TO AN RSYNC DAEMON)
180
181 It is also possible to use rsync without a remote shell as the transport.
182 In this case you will directly connect to a remote rsync daemon, typically
183 using TCP port 873.  (This obviously requires the daemon to be running on
184 the remote system, so refer to the STARTING AN RSYNC DAEMON TO ACCEPT
185 CONNECTIONS section below for information on that.)
186
187 Using rsync in this way is the same as using it with a remote shell except
188 that:
189
190 itemization(
191         it() you either use a double colon :: instead of a single colon to
192         separate the hostname from the path, or you use an rsync:// URL.
193         it() the first word of the "path" is actually a module name.
194         it() the remote daemon may print a message of the day when you
195         connect.
196         it() if you specify no path name on the remote daemon then the
197         list of accessible paths on the daemon will be shown.
198         it() if you specify no local destination then a listing of the
199         specified files on the remote daemon is provided.
200         it() you must not specify the bf(--rsh) (bf(-e)) option.
201 )
202
203 An example that copies all the files in a remote module named "src":
204
205 verb(    rsync -av host::src /dest)
206
207 Some modules on the remote daemon may require authentication. If so,
208 you will receive a password prompt when you connect. You can avoid the
209 password prompt by setting the environment variable RSYNC_PASSWORD to
210 the password you want to use or using the bf(--password-file) option. This
211 may be useful when scripting rsync.
212
213 WARNING: On some systems environment variables are visible to all
214 users. On those systems using bf(--password-file) is recommended.
215
216 You may establish the connection via a web proxy by setting the
217 environment variable RSYNC_PROXY to a hostname:port pair pointing to
218 your web proxy.  Note that your web proxy's configuration must support
219 proxy connections to port 873.
220
221 You may also establish a daemon connection using a program as a proxy by
222 setting the environment variable RSYNC_CONNECT_PROG to the commands you
223 wish to run in place of making a direct socket connection.  The string may
224 contain the escape "%H" to represent the hostname specified in the rsync
225 command (so use "%%" if you need a single "%" in your string).  For
226 example:
227
228 verb(  export RSYNC_CONNECT_PROG='ssh proxyhost nc %H 873'
229   rsync -av targethost1::module/src/ /dest/
230   rsync -av rsync:://targethost2/module/src/ /dest/ )
231
232 The command specified above uses ssh to run nc (netcat) on a proxyhost,
233 which forwards all data to port 873 (the rsync daemon) on the targethost
234 (%H).
235
236 manpagesection(USING RSYNC-DAEMON FEATURES VIA A REMOTE-SHELL CONNECTION)
237
238 It is sometimes useful to use various features of an rsync daemon (such as
239 named modules) without actually allowing any new socket connections into a
240 system (other than what is already required to allow remote-shell access).
241 Rsync supports connecting to a host using a remote shell and then spawning
242 a single-use "daemon" server that expects to read its config file in the
243 home dir of the remote user.  This can be useful if you want to encrypt a
244 daemon-style transfer's data, but since the daemon is started up fresh by
245 the remote user, you may not be able to use features such as chroot or
246 change the uid used by the daemon.  (For another way to encrypt a daemon
247 transfer, consider using ssh to tunnel a local port to a remote machine and
248 configure a normal rsync daemon on that remote host to only allow
249 connections from "localhost".)
250
251 From the user's perspective, a daemon transfer via a remote-shell
252 connection uses nearly the same command-line syntax as a normal
253 rsync-daemon transfer, with the only exception being that you must
254 explicitly set the remote shell program on the command-line with the
255 bf(--rsh=COMMAND) option.  (Setting the RSYNC_RSH in the environment
256 will not turn on this functionality.)  For example:
257
258 verb(    rsync -av --rsh=ssh host::module /dest)
259
260 If you need to specify a different remote-shell user, keep in mind that the
261 user@ prefix in front of the host is specifying the rsync-user value (for a
262 module that requires user-based authentication).  This means that you must
263 give the '-l user' option to ssh when specifying the remote-shell, as in
264 this example that uses the short version of the bf(--rsh) option:
265
266 verb(    rsync -av -e "ssh -l ssh-user" rsync-user@host::module /dest)
267
268 The "ssh-user" will be used at the ssh level; the "rsync-user" will be
269 used to log-in to the "module".
270
271 manpagesection(STARTING AN RSYNC DAEMON TO ACCEPT CONNECTIONS)
272
273 In order to connect to an rsync daemon, the remote system needs to have a
274 daemon already running (or it needs to have configured something like inetd
275 to spawn an rsync daemon for incoming connections on a particular port).
276 For full information on how to start a daemon that will handling incoming
277 socket connections, see the bf(rsyncd.conf)(5) man page -- that is the config
278 file for the daemon, and it contains the full details for how to run the
279 daemon (including stand-alone and inetd configurations).
280
281 If you're using one of the remote-shell transports for the transfer, there is
282 no need to manually start an rsync daemon.
283
284 manpagesection(EXAMPLES)
285
286 Here are some examples of how I use rsync.
287
288 To backup my wife's home directory, which consists of large MS Word
289 files and mail folders, I use a cron job that runs
290
291 quote(tt(rsync -Cavz . arvidsjaur:backup))
292
293 each night over a PPP connection to a duplicate directory on my machine
294 "arvidsjaur".
295
296 To synchronize my samba source trees I use the following Makefile
297 targets:
298
299 verb(    get:
300             rsync -avuzb --exclude '*~' samba:samba/ .
301     put:
302             rsync -Cavuzb . samba:samba/
303     sync: get put)
304
305 this allows me to sync with a CVS directory at the other end of the
306 connection. I then do CVS operations on the remote machine, which saves a
307 lot of time as the remote CVS protocol isn't very efficient.
308
309 I mirror a directory between my "old" and "new" ftp sites with the
310 command:
311
312 tt(rsync -az -e ssh --delete ~ftp/pub/samba nimbus:"~ftp/pub/tridge")
313
314 This is launched from cron every few hours.
315
316 manpagesection(OPTIONS SUMMARY)
317
318 Here is a short summary of the options available in rsync. Please refer
319 to the detailed description below for a complete description.  verb(
320  -v, --verbose               increase verbosity
321      --info=FLAGS            fine-grained informational verbosity
322      --debug=FLAGS           fine-grained debug verbosity
323  -q, --quiet                 suppress non-error messages
324      --no-motd               suppress daemon-mode MOTD (see caveat)
325  -c, --checksum              skip based on checksum, not mod-time & size
326  -a, --archive               archive mode; equals -rlptgoD (no -H,-A,-X)
327      --no-OPTION             turn off an implied OPTION (e.g. --no-D)
328  -r, --recursive             recurse into directories
329  -R, --relative              use relative path names
330      --no-implied-dirs       don't send implied dirs with --relative
331  -b, --backup                make backups (see --suffix & --backup-dir)
332      --backup-dir=DIR        make backups into hierarchy based in DIR
333      --suffix=SUFFIX         backup suffix (default ~ w/o --backup-dir)
334  -u, --update                skip files that are newer on the receiver
335      --inplace               update destination files in-place
336      --append                append data onto shorter files
337      --append-verify         --append w/old data in file checksum
338  -d, --dirs                  transfer directories without recursing
339  -l, --links                 copy symlinks as symlinks
340  -L, --copy-links            transform symlink into referent file/dir
341      --copy-unsafe-links     only "unsafe" symlinks are transformed
342      --safe-links            ignore symlinks that point outside the tree
343      --munge-links           munge symlinks to make them safer
344  -k, --copy-dirlinks         transform symlink to dir into referent dir
345  -K, --keep-dirlinks         treat symlinked dir on receiver as dir
346  -H, --hard-links            preserve hard links
347  -p, --perms                 preserve permissions
348  -E, --executability         preserve executability
349      --chmod=CHMOD           affect file and/or directory permissions
350  -A, --acls                  preserve ACLs (implies -p)
351  -X, --xattrs                preserve extended attributes
352  -o, --owner                 preserve owner (super-user only)
353  -g, --group                 preserve group
354      --devices               preserve device files (super-user only)
355      --specials              preserve special files
356  -D                          same as --devices --specials
357  -t, --times                 preserve modification times
358  -O, --omit-dir-times        omit directories from --times
359  -J, --omit-link-times       omit symlinks from --times
360      --super                 receiver attempts super-user activities
361      --fake-super            store/recover privileged attrs using xattrs
362  -S, --sparse                handle sparse files efficiently
363      --preallocate           allocate dest files before writing
364  -n, --dry-run               perform a trial run with no changes made
365  -W, --whole-file            copy files whole (w/o delta-xfer algorithm)
366  -x, --one-file-system       don't cross filesystem boundaries
367  -B, --block-size=SIZE       force a fixed checksum block-size
368  -e, --rsh=COMMAND           specify the remote shell to use
369      --rsync-path=PROGRAM    specify the rsync to run on remote machine
370      --existing              skip creating new files on receiver
371      --ignore-existing       skip updating files that exist on receiver
372      --remove-source-files   sender removes synchronized files (non-dir)
373      --del                   an alias for --delete-during
374      --delete                delete extraneous files from dest dirs
375      --delete-before         receiver deletes before xfer, not during
376      --delete-during         receiver deletes during transfer (default)
377      --delete-delay          find deletions during, delete after
378      --delete-after          receiver deletes after transfer, not before
379      --delete-excluded       also delete excluded files from dest dirs
380      --ignore-missing-args   ignore missing source args without error
381      --delete-missing-args   delete missing source args from destination
382      --ignore-errors         delete even if there are I/O errors
383      --force                 force deletion of dirs even if not empty
384      --max-delete=NUM        don't delete more than NUM files
385      --max-size=SIZE         don't transfer any file larger than SIZE
386      --min-size=SIZE         don't transfer any file smaller than SIZE
387      --partial               keep partially transferred files
388      --partial-dir=DIR       put a partially transferred file into DIR
389      --delay-updates         put all updated files into place at end
390  -m, --prune-empty-dirs      prune empty directory chains from file-list
391      --numeric-ids           don't map uid/gid values by user/group name
392      --usermap=STRING        custom username mapping
393      --groupmap=STRING       custom groupname mapping
394      --chown=USER:GROUP      simple username/groupname mapping
395      --timeout=SECONDS       set I/O timeout in seconds
396      --contimeout=SECONDS    set daemon connection timeout in seconds
397  -I, --ignore-times          don't skip files that match size and time
398      --size-only             skip files that match in size
399      --modify-window=NUM     compare mod-times with reduced accuracy
400  -T, --temp-dir=DIR          create temporary files in directory DIR
401  -y, --fuzzy                 find similar file for basis if no dest file
402      --compare-dest=DIR      also compare received files relative to DIR
403      --copy-dest=DIR         ... and include copies of unchanged files
404      --link-dest=DIR         hardlink to files in DIR when unchanged
405  -z, --compress              compress file data during the transfer
406      --compress-level=NUM    explicitly set compression level
407      --skip-compress=LIST    skip compressing files with suffix in LIST
408  -C, --cvs-exclude           auto-ignore files in the same way CVS does
409  -f, --filter=RULE           add a file-filtering RULE
410  -F                          same as --filter='dir-merge /.rsync-filter'
411                              repeated: --filter='- .rsync-filter'
412      --exclude=PATTERN       exclude files matching PATTERN
413      --exclude-from=FILE     read exclude patterns from FILE
414      --include=PATTERN       don't exclude files matching PATTERN
415      --include-from=FILE     read include patterns from FILE
416      --files-from=FILE       read list of source-file names from FILE
417  -0, --from0                 all *from/filter files are delimited by 0s
418  -s, --protect-args          no space-splitting; wildcard chars only
419      --address=ADDRESS       bind address for outgoing socket to daemon
420      --port=PORT             specify double-colon alternate port number
421      --sockopts=OPTIONS      specify custom TCP options
422      --blocking-io           use blocking I/O for the remote shell
423      --stats                 give some file-transfer stats
424  -8, --8-bit-output          leave high-bit chars unescaped in output
425  -h, --human-readable        output numbers in a human-readable format
426      --progress              show progress during transfer
427  -P                          same as --partial --progress
428  -i, --itemize-changes       output a change-summary for all updates
429  -M, --remote-option=OPTION  send OPTION to the remote side only
430      --out-format=FORMAT     output updates using the specified FORMAT
431      --log-file=FILE         log what we're doing to the specified FILE
432      --log-file-format=FMT   log updates using the specified FMT
433      --password-file=FILE    read daemon-access password from FILE
434      --list-only             list the files instead of copying them
435      --bwlimit=RATE          limit socket I/O bandwidth
436      --write-batch=FILE      write a batched update to FILE
437      --only-write-batch=FILE like --write-batch but w/o updating dest
438      --read-batch=FILE       read a batched update from FILE
439      --protocol=NUM          force an older protocol version to be used
440      --iconv=CONVERT_SPEC    request charset conversion of filenames
441      --checksum-seed=NUM     set block/file checksum seed (advanced)
442  -4, --ipv4                  prefer IPv4
443  -6, --ipv6                  prefer IPv6
444      --version               print version number
445 (-h) --help                  show this help (see below for -h comment))
446
447 Rsync can also be run as a daemon, in which case the following options are
448 accepted: verb(
449      --daemon                run as an rsync daemon
450      --address=ADDRESS       bind to the specified address
451      --bwlimit=RATE          limit socket I/O bandwidth
452      --config=FILE           specify alternate rsyncd.conf file
453  -M, --dparam=OVERRIDE       override global daemon config parameter
454      --no-detach             do not detach from the parent
455      --port=PORT             listen on alternate port number
456      --log-file=FILE         override the "log file" setting
457      --log-file-format=FMT   override the "log format" setting
458      --sockopts=OPTIONS      specify custom TCP options
459  -v, --verbose               increase verbosity
460  -4, --ipv4                  prefer IPv4
461  -6, --ipv6                  prefer IPv6
462  -h, --help                  show this help (if used after --daemon))
463
464 manpageoptions()
465
466 Rsync accepts both long (double-dash + word) and short (single-dash + letter)
467 options.  The full list of the available options are described below.  If an
468 option can be specified in more than one way, the choices are comma-separated.
469 Some options only have a long variant, not a short.  If the option takes a
470 parameter, the parameter is only listed after the long variant, even though it
471 must also be specified for the short.  When specifying a parameter, you can
472 either use the form --option=param or replace the '=' with whitespace.  The
473 parameter may need to be quoted in some manner for it to survive the shell's
474 command-line parsing.  Keep in mind that a leading tilde (~) in a filename is
475 substituted by your shell, so --option=~/foo will not change the tilde into
476 your home directory (remove the '=' for that).
477
478 startdit()
479 dit(bf(--help)) Print a short help page describing the options
480 available in rsync and exit.  For backward-compatibility with older
481 versions of rsync, the help will also be output if you use the bf(-h)
482 option without any other args.
483
484 dit(bf(--version)) print the rsync version number and exit.
485
486 dit(bf(-v, --verbose)) This option increases the amount of information you
487 are given during the transfer.  By default, rsync works silently. A
488 single bf(-v) will give you information about what files are being
489 transferred and a brief summary at the end. Two bf(-v) options will give you
490 information on what files are being skipped and slightly more
491 information at the end. More than two bf(-v) options should only be used if
492 you are debugging rsync.
493
494 In a modern rsync, the bf(-v) option is equivalent to the setting of groups
495 of bf(--info) and bf(--debug) options.  You can choose to use these newer
496 options in addition to, or in place of using bf(--verbose), as any
497 fine-grained settings override the implied settings of bf(-v).  Both
498 bf(--info) and bf(--debug) have a way to ask for help that tells you
499 exactly what flags are set for each increase in verbosity.
500
501 dit(bf(--info=FLAGS))
502 This option lets you have fine-grained control over the
503 information
504 output you want to see.  An individual flag name may be followed by a level
505 number, with 0 meaning to silence that output, 1 being the default output
506 level, and higher numbers increasing the output of that flag (for those
507 that support higher levels).  Use
508 bf(--info=help)
509 to see all the available flag names, what they output, and what flag names
510 are added for each increase in the verbose level.  Some examples:
511
512 verb(    rsync -a --info=progress2 src/ dest/
513     rsync -avv --info=stats2,misc1,flist0 src/ dest/ )
514
515 Note that bf(--info=name)'s output is affected by the bf(--out-format) and
516 bf(--itemize-changes) (bf(-i)) options.  See those options for more
517 information on what is output and when.
518
519 This option was added to 3.1.0, so an older rsync on the server side might
520 reject your attempts at fine-grained control (if one or more flags needed
521 to be send to the server and the server was too old to understand them).
522
523 dit(bf(--debug=FLAGS))
524 This option lets you have fine-grained control over the
525 debug
526 output you want to see.  An individual flag name may be followed by a level
527 number, with 0 meaning to silence that output, 1 being the default output
528 level, and higher numbers increasing the output of that flag (for those
529 that support higher levels).  Use
530 bf(--debug=help)
531 to see all the available flag names, what they output, and what flag names
532 are added for each increase in the verbose level.  Some examples:
533
534 verb(    rsync -avvv --debug=none src/ dest/
535     rsync -avA --del --debug=del2,acl src/ dest/ )
536
537 This option was added to 3.1.0, so an older rsync on the server side might
538 reject your attempts at fine-grained control (if one or more flags needed
539 to be send to the server and the server was too old to understand them).
540
541 dit(bf(-q, --quiet)) This option decreases the amount of information you
542 are given during the transfer, notably suppressing information messages
543 from the remote server. This option name is useful when invoking rsync from
544 cron.
545
546 dit(bf(--no-motd)) This option affects the information that is output
547 by the client at the start of a daemon transfer.  This suppresses the
548 message-of-the-day (MOTD) text, but it also affects the list of modules
549 that the daemon sends in response to the "rsync host::" request (due to
550 a limitation in the rsync protocol), so omit this option if you want to
551 request the list of modules from the daemon.
552
553 dit(bf(-I, --ignore-times)) Normally rsync will skip any files that are
554 already the same size and have the same modification timestamp.
555 This option turns off this "quick check" behavior, causing all files to
556 be updated.
557
558 dit(bf(--size-only)) This modifies rsync's "quick check" algorithm for
559 finding files that need to be transferred, changing it from the default of
560 transferring files with either a changed size or a changed last-modified
561 time to just looking for files that have changed in size.  This is useful
562 when starting to use rsync after using another mirroring system which may
563 not preserve timestamps exactly.
564
565 dit(bf(--modify-window)) When comparing two timestamps, rsync treats the
566 timestamps as being equal if they differ by no more than the modify-window
567 value.  This is normally 0 (for an exact match), but you may find it useful
568 to set this to a larger value in some situations.  In particular, when
569 transferring to or from an MS Windows FAT filesystem (which represents
570 times with a 2-second resolution), bf(--modify-window=1) is useful
571 (allowing times to differ by up to 1 second).
572
573 dit(bf(-c, --checksum)) This changes the way rsync checks if the files have
574 been changed and are in need of a transfer.  Without this option, rsync
575 uses a "quick check" that (by default) checks if each file's size and time
576 of last modification match between the sender and receiver.  This option
577 changes this to compare a 128-bit checksum for each file that has a
578 matching size.  Generating the checksums means that both sides will expend
579 a lot of disk I/O reading all the data in the files in the transfer (and
580 this is prior to any reading that will be done to transfer changed files),
581 so this can slow things down significantly.
582
583 The sending side generates its checksums while it is doing the file-system
584 scan that builds the list of the available files.  The receiver generates
585 its checksums when it is scanning for changed files, and will checksum any
586 file that has the same size as the corresponding sender's file:  files with
587 either a changed size or a changed checksum are selected for transfer.
588
589 Note that rsync always verifies that each em(transferred) file was
590 correctly reconstructed on the receiving side by checking a whole-file
591 checksum that is generated as the file is transferred, but that
592 automatic after-the-transfer verification has nothing to do with this
593 option's before-the-transfer "Does this file need to be updated?" check.
594
595 For protocol 30 and beyond (first supported in 3.0.0), the checksum used is
596 MD5.  For older protocols, the checksum used is MD4.
597
598 dit(bf(-a, --archive)) This is equivalent to bf(-rlptgoD). It is a quick
599 way of saying you want recursion and want to preserve almost
600 everything (with -H being a notable omission).
601 The only exception to the above equivalence is when bf(--files-from) is
602 specified, in which case bf(-r) is not implied.
603
604 Note that bf(-a) bf(does not preserve hardlinks), because
605 finding multiply-linked files is expensive.  You must separately
606 specify bf(-H).
607
608 dit(--no-OPTION) You may turn off one or more implied options by prefixing
609 the option name with "no-".  Not all options may be prefixed with a "no-":
610 only options that are implied by other options (e.g. bf(--no-D),
611 bf(--no-perms)) or have different defaults in various circumstances
612 (e.g. bf(--no-whole-file), bf(--no-blocking-io), bf(--no-dirs)).  You may
613 specify either the short or the long option name after the "no-" prefix
614 (e.g. bf(--no-R) is the same as bf(--no-relative)).
615
616 For example: if you want to use bf(-a) (bf(--archive)) but don't want
617 bf(-o) (bf(--owner)), instead of converting bf(-a) into bf(-rlptgD), you
618 could specify bf(-a --no-o) (or bf(-a --no-owner)).
619
620 The order of the options is important:  if you specify bf(--no-r -a), the
621 bf(-r) option would end up being turned on, the opposite of bf(-a --no-r).
622 Note also that the side-effects of the bf(--files-from) option are NOT
623 positional, as it affects the default state of several options and slightly
624 changes the meaning of bf(-a) (see the bf(--files-from) option for more
625 details).
626
627 dit(bf(-r, --recursive)) This tells rsync to copy directories
628 recursively.  See also bf(--dirs) (bf(-d)).
629
630 Beginning with rsync 3.0.0, the recursive algorithm used is now an
631 incremental scan that uses much less memory than before and begins the
632 transfer after the scanning of the first few directories have been
633 completed.  This incremental scan only affects our recursion algorithm, and
634 does not change a non-recursive transfer.  It is also only possible when
635 both ends of the transfer are at least version 3.0.0.
636
637 Some options require rsync to know the full file list, so these options
638 disable the incremental recursion mode.  These include: bf(--delete-before),
639 bf(--delete-after), bf(--prune-empty-dirs), and bf(--delay-updates).
640 Because of this, the default delete mode when you specify bf(--delete) is now
641 bf(--delete-during) when both ends of the connection are at least 3.0.0
642 (use bf(--del) or bf(--delete-during) to request this improved deletion mode
643 explicitly).  See also the bf(--delete-delay) option that is a better choice
644 than using bf(--delete-after).
645
646 Incremental recursion can be disabled using the bf(--no-inc-recursive)
647 option or its shorter bf(--no-i-r) alias.
648
649 dit(bf(-R, --relative)) Use relative paths. This means that the full path
650 names specified on the command line are sent to the server rather than
651 just the last parts of the filenames. This is particularly useful when
652 you want to send several different directories at the same time. For
653 example, if you used this command:
654
655 quote(tt(   rsync -av /foo/bar/baz.c remote:/tmp/))
656
657 ... this would create a file named baz.c in /tmp/ on the remote
658 machine. If instead you used
659
660 quote(tt(   rsync -avR /foo/bar/baz.c remote:/tmp/))
661
662 then a file named /tmp/foo/bar/baz.c would be created on the remote
663 machine, preserving its full path.  These extra path elements are called
664 "implied directories" (i.e. the "foo" and the "foo/bar" directories in the
665 above example).
666
667 Beginning with rsync 3.0.0, rsync always sends these implied directories as
668 real directories in the file list, even if a path element is really a
669 symlink on the sending side.  This prevents some really unexpected
670 behaviors when copying the full path of a file that you didn't realize had
671 a symlink in its path.  If you want to duplicate a server-side symlink,
672 include both the symlink via its path, and referent directory via its real
673 path.  If you're dealing with an older rsync on the sending side, you may
674 need to use the bf(--no-implied-dirs) option.
675
676 It is also possible to limit the amount of path information that is sent as
677 implied directories for each path you specify.  With a modern rsync on the
678 sending side (beginning with 2.6.7), you can insert a dot and a slash into
679 the source path, like this:
680
681 quote(tt(   rsync -avR /foo/./bar/baz.c remote:/tmp/))
682
683 That would create /tmp/bar/baz.c on the remote machine.  (Note that the
684 dot must be followed by a slash, so "/foo/." would not be abbreviated.)
685 For older rsync versions, you would need to use a chdir to limit the
686 source path.  For example, when pushing files:
687
688 quote(tt(   (cd /foo; rsync -avR bar/baz.c remote:/tmp/) ))
689
690 (Note that the parens put the two commands into a sub-shell, so that the
691 "cd" command doesn't remain in effect for future commands.)
692 If you're pulling files from an older rsync, use this idiom (but only
693 for a non-daemon transfer):
694
695 quote(
696 tt(   rsync -avR --rsync-path="cd /foo; rsync" \ )nl()
697 tt(       remote:bar/baz.c /tmp/)
698 )
699
700 dit(bf(--no-implied-dirs)) This option affects the default behavior of the
701 bf(--relative) option.  When it is specified, the attributes of the implied
702 directories from the source names are not included in the transfer.  This
703 means that the corresponding path elements on the destination system are
704 left unchanged if they exist, and any missing implied directories are
705 created with default attributes.  This even allows these implied path
706 elements to have big differences, such as being a symlink to a directory on
707 the receiving side.
708
709 For instance, if a command-line arg or a files-from entry told rsync to
710 transfer the file "path/foo/file", the directories "path" and "path/foo"
711 are implied when bf(--relative) is used.  If "path/foo" is a symlink to
712 "bar" on the destination system, the receiving rsync would ordinarily
713 delete "path/foo", recreate it as a directory, and receive the file into
714 the new directory.  With bf(--no-implied-dirs), the receiving rsync updates
715 "path/foo/file" using the existing path elements, which means that the file
716 ends up being created in "path/bar".  Another way to accomplish this link
717 preservation is to use the bf(--keep-dirlinks) option (which will also
718 affect symlinks to directories in the rest of the transfer).
719
720 When pulling files from an rsync older than 3.0.0, you may need to use this
721 option if the sending side has a symlink in the path you request and you
722 wish the implied directories to be transferred as normal directories.
723
724 dit(bf(-b, --backup)) With this option, preexisting destination files are
725 renamed as each file is transferred or deleted.  You can control where the
726 backup file goes and what (if any) suffix gets appended using the
727 bf(--backup-dir) and bf(--suffix) options.
728
729 Note that if you don't specify bf(--backup-dir), (1) the
730 bf(--omit-dir-times) option will be implied, and (2) if bf(--delete) is
731 also in effect (without bf(--delete-excluded)), rsync will add a "protect"
732 filter-rule for the backup suffix to the end of all your existing excludes
733 (e.g. bf(-f "P *~")).  This will prevent previously backed-up files from being
734 deleted.  Note that if you are supplying your own filter rules, you may
735 need to manually insert your own exclude/protect rule somewhere higher up
736 in the list so that it has a high enough priority to be effective (e.g., if
737 your rules specify a trailing inclusion/exclusion of '*', the auto-added
738 rule would never be reached).
739
740 dit(bf(--backup-dir=DIR)) In combination with the bf(--backup) option, this
741 tells rsync to store all backups in the specified directory on the receiving
742 side.  This can be used for incremental backups.  You can additionally
743 specify a backup suffix using the bf(--suffix) option
744 (otherwise the files backed up in the specified directory
745 will keep their original filenames).
746
747 Note that if you specify a relative path, the backup directory will be
748 relative to the destination directory, so you probably want to specify
749 either an absolute path or a path that starts with "../".  If an rsync
750 daemon is the receiver, the backup dir cannot go outside the module's path
751 hierarchy, so take extra care not to delete it or copy into it.
752
753 dit(bf(--suffix=SUFFIX)) This option allows you to override the default
754 backup suffix used with the bf(--backup) (bf(-b)) option. The default suffix is a ~
755 if no -bf(-backup-dir) was specified, otherwise it is an empty string.
756
757 dit(bf(-u, --update)) This forces rsync to skip any files which exist on
758 the destination and have a modified time that is newer than the source
759 file.  (If an existing destination file has a modification time equal to the
760 source file's, it will be updated if the sizes are different.)
761
762 Note that this does not affect the copying of symlinks or other special
763 files.  Also, a difference of file format between the sender and receiver
764 is always considered to be important enough for an update, no matter what
765 date is on the objects.  In other words, if the source has a directory
766 where the destination has a file, the transfer would occur regardless of
767 the timestamps.
768
769 This option is a transfer rule, not an exclude, so it doesn't affect the
770 data that goes into the file-lists, and thus it doesn't affect deletions.
771 It just limits the files that the receiver requests to be transferred.
772
773 dit(bf(--inplace)) This option changes how rsync transfers a file when
774 its data needs to be updated: instead of the default method of creating
775 a new copy of the file and moving it into place when it is complete, rsync
776 instead writes the updated data directly to the destination file.
777
778 This has several effects:
779
780 quote(itemization(
781   it() Hard links are not broken.  This means the new data will be visible
782   through other hard links to the destination file.  Moreover, attempts to
783   copy differing source files onto a multiply-linked destination file will
784   result in a "tug of war" with the destination data changing back and forth.
785   it() In-use binaries cannot be updated (either the OS will prevent this from
786   happening, or binaries that attempt to swap-in their data will misbehave or
787   crash).
788   it() The file's data will be in an inconsistent state during the transfer
789   and will be left that way if the transfer is interrupted or if an update
790   fails.
791   it() A file that rsync cannot write to cannot be updated. While a super user
792   can update any file, a normal user needs to be granted write permission for
793   the open of the file for writing to be successful.
794   it() The efficiency of rsync's delta-transfer algorithm may be reduced if
795   some data in the destination file is overwritten before it can be copied to
796   a position later in the file.  This does not apply if you use bf(--backup),
797   since rsync is smart enough to use the backup file as the basis file for the
798   transfer.
799 ))
800
801 WARNING: you should not use this option to update files that are being
802 accessed by others, so be careful when choosing to use this for a copy.
803
804 This option is useful for transferring large files with block-based changes
805 or appended data, and also on systems that are disk bound, not network
806 bound.  It can also help keep a copy-on-write filesystem snapshot from
807 diverging the entire contents of a file that only has minor changes.
808
809 The option implies bf(--partial) (since an interrupted transfer does not delete
810 the file), but conflicts with bf(--partial-dir) and bf(--delay-updates).
811 Prior to rsync 2.6.4 bf(--inplace) was also incompatible with bf(--compare-dest)
812 and bf(--link-dest).
813
814 dit(bf(--append)) This causes rsync to update a file by appending data onto
815 the end of the file, which presumes that the data that already exists on
816 the receiving side is identical with the start of the file on the sending
817 side.  If a file needs to be transferred and its size on the receiver is
818 the same or longer than the size on the sender, the file is skipped.  This
819 does not interfere with the updating of a file's non-content attributes
820 (e.g. permissions, ownership, etc.) when the file does not need to be
821 transferred, nor does it affect the updating of any non-regular files.
822 Implies bf(--inplace),
823 but does not conflict with bf(--sparse) (since it is always extending a
824 file's length).
825
826 dit(bf(--append-verify)) This works just like the bf(--append) option, but
827 the existing data on the receiving side is included in the full-file
828 checksum verification step, which will cause a file to be resent if the
829 final verification step fails (rsync uses a normal, non-appending
830 bf(--inplace) transfer for the resend).
831
832 Note: prior to rsync 3.0.0, the bf(--append) option worked like
833 bf(--append-verify), so if you are interacting with an older rsync (or the
834 transfer is using a protocol prior to 30), specifying either append option
835 will initiate an bf(--append-verify) transfer.
836
837 dit(bf(-d, --dirs)) Tell the sending side to include any directories that
838 are encountered.  Unlike bf(--recursive), a directory's contents are not copied
839 unless the directory name specified is "." or ends with a trailing slash
840 (e.g. ".", "dir/.", "dir/", etc.).  Without this option or the
841 bf(--recursive) option, rsync will skip all directories it encounters (and
842 output a message to that effect for each one).  If you specify both
843 bf(--dirs) and bf(--recursive), bf(--recursive) takes precedence.
844
845 The bf(--dirs) option is implied by the bf(--files-from) option
846 or the bf(--list-only) option (including an implied
847 bf(--list-only) usage) if bf(--recursive) wasn't specified (so that
848 directories are seen in the listing).  Specify bf(--no-dirs) (or bf(--no-d))
849 if you want to turn this off.
850
851 There is also a backward-compatibility helper option, bf(--old-dirs) (or
852 bf(--old-d)) that tells rsync to use a hack of "-r --exclude='/*/*'" to get
853 an older rsync to list a single directory without recursing.
854
855 dit(bf(-l, --links)) When symlinks are encountered, recreate the
856 symlink on the destination.
857
858 dit(bf(-L, --copy-links)) When symlinks are encountered, the item that
859 they point to (the referent) is copied, rather than the symlink.  In older
860 versions of rsync, this option also had the side-effect of telling the
861 receiving side to follow symlinks, such as symlinks to directories.  In a
862 modern rsync such as this one, you'll need to specify bf(--keep-dirlinks) (bf(-K))
863 to get this extra behavior.  The only exception is when sending files to
864 an rsync that is too old to understand bf(-K) -- in that case, the bf(-L) option
865 will still have the side-effect of bf(-K) on that older receiving rsync.
866
867 dit(bf(--copy-unsafe-links)) This tells rsync to copy the referent of
868 symbolic links that point outside the copied tree.  Absolute symlinks
869 are also treated like ordinary files, and so are any symlinks in the
870 source path itself when bf(--relative) is used.  This option has no
871 additional effect if bf(--copy-links) was also specified.
872
873 dit(bf(--safe-links)) This tells rsync to ignore any symbolic links
874 which point outside the copied tree. All absolute symlinks are
875 also ignored. Using this option in conjunction with bf(--relative) may
876 give unexpected results.
877
878 dit(bf(--munge-links)) This option tells rsync to (1) modify all symlinks on
879 the receiving side in a way that makes them unusable but recoverable (see
880 below), or (2) to unmunge symlinks on the sending side that had been stored in
881 a munged state.  This is useful if you don't quite trust the source of the data
882 to not try to slip in a symlink to a unexpected place.
883
884 The way rsync disables the use of symlinks is to prefix each one with the
885 string "/rsyncd-munged/".  This prevents the links from being used as long as
886 that directory does not exist.  When this option is enabled, rsync will refuse
887 to run if that path is a directory or a symlink to a directory.
888
889 The option only affects the client side of the transfer, so if you need it to
890 affect the server, specify it via bf(--remote-option).  (Note that in a local
891 transfer, the client side is the sender.)
892
893 This option has no affect on a daemon, since the daemon configures whether it
894 wants munged symlinks via its "munge symlinks" parameter.  See also the
895 "munge-symlinks" perl script in the support directory of the source code.
896
897 dit(bf(-k, --copy-dirlinks)) This option causes the sending side to treat
898 a symlink to a directory as though it were a real directory.  This is
899 useful if you don't want symlinks to non-directories to be affected, as
900 they would be using bf(--copy-links).
901
902 Without this option, if the sending side has replaced a directory with a
903 symlink to a directory, the receiving side will delete anything that is in
904 the way of the new symlink, including a directory hierarchy (as long as
905 bf(--force) or bf(--delete) is in effect).
906
907 See also bf(--keep-dirlinks) for an analogous option for the receiving
908 side.
909
910 bf(--copy-dirlinks) applies to all symlinks to directories in the source.  If
911 you want to follow only a few specified symlinks, a trick you can use is to
912 pass them as additional source args with a trailing slash, using bf(--relative)
913 to make the paths match up right.  For example:
914
915 quote(tt(rsync -r --relative src/./ src/./follow-me/ dest/))
916
917 This works because rsync calls bf(lstat)(2) on the source arg as given, and the
918 trailing slash makes bf(lstat)(2) follow the symlink, giving rise to a directory
919 in the file-list which overrides the symlink found during the scan of "src/./".
920
921 dit(bf(-K, --keep-dirlinks)) This option causes the receiving side to treat
922 a symlink to a directory as though it were a real directory, but only if it
923 matches a real directory from the sender.  Without this option, the
924 receiver's symlink would be deleted and replaced with a real directory.
925
926 For example, suppose you transfer a directory "foo" that contains a file
927 "file", but "foo" is a symlink to directory "bar" on the receiver.  Without
928 bf(--keep-dirlinks), the receiver deletes symlink "foo", recreates it as a
929 directory, and receives the file into the new directory.  With
930 bf(--keep-dirlinks), the receiver keeps the symlink and "file" ends up in
931 "bar".
932
933 One note of caution:  if you use bf(--keep-dirlinks), you must trust all
934 the symlinks in the copy!  If it is possible for an untrusted user to
935 create their own symlink to any directory, the user could then (on a
936 subsequent copy) replace the symlink with a real directory and affect the
937 content of whatever directory the symlink references.  For backup copies,
938 you are better off using something like a bind mount instead of a symlink
939 to modify your receiving hierarchy.
940
941 See also bf(--copy-dirlinks) for an analogous option for the sending side.
942
943 dit(bf(-H, --hard-links)) This tells rsync to look for hard-linked files in
944 the source and link together the corresponding files on the destination.
945 Without this option, hard-linked files in the source are treated
946 as though they were separate files.
947
948 This option does NOT necessarily ensure that the pattern of hard links on the
949 destination exactly matches that on the source.  Cases in which the
950 destination may end up with extra hard links include the following:
951
952 quote(itemization(
953   it() If the destination contains extraneous hard-links (more linking than
954   what is present in the source file list), the copying algorithm will not
955   break them explicitly.  However, if one or more of the paths have content
956   differences, the normal file-update process will break those extra links
957   (unless you are using the bf(--inplace) option).
958   it() If you specify a bf(--link-dest) directory that contains hard links,
959   the linking of the destination files against the bf(--link-dest) files can
960   cause some paths in the destination to become linked together due to the
961   bf(--link-dest) associations.
962 ))
963
964 Note that rsync can only detect hard links between files that are inside
965 the transfer set.  If rsync updates a file that has extra hard-link
966 connections to files outside the transfer, that linkage will be broken.  If
967 you are tempted to use the bf(--inplace) option to avoid this breakage, be
968 very careful that you know how your files are being updated so that you are
969 certain that no unintended changes happen due to lingering hard links (and
970 see the bf(--inplace) option for more caveats).
971
972 If incremental recursion is active (see bf(--recursive)), rsync may transfer
973 a missing hard-linked file before it finds that another link for that contents
974 exists elsewhere in the hierarchy.  This does not affect the accuracy of
975 the transfer (i.e. which files are hard-linked together), just its efficiency
976 (i.e. copying the data for a new, early copy of a hard-linked file that could
977 have been found later in the transfer in another member of the hard-linked
978 set of files).  One way to avoid this inefficiency is to disable
979 incremental recursion using the bf(--no-inc-recursive) option.
980
981 dit(bf(-p, --perms)) This option causes the receiving rsync to set the
982 destination permissions to be the same as the source permissions.  (See
983 also the bf(--chmod) option for a way to modify what rsync considers to
984 be the source permissions.)
985
986 When this option is em(off), permissions are set as follows:
987
988 quote(itemization(
989   it() Existing files (including updated files) retain their existing
990   permissions, though the bf(--executability) option might change just
991   the execute permission for the file.
992   it() New files get their "normal" permission bits set to the source
993   file's permissions masked with the receiving directory's default
994   permissions (either the receiving process's umask, or the permissions
995   specified via the destination directory's default ACL), and
996   their special permission bits disabled except in the case where a new
997   directory inherits a setgid bit from its parent directory.
998 ))
999
1000 Thus, when bf(--perms) and bf(--executability) are both disabled,
1001 rsync's behavior is the same as that of other file-copy utilities,
1002 such as bf(cp)(1) and bf(tar)(1).
1003
1004 In summary: to give destination files (both old and new) the source
1005 permissions, use bf(--perms).  To give new files the destination-default
1006 permissions (while leaving existing files unchanged), make sure that the
1007 bf(--perms) option is off and use bf(--chmod=ugo=rwX) (which ensures that
1008 all non-masked bits get enabled).  If you'd care to make this latter
1009 behavior easier to type, you could define a popt alias for it, such as
1010 putting this line in the file ~/.popt (the following defines the bf(-Z) option,
1011 and includes --no-g to use the default group of the destination dir):
1012
1013 quote(tt(   rsync alias -Z --no-p --no-g --chmod=ugo=rwX))
1014
1015 You could then use this new option in a command such as this one:
1016
1017 quote(tt(   rsync -avZ src/ dest/))
1018
1019 (Caveat: make sure that bf(-a) does not follow bf(-Z), or it will re-enable
1020 the two "--no-*" options mentioned above.)
1021
1022 The preservation of the destination's setgid bit on newly-created
1023 directories when bf(--perms) is off was added in rsync 2.6.7.  Older rsync
1024 versions erroneously preserved the three special permission bits for
1025 newly-created files when bf(--perms) was off, while overriding the
1026 destination's setgid bit setting on a newly-created directory.  Default ACL
1027 observance was added to the ACL patch for rsync 2.6.7, so older (or
1028 non-ACL-enabled) rsyncs use the umask even if default ACLs are present.
1029 (Keep in mind that it is the version of the receiving rsync that affects
1030 these behaviors.)
1031
1032 dit(bf(-E, --executability)) This option causes rsync to preserve the
1033 executability (or non-executability) of regular files when bf(--perms) is
1034 not enabled.  A regular file is considered to be executable if at least one
1035 'x' is turned on in its permissions.  When an existing destination file's
1036 executability differs from that of the corresponding source file, rsync
1037 modifies the destination file's permissions as follows:
1038
1039 quote(itemization(
1040   it() To make a file non-executable, rsync turns off all its 'x'
1041   permissions.
1042   it() To make a file executable, rsync turns on each 'x' permission that
1043   has a corresponding 'r' permission enabled.
1044 ))
1045
1046 If bf(--perms) is enabled, this option is ignored.
1047
1048 dit(bf(-A, --acls)) This option causes rsync to update the destination
1049 ACLs to be the same as the source ACLs.
1050 The option also implies bf(--perms).
1051
1052 The source and destination systems must have compatible ACL entries for this
1053 option to work properly.  See the bf(--fake-super) option for a way to backup
1054 and restore ACLs that are not compatible.
1055
1056 dit(bf(-X, --xattrs)) This option causes rsync to update the destination
1057 extended attributes to be the same as the source ones.
1058
1059 For systems that support extended-attribute namespaces, a copy being done by a
1060 super-user copies all namespaces except system.*.  A normal user only copies
1061 the user.* namespace.  To be able to backup and restore non-user namespaces as
1062 a normal user, see the bf(--fake-super) option.
1063
1064 Note that this option does not copy rsyncs special xattr values (e.g. those
1065 used by bf(--fake-super)) unless you repeat the option (e.g. -XX).  This
1066 "copy all xattrs" mode cannot be used with bf(--fake-super).
1067
1068 dit(bf(--chmod)) This option tells rsync to apply one or more
1069 comma-separated "chmod" modes to the permission of the files in the
1070 transfer.  The resulting value is treated as though it were the permissions
1071 that the sending side supplied for the file, which means that this option
1072 can seem to have no effect on existing files if bf(--perms) is not enabled.
1073
1074 In addition to the normal parsing rules specified in the bf(chmod)(1)
1075 manpage, you can specify an item that should only apply to a directory by
1076 prefixing it with a 'D', or specify an item that should only apply to a
1077 file by prefixing it with a 'F'.  For example, the following will ensure
1078 that all directories get marked set-gid, that no files are other-writable,
1079 that both are user-writable and group-writable, and that both have
1080 consistent executability across all bits:
1081
1082 quote(--chmod=Dg+s,ug+w,Fo-w,+X)
1083
1084 Using octal mode numbers is also allowed:
1085
1086 quote(--chmod=D2775,F664)
1087
1088 It is also legal to specify multiple bf(--chmod) options, as each
1089 additional option is just appended to the list of changes to make.
1090
1091 See the bf(--perms) and bf(--executability) options for how the resulting
1092 permission value can be applied to the files in the transfer.
1093
1094 dit(bf(-o, --owner)) This option causes rsync to set the owner of the
1095 destination file to be the same as the source file, but only if the
1096 receiving rsync is being run as the super-user (see also the bf(--super)
1097 and bf(--fake-super) options).
1098 Without this option, the owner of new and/or transferred files are set to
1099 the invoking user on the receiving side.
1100
1101 The preservation of ownership will associate matching names by default, but
1102 may fall back to using the ID number in some circumstances (see also the
1103 bf(--numeric-ids) option for a full discussion).
1104
1105 dit(bf(-g, --group)) This option causes rsync to set the group of the
1106 destination file to be the same as the source file.  If the receiving
1107 program is not running as the super-user (or if bf(--no-super) was
1108 specified), only groups that the invoking user on the receiving side
1109 is a member of will be preserved.
1110 Without this option, the group is set to the default group of the invoking
1111 user on the receiving side.
1112
1113 The preservation of group information will associate matching names by
1114 default, but may fall back to using the ID number in some circumstances
1115 (see also the bf(--numeric-ids) option for a full discussion).
1116
1117 dit(bf(--devices)) This option causes rsync to transfer character and
1118 block device files to the remote system to recreate these devices.
1119 This option has no effect if the receiving rsync is not run as the
1120 super-user (see also the bf(--super) and bf(--fake-super) options).
1121
1122 dit(bf(--specials)) This option causes rsync to transfer special files
1123 such as named sockets and fifos.
1124
1125 dit(bf(-D)) The bf(-D) option is equivalent to bf(--devices) bf(--specials).
1126
1127 dit(bf(-t, --times)) This tells rsync to transfer modification times along
1128 with the files and update them on the remote system.  Note that if this
1129 option is not used, the optimization that excludes files that have not been
1130 modified cannot be effective; in other words, a missing bf(-t) or bf(-a) will
1131 cause the next transfer to behave as if it used bf(-I), causing all files to be
1132 updated (though rsync's delta-transfer algorithm will make the update fairly efficient
1133 if the files haven't actually changed, you're much better off using bf(-t)).
1134
1135 dit(bf(-O, --omit-dir-times)) This tells rsync to omit directories when
1136 it is preserving modification times (see bf(--times)).  If NFS is sharing
1137 the directories on the receiving side, it is a good idea to use bf(-O).
1138 This option is inferred if you use bf(--backup) without bf(--backup-dir).
1139
1140 dit(bf(-J, --omit-link-times)) This tells rsync to omit symlinks when
1141 it is preserving modification times (see bf(--times)).
1142
1143 dit(bf(--super)) This tells the receiving side to attempt super-user
1144 activities even if the receiving rsync wasn't run by the super-user.  These
1145 activities include: preserving users via the bf(--owner) option, preserving
1146 all groups (not just the current user's groups) via the bf(--groups)
1147 option, and copying devices via the bf(--devices) option.  This is useful
1148 for systems that allow such activities without being the super-user, and
1149 also for ensuring that you will get errors if the receiving side isn't
1150 being run as the super-user.  To turn off super-user activities, the
1151 super-user can use bf(--no-super).
1152
1153 dit(bf(--fake-super)) When this option is enabled, rsync simulates
1154 super-user activities by saving/restoring the privileged attributes via
1155 special extended attributes that are attached to each file (as needed).  This
1156 includes the file's owner and group (if it is not the default), the file's
1157 device info (device & special files are created as empty text files), and
1158 any permission bits that we won't allow to be set on the real file (e.g.
1159 the real file gets u-s,g-s,o-t for safety) or that would limit the owner's
1160 access (since the real super-user can always access/change a file, the
1161 files we create can always be accessed/changed by the creating user).
1162 This option also handles ACLs (if bf(--acls) was specified) and non-user
1163 extended attributes (if bf(--xattrs) was specified).
1164
1165 This is a good way to backup data without using a super-user, and to store
1166 ACLs from incompatible systems.
1167
1168 The bf(--fake-super) option only affects the side where the option is used.
1169 To affect the remote side of a remote-shell connection, use the
1170 bf(--remote-option) (bf(-M)) option:
1171
1172 quote(tt(  rsync -av -M--fake-super /src/ host:/dest/))
1173
1174 For a local copy, this option affects both the source and the destination.
1175 If you wish a local copy to enable this option just for the destination
1176 files, specify bf(-M--fake-super).  If you wish a local copy to enable
1177 this option just for the source files, combine bf(--fake-super) with
1178 bf(-M--super).
1179
1180 This option is overridden by both bf(--super) and bf(--no-super).
1181
1182 See also the "fake super" setting in the daemon's rsyncd.conf file.
1183
1184 dit(bf(-S, --sparse)) Try to handle sparse files efficiently so they take
1185 up less space on the destination.  Conflicts with bf(--inplace) because it's
1186 not possible to overwrite data in a sparse fashion.
1187
1188 dit(bf(--preallocate)) This tells the receiver to allocate each destination
1189 file to its eventual size before writing data to the file.  Rsync will only use
1190 the real filesystem-level preallocation support provided by Linux's
1191 bf(fallocate)(2) system call or Cygwin's bf(posix_fallocate)(3), not the slow
1192 glibc implementation that writes a zero byte into each block.
1193
1194 Without this option, larger files may not be entirely contiguous on the
1195 filesystem, but with this option rsync will probably copy more slowly.  If the
1196 destination is not an extent-supporting filesystem (such as ext4, xfs, NTFS,
1197 etc.), this option may have no positive effect at all.
1198
1199 dit(bf(-n, --dry-run)) This makes rsync perform a trial run that doesn't
1200 make any changes (and produces mostly the same output as a real run).  It
1201 is most commonly used in combination with the bf(-v, --verbose) and/or
1202 bf(-i, --itemize-changes) options to see what an rsync command is going
1203 to do before one actually runs it.
1204
1205 The output of bf(--itemize-changes) is supposed to be exactly the same on a
1206 dry run and a subsequent real run (barring intentional trickery and system
1207 call failures); if it isn't, that's a bug.  Other output should be mostly
1208 unchanged, but may differ in some areas.  Notably, a dry run does not
1209 send the actual data for file transfers, so bf(--progress) has no effect,
1210 the "bytes sent", "bytes received", "literal data", and "matched data"
1211 statistics are too small, and the "speedup" value is equivalent to a run
1212 where no file transfers were needed.
1213
1214 dit(bf(-W, --whole-file)) With this option rsync's delta-transfer algorithm
1215 is not used and the whole file is sent as-is instead.  The transfer may be
1216 faster if this option is used when the bandwidth between the source and
1217 destination machines is higher than the bandwidth to disk (especially when the
1218 "disk" is actually a networked filesystem).  This is the default when both
1219 the source and destination are specified as local paths, but only if no
1220 batch-writing option is in effect.
1221
1222 dit(bf(-x, --one-file-system)) This tells rsync to avoid crossing a
1223 filesystem boundary when recursing.  This does not limit the user's ability
1224 to specify items to copy from multiple filesystems, just rsync's recursion
1225 through the hierarchy of each directory that the user specified, and also
1226 the analogous recursion on the receiving side during deletion.  Also keep
1227 in mind that rsync treats a "bind" mount to the same device as being on the
1228 same filesystem.
1229
1230 If this option is repeated, rsync omits all mount-point directories from
1231 the copy.  Otherwise, it includes an empty directory at each mount-point it
1232 encounters (using the attributes of the mounted directory because those of
1233 the underlying mount-point directory are inaccessible).
1234
1235 If rsync has been told to collapse symlinks (via bf(--copy-links) or
1236 bf(--copy-unsafe-links)), a symlink to a directory on another device is
1237 treated like a mount-point.  Symlinks to non-directories are unaffected
1238 by this option.
1239
1240 dit(bf(--existing, --ignore-non-existing)) This tells rsync to skip
1241 creating files (including directories) that do not exist
1242 yet on the destination.  If this option is
1243 combined with the bf(--ignore-existing) option, no files will be updated
1244 (which can be useful if all you want to do is delete extraneous files).
1245
1246 This option is a transfer rule, not an exclude, so it doesn't affect the
1247 data that goes into the file-lists, and thus it doesn't affect deletions.
1248 It just limits the files that the receiver requests to be transferred.
1249
1250 dit(bf(--ignore-existing)) This tells rsync to skip updating files that
1251 already exist on the destination (this does em(not) ignore existing
1252 directories, or nothing would get done).  See also bf(--existing).
1253
1254 This option is a transfer rule, not an exclude, so it doesn't affect the
1255 data that goes into the file-lists, and thus it doesn't affect deletions.
1256 It just limits the files that the receiver requests to be transferred.
1257
1258 This option can be useful for those doing backups using the bf(--link-dest)
1259 option when they need to continue a backup run that got interrupted.  Since
1260 a bf(--link-dest) run is copied into a new directory hierarchy (when it is
1261 used properly), using bf(--ignore existing) will ensure that the
1262 already-handled files don't get tweaked (which avoids a change in
1263 permissions on the hard-linked files).  This does mean that this option
1264 is only looking at the existing files in the destination hierarchy itself.
1265
1266 dit(bf(--remove-source-files)) This tells rsync to remove from the sending
1267 side the files (meaning non-directories) that are a part of the transfer
1268 and have been successfully duplicated on the receiving side.
1269
1270 Note that you should only use this option on source files that are quiescent.
1271 If you are using this to move files that show up in a particular directory over
1272 to another host, make sure that the finished files get renamed into the source
1273 directory, not directly written into it, so that rsync can't possibly transfer
1274 a file that is not yet fully written.  If you can't first write the files into
1275 a different directory, you should use a naming idiom that lets rsync avoid
1276 transferring files that are not yet finished (e.g. name the file "foo.new" when
1277 it is written, rename it to "foo" when it is done, and then use the option
1278 bf(--exclude='*.new') for the rsync transfer).
1279
1280 Starting with 3.1.0, rsync will skip the sender-side removal (and output an
1281 error) if the file's size or modify time has not stayed unchanged.
1282
1283 dit(bf(--delete)) This tells rsync to delete extraneous files from the
1284 receiving side (ones that aren't on the sending side), but only for the
1285 directories that are being synchronized.  You must have asked rsync to
1286 send the whole directory (e.g. "dir" or "dir/") without using a wildcard
1287 for the directory's contents (e.g. "dir/*") since the wildcard is expanded
1288 by the shell and rsync thus gets a request to transfer individual files, not
1289 the files' parent directory.  Files that are excluded from the transfer are
1290 also excluded from being deleted unless you use the bf(--delete-excluded)
1291 option or mark the rules as only matching on the sending side (see the
1292 include/exclude modifiers in the FILTER RULES section).
1293
1294 Prior to rsync 2.6.7, this option would have no effect unless bf(--recursive)
1295 was enabled.  Beginning with 2.6.7, deletions will also occur when bf(--dirs)
1296 (bf(-d)) is enabled, but only for directories whose contents are being copied.
1297
1298 This option can be dangerous if used incorrectly!  It is a very good idea to
1299 first try a run using the bf(--dry-run) option (bf(-n)) to see what files are
1300 going to be deleted.
1301
1302 If the sending side detects any I/O errors, then the deletion of any
1303 files at the destination will be automatically disabled. This is to
1304 prevent temporary filesystem failures (such as NFS errors) on the
1305 sending side from causing a massive deletion of files on the
1306 destination.  You can override this with the bf(--ignore-errors) option.
1307
1308 The bf(--delete) option may be combined with one of the --delete-WHEN options
1309 without conflict, as well as bf(--delete-excluded).  However, if none of the
1310 --delete-WHEN options are specified, rsync will choose the
1311 bf(--delete-during) algorithm when talking to rsync 3.0.0 or newer, and
1312 the bf(--delete-before) algorithm when talking to an older rsync.  See also
1313 bf(--delete-delay) and bf(--delete-after).
1314
1315 dit(bf(--delete-before)) Request that the file-deletions on the receiving
1316 side be done before the transfer starts.
1317 See bf(--delete) (which is implied) for more details on file-deletion.
1318
1319 Deleting before the transfer is helpful if the filesystem is tight for space
1320 and removing extraneous files would help to make the transfer possible.
1321 However, it does introduce a delay before the start of the transfer,
1322 and this delay might cause the transfer to timeout (if bf(--timeout) was
1323 specified).  It also forces rsync to use the old, non-incremental recursion
1324 algorithm that requires rsync to scan all the files in the transfer into
1325 memory at once (see bf(--recursive)).
1326
1327 dit(bf(--delete-during, --del)) Request that the file-deletions on the
1328 receiving side be done incrementally as the transfer happens.  The
1329 per-directory delete scan is done right before each directory is checked
1330 for updates, so it behaves like a more efficient bf(--delete-before),
1331 including doing the deletions prior to any per-directory filter files
1332 being updated.  This option was first added in rsync version 2.6.4.
1333 See bf(--delete) (which is implied) for more details on file-deletion.
1334
1335 dit(bf(--delete-delay)) Request that the file-deletions on the receiving
1336 side be computed during the transfer (like bf(--delete-during)), and then
1337 removed after the transfer completes.  This is useful when combined with
1338 bf(--delay-updates) and/or bf(--fuzzy), and is more efficient than using
1339 bf(--delete-after) (but can behave differently, since bf(--delete-after)
1340 computes the deletions in a separate pass after all updates are done).
1341 If the number of removed files overflows an internal buffer, a
1342 temporary file will be created on the receiving side to hold the names (it
1343 is removed while open, so you shouldn't see it during the transfer).  If
1344 the creation of the temporary file fails, rsync will try to fall back to
1345 using bf(--delete-after) (which it cannot do if bf(--recursive) is doing an
1346 incremental scan).
1347 See bf(--delete) (which is implied) for more details on file-deletion.
1348
1349 dit(bf(--delete-after)) Request that the file-deletions on the receiving
1350 side be done after the transfer has completed.  This is useful if you
1351 are sending new per-directory merge files as a part of the transfer and
1352 you want their exclusions to take effect for the delete phase of the
1353 current transfer.  It also forces rsync to use the old, non-incremental
1354 recursion algorithm that requires rsync to scan all the files in the
1355 transfer into memory at once (see bf(--recursive)).
1356 See bf(--delete) (which is implied) for more details on file-deletion.
1357
1358 dit(bf(--delete-excluded)) In addition to deleting the files on the
1359 receiving side that are not on the sending side, this tells rsync to also
1360 delete any files on the receiving side that are excluded (see bf(--exclude)).
1361 See the FILTER RULES section for a way to make individual exclusions behave
1362 this way on the receiver, and for a way to protect files from
1363 bf(--delete-excluded).
1364 See bf(--delete) (which is implied) for more details on file-deletion.
1365
1366 dit(bf(--ignore-missing-args)) When rsync is first processing the explicitly
1367 requested source files (e.g. command-line arguments or bf(--files-from)
1368 entries), it is normally an error if the file cannot be found.  This option
1369 suppresses that error, and does not try to transfer the file.  This does not
1370 affect subsequent vanished-file errors if a file was initially found to be
1371 present and later is no longer there.
1372
1373 dit(bf(--delete-missing-args)) This option takes the behavior of (the implied)
1374 bf(--ignore-missing-args) option a step farther:  each missing arg will become
1375 a deletion request of the corresponding destination file on the receiving side
1376 (should it exist).  If the destination file is a non-empty directory, it will
1377 only be successfully deleted if --force or --delete are in effect.  Other than
1378 that, this option is independent of any other type of delete processing.
1379
1380 The missing source files are represented by special file-list entries which
1381 display as a "*missing" entry in the bf(--list-only) output.
1382
1383 dit(bf(--ignore-errors)) Tells bf(--delete) to go ahead and delete files
1384 even when there are I/O errors.
1385
1386 dit(bf(--force)) This option tells rsync to delete a non-empty directory
1387 when it is to be replaced by a non-directory.  This is only relevant if
1388 deletions are not active (see bf(--delete) for details).
1389
1390 Note for older rsync versions: bf(--force) used to still be required when
1391 using bf(--delete-after), and it used to be non-functional unless the
1392 bf(--recursive) option was also enabled.
1393
1394 dit(bf(--max-delete=NUM)) This tells rsync not to delete more than NUM
1395 files or directories.  If that limit is exceeded, a warning is output
1396 and rsync exits with an error code of 25 (new for 3.0.0).
1397
1398 Also new for version 3.0.0, you may specify bf(--max-delete=0) to be warned
1399 about any extraneous files in the destination without removing any of them.
1400 Older clients interpreted this as "unlimited", so if you don't know what
1401 version the client is, you can use the less obvious bf(--max-delete=-1) as
1402 a backward-compatible way to specify that no deletions be allowed (though
1403 older versions didn't warn when the limit was exceeded).
1404
1405 dit(bf(--max-size=SIZE)) This tells rsync to avoid transferring any
1406 file that is larger than the specified SIZE. The SIZE value can be
1407 suffixed with a string to indicate a size multiplier, and
1408 may be a fractional value (e.g. "bf(--max-size=1.5m)").
1409
1410 This option is a transfer rule, not an exclude, so it doesn't affect the
1411 data that goes into the file-lists, and thus it doesn't affect deletions.
1412 It just limits the files that the receiver requests to be transferred.
1413
1414 The suffixes are as follows: "K" (or "KiB") is a kibibyte (1024),
1415 "M" (or "MiB") is a mebibyte (1024*1024), and "G" (or "GiB") is a
1416 gibibyte (1024*1024*1024).
1417 If you want the multiplier to be 1000 instead of 1024, use "KB",
1418 "MB", or "GB".  (Note: lower-case is also accepted for all values.)
1419 Finally, if the suffix ends in either "+1" or "-1", the value will
1420 be offset by one byte in the indicated direction.
1421
1422 Examples: --max-size=1.5mb-1 is 1499999 bytes, and --max-size=2g+1 is
1423 2147483649 bytes.
1424
1425 dit(bf(--min-size=SIZE)) This tells rsync to avoid transferring any
1426 file that is smaller than the specified SIZE, which can help in not
1427 transferring small, junk files.
1428 See the bf(--max-size) option for a description of SIZE and other information.
1429
1430 dit(bf(-B, --block-size=BLOCKSIZE)) This forces the block size used in
1431 rsync's delta-transfer algorithm to a fixed value.  It is normally selected based on
1432 the size of each file being updated.  See the technical report for details.
1433
1434 dit(bf(-e, --rsh=COMMAND)) This option allows you to choose an alternative
1435 remote shell program to use for communication between the local and
1436 remote copies of rsync. Typically, rsync is configured to use ssh by
1437 default, but you may prefer to use rsh on a local network.
1438
1439 If this option is used with bf([user@]host::module/path), then the
1440 remote shell em(COMMAND) will be used to run an rsync daemon on the
1441 remote host, and all data will be transmitted through that remote
1442 shell connection, rather than through a direct socket connection to a
1443 running rsync daemon on the remote host.  See the section "USING
1444 RSYNC-DAEMON FEATURES VIA A REMOTE-SHELL CONNECTION" above.
1445
1446 Command-line arguments are permitted in COMMAND provided that COMMAND is
1447 presented to rsync as a single argument.  You must use spaces (not tabs
1448 or other whitespace) to separate the command and args from each other,
1449 and you can use single- and/or double-quotes to preserve spaces in an
1450 argument (but not backslashes).  Note that doubling a single-quote
1451 inside a single-quoted string gives you a single-quote; likewise for
1452 double-quotes (though you need to pay attention to which quotes your
1453 shell is parsing and which quotes rsync is parsing).  Some examples:
1454
1455 quote(
1456 tt(    -e 'ssh -p 2234')nl()
1457 tt(    -e 'ssh -o "ProxyCommand nohup ssh firewall nc -w1 %h %p"')nl()
1458 )
1459
1460 (Note that ssh users can alternately customize site-specific connect
1461 options in their .ssh/config file.)
1462
1463 You can also choose the remote shell program using the RSYNC_RSH
1464 environment variable, which accepts the same range of values as bf(-e).
1465
1466 See also the bf(--blocking-io) option which is affected by this option.
1467
1468 dit(bf(--rsync-path=PROGRAM)) Use this to specify what program is to be run
1469 on the remote machine to start-up rsync.  Often used when rsync is not in
1470 the default remote-shell's path (e.g. --rsync-path=/usr/local/bin/rsync).
1471 Note that PROGRAM is run with the help of a shell, so it can be any
1472 program, script, or command sequence you'd care to run, so long as it does
1473 not corrupt the standard-in & standard-out that rsync is using to
1474 communicate.
1475
1476 One tricky example is to set a different default directory on the remote
1477 machine for use with the bf(--relative) option.  For instance:
1478
1479 quote(tt(    rsync -avR --rsync-path="cd /a/b && rsync" host:c/d /e/))
1480
1481 dit(bf(-M, --remote-option=OPTION)) This option is used for more advanced
1482 situations where you want certain effects to be limited to one side of the
1483 transfer only.  For instance, if you want to pass bf(--log-file=FILE) and
1484 bf(--fake-super) to the remote system, specify it like this:
1485
1486 quote(tt(    rsync -av -M --log-file=foo -M--fake-super src/ dest/))
1487
1488 If you want to have an option affect only the local side of a transfer when
1489 it normally affects both sides, send its negation to the remote side.  Like
1490 this:
1491
1492 quote(tt(    rsync -av -x -M--no-x src/ dest/))
1493
1494 Be cautious using this, as it is possible to toggle an option that will cause
1495 rsync to have a different idea about what data to expect next over the socket,
1496 and that will make it fail in a cryptic fashion.
1497
1498 Note that it is best to use a separate bf(--remote-option) for each option you
1499 want to pass.  This makes your useage compatible with the bf(--protect-args)
1500 option.  If that option is off, any spaces in your remote options will be split
1501 by the remote shell unless you take steps to protect them.
1502
1503 When performing a local transfer, the "local" side is the sender and the
1504 "remote" side is the receiver.
1505
1506 Note some versions of the popt option-parsing library have a bug in them that
1507 prevents you from using an adjacent arg with an equal in it next to a short
1508 option letter (e.g. tt(-M--log-file=/tmp/foo).  If this bug affects your
1509 version of popt, you can use the version of popt that is included with rsync.
1510
1511 dit(bf(-C, --cvs-exclude)) This is a useful shorthand for excluding a
1512 broad range of files that you often don't want to transfer between
1513 systems. It uses a similar algorithm to CVS to determine if
1514 a file should be ignored.
1515
1516 The exclude list is initialized to exclude the following items (these
1517 initial items are marked as perishable -- see the FILTER RULES section):
1518
1519 quote(quote(tt(RCS SCCS CVS CVS.adm RCSLOG cvslog.* tags TAGS .make.state
1520 .nse_depinfo *~ #* .#* ,* _$* *$ *.old *.bak *.BAK *.orig *.rej .del-*
1521 *.a *.olb *.o *.obj *.so *.exe *.Z *.elc *.ln core .svn/ .git/ .hg/ .bzr/)))
1522
1523 then, files listed in a $HOME/.cvsignore are added to the list and any
1524 files listed in the CVSIGNORE environment variable (all cvsignore names
1525 are delimited by whitespace).
1526
1527 Finally, any file is ignored if it is in the same directory as a
1528 .cvsignore file and matches one of the patterns listed therein.  Unlike
1529 rsync's filter/exclude files, these patterns are split on whitespace.
1530 See the bf(cvs)(1) manual for more information.
1531
1532 If you're combining bf(-C) with your own bf(--filter) rules, you should
1533 note that these CVS excludes are appended at the end of your own rules,
1534 regardless of where the bf(-C) was placed on the command-line.  This makes them
1535 a lower priority than any rules you specified explicitly.  If you want to
1536 control where these CVS excludes get inserted into your filter rules, you
1537 should omit the bf(-C) as a command-line option and use a combination of
1538 bf(--filter=:C) and bf(--filter=-C) (either on your command-line or by
1539 putting the ":C" and "-C" rules into a filter file with your other rules).
1540 The first option turns on the per-directory scanning for the .cvsignore
1541 file.  The second option does a one-time import of the CVS excludes
1542 mentioned above.
1543
1544 dit(bf(-f, --filter=RULE)) This option allows you to add rules to selectively
1545 exclude certain files from the list of files to be transferred. This is
1546 most useful in combination with a recursive transfer.
1547
1548 You may use as many bf(--filter) options on the command line as you like
1549 to build up the list of files to exclude.  If the filter contains whitespace,
1550 be sure to quote it so that the shell gives the rule to rsync as a single
1551 argument.  The text below also mentions that you can use an underscore to
1552 replace the space that separates a rule from its arg.
1553
1554 See the FILTER RULES section for detailed information on this option.
1555
1556 dit(bf(-F)) The bf(-F) option is a shorthand for adding two bf(--filter) rules to
1557 your command.  The first time it is used is a shorthand for this rule:
1558
1559 quote(tt(   --filter='dir-merge /.rsync-filter'))
1560
1561 This tells rsync to look for per-directory .rsync-filter files that have
1562 been sprinkled through the hierarchy and use their rules to filter the
1563 files in the transfer.  If bf(-F) is repeated, it is a shorthand for this
1564 rule:
1565
1566 quote(tt(   --filter='exclude .rsync-filter'))
1567
1568 This filters out the .rsync-filter files themselves from the transfer.
1569
1570 See the FILTER RULES section for detailed information on how these options
1571 work.
1572
1573 dit(bf(--exclude=PATTERN)) This option is a simplified form of the
1574 bf(--filter) option that defaults to an exclude rule and does not allow
1575 the full rule-parsing syntax of normal filter rules.
1576
1577 See the FILTER RULES section for detailed information on this option.
1578
1579 dit(bf(--exclude-from=FILE)) This option is related to the bf(--exclude)
1580 option, but it specifies a FILE that contains exclude patterns (one per line).
1581 Blank lines in the file and lines starting with ';' or '#' are ignored.
1582 If em(FILE) is bf(-), the list will be read from standard input.
1583
1584 dit(bf(--include=PATTERN)) This option is a simplified form of the
1585 bf(--filter) option that defaults to an include rule and does not allow
1586 the full rule-parsing syntax of normal filter rules.
1587
1588 See the FILTER RULES section for detailed information on this option.
1589
1590 dit(bf(--include-from=FILE)) This option is related to the bf(--include)
1591 option, but it specifies a FILE that contains include patterns (one per line).
1592 Blank lines in the file and lines starting with ';' or '#' are ignored.
1593 If em(FILE) is bf(-), the list will be read from standard input.
1594
1595 dit(bf(--files-from=FILE)) Using this option allows you to specify the
1596 exact list of files to transfer (as read from the specified FILE or bf(-)
1597 for standard input).  It also tweaks the default behavior of rsync to make
1598 transferring just the specified files and directories easier:
1599
1600 quote(itemization(
1601   it() The bf(--relative) (bf(-R)) option is implied, which preserves the path
1602   information that is specified for each item in the file (use
1603   bf(--no-relative) or bf(--no-R) if you want to turn that off).
1604   it() The bf(--dirs) (bf(-d)) option is implied, which will create directories
1605   specified in the list on the destination rather than noisily skipping
1606   them (use bf(--no-dirs) or bf(--no-d) if you want to turn that off).
1607   it() The bf(--archive) (bf(-a)) option's behavior does not imply bf(--recursive)
1608   (bf(-r)), so specify it explicitly, if you want it.
1609   it() These side-effects change the default state of rsync, so the position
1610   of the bf(--files-from) option on the command-line has no bearing on how
1611   other options are parsed (e.g. bf(-a) works the same before or after
1612   bf(--files-from), as does bf(--no-R) and all other options).
1613 ))
1614
1615 The filenames that are read from the FILE are all relative to the
1616 source dir -- any leading slashes are removed and no ".." references are
1617 allowed to go higher than the source dir.  For example, take this
1618 command:
1619
1620 quote(tt(   rsync -a --files-from=/tmp/foo /usr remote:/backup))
1621
1622 If /tmp/foo contains the string "bin" (or even "/bin"), the /usr/bin
1623 directory will be created as /backup/bin on the remote host.  If it
1624 contains "bin/" (note the trailing slash), the immediate contents of
1625 the directory would also be sent (without needing to be explicitly
1626 mentioned in the file -- this began in version 2.6.4).  In both cases,
1627 if the bf(-r) option was enabled, that dir's entire hierarchy would
1628 also be transferred (keep in mind that bf(-r) needs to be specified
1629 explicitly with bf(--files-from), since it is not implied by bf(-a)).
1630 Also note
1631 that the effect of the (enabled by default) bf(--relative) option is to
1632 duplicate only the path info that is read from the file -- it does not
1633 force the duplication of the source-spec path (/usr in this case).
1634
1635 In addition, the bf(--files-from) file can be read from the remote host
1636 instead of the local host if you specify a "host:" in front of the file
1637 (the host must match one end of the transfer).  As a short-cut, you can
1638 specify just a prefix of ":" to mean "use the remote end of the
1639 transfer".  For example:
1640
1641 quote(tt(   rsync -a --files-from=:/path/file-list src:/ /tmp/copy))
1642
1643 This would copy all the files specified in the /path/file-list file that
1644 was located on the remote "src" host.
1645
1646 If the bf(--iconv) and bf(--protect-args) options are specified and the
1647 bf(--files-from) filenames are being sent from one host to another, the
1648 filenames will be translated from the sending host's charset to the
1649 receiving host's charset.
1650
1651 NOTE: sorting the list of files in the --files-from input helps rsync to be
1652 more efficient, as it will avoid re-visiting the path elements that are shared
1653 between adjacent entries.  If the input is not sorted, some path elements
1654 (implied directories) may end up being scanned multiple times, and rsync will
1655 eventually unduplicate them after they get turned into file-list elements.
1656
1657 dit(bf(-0, --from0)) This tells rsync that the rules/filenames it reads from a
1658 file are terminated by a null ('\0') character, not a NL, CR, or CR+LF.
1659 This affects bf(--exclude-from), bf(--include-from), bf(--files-from), and any
1660 merged files specified in a bf(--filter) rule.
1661 It does not affect bf(--cvs-exclude) (since all names read from a .cvsignore
1662 file are split on whitespace).
1663
1664 dit(bf(-s, --protect-args)) This option sends all filenames and most options to
1665 the remote rsync without allowing the remote shell to interpret them.  This
1666 means that spaces are not split in names, and any non-wildcard special
1667 characters are not translated (such as ~, $, ;, &, etc.).  Wildcards are
1668 expanded on the remote host by rsync (instead of the shell doing it).
1669
1670 If you use this option with bf(--iconv), the args related to the remote
1671 side will also be translated
1672 from the local to the remote character-set.  The translation happens before
1673 wild-cards are expanded.  See also the bf(--files-from) option.
1674
1675 You may also control this option via the RSYNC_PROTECT_ARGS environment
1676 variable.  If this variable has a non-zero value, this option will be enabled
1677 by default, otherwise it will be disabled by default.  Either state is
1678 overridden by a manually specified positive or negative version of this option
1679 (note that bf(--no-s) and bf(--no-protect-args) are the negative versions).
1680 Since this option was first introduced in 3.0.0, you'll need to make sure it's
1681 disabled if you ever need to interact with a remote rsync that is older than
1682 that.
1683
1684 Rsync can also be configured (at build time) to have this option enabled by
1685 default (with is overridden by both the environment and the command-line).
1686 This option will eventually become a new default setting at some
1687 as-yet-undetermined point in the future.
1688
1689 dit(bf(-T, --temp-dir=DIR)) This option instructs rsync to use DIR as a
1690 scratch directory when creating temporary copies of the files transferred
1691 on the receiving side.  The default behavior is to create each temporary
1692 file in the same directory as the associated destination file.
1693
1694 This option is most often used when the receiving disk partition does not
1695 have enough free space to hold a copy of the largest file in the transfer.
1696 In this case (i.e. when the scratch directory is on a different disk
1697 partition), rsync will not be able to rename each received temporary file
1698 over the top of the associated destination file, but instead must copy it
1699 into place.  Rsync does this by copying the file over the top of the
1700 destination file, which means that the destination file will contain
1701 truncated data during this copy.  If this were not done this way (even if
1702 the destination file were first removed, the data locally copied to a
1703 temporary file in the destination directory, and then renamed into place)
1704 it would be possible for the old file to continue taking up disk space (if
1705 someone had it open), and thus there might not be enough room to fit the
1706 new version on the disk at the same time.
1707
1708 If you are using this option for reasons other than a shortage of disk
1709 space, you may wish to combine it with the bf(--delay-updates) option,
1710 which will ensure that all copied files get put into subdirectories in the
1711 destination hierarchy, awaiting the end of the transfer.  If you don't
1712 have enough room to duplicate all the arriving files on the destination
1713 partition, another way to tell rsync that you aren't overly concerned
1714 about disk space is to use the bf(--partial-dir) option with a relative
1715 path; because this tells rsync that it is OK to stash off a copy of a
1716 single file in a subdir in the destination hierarchy, rsync will use the
1717 partial-dir as a staging area to bring over the copied file, and then
1718 rename it into place from there. (Specifying a bf(--partial-dir) with
1719 an absolute path does not have this side-effect.)
1720
1721 dit(bf(-y, --fuzzy)) This option tells rsync that it should look for a
1722 basis file for any destination file that is missing.  The current algorithm
1723 looks in the same directory as the destination file for either a file that
1724 has an identical size and modified-time, or a similarly-named file.  If
1725 found, rsync uses the fuzzy basis file to try to speed up the transfer.
1726
1727 Note that the use of the bf(--delete) option might get rid of any potential
1728 fuzzy-match files, so either use bf(--delete-after) or specify some
1729 filename exclusions if you need to prevent this.
1730
1731 dit(bf(--compare-dest=DIR)) This option instructs rsync to use em(DIR) on
1732 the destination machine as an additional hierarchy to compare destination
1733 files against doing transfers (if the files are missing in the destination
1734 directory).  If a file is found in em(DIR) that is identical to the
1735 sender's file, the file will NOT be transferred to the destination
1736 directory.  This is useful for creating a sparse backup of just files that
1737 have changed from an earlier backup.
1738
1739 Beginning in version 2.6.4, multiple bf(--compare-dest) directories may be
1740 provided, which will cause rsync to search the list in the order specified
1741 for an exact match.
1742 If a match is found that differs only in attributes, a local copy is made
1743 and the attributes updated.
1744 If a match is not found, a basis file from one of the em(DIR)s will be
1745 selected to try to speed up the transfer.
1746
1747 If em(DIR) is a relative path, it is relative to the destination directory.
1748 See also bf(--copy-dest) and bf(--link-dest).
1749
1750 dit(bf(--copy-dest=DIR)) This option behaves like bf(--compare-dest), but
1751 rsync will also copy unchanged files found in em(DIR) to the destination
1752 directory using a local copy.
1753 This is useful for doing transfers to a new destination while leaving
1754 existing files intact, and then doing a flash-cutover when all files have
1755 been successfully transferred.
1756
1757 Multiple bf(--copy-dest) directories may be provided, which will cause
1758 rsync to search the list in the order specified for an unchanged file.
1759 If a match is not found, a basis file from one of the em(DIR)s will be
1760 selected to try to speed up the transfer.
1761
1762 If em(DIR) is a relative path, it is relative to the destination directory.
1763 See also bf(--compare-dest) and bf(--link-dest).
1764
1765 dit(bf(--link-dest=DIR)) This option behaves like bf(--copy-dest), but
1766 unchanged files are hard linked from em(DIR) to the destination directory.
1767 The files must be identical in all preserved attributes (e.g. permissions,
1768 possibly ownership) in order for the files to be linked together.
1769 An example:
1770
1771 quote(tt(  rsync -av --link-dest=$PWD/prior_dir host:src_dir/ new_dir/))
1772
1773 If file's aren't linking, double-check their attributes.  Also check if some
1774 attributes are getting forced outside of rsync's control, such a mount option
1775 that squishes root to a single user, or mounts a removable drive with generic
1776 ownership (such as OS X's "Ignore ownership on this volume" option).
1777
1778 Beginning in version 2.6.4, multiple bf(--link-dest) directories may be
1779 provided, which will cause rsync to search the list in the order specified
1780 for an exact match.
1781 If a match is found that differs only in attributes, a local copy is made
1782 and the attributes updated.
1783 If a match is not found, a basis file from one of the em(DIR)s will be
1784 selected to try to speed up the transfer.
1785
1786 This option works best when copying into an empty destination hierarchy, as
1787 rsync treats existing files as definitive (so it never looks in the link-dest
1788 dirs when a destination file already exists), and as malleable (so it might
1789 change the attributes of a destination file, which affects all the hard-linked
1790 versions).
1791
1792 Note that if you combine this option with bf(--ignore-times), rsync will not
1793 link any files together because it only links identical files together as a
1794 substitute for transferring the file, never as an additional check after the
1795 file is updated.
1796
1797 If em(DIR) is a relative path, it is relative to the destination directory.
1798 See also bf(--compare-dest) and bf(--copy-dest).
1799
1800 Note that rsync versions prior to 2.6.1 had a bug that could prevent
1801 bf(--link-dest) from working properly for a non-super-user when bf(-o) was
1802 specified (or implied by bf(-a)).  You can work-around this bug by avoiding
1803 the bf(-o) option when sending to an old rsync.
1804
1805 dit(bf(-z, --compress)) With this option, rsync compresses the file data
1806 as it is sent to the destination machine, which reduces the amount of data
1807 being transmitted -- something that is useful over a slow connection.
1808
1809 Note that this option typically achieves better compression ratios than can
1810 be achieved by using a compressing remote shell or a compressing transport
1811 because it takes advantage of the implicit information in the matching data
1812 blocks that are not explicitly sent over the connection.
1813
1814 See the bf(--skip-compress) option for the default list of file suffixes
1815 that will not be compressed.
1816
1817 dit(bf(--compress-level=NUM)) Explicitly set the compression level to use
1818 (see bf(--compress)) instead of letting it default.  If NUM is non-zero,
1819 the bf(--compress) option is implied.
1820
1821 dit(bf(--skip-compress=LIST)) Override the list of file suffixes that will
1822 not be compressed.  The bf(LIST) should be one or more file suffixes
1823 (without the dot) separated by slashes (/).
1824
1825 You may specify an empty string to indicate that no file should be skipped.
1826
1827 Simple character-class matching is supported: each must consist of a list
1828 of letters inside the square brackets (e.g. no special classes, such as
1829 "[:alpha:]", are supported, and '-' has no special meaning).
1830
1831 The characters asterisk (*) and question-mark (?) have no special meaning.
1832
1833 Here's an example that specifies 6 suffixes to skip (since 1 of the 5 rules
1834 matches 2 suffixes):
1835
1836 verb(    --skip-compress=gz/jpg/mp[34]/7z/bz2)
1837
1838 The default list of suffixes that will not be compressed is this (in this
1839 version of rsync):
1840
1841 bf(7z)
1842 bf(ace)
1843 bf(avi)
1844 bf(bz2)
1845 bf(deb)
1846 bf(gpg)
1847 bf(gz)
1848 bf(iso)
1849 bf(jpeg)
1850 bf(jpg)
1851 bf(lz)
1852 bf(lzma)
1853 bf(lzo)
1854 bf(mov)
1855 bf(mp3)
1856 bf(mp4)
1857 bf(ogg)
1858 bf(png)
1859 bf(rar)
1860 bf(rpm)
1861 bf(rzip)
1862 bf(tbz)
1863 bf(tgz)
1864 bf(tlz)
1865 bf(txz)
1866 bf(xz)
1867 bf(z)
1868 bf(zip)
1869
1870 This list will be replaced by your bf(--skip-compress) list in all but one
1871 situation: a copy from a daemon rsync will add your skipped suffixes to
1872 its list of non-compressing files (and its list may be configured to a
1873 different default).
1874
1875 dit(bf(--numeric-ids)) With this option rsync will transfer numeric group
1876 and user IDs rather than using user and group names and mapping them
1877 at both ends.
1878
1879 By default rsync will use the username and groupname to determine
1880 what ownership to give files. The special uid 0 and the special group
1881 0 are never mapped via user/group names even if the bf(--numeric-ids)
1882 option is not specified.
1883
1884 If a user or group has no name on the source system or it has no match
1885 on the destination system, then the numeric ID
1886 from the source system is used instead.  See also the comments on the
1887 "use chroot" setting in the rsyncd.conf manpage for information on how
1888 the chroot setting affects rsync's ability to look up the names of the
1889 users and groups and what you can do about it.
1890
1891 dit(bf(--usermap=STRING, --groupmap=STRING)) These options allow you to
1892 specify users and groups that should be mapped to other values by the
1893 receiving side.  The bf(STRING) is one or more bf(FROM):bf(TO) pairs of
1894 values separated by commas.  Any matching bf(FROM) value from the sender is
1895 replaced with a bf(TO) value from the receiver.  You may specify usernames
1896 or user IDs for the bf(FROM) and bf(TO) values, and the bf(FROM) value may
1897 also be a wild-card string, which will be matched against the sender's
1898 names (wild-cards do NOT match against ID numbers, though see below for
1899 why a '*' matches everything).  You may instead specify a range of ID
1900 numbers via an inclusive range: LOW-HIGH.  For example:
1901
1902 verb(  --usermap=0-99:nobody,wayne:admin,*:normal --groupmap=usr:1,1:usr)
1903
1904 The first match in the list is the one that is used.  You should specify
1905 all your user mappings using a single bf(--usermap) option, and/or all
1906 your group mappings using a single bf(--groupmap) option.
1907
1908 Note that the sender's name for the 0 user and group are not transmitted
1909 to the receiver, so you should either match these values using a 0, or use
1910 the names in effect on the receiving side (typically "root").  All other
1911 bf(FROM) names match those in use on the sending side.  All bf(TO) names
1912 match those in use on the receiving side.
1913
1914 Any IDs that do not have a name on the sending side are treated as having an
1915 empty name for the purpose of matching.  This allows them to be matched via
1916 a "*" or using an empty name.  For instance:
1917
1918 verb(  --usermap=:nobody --groupmap=*:nobody)
1919
1920 When the bf(--numeric-ids) option is used, the sender does not send any
1921 names, so all the IDs are treated as having an empty name.  This means that
1922 you will need to specify numeric bf(FROM) values if you want to map these
1923 nameless IDs to different values.
1924
1925 For the bf(--usermap) option to have any effect, the bf(-o) (bf(--owner))
1926 option must be used (or implied), and the receiver will need to be running
1927 as a super-user (see also the bf(--fake-super) option).  For the bf(--groupmap)
1928 option to have any effect, the bf(-g) (bf(--groups)) option must be used
1929 (or implied), and the receiver will need to have permissions to set that
1930 group.
1931
1932 dit(bf(--chown=USER:GROUP)) This option forces all files to be owned by USER
1933 with group GROUP.  This is a simpler interface than using bf(--usermap) and
1934 bf(--groupmap) directly, but it is implemented using those options internally,
1935 so you cannot mix them.  If either the USER or GROUP is empty, no mapping for
1936 the omitted user/group will occur.  If GROUP is empty, the trailing colon may
1937 be omitted, but if USER is empty, a leading colon must be supplied.
1938
1939 If you specify "--chown=foo:bar, this is exactly the same as specifying
1940 "--usermap=*:foo --groupmap=*:bar", only easier.
1941
1942 dit(bf(--timeout=TIMEOUT)) This option allows you to set a maximum I/O
1943 timeout in seconds. If no data is transferred for the specified time
1944 then rsync will exit. The default is 0, which means no timeout.
1945
1946 dit(bf(--contimeout)) This option allows you to set the amount of time
1947 that rsync will wait for its connection to an rsync daemon to succeed.
1948 If the timeout is reached, rsync exits with an error.
1949
1950 dit(bf(--address)) By default rsync will bind to the wildcard address when
1951 connecting to an rsync daemon.  The bf(--address) option allows you to
1952 specify a specific IP address (or hostname) to bind to.  See also this
1953 option in the bf(--daemon) mode section.
1954
1955 dit(bf(--port=PORT)) This specifies an alternate TCP port number to use
1956 rather than the default of 873.  This is only needed if you are using the
1957 double-colon (::) syntax to connect with an rsync daemon (since the URL
1958 syntax has a way to specify the port as a part of the URL).  See also this
1959 option in the bf(--daemon) mode section.
1960
1961 dit(bf(--sockopts)) This option can provide endless fun for people
1962 who like to tune their systems to the utmost degree. You can set all
1963 sorts of socket options which may make transfers faster (or
1964 slower!). Read the man page for the code(setsockopt()) system call for
1965 details on some of the options you may be able to set. By default no
1966 special socket options are set. This only affects direct socket
1967 connections to a remote rsync daemon.  This option also exists in the
1968 bf(--daemon) mode section.
1969
1970 dit(bf(--blocking-io)) This tells rsync to use blocking I/O when launching
1971 a remote shell transport.  If the remote shell is either rsh or remsh,
1972 rsync defaults to using
1973 blocking I/O, otherwise it defaults to using non-blocking I/O.  (Note that
1974 ssh prefers non-blocking I/O.)
1975
1976 dit(bf(-i, --itemize-changes)) Requests a simple itemized list of the
1977 changes that are being made to each file, including attribute changes.
1978 This is exactly the same as specifying bf(--out-format='%i %n%L').
1979 If you repeat the option, unchanged files will also be output, but only
1980 if the receiving rsync is at least version 2.6.7 (you can use bf(-vv)
1981 with older versions of rsync, but that also turns on the output of other
1982 verbose messages).
1983
1984 The "%i" escape has a cryptic output that is 11 letters long.  The general
1985 format is like the string bf(YXcstpoguax), where bf(Y) is replaced by the
1986 type of update being done, bf(X) is replaced by the file-type, and the
1987 other letters represent attributes that may be output if they are being
1988 modified.
1989
1990 The update types that replace the bf(Y) are as follows:
1991
1992 quote(itemization(
1993   it() A bf(<) means that a file is being transferred to the remote host
1994   (sent).
1995   it() A bf(>) means that a file is being transferred to the local host
1996   (received).
1997   it() A bf(c) means that a local change/creation is occurring for the item
1998   (such as the creation of a directory or the changing of a symlink, etc.).
1999   it() A bf(h) means that the item is a hard link to another item (requires
2000   bf(--hard-links)).
2001   it() A bf(.) means that the item is not being updated (though it might
2002   have attributes that are being modified).
2003   it() A bf(*) means that the rest of the itemized-output area contains
2004   a message (e.g. "deleting").
2005 ))
2006
2007 The file-types that replace the bf(X) are: bf(f) for a file, a bf(d) for a
2008 directory, an bf(L) for a symlink, a bf(D) for a device, and a bf(S) for a
2009 special file (e.g. named sockets and fifos).
2010
2011 The other letters in the string above are the actual letters that
2012 will be output if the associated attribute for the item is being updated or
2013 a "." for no change.  Three exceptions to this are: (1) a newly created
2014 item replaces each letter with a "+", (2) an identical item replaces the
2015 dots with spaces, and (3) an unknown attribute replaces each letter with
2016 a "?" (this can happen when talking to an older rsync).
2017
2018 The attribute that is associated with each letter is as follows:
2019
2020 quote(itemization(
2021   it() A bf(c) means either that a regular file has a different checksum
2022   (requires bf(--checksum)) or that a symlink, device, or special file has
2023   a changed value.
2024   Note that if you are sending files to an rsync prior to 3.0.1, this
2025   change flag will be present only for checksum-differing regular files.
2026   it() A bf(s) means the size of a regular file is different and will be updated
2027   by the file transfer.
2028   it() A bf(t) means the modification time is different and is being updated
2029   to the sender's value (requires bf(--times)).  An alternate value of bf(T)
2030   means that the modification time will be set to the transfer time, which happens
2031   when a file/symlink/device is updated without bf(--times) and when a
2032   symlink is changed and the receiver can't set its time.
2033   (Note: when using an rsync 3.0.0 client, you might see the bf(s) flag combined
2034   with bf(t) instead of the proper bf(T) flag for this time-setting failure.)
2035   it() A bf(p) means the permissions are different and are being updated to
2036   the sender's value (requires bf(--perms)).
2037   it() An bf(o) means the owner is different and is being updated to the
2038   sender's value (requires bf(--owner) and super-user privileges).
2039   it() A bf(g) means the group is different and is being updated to the
2040   sender's value (requires bf(--group) and the authority to set the group).
2041   it() The bf(u) slot is reserved for future use.
2042   it() The bf(a) means that the ACL information changed.
2043   it() The bf(x) means that the extended attribute information changed.
2044 ))
2045
2046 One other output is possible:  when deleting files, the "%i" will output
2047 the string "*deleting" for each item that is being removed (assuming that
2048 you are talking to a recent enough rsync that it logs deletions instead of
2049 outputting them as a verbose message).
2050
2051 dit(bf(--out-format=FORMAT)) This allows you to specify exactly what the
2052 rsync client outputs to the user on a per-update basis.  The format is a
2053 text string containing embedded single-character escape sequences prefixed
2054 with a percent (%) character.   A default format of "%n%L" is assumed if
2055 either bf(--info=name) or bf(-v) is specified (this tells you just the name
2056 of the file and, if the item is a link, where it points).  For a full list
2057 of the possible escape characters, see the "log format" setting in the
2058 rsyncd.conf manpage.
2059
2060 Specifying the bf(--out-format) option implies the bf(--info=name) option,
2061 which will mention each file, dir, etc. that gets updated in a significant
2062 way (a transferred file, a recreated symlink/device, or a touched
2063 directory).  In addition, if the itemize-changes escape (%i) is included in
2064 the string (e.g. if the bf(--itemize-changes) option was used), the logging
2065 of names increases to mention any item that is changed in any way (as long
2066 as the receiving side is at least 2.6.4).  See the bf(--itemize-changes)
2067 option for a description of the output of "%i".
2068
2069 Rsync will output the out-format string prior to a file's transfer unless
2070 one of the transfer-statistic escapes is requested, in which case the
2071 logging is done at the end of the file's transfer.  When this late logging
2072 is in effect and bf(--progress) is also specified, rsync will also output
2073 the name of the file being transferred prior to its progress information
2074 (followed, of course, by the out-format output).
2075
2076 dit(bf(--log-file=FILE)) This option causes rsync to log what it is doing
2077 to a file.  This is similar to the logging that a daemon does, but can be
2078 requested for the client side and/or the server side of a non-daemon
2079 transfer.  If specified as a client option, transfer logging will be
2080 enabled with a default format of "%i %n%L".  See the bf(--log-file-format)
2081 option if you wish to override this.
2082
2083 Here's a example command that requests the remote side to log what is
2084 happening:
2085
2086 verb(  rsync -av --remote-option=--log-file=/tmp/rlog src/ dest/)
2087
2088 This is very useful if you need to debug why a connection is closing
2089 unexpectedly.
2090
2091 dit(bf(--log-file-format=FORMAT)) This allows you to specify exactly what
2092 per-update logging is put into the file specified by the bf(--log-file) option
2093 (which must also be specified for this option to have any effect).  If you
2094 specify an empty string, updated files will not be mentioned in the log file.
2095 For a list of the possible escape characters, see the "log format" setting
2096 in the rsyncd.conf manpage.
2097
2098 The default FORMAT used if bf(--log-file) is specified and this option is not
2099 is '%i %n%L'.
2100
2101 dit(bf(--stats)) This tells rsync to print a verbose set of statistics
2102 on the file transfer, allowing you to tell how effective rsync's delta-transfer
2103 algorithm is for your data.  This option is equivalent to bf(--info=stats2)
2104 if combined with 0 or 1 bf(-v) options, or bf(--info=stats3) if combined
2105 with 2 or more bf(-v) options.
2106
2107 The current statistics are as follows: quote(itemization(
2108   it() bf(Number of files) is the count of all "files" (in the generic
2109   sense), which includes directories, symlinks, etc.  The total count will
2110   be followed by a list of counts by filetype (if the total is non-zero).
2111   For example: "(reg: 5, dir: 3, link: 2, dev: 1, special: 1)" lists the
2112   totals for regular files, directories, symlinks, devices, and special
2113   files.  If any of value is 0, it is completely omitted from the list.
2114   it() bf(Number of created files) is the count of how many "files" (generic
2115   sense) were created (as opposed to updated).  The total count will be
2116   followed by a list of counts by filetype (if the total is non-zero).
2117   it() bf(Number of deleted files) is the count of how many "files" (generic
2118   sense) were created (as opposed to updated).  The total count will be
2119   followed by a list of counts by filetype (if the total is non-zero).
2120   Note that this line is only output if deletions are in effect, and only
2121   if protocol 31 is being used (the default for rsync 3.1.x).
2122   it() bf(Number of regular files transferred) is the count of normal files
2123   that were updated via rsync's delta-transfer algorithm, which does not
2124   include dirs, symlinks, etc.  Note that rsync 3.1.0 added the word
2125   "regular" into this heading.
2126   it() bf(Total file size) is the total sum of all file sizes in the transfer.
2127   This does not count any size for directories or special files, but does
2128   include the size of symlinks.
2129   it() bf(Total transferred file size) is the total sum of all files sizes
2130   for just the transferred files.
2131   it() bf(Literal data) is how much unmatched file-update data we had to
2132   send to the receiver for it to recreate the updated files.
2133   it() bf(Matched data) is how much data the receiver got locally when
2134   recreating the updated files.
2135   it() bf(File list size) is how big the file-list data was when the sender
2136   sent it to the receiver.  This is smaller than the in-memory size for the
2137   file list due to some compressing of duplicated data when rsync sends the
2138   list.
2139   it() bf(File list generation time) is the number of seconds that the
2140   sender spent creating the file list.  This requires a modern rsync on the
2141   sending side for this to be present.
2142   it() bf(File list transfer time) is the number of seconds that the sender
2143   spent sending the file list to the receiver.
2144   it() bf(Total bytes sent) is the count of all the bytes that rsync sent
2145   from the client side to the server side.
2146   it() bf(Total bytes received) is the count of all non-message bytes that
2147   rsync received by the client side from the server side.  "Non-message"
2148   bytes means that we don't count the bytes for a verbose message that the
2149   server sent to us, which makes the stats more consistent.
2150 ))
2151
2152 dit(bf(-8, --8-bit-output)) This tells rsync to leave all high-bit characters
2153 unescaped in the output instead of trying to test them to see if they're
2154 valid in the current locale and escaping the invalid ones.  All control
2155 characters (but never tabs) are always escaped, regardless of this option's
2156 setting.
2157
2158 The escape idiom that started in 2.6.7 is to output a literal backslash (\)
2159 and a hash (#), followed by exactly 3 octal digits.  For example, a newline
2160 would output as "\#012".  A literal backslash that is in a filename is not
2161 escaped unless it is followed by a hash and 3 digits (0-9).
2162
2163 dit(bf(-h, --human-readable)) Output numbers in a more human-readable format.
2164 There are 3 possible levels:  (1) output numbers with a separator between each
2165 set of 3 digits (either a comma or a period, depending on if the decimal point
2166 is represented by a period or a comma); (2) output numbers in units of 1000
2167 (with a character suffix for larger units -- see below); (3) output numbers in
2168 units of 1024.
2169
2170 The default is human-readable level 1.  Each bf(-h) option increases the level
2171 by one.  You can take the level down to 0 (to output numbers as pure digits) by
2172 specifing the bf(--no-human-readable) (bf(--no-h)) option.
2173
2174 The unit letters that are appended in levels 2 and 3 are: K (kilo), M (mega),
2175 G (giga), or T (tera).  For example, a 1234567-byte file would output as 1.23M
2176 in level-2 (assuming that a period is your local decimal point).
2177
2178 Backward compatibility note:  versions of rsync prior to 3.1.0 do not support
2179 human-readable level 1, and they default to level 0.  Thus, specifying one or
2180 two bf(-h) options will behave in a comparable manner in old and new versions
2181 as long as you didn't specify a bf(--no-h) option prior to one or more bf(-h)
2182 options.  See the bf(--list-only) option for one difference.
2183
2184 dit(bf(--partial)) By default, rsync will delete any partially
2185 transferred file if the transfer is interrupted. In some circumstances
2186 it is more desirable to keep partially transferred files. Using the
2187 bf(--partial) option tells rsync to keep the partial file which should
2188 make a subsequent transfer of the rest of the file much faster.
2189
2190 dit(bf(--partial-dir=DIR)) A better way to keep partial files than the
2191 bf(--partial) option is to specify a em(DIR) that will be used to hold the
2192 partial data (instead of writing it out to the destination file).
2193 On the next transfer, rsync will use a file found in this
2194 dir as data to speed up the resumption of the transfer and then delete it
2195 after it has served its purpose.
2196
2197 Note that if bf(--whole-file) is specified (or implied), any partial-dir
2198 file that is found for a file that is being updated will simply be removed
2199 (since
2200 rsync is sending files without using rsync's delta-transfer algorithm).
2201
2202 Rsync will create the em(DIR) if it is missing (just the last dir -- not
2203 the whole path).  This makes it easy to use a relative path (such as
2204 "bf(--partial-dir=.rsync-partial)") to have rsync create the
2205 partial-directory in the destination file's directory when needed, and then
2206 remove it again when the partial file is deleted.
2207
2208 If the partial-dir value is not an absolute path, rsync will add an exclude
2209 rule at the end of all your existing excludes.  This will prevent the
2210 sending of any partial-dir files that may exist on the sending side, and
2211 will also prevent the untimely deletion of partial-dir items on the
2212 receiving side.  An example: the above bf(--partial-dir) option would add
2213 the equivalent of "bf(-f '-p .rsync-partial/')" at the end of any other
2214 filter rules.
2215
2216 If you are supplying your own exclude rules, you may need to add your own
2217 exclude/hide/protect rule for the partial-dir because (1) the auto-added
2218 rule may be ineffective at the end of your other rules, or (2) you may wish
2219 to override rsync's exclude choice.  For instance, if you want to make
2220 rsync clean-up any left-over partial-dirs that may be lying around, you
2221 should specify bf(--delete-after) and add a "risk" filter rule, e.g.
2222 bf(-f 'R .rsync-partial/').  (Avoid using bf(--delete-before) or
2223 bf(--delete-during) unless you don't need rsync to use any of the
2224 left-over partial-dir data during the current run.)
2225
2226 IMPORTANT: the bf(--partial-dir) should not be writable by other users or it
2227 is a security risk.  E.g. AVOID "/tmp".
2228
2229 You can also set the partial-dir value the RSYNC_PARTIAL_DIR environment
2230 variable.  Setting this in the environment does not force bf(--partial) to be
2231 enabled, but rather it affects where partial files go when bf(--partial) is
2232 specified.  For instance, instead of using bf(--partial-dir=.rsync-tmp)
2233 along with bf(--progress), you could set RSYNC_PARTIAL_DIR=.rsync-tmp in your
2234 environment and then just use the bf(-P) option to turn on the use of the
2235 .rsync-tmp dir for partial transfers.  The only times that the bf(--partial)
2236 option does not look for this environment value are (1) when bf(--inplace) was
2237 specified (since bf(--inplace) conflicts with bf(--partial-dir)), and (2) when
2238 bf(--delay-updates) was specified (see below).
2239
2240 For the purposes of the daemon-config's "refuse options" setting,
2241 bf(--partial-dir) does em(not) imply bf(--partial).  This is so that a
2242 refusal of the bf(--partial) option can be used to disallow the overwriting
2243 of destination files with a partial transfer, while still allowing the
2244 safer idiom provided by bf(--partial-dir).
2245
2246 dit(bf(--delay-updates)) This option puts the temporary file from each
2247 updated file into a holding directory until the end of the
2248 transfer, at which time all the files are renamed into place in rapid
2249 succession.  This attempts to make the updating of the files a little more
2250 atomic.  By default the files are placed into a directory named ".~tmp~" in
2251 each file's destination directory, but if you've specified the
2252 bf(--partial-dir) option, that directory will be used instead.  See the
2253 comments in the bf(--partial-dir) section for a discussion of how this
2254 ".~tmp~" dir will be excluded from the transfer, and what you can do if
2255 you want rsync to cleanup old ".~tmp~" dirs that might be lying around.
2256 Conflicts with bf(--inplace) and bf(--append).
2257
2258 This option uses more memory on the receiving side (one bit per file
2259 transferred) and also requires enough free disk space on the receiving
2260 side to hold an additional copy of all the updated files.  Note also that
2261 you should not use an absolute path to bf(--partial-dir) unless (1)
2262 there is no
2263 chance of any of the files in the transfer having the same name (since all
2264 the updated files will be put into a single directory if the path is
2265 absolute)
2266 and (2) there are no mount points in the hierarchy (since the
2267 delayed updates will fail if they can't be renamed into place).
2268
2269 See also the "atomic-rsync" perl script in the "support" subdir for an
2270 update algorithm that is even more atomic (it uses bf(--link-dest) and a
2271 parallel hierarchy of files).
2272
2273 dit(bf(-m, --prune-empty-dirs)) This option tells the receiving rsync to get
2274 rid of empty directories from the file-list, including nested directories
2275 that have no non-directory children.  This is useful for avoiding the
2276 creation of a bunch of useless directories when the sending rsync is
2277 recursively scanning a hierarchy of files using include/exclude/filter
2278 rules.
2279
2280 Note that the use of transfer rules, such as the bf(--min-size) option, does
2281 not affect what goes into the file list, and thus does not leave directories
2282 empty, even if none of the files in a directory match the transfer rule.
2283
2284 Because the file-list is actually being pruned, this option also affects
2285 what directories get deleted when a delete is active.  However, keep in
2286 mind that excluded files and directories can prevent existing items from
2287 being deleted due to an exclude both hiding source files and protecting
2288 destination files.  See the perishable filter-rule option for how to avoid
2289 this.
2290
2291 You can prevent the pruning of certain empty directories from the file-list
2292 by using a global "protect" filter.  For instance, this option would ensure
2293 that the directory "emptydir" was kept in the file-list:
2294
2295 quote(    --filter 'protect emptydir/')
2296
2297 Here's an example that copies all .pdf files in a hierarchy, only creating
2298 the necessary destination directories to hold the .pdf files, and ensures
2299 that any superfluous files and directories in the destination are removed
2300 (note the hide filter of non-directories being used instead of an exclude):
2301
2302 quote(     rsync -avm --del --include='*.pdf' -f 'hide,! */' src/ dest)
2303
2304 If you didn't want to remove superfluous destination files, the more
2305 time-honored options of "bf(--include='*/' --exclude='*')" would work fine
2306 in place of the hide-filter (if that is more natural to you).
2307
2308 dit(bf(--progress)) This option tells rsync to print information
2309 showing the progress of the transfer. This gives a bored user
2310 something to watch.
2311 With a modern rsync this is the same as specifying
2312 bf(--info=flist2,name,progress), but any user-supplied settings for those
2313 info flags takes precedence (e.g. "--info=flist0 --progress").
2314
2315 While rsync is transferring a regular file, it updates a progress line that
2316 looks like this:
2317
2318 verb(      782448  63%  110.64kB/s    0:00:04)
2319
2320 In this example, the receiver has reconstructed 782448 bytes or 63% of the
2321 sender's file, which is being reconstructed at a rate of 110.64 kilobytes
2322 per second, and the transfer will finish in 4 seconds if the current rate
2323 is maintained until the end.
2324
2325 These statistics can be misleading if rsync's delta-transfer algorithm is
2326 in use.  For example, if the sender's file consists of the basis file
2327 followed by additional data, the reported rate will probably drop
2328 dramatically when the receiver gets to the literal data, and the transfer
2329 will probably take much longer to finish than the receiver estimated as it
2330 was finishing the matched part of the file.
2331
2332 When the file transfer finishes, rsync replaces the progress line with a
2333 summary line that looks like this:
2334
2335 verb(      1,238,099 100%  146.38kB/s    0:00:08  (xfr#5, to-chk=169/396))
2336
2337 In this example, the file was 1,238,099 bytes long in total, the average rate
2338 of transfer for the whole file was 146.38 kilobytes per second over the 8
2339 seconds that it took to complete, it was the 5th transfer of a regular file
2340 during the current rsync session, and there are 169 more files for the
2341 receiver to check (to see if they are up-to-date or not) remaining out of
2342 the 396 total files in the file-list.
2343
2344 In an incremental recursion scan, rsync won't know the total number of files
2345 in the file-list until it reaches the ends of the scan, but since it starts to
2346 transfer files during the scan, it will display a line with the text "ir-chk"
2347 (for incremental recursion check) instead of "to-chk" until the point that it
2348 knows the full size of the list, at which point it will switch to using
2349 "to-chk".  Thus, seeing "ir-chk" lets you know that the total count of files
2350 in the file list is still going to increase (and each time it does, the count
2351 of files left to check  will increase by the number of the files added to the
2352 list).
2353
2354 dit(bf(-P)) The bf(-P) option is equivalent to bf(--partial) bf(--progress).  Its
2355 purpose is to make it much easier to specify these two options for a long
2356 transfer that may be interrupted.
2357
2358 There is also a bf(--info=progress2) option that outputs statistics based
2359 on the whole transfer, rather than individual files.  Use this flag without
2360 outputting a filename (e.g. avoid bf(-v) or specify bf(--info=name0) if you
2361 want to see how the transfer is doing without scrolling the screen with a
2362 lot of names.  (You don't need to specify the bf(--progress) option in
2363 order to use bf(--info=progress2).)
2364
2365 dit(bf(--password-file)) This option allows you to provide a password in a
2366 file for accessing an rsync daemon.  The file must not be world readable.
2367 It should contain just the password as the first line of the file (all
2368 other lines are ignored).
2369
2370 This option does not supply a password to a remote shell transport such as
2371 ssh; to learn how to do that, consult the remote shell's documentation.
2372 When accessing an rsync daemon using a remote shell as the transport, this
2373 option only comes into effect after the remote shell finishes its
2374 authentication (i.e. if you have also specified a password in the daemon's
2375 config file).
2376
2377 dit(bf(--list-only)) This option will cause the source files to be listed
2378 instead of transferred.  This option is inferred if there is a single source
2379 arg and no destination specified, so its main uses are: (1) to turn a copy
2380 command that includes a
2381 destination arg into a file-listing command, or (2) to be able to specify
2382 more than one source arg (note: be sure to include the destination).
2383 Caution: keep in mind that a source arg with a wild-card is expanded by the
2384 shell into multiple args, so it is never safe to try to list such an arg
2385 without using this option.  For example:
2386
2387 verb(    rsync -av --list-only foo* dest/)
2388
2389 Starting with rsync 3.1.0, the sizes output by bf(--list-only) are affected
2390 by the bf(--human-readable) option.  By default they will contain digit
2391 separators, but higher levels of readability will output the sizes with
2392 unit suffixes.  Note also that the column width for the size output has
2393 increased from 11 to 14 characters for all human-readable levels.  Use
2394 bf(--no-h) if you want just digits in the sizes, and the old column width
2395 of 11 characters.
2396
2397 Compatibility note:  when requesting a remote listing of files from an rsync
2398 that is version 2.6.3 or older, you may encounter an error if you ask for a
2399 non-recursive listing.  This is because a file listing implies the bf(--dirs)
2400 option w/o bf(--recursive), and older rsyncs don't have that option.  To
2401 avoid this problem, either specify the bf(--no-dirs) option (if you don't
2402 need to expand a directory's content), or turn on recursion and exclude
2403 the content of subdirectories: bf(-r --exclude='/*/*').
2404
2405 dit(bf(--bwlimit=RATE)) This option allows you to specify the maximum transfer
2406 rate for the data sent over the socket, specified in units per second.  The
2407 RATE value can be suffixed with a string to indicate a size multiplier, and may
2408 be a fractional value (e.g.  "bf(--bwlimit=1.5m)").  If no suffix is specified,
2409 the value will be assumed to be in units of 1024 bytes (as if "K" or "KiB" had
2410 been appended).  See the bf(--max-size) option for a description of all the
2411 available suffixes. A value of zero specifies no limit.
2412
2413 For backward-compatibility reasons, the rate limit will be rounded to the
2414 nearest KiB unit, so no rate smaller than 1024 bytes per second is possible.
2415
2416 Rsync writes data over the socket in blocks, and this option both limits the
2417 size of the blocks that rsync writes, and tries to keep the average transfer
2418 rate at the requested limit.  Some "burstiness" may be seen where rsync writes
2419 out a block of data and then sleeps to bring the average rate into compliance.
2420
2421 Due to the internal buffering of data, the bf(--progress) option may not be an
2422 accurate reflection on how fast the data is being sent.  This is because some
2423 files can show up as being rapidly sent when the data is quickly buffered,
2424 while other can show up as very slow when the flushing of the output buffer
2425 occurs.  This may be fixed in a future version.
2426
2427 dit(bf(--write-batch=FILE)) Record a file that can later be applied to
2428 another identical destination with bf(--read-batch). See the "BATCH MODE"
2429 section for details, and also the bf(--only-write-batch) option.
2430
2431 dit(bf(--only-write-batch=FILE)) Works like bf(--write-batch), except that
2432 no updates are made on the destination system when creating the batch.
2433 This lets you transport the changes to the destination system via some
2434 other means and then apply the changes via bf(--read-batch).
2435
2436 Note that you can feel free to write the batch directly to some portable
2437 media: if this media fills to capacity before the end of the transfer, you
2438 can just apply that partial transfer to the destination and repeat the
2439 whole process to get the rest of the changes (as long as you don't mind a
2440 partially updated destination system while the multi-update cycle is
2441 happening).
2442
2443 Also note that you only save bandwidth when pushing changes to a remote
2444 system because this allows the batched data to be diverted from the sender
2445 into the batch file without having to flow over the wire to the receiver
2446 (when pulling, the sender is remote, and thus can't write the batch).
2447
2448 dit(bf(--read-batch=FILE)) Apply all of the changes stored in FILE, a
2449 file previously generated by bf(--write-batch).
2450 If em(FILE) is bf(-), the batch data will be read from standard input.
2451 See the "BATCH MODE" section for details.
2452
2453 dit(bf(--protocol=NUM)) Force an older protocol version to be used.  This
2454 is useful for creating a batch file that is compatible with an older
2455 version of rsync.  For instance, if rsync 2.6.4 is being used with the
2456 bf(--write-batch) option, but rsync 2.6.3 is what will be used to run the
2457 bf(--read-batch) option, you should use "--protocol=28" when creating the
2458 batch file to force the older protocol version to be used in the batch
2459 file (assuming you can't upgrade the rsync on the reading system).
2460
2461 dit(bf(--iconv=CONVERT_SPEC)) Rsync can convert filenames between character
2462 sets using this option.  Using a CONVERT_SPEC of "." tells rsync to look up
2463 the default character-set via the locale setting.  Alternately, you can
2464 fully specify what conversion to do by giving a local and a remote charset
2465 separated by a comma in the order bf(--iconv=LOCAL,REMOTE), e.g.
2466 bf(--iconv=utf8,iso88591).  This order ensures that the option
2467 will stay the same whether you're pushing or pulling files.
2468 Finally, you can specify either bf(--no-iconv) or a CONVERT_SPEC of "-"
2469 to turn off any conversion.
2470 The default setting of this option is site-specific, and can also be
2471 affected via the RSYNC_ICONV environment variable.
2472
2473 For a list of what charset names your local iconv library supports, you can
2474 run "iconv --list".
2475
2476 If you specify the bf(--protect-args) option (bf(-s)), rsync will translate
2477 the filenames you specify on the command-line that are being sent to the
2478 remote host.  See also the bf(--files-from) option.
2479
2480 Note that rsync does not do any conversion of names in filter files
2481 (including include/exclude files).  It is up to you to ensure that you're
2482 specifying matching rules that can match on both sides of the transfer.
2483 For instance, you can specify extra include/exclude rules if there are
2484 filename differences on the two sides that need to be accounted for.
2485
2486 When you pass an bf(--iconv) option to an rsync daemon that allows it, the
2487 daemon uses the charset specified in its "charset" configuration parameter
2488 regardless of the remote charset you actually pass.  Thus, you may feel free to
2489 specify just the local charset for a daemon transfer (e.g. bf(--iconv=utf8)).
2490
2491 dit(bf(-4, --ipv4) or bf(-6, --ipv6)) Tells rsync to prefer IPv4/IPv6
2492 when creating sockets.  This only affects sockets that rsync has direct
2493 control over, such as the outgoing socket when directly contacting an
2494 rsync daemon.  See also these options in the bf(--daemon) mode section.
2495
2496 If rsync was complied without support for IPv6, the bf(--ipv6) option
2497 will have no effect.  The bf(--version) output will tell you if this
2498 is the case.
2499
2500 dit(bf(--checksum-seed=NUM)) Set the checksum seed to the integer
2501 NUM.  This 4 byte checksum seed is included in each block and file
2502 checksum calculation.  By default the checksum seed is generated
2503 by the server and defaults to the current code(time()).  This option
2504 is used to set a specific checksum seed, which is useful for
2505 applications that want repeatable block and file checksums, or
2506 in the case where the user wants a more random checksum seed.
2507 Setting NUM to 0 causes rsync to use the default of code(time())
2508 for checksum seed.
2509 enddit()
2510
2511 manpagesection(DAEMON OPTIONS)
2512
2513 The options allowed when starting an rsync daemon are as follows:
2514
2515 startdit()
2516 dit(bf(--daemon)) This tells rsync that it is to run as a daemon.  The
2517 daemon you start running may be accessed using an rsync client using
2518 the bf(host::module) or bf(rsync://host/module/) syntax.
2519
2520 If standard input is a socket then rsync will assume that it is being
2521 run via inetd, otherwise it will detach from the current terminal and
2522 become a background daemon.  The daemon will read the config file
2523 (rsyncd.conf) on each connect made by a client and respond to
2524 requests accordingly.  See the bf(rsyncd.conf)(5) man page for more
2525 details.
2526
2527 dit(bf(--address)) By default rsync will bind to the wildcard address when
2528 run as a daemon with the bf(--daemon) option.  The bf(--address) option
2529 allows you to specify a specific IP address (or hostname) to bind to.  This
2530 makes virtual hosting possible in conjunction with the bf(--config) option.
2531 See also the "address" global option in the rsyncd.conf manpage.
2532
2533 dit(bf(--bwlimit=RATE)) This option allows you to specify the maximum transfer
2534 rate for the data the daemon sends over the socket.  The client can still
2535 specify a smaller bf(--bwlimit) value, but no larger value will be allowed.
2536 See the client version of this option (above) for some extra details.
2537
2538 dit(bf(--config=FILE)) This specifies an alternate config file than
2539 the default.  This is only relevant when bf(--daemon) is specified.
2540 The default is /etc/rsyncd.conf unless the daemon is running over
2541 a remote shell program and the remote user is not the super-user; in that case
2542 the default is rsyncd.conf in the current directory (typically $HOME).
2543
2544 dit(bf(-M, --dparam=OVERRIDE)) This option can be used to set a daemon-config
2545 parameter when starting up rsync in daemon mode.  It is equivalent to adding
2546 the parameter at the end of the global settings prior to the first module's
2547 definition.  The parameter names can be specified without spaces, if you so
2548 desire.  For instance:
2549
2550 verb(    rsync --daemon -M pidfile=/path/rsync.pid )
2551
2552 dit(bf(--no-detach)) When running as a daemon, this option instructs
2553 rsync to not detach itself and become a background process.  This
2554 option is required when running as a service on Cygwin, and may also
2555 be useful when rsync is supervised by a program such as
2556 bf(daemontools) or AIX's bf(System Resource Controller).
2557 bf(--no-detach) is also recommended when rsync is run under a
2558 debugger.  This option has no effect if rsync is run from inetd or
2559 sshd.
2560
2561 dit(bf(--port=PORT)) This specifies an alternate TCP port number for the
2562 daemon to listen on rather than the default of 873.  See also the "port"
2563 global option in the rsyncd.conf manpage.
2564
2565 dit(bf(--log-file=FILE)) This option tells the rsync daemon to use the
2566 given log-file name instead of using the "log file" setting in the config
2567 file.
2568
2569 dit(bf(--log-file-format=FORMAT)) This option tells the rsync daemon to use the
2570 given FORMAT string instead of using the "log format" setting in the config
2571 file.  It also enables "transfer logging" unless the string is empty, in which
2572 case transfer logging is turned off.
2573
2574 dit(bf(--sockopts)) This overrides the bf(socket options) setting in the
2575 rsyncd.conf file and has the same syntax.
2576
2577 dit(bf(-v, --verbose)) This option increases the amount of information the
2578 daemon logs during its startup phase.  After the client connects, the
2579 daemon's verbosity level will be controlled by the options that the client
2580 used and the "max verbosity" setting in the module's config section.
2581
2582 dit(bf(-4, --ipv4) or bf(-6, --ipv6)) Tells rsync to prefer IPv4/IPv6
2583 when creating the incoming sockets that the rsync daemon will use to
2584 listen for connections.  One of these options may be required in older
2585 versions of Linux to work around an IPv6 bug in the kernel (if you see
2586 an "address already in use" error when nothing else is using the port,
2587 try specifying bf(--ipv6) or bf(--ipv4) when starting the daemon).
2588
2589 If rsync was complied without support for IPv6, the bf(--ipv6) option
2590 will have no effect.  The bf(--version) output will tell you if this
2591 is the case.
2592
2593 dit(bf(-h, --help)) When specified after bf(--daemon), print a short help
2594 page describing the options available for starting an rsync daemon.
2595 enddit()
2596
2597 manpagesection(FILTER RULES)
2598
2599 The filter rules allow for flexible selection of which files to transfer
2600 (include) and which files to skip (exclude).  The rules either directly
2601 specify include/exclude patterns or they specify a way to acquire more
2602 include/exclude patterns (e.g. to read them from a file).
2603
2604 As the list of files/directories to transfer is built, rsync checks each
2605 name to be transferred against the list of include/exclude patterns in
2606 turn, and the first matching pattern is acted on:  if it is an exclude
2607 pattern, then that file is skipped; if it is an include pattern then that
2608 filename is not skipped; if no matching pattern is found, then the
2609 filename is not skipped.
2610
2611 Rsync builds an ordered list of filter rules as specified on the
2612 command-line.  Filter rules have the following syntax:
2613
2614 quote(
2615 tt(RULE [PATTERN_OR_FILENAME])nl()
2616 tt(RULE,MODIFIERS [PATTERN_OR_FILENAME])nl()
2617 )
2618
2619 You have your choice of using either short or long RULE names, as described
2620 below.  If you use a short-named rule, the ',' separating the RULE from the
2621 MODIFIERS is optional.  The PATTERN or FILENAME that follows (when present)
2622 must come after either a single space or an underscore (_).
2623 Here are the available rule prefixes:
2624
2625 quote(
2626 bf(exclude, -) specifies an exclude pattern. nl()
2627 bf(include, +) specifies an include pattern. nl()
2628 bf(merge, .) specifies a merge-file to read for more rules. nl()
2629 bf(dir-merge, :) specifies a per-directory merge-file. nl()
2630 bf(hide, H) specifies a pattern for hiding files from the transfer. nl()
2631 bf(show, S) files that match the pattern are not hidden. nl()
2632 bf(protect, P) specifies a pattern for protecting files from deletion. nl()
2633 bf(risk, R) files that match the pattern are not protected. nl()
2634 bf(clear, !) clears the current include/exclude list (takes no arg) nl()
2635 )
2636
2637 When rules are being read from a file, empty lines are ignored, as are
2638 comment lines that start with a "#".
2639
2640 Note that the bf(--include)/bf(--exclude) command-line options do not allow the
2641 full range of rule parsing as described above -- they only allow the
2642 specification of include/exclude patterns plus a "!" token to clear the
2643 list (and the normal comment parsing when rules are read from a file).
2644 If a pattern
2645 does not begin with "- " (dash, space) or "+ " (plus, space), then the
2646 rule will be interpreted as if "+ " (for an include option) or "- " (for
2647 an exclude option) were prefixed to the string.  A bf(--filter) option, on
2648 the other hand, must always contain either a short or long rule name at the
2649 start of the rule.
2650
2651 Note also that the bf(--filter), bf(--include), and bf(--exclude) options take one
2652 rule/pattern each. To add multiple ones, you can repeat the options on
2653 the command-line, use the merge-file syntax of the bf(--filter) option, or
2654 the bf(--include-from)/bf(--exclude-from) options.
2655
2656 manpagesection(INCLUDE/EXCLUDE PATTERN RULES)
2657
2658 You can include and exclude files by specifying patterns using the "+",
2659 "-", etc. filter rules (as introduced in the FILTER RULES section above).
2660 The include/exclude rules each specify a pattern that is matched against
2661 the names of the files that are going to be transferred.  These patterns
2662 can take several forms:
2663
2664 itemization(
2665   it() if the pattern starts with a / then it is anchored to a
2666   particular spot in the hierarchy of files, otherwise it is matched
2667   against the end of the pathname.  This is similar to a leading ^ in
2668   regular expressions.
2669   Thus "/foo" would match a name of "foo" at either the "root of the
2670   transfer" (for a global rule) or in the merge-file's directory (for a
2671   per-directory rule).
2672   An unqualified "foo" would match a name of "foo" anywhere in the
2673   tree because the algorithm is applied recursively from the
2674   top down; it behaves as if each path component gets a turn at being the
2675   end of the filename.  Even the unanchored "sub/foo" would match at
2676   any point in the hierarchy where a "foo" was found within a directory
2677   named "sub".  See the section on ANCHORING INCLUDE/EXCLUDE PATTERNS for
2678   a full discussion of how to specify a pattern that matches at the root
2679   of the transfer.
2680   it() if the pattern ends with a / then it will only match a
2681   directory, not a regular file, symlink, or device.
2682   it() rsync chooses between doing a simple string match and wildcard
2683   matching by checking if the pattern contains one of these three wildcard
2684   characters: '*', '?', and '[' .
2685   it() a '*' matches any path component, but it stops at slashes.
2686   it() use '**' to match anything, including slashes.
2687   it() a '?' matches any character except a slash (/).
2688   it() a '[' introduces a character class, such as [a-z] or [[:alpha:]].
2689   it() in a wildcard pattern, a backslash can be used to escape a wildcard
2690   character, but it is matched literally when no wildcards are present.
2691   it() if the pattern contains a / (not counting a trailing /) or a "**",
2692   then it is matched against the full pathname, including any leading
2693   directories. If the pattern doesn't contain a / or a "**", then it is
2694   matched only against the final component of the filename.
2695   (Remember that the algorithm is applied recursively so "full filename"
2696   can actually be any portion of a path from the starting directory on
2697   down.)
2698   it() a trailing "dir_name/***" will match both the directory (as if
2699   "dir_name/" had been specified) and everything in the directory
2700   (as if "dir_name/**" had been specified).  This behavior was added in
2701   version 2.6.7.
2702 )
2703
2704 Note that, when using the bf(--recursive) (bf(-r)) option (which is implied by
2705 bf(-a)), every subcomponent of every path is visited from the top down, so
2706 include/exclude patterns get applied recursively to each subcomponent's
2707 full name (e.g. to include "/foo/bar/baz" the subcomponents "/foo" and
2708 "/foo/bar" must not be excluded).
2709 The exclude patterns actually short-circuit the directory traversal stage
2710 when rsync finds the files to send.  If a pattern excludes a particular
2711 parent directory, it can render a deeper include pattern ineffectual
2712 because rsync did not descend through that excluded section of the
2713 hierarchy.  This is particularly important when using a trailing '*' rule.
2714 For instance, this won't work:
2715
2716 quote(
2717 tt(+ /some/path/this-file-will-not-be-found)nl()
2718 tt(+ /file-is-included)nl()
2719 tt(- *)nl()
2720 )
2721
2722 This fails because the parent directory "some" is excluded by the '*'
2723 rule, so rsync never visits any of the files in the "some" or "some/path"
2724 directories.  One solution is to ask for all directories in the hierarchy
2725 to be included by using a single rule: "+ */" (put it somewhere before the
2726 "- *" rule), and perhaps use the bf(--prune-empty-dirs) option.  Another
2727 solution is to add specific include rules for all
2728 the parent dirs that need to be visited.  For instance, this set of rules
2729 works fine:
2730
2731 quote(
2732 tt(+ /some/)nl()
2733 tt(+ /some/path/)nl()
2734 tt(+ /some/path/this-file-is-found)nl()
2735 tt(+ /file-also-included)nl()
2736 tt(- *)nl()
2737 )
2738
2739 Here are some examples of exclude/include matching:
2740
2741 itemization(
2742   it() "- *.o" would exclude all names matching *.o
2743   it() "- /foo" would exclude a file (or directory) named foo in the
2744   transfer-root directory
2745   it() "- foo/" would exclude any directory named foo
2746   it() "- /foo/*/bar" would exclude any file named bar which is at two
2747   levels below a directory named foo in the transfer-root directory
2748   it() "- /foo/**/bar" would exclude any file named bar two
2749   or more levels below a directory named foo in the transfer-root directory
2750   it() The combination of "+ */", "+ *.c", and "- *" would include all
2751   directories and C source files but nothing else (see also the
2752   bf(--prune-empty-dirs) option)
2753   it() The combination of "+ foo/", "+ foo/bar.c", and "- *" would include
2754   only the foo directory and foo/bar.c (the foo directory must be
2755   explicitly included or it would be excluded by the "*")
2756 )
2757
2758 The following modifiers are accepted after a "+" or "-":
2759
2760 itemization(
2761   it() A bf(/) specifies that the include/exclude rule should be matched
2762   against the absolute pathname of the current item.  For example,
2763   "-/ /etc/passwd" would exclude the passwd file any time the transfer
2764   was sending files from the "/etc" directory, and "-/ subdir/foo"
2765   would always exclude "foo" when it is in a dir named "subdir", even
2766   if "foo" is at the root of the current transfer.
2767   it() A bf(!) specifies that the include/exclude should take effect if
2768   the pattern fails to match.  For instance, "-! */" would exclude all
2769   non-directories.
2770   it() A bf(C) is used to indicate that all the global CVS-exclude rules
2771   should be inserted as excludes in place of the "-C".  No arg should
2772   follow.
2773   it() An bf(s) is used to indicate that the rule applies to the sending
2774   side.  When a rule affects the sending side, it prevents files from
2775   being transferred.  The default is for a rule to affect both sides
2776   unless bf(--delete-excluded) was specified, in which case default rules
2777   become sender-side only.  See also the hide (H) and show (S) rules,
2778   which are an alternate way to specify sending-side includes/excludes.
2779   it() An bf(r) is used to indicate that the rule applies to the receiving
2780   side.  When a rule affects the receiving side, it prevents files from
2781   being deleted.  See the bf(s) modifier for more info.  See also the
2782   protect (P) and risk (R) rules, which are an alternate way to
2783   specify receiver-side includes/excludes.
2784   it() A bf(p) indicates that a rule is perishable, meaning that it is
2785   ignored in directories that are being deleted.  For instance, the bf(-C)
2786   option's default rules that exclude things like "CVS" and "*.o" are
2787   marked as perishable, and will not prevent a directory that was removed
2788   on the source from being deleted on the destination.
2789 )
2790
2791 manpagesection(MERGE-FILE FILTER RULES)
2792
2793 You can merge whole files into your filter rules by specifying either a
2794 merge (.) or a dir-merge (:) filter rule (as introduced in the FILTER RULES
2795 section above).
2796
2797 There are two kinds of merged files -- single-instance ('.') and
2798 per-directory (':').  A single-instance merge file is read one time, and
2799 its rules are incorporated into the filter list in the place of the "."
2800 rule.  For per-directory merge files, rsync will scan every directory that
2801 it traverses for the named file, merging its contents when the file exists
2802 into the current list of inherited rules.  These per-directory rule files
2803 must be created on the sending side because it is the sending side that is
2804 being scanned for the available files to transfer.  These rule files may
2805 also need to be transferred to the receiving side if you want them to
2806 affect what files don't get deleted (see PER-DIRECTORY RULES AND DELETE
2807 below).
2808
2809 Some examples:
2810
2811 quote(
2812 tt(merge /etc/rsync/default.rules)nl()
2813 tt(. /etc/rsync/default.rules)nl()
2814 tt(dir-merge .per-dir-filter)nl()
2815 tt(dir-merge,n- .non-inherited-per-dir-excludes)nl()
2816 tt(:n- .non-inherited-per-dir-excludes)nl()
2817 )
2818
2819 The following modifiers are accepted after a merge or dir-merge rule:
2820
2821 itemization(
2822   it() A bf(-) specifies that the file should consist of only exclude
2823   patterns, with no other rule-parsing except for in-file comments.
2824   it() A bf(+) specifies that the file should consist of only include
2825   patterns, with no other rule-parsing except for in-file comments.
2826   it() A bf(C) is a way to specify that the file should be read in a
2827   CVS-compatible manner.  This turns on 'n', 'w', and '-', but also
2828   allows the list-clearing token (!) to be specified.  If no filename is
2829   provided, ".cvsignore" is assumed.
2830   it() A bf(e) will exclude the merge-file name from the transfer; e.g.
2831   "dir-merge,e .rules" is like "dir-merge .rules" and "- .rules".
2832   it() An bf(n) specifies that the rules are not inherited by subdirectories.
2833   it() A bf(w) specifies that the rules are word-split on whitespace instead
2834   of the normal line-splitting.  This also turns off comments.  Note: the
2835   space that separates the prefix from the rule is treated specially, so
2836   "- foo + bar" is parsed as two rules (assuming that prefix-parsing wasn't
2837   also disabled).
2838   it() You may also specify any of the modifiers for the "+" or "-" rules
2839   (above) in order to have the rules that are read in from the file
2840   default to having that modifier set (except for the bf(!) modifier, which
2841   would not be useful).  For instance, "merge,-/ .excl" would
2842   treat the contents of .excl as absolute-path excludes,
2843   while "dir-merge,s .filt" and ":sC" would each make all their
2844   per-directory rules apply only on the sending side.  If the merge rule
2845   specifies sides to affect (via the bf(s) or bf(r) modifier or both),
2846   then the rules in the file must not specify sides (via a modifier or
2847   a rule prefix such as bf(hide)).
2848 )
2849
2850 Per-directory rules are inherited in all subdirectories of the directory
2851 where the merge-file was found unless the 'n' modifier was used.  Each
2852 subdirectory's rules are prefixed to the inherited per-directory rules
2853 from its parents, which gives the newest rules a higher priority than the
2854 inherited rules.  The entire set of dir-merge rules are grouped together in
2855 the spot where the merge-file was specified, so it is possible to override
2856 dir-merge rules via a rule that got specified earlier in the list of global
2857 rules.  When the list-clearing rule ("!") is read from a per-directory
2858 file, it only clears the inherited rules for the current merge file.
2859
2860 Another way to prevent a single rule from a dir-merge file from being inherited is to
2861 anchor it with a leading slash.  Anchored rules in a per-directory
2862 merge-file are relative to the merge-file's directory, so a pattern "/foo"
2863 would only match the file "foo" in the directory where the dir-merge filter
2864 file was found.
2865
2866 Here's an example filter file which you'd specify via bf(--filter=". file":)
2867
2868 quote(
2869 tt(merge /home/user/.global-filter)nl()
2870 tt(- *.gz)nl()
2871 tt(dir-merge .rules)nl()
2872 tt(+ *.[ch])nl()
2873 tt(- *.o)nl()
2874 )
2875
2876 This will merge the contents of the /home/user/.global-filter file at the
2877 start of the list and also turns the ".rules" filename into a per-directory
2878 filter file.  All rules read in prior to the start of the directory scan
2879 follow the global anchoring rules (i.e. a leading slash matches at the root
2880 of the transfer).
2881
2882 If a per-directory merge-file is specified with a path that is a parent
2883 directory of the first transfer directory, rsync will scan all the parent
2884 dirs from that starting point to the transfer directory for the indicated
2885 per-directory file.  For instance, here is a common filter (see bf(-F)):
2886
2887 quote(tt(--filter=': /.rsync-filter'))
2888
2889 That rule tells rsync to scan for the file .rsync-filter in all
2890 directories from the root down through the parent directory of the
2891 transfer prior to the start of the normal directory scan of the file in
2892 the directories that are sent as a part of the transfer.  (Note: for an
2893 rsync daemon, the root is always the same as the module's "path".)
2894
2895 Some examples of this pre-scanning for per-directory files:
2896
2897 quote(
2898 tt(rsync -avF /src/path/ /dest/dir)nl()
2899 tt(rsync -av --filter=': ../../.rsync-filter' /src/path/ /dest/dir)nl()
2900 tt(rsync -av --filter=': .rsync-filter' /src/path/ /dest/dir)nl()
2901 )
2902
2903 The first two commands above will look for ".rsync-filter" in "/" and
2904 "/src" before the normal scan begins looking for the file in "/src/path"
2905 and its subdirectories.  The last command avoids the parent-dir scan
2906 and only looks for the ".rsync-filter" files in each directory that is
2907 a part of the transfer.
2908
2909 If you want to include the contents of a ".cvsignore" in your patterns,
2910 you should use the rule ":C", which creates a dir-merge of the .cvsignore
2911 file, but parsed in a CVS-compatible manner.  You can
2912 use this to affect where the bf(--cvs-exclude) (bf(-C)) option's inclusion of the
2913 per-directory .cvsignore file gets placed into your rules by putting the
2914 ":C" wherever you like in your filter rules.  Without this, rsync would
2915 add the dir-merge rule for the .cvsignore file at the end of all your other
2916 rules (giving it a lower priority than your command-line rules).  For
2917 example:
2918
2919 quote(
2920 tt(cat <<EOT | rsync -avC --filter='. -' a/ b)nl()
2921 tt(+ foo.o)nl()
2922 tt(:C)nl()
2923 tt(- *.old)nl()
2924 tt(EOT)nl()
2925 tt(rsync -avC --include=foo.o -f :C --exclude='*.old' a/ b)nl()
2926 )
2927
2928 Both of the above rsync commands are identical.  Each one will merge all
2929 the per-directory .cvsignore rules in the middle of the list rather than
2930 at the end.  This allows their dir-specific rules to supersede the rules
2931 that follow the :C instead of being subservient to all your rules.  To
2932 affect the other CVS exclude rules (i.e. the default list of exclusions,
2933 the contents of $HOME/.cvsignore, and the value of $CVSIGNORE) you should
2934 omit the bf(-C) command-line option and instead insert a "-C" rule into
2935 your filter rules; e.g. "bf(--filter=-C)".
2936
2937 manpagesection(LIST-CLEARING FILTER RULE)
2938
2939 You can clear the current include/exclude list by using the "!" filter
2940 rule (as introduced in the FILTER RULES section above).  The "current"
2941 list is either the global list of rules (if the rule is encountered while
2942 parsing the filter options) or a set of per-directory rules (which are
2943 inherited in their own sub-list, so a subdirectory can use this to clear
2944 out the parent's rules).
2945
2946 manpagesection(ANCHORING INCLUDE/EXCLUDE PATTERNS)
2947
2948 As mentioned earlier, global include/exclude patterns are anchored at the
2949 "root of the transfer" (as opposed to per-directory patterns, which are
2950 anchored at the merge-file's directory).  If you think of the transfer as
2951 a subtree of names that are being sent from sender to receiver, the
2952 transfer-root is where the tree starts to be duplicated in the destination
2953 directory.  This root governs where patterns that start with a / match.
2954
2955 Because the matching is relative to the transfer-root, changing the
2956 trailing slash on a source path or changing your use of the bf(--relative)
2957 option affects the path you need to use in your matching (in addition to
2958 changing how much of the file tree is duplicated on the destination
2959 host).  The following examples demonstrate this.
2960
2961 Let's say that we want to match two source files, one with an absolute
2962 path of "/home/me/foo/bar", and one with a path of "/home/you/bar/baz".
2963 Here is how the various command choices differ for a 2-source transfer:
2964
2965 quote(
2966    Example cmd: rsync -a /home/me /home/you /dest nl()
2967    +/- pattern: /me/foo/bar nl()
2968    +/- pattern: /you/bar/baz nl()
2969    Target file: /dest/me/foo/bar nl()
2970    Target file: /dest/you/bar/baz nl()
2971 )
2972
2973 quote(
2974    Example cmd: rsync -a /home/me/ /home/you/ /dest nl()
2975    +/- pattern: /foo/bar               (note missing "me") nl()
2976    +/- pattern: /bar/baz               (note missing "you") nl()
2977    Target file: /dest/foo/bar nl()
2978    Target file: /dest/bar/baz nl()
2979 )
2980
2981 quote(
2982    Example cmd: rsync -a --relative /home/me/ /home/you /dest nl()
2983    +/- pattern: /home/me/foo/bar       (note full path) nl()
2984    +/- pattern: /home/you/bar/baz      (ditto) nl()
2985    Target file: /dest/home/me/foo/bar nl()
2986    Target file: /dest/home/you/bar/baz nl()
2987 )
2988
2989 quote(
2990    Example cmd: cd /home; rsync -a --relative me/foo you/ /dest nl()
2991    +/- pattern: /me/foo/bar      (starts at specified path) nl()
2992    +/- pattern: /you/bar/baz     (ditto) nl()
2993    Target file: /dest/me/foo/bar nl()
2994    Target file: /dest/you/bar/baz nl()
2995 )
2996
2997 The easiest way to see what name you should filter is to just
2998 look at the output when using bf(--verbose) and put a / in front of the name
2999 (use the bf(--dry-run) option if you're not yet ready to copy any files).
3000
3001 manpagesection(PER-DIRECTORY RULES AND DELETE)
3002
3003 Without a delete option, per-directory rules are only relevant on the
3004 sending side, so you can feel free to exclude the merge files themselves
3005 without affecting the transfer.  To make this easy, the 'e' modifier adds
3006 this exclude for you, as seen in these two equivalent commands:
3007
3008 quote(
3009 tt(rsync -av --filter=': .excl' --exclude=.excl host:src/dir /dest)nl()
3010 tt(rsync -av --filter=':e .excl' host:src/dir /dest)nl()
3011 )
3012
3013 However, if you want to do a delete on the receiving side AND you want some
3014 files to be excluded from being deleted, you'll need to be sure that the
3015 receiving side knows what files to exclude.  The easiest way is to include
3016 the per-directory merge files in the transfer and use bf(--delete-after),
3017 because this ensures that the receiving side gets all the same exclude
3018 rules as the sending side before it tries to delete anything:
3019
3020 quote(tt(rsync -avF --delete-after host:src/dir /dest))
3021
3022 However, if the merge files are not a part of the transfer, you'll need to
3023 either specify some global exclude rules (i.e. specified on the command
3024 line), or you'll need to maintain your own per-directory merge files on
3025 the receiving side.  An example of the first is this (assume that the
3026 remote .rules files exclude themselves):
3027
3028 verb(rsync -av --filter=': .rules' --filter='. /my/extra.rules'
3029    --delete host:src/dir /dest)
3030
3031 In the above example the extra.rules file can affect both sides of the
3032 transfer, but (on the sending side) the rules are subservient to the rules
3033 merged from the .rules files because they were specified after the
3034 per-directory merge rule.
3035
3036 In one final example, the remote side is excluding the .rsync-filter
3037 files from the transfer, but we want to use our own .rsync-filter files
3038 to control what gets deleted on the receiving side.  To do this we must
3039 specifically exclude the per-directory merge files (so that they don't get
3040 deleted) and then put rules into the local files to control what else
3041 should not get deleted.  Like one of these commands:
3042
3043 verb(    rsync -av --filter=':e /.rsync-filter' --delete \ 
3044         host:src/dir /dest
3045     rsync -avFF --delete host:src/dir /dest)
3046
3047 manpagesection(BATCH MODE)
3048
3049 Batch mode can be used to apply the same set of updates to many
3050 identical systems. Suppose one has a tree which is replicated on a
3051 number of hosts.  Now suppose some changes have been made to this
3052 source tree and those changes need to be propagated to the other
3053 hosts. In order to do this using batch mode, rsync is run with the
3054 write-batch option to apply the changes made to the source tree to one
3055 of the destination trees.  The write-batch option causes the rsync
3056 client to store in a "batch file" all the information needed to repeat
3057 this operation against other, identical destination trees.
3058
3059 Generating the batch file once saves having to perform the file
3060 status, checksum, and data block generation more than once when
3061 updating multiple destination trees. Multicast transport protocols can
3062 be used to transfer the batch update files in parallel to many hosts
3063 at once, instead of sending the same data to every host individually.
3064
3065 To apply the recorded changes to another destination tree, run rsync
3066 with the read-batch option, specifying the name of the same batch
3067 file, and the destination tree.  Rsync updates the destination tree
3068 using the information stored in the batch file.
3069
3070 For your convenience, a script file is also created when the write-batch
3071 option is used:  it will be named the same as the batch file with ".sh"
3072 appended.  This script file contains a command-line suitable for updating a
3073 destination tree using the associated batch file. It can be executed using
3074 a Bourne (or Bourne-like) shell, optionally passing in an alternate
3075 destination tree pathname which is then used instead of the original
3076 destination path.  This is useful when the destination tree path on the
3077 current host differs from the one used to create the batch file.
3078
3079 Examples:
3080
3081 quote(
3082 tt($ rsync --write-batch=foo -a host:/source/dir/ /adest/dir/)nl()
3083 tt($ scp foo* remote:)nl()
3084 tt($ ssh remote ./foo.sh /bdest/dir/)nl()
3085 )
3086
3087 quote(
3088 tt($ rsync --write-batch=foo -a /source/dir/ /adest/dir/)nl()
3089 tt($ ssh remote rsync --read-batch=- -a /bdest/dir/ <foo)nl()
3090 )
3091
3092 In these examples, rsync is used to update /adest/dir/ from /source/dir/
3093 and the information to repeat this operation is stored in "foo" and
3094 "foo.sh".  The host "remote" is then updated with the batched data going
3095 into the directory /bdest/dir.  The differences between the two examples
3096 reveals some of the flexibility you have in how you deal with batches:
3097
3098 itemization(
3099   it() The first example shows that the initial copy doesn't have to be
3100   local -- you can push or pull data to/from a remote host using either the
3101   remote-shell syntax or rsync daemon syntax, as desired.
3102   it() The first example uses the created "foo.sh" file to get the right
3103   rsync options when running the read-batch command on the remote host.
3104   it() The second example reads the batch data via standard input so that
3105   the batch file doesn't need to be copied to the remote machine first.
3106   This example avoids the foo.sh script because it needed to use a modified
3107   bf(--read-batch) option, but you could edit the script file if you wished to
3108   make use of it (just be sure that no other option is trying to use
3109   standard input, such as the "bf(--exclude-from=-)" option).
3110 )
3111
3112 Caveats:
3113
3114 The read-batch option expects the destination tree that it is updating
3115 to be identical to the destination tree that was used to create the
3116 batch update fileset.  When a difference between the destination trees
3117 is encountered the update might be discarded with a warning (if the file
3118 appears to be up-to-date already) or the file-update may be attempted
3119 and then, if the file fails to verify, the update discarded with an
3120 error.  This means that it should be safe to re-run a read-batch operation
3121 if the command got interrupted.  If you wish to force the batched-update to
3122 always be attempted regardless of the file's size and date, use the bf(-I)
3123 option (when reading the batch).
3124 If an error occurs, the destination tree will probably be in a
3125 partially updated state. In that case, rsync can
3126 be used in its regular (non-batch) mode of operation to fix up the
3127 destination tree.
3128
3129 The rsync version used on all destinations must be at least as new as the
3130 one used to generate the batch file.  Rsync will die with an error if the
3131 protocol version in the batch file is too new for the batch-reading rsync
3132 to handle.  See also the bf(--protocol) option for a way to have the
3133 creating rsync generate a batch file that an older rsync can understand.
3134 (Note that batch files changed format in version 2.6.3, so mixing versions
3135 older than that with newer versions will not work.)
3136
3137 When reading a batch file, rsync will force the value of certain options
3138 to match the data in the batch file if you didn't set them to the same
3139 as the batch-writing command.  Other options can (and should) be changed.
3140 For instance bf(--write-batch) changes to bf(--read-batch),
3141 bf(--files-from) is dropped, and the
3142 bf(--filter)/bf(--include)/bf(--exclude) options are not needed unless
3143 one of the bf(--delete) options is specified.
3144
3145 The code that creates the BATCH.sh file transforms any filter/include/exclude
3146 options into a single list that is appended as a "here" document to the
3147 shell script file.  An advanced user can use this to modify the exclude
3148 list if a change in what gets deleted by bf(--delete) is desired.  A normal
3149 user can ignore this detail and just use the shell script as an easy way
3150 to run the appropriate bf(--read-batch) command for the batched data.
3151
3152 The original batch mode in rsync was based on "rsync+", but the latest
3153 version uses a new implementation.
3154
3155 manpagesection(SYMBOLIC LINKS)
3156
3157 Three basic behaviors are possible when rsync encounters a symbolic
3158 link in the source directory.
3159
3160 By default, symbolic links are not transferred at all.  A message
3161 "skipping non-regular" file is emitted for any symlinks that exist.
3162
3163 If bf(--links) is specified, then symlinks are recreated with the same
3164 target on the destination.  Note that bf(--archive) implies
3165 bf(--links).
3166
3167 If bf(--copy-links) is specified, then symlinks are "collapsed" by
3168 copying their referent, rather than the symlink.
3169
3170 Rsync can also distinguish "safe" and "unsafe" symbolic links.  An
3171 example where this might be used is a web site mirror that wishes to
3172 ensure that the rsync module that is copied does not include symbolic links to
3173 bf(/etc/passwd) in the public section of the site.  Using
3174 bf(--copy-unsafe-links) will cause any links to be copied as the file
3175 they point to on the destination.  Using bf(--safe-links) will cause
3176 unsafe links to be omitted altogether.  (Note that you must specify
3177 bf(--links) for bf(--safe-links) to have any effect.)
3178
3179 Symbolic links are considered unsafe if they are absolute symlinks
3180 (start with bf(/)), empty, or if they contain enough ".."
3181 components to ascend from the directory being copied.
3182
3183 Here's a summary of how the symlink options are interpreted.  The list is
3184 in order of precedence, so if your combination of options isn't mentioned,
3185 use the first line that is a complete subset of your options:
3186
3187 dit(bf(--copy-links)) Turn all symlinks into normal files (leaving no
3188 symlinks for any other options to affect).
3189
3190 dit(bf(--links --copy-unsafe-links)) Turn all unsafe symlinks into files
3191 and duplicate all safe symlinks.
3192
3193 dit(bf(--copy-unsafe-links)) Turn all unsafe symlinks into files, noisily
3194 skip all safe symlinks.
3195
3196 dit(bf(--links --safe-links)) Duplicate safe symlinks and skip unsafe
3197 ones.
3198
3199 dit(bf(--links)) Duplicate all symlinks.
3200
3201 manpagediagnostics()
3202
3203 rsync occasionally produces error messages that may seem a little
3204 cryptic. The one that seems to cause the most confusion is "protocol
3205 version mismatch -- is your shell clean?".
3206
3207 This message is usually caused by your startup scripts or remote shell
3208 facility producing unwanted garbage on the stream that rsync is using
3209 for its transport. The way to diagnose this problem is to run your
3210 remote shell like this:
3211
3212 quote(tt(ssh remotehost /bin/true > out.dat))
3213
3214 then look at out.dat. If everything is working correctly then out.dat
3215 should be a zero length file. If you are getting the above error from
3216 rsync then you will probably find that out.dat contains some text or
3217 data. Look at the contents and try to work out what is producing
3218 it. The most common cause is incorrectly configured shell startup
3219 scripts (such as .cshrc or .profile) that contain output statements
3220 for non-interactive logins.
3221
3222 If you are having trouble debugging filter patterns, then
3223 try specifying the bf(-vv) option.  At this level of verbosity rsync will
3224 show why each individual file is included or excluded.
3225
3226 manpagesection(EXIT VALUES)
3227
3228 startdit()
3229 dit(bf(0)) Success
3230 dit(bf(1)) Syntax or usage error
3231 dit(bf(2)) Protocol incompatibility
3232 dit(bf(3)) Errors selecting input/output files, dirs
3233 dit(bf(4)) Requested action not supported: an attempt
3234 was made to manipulate 64-bit files on a platform that cannot support
3235 them; or an option was specified that is supported by the client and
3236 not by the server.
3237 dit(bf(5)) Error starting client-server protocol
3238 dit(bf(6)) Daemon unable to append to log-file
3239 dit(bf(10)) Error in socket I/O
3240 dit(bf(11)) Error in file I/O
3241 dit(bf(12)) Error in rsync protocol data stream
3242 dit(bf(13)) Errors with program diagnostics
3243 dit(bf(14)) Error in IPC code
3244 dit(bf(20)) Received SIGUSR1 or SIGINT
3245 dit(bf(21)) Some error returned by code(waitpid())
3246 dit(bf(22)) Error allocating core memory buffers
3247 dit(bf(23)) Partial transfer due to error
3248 dit(bf(24)) Partial transfer due to vanished source files
3249 dit(bf(25)) The --max-delete limit stopped deletions
3250 dit(bf(30)) Timeout in data send/receive
3251 dit(bf(35)) Timeout waiting for daemon connection
3252 enddit()
3253
3254 manpagesection(ENVIRONMENT VARIABLES)
3255
3256 startdit()
3257 dit(bf(CVSIGNORE)) The CVSIGNORE environment variable supplements any
3258 ignore patterns in .cvsignore files. See the bf(--cvs-exclude) option for
3259 more details.
3260 dit(bf(RSYNC_ICONV)) Specify a default bf(--iconv) setting using this
3261 environment variable. (First supported in 3.0.0.)
3262 dit(bf(RSYNC_PROTECT_ARGS)) Specify a non-zero numeric value if you want the
3263 bf(--protect-args) option to be enabled by default, or a zero value to make
3264 sure that it is disabled by default. (First supported in 3.1.0.)
3265 dit(bf(RSYNC_RSH)) The RSYNC_RSH environment variable allows you to
3266 override the default shell used as the transport for rsync.  Command line
3267 options are permitted after the command name, just as in the bf(-e) option.
3268 dit(bf(RSYNC_PROXY)) The RSYNC_PROXY environment variable allows you to
3269 redirect your rsync client to use a web proxy when connecting to a
3270 rsync daemon. You should set RSYNC_PROXY to a hostname:port pair.
3271 dit(bf(RSYNC_PASSWORD)) Setting RSYNC_PASSWORD to the required
3272 password allows you to run authenticated rsync connections to an rsync
3273 daemon without user intervention. Note that this does not supply a
3274 password to a remote shell transport such as ssh; to learn how to do that,
3275 consult the remote shell's documentation.
3276 dit(bf(USER) or bf(LOGNAME)) The USER or LOGNAME environment variables
3277 are used to determine the default username sent to an rsync daemon.
3278 If neither is set, the username defaults to "nobody".
3279 dit(bf(HOME)) The HOME environment variable is used to find the user's
3280 default .cvsignore file.
3281 enddit()
3282
3283 manpagefiles()
3284
3285 /etc/rsyncd.conf or rsyncd.conf
3286
3287 manpageseealso()
3288
3289 bf(rsyncd.conf)(5)
3290
3291 manpagebugs()
3292
3293 times are transferred as *nix time_t values
3294
3295 When transferring to FAT filesystems rsync may re-sync
3296 unmodified files.
3297 See the comments on the bf(--modify-window) option.
3298
3299 file permissions, devices, etc. are transferred as native numerical
3300 values
3301
3302 see also the comments on the bf(--delete) option
3303
3304 Please report bugs! See the web site at
3305 url(http://rsync.samba.org/)(http://rsync.samba.org/)
3306
3307 manpagesection(VERSION)
3308
3309 This man page is current for version 3.0.3 of rsync.
3310
3311 manpagesection(INTERNAL OPTIONS)
3312
3313 The options bf(--server) and bf(--sender) are used internally by rsync,
3314 and should never be typed by a user under normal circumstances.  Some
3315 awareness of these options may be needed in certain scenarios, such as
3316 when setting up a login that can only run an rsync command.  For instance,
3317 the support directory of the rsync distribution has an example script
3318 named rrsync (for restricted rsync) that can be used with a restricted
3319 ssh login.
3320
3321 manpagesection(CREDITS)
3322
3323 rsync is distributed under the GNU public license.  See the file
3324 COPYING for details.
3325
3326 A WEB site is available at
3327 url(http://rsync.samba.org/)(http://rsync.samba.org/).  The site
3328 includes an FAQ-O-Matic which may cover questions unanswered by this
3329 manual page.
3330
3331 The primary ftp site for rsync is
3332 url(ftp://rsync.samba.org/pub/rsync)(ftp://rsync.samba.org/pub/rsync).
3333
3334 We would be delighted to hear from you if you like this program.
3335 Please contact the mailing-list at rsync@lists.samba.org.
3336
3337 This program uses the excellent zlib compression library written by
3338 Jean-loup Gailly and Mark Adler.
3339
3340 manpagesection(THANKS)
3341
3342 Special thanks go out to: John Van Essen, Matt McCutchen, Wesley W. Terpstra,
3343 David Dykstra, Jos Backus, Sebastian Krahmer, Martin Pool, and our
3344 gone-but-not-forgotten compadre, J.W. Schultz.
3345
3346 Thanks also to Richard Brent, Brendan Mackay, Bill Waite, Stephen Rothwell
3347 and David Bell.  I've probably missed some people, my apologies if I have.
3348
3349 manpageauthor()
3350
3351 rsync was originally written by Andrew Tridgell and Paul Mackerras.
3352 Many people have later contributed to it.  It is currently maintained
3353 by Wayne Davison.
3354
3355 Mailing lists for support and development are available at
3356 url(http://lists.samba.org)(lists.samba.org)