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