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