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