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