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