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