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