1 mailto(rsync-bugs@samba.org)
2 manpage(rsync)(1)(30 Apr 2004)()()
3 manpagename(rsync)(faster, flexible replacement for rcp)
6 rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST
8 rsync [OPTION]... [USER@]HOST:SRC DEST
10 rsync [OPTION]... SRC [SRC]... DEST
12 rsync [OPTION]... [USER@]HOST::SRC [DEST]
14 rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST
16 rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]
18 rsync [OPTION]... SRC [SRC]... rsync://[USER@]HOST[:PORT]/DEST
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 already
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.
32 Some of the additional features of rsync are:
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
45 manpagesection(GENERAL)
47 There are eight different ways of using rsync. They are:
50 it() for copying local files. This is invoked when neither
51 source nor destination path contains a : separator
53 it() for copying from the local machine to a remote machine using
54 a remote shell program as the transport (such as ssh or
55 rsh). This is invoked when the destination path contains a
58 it() for copying from a remote machine to the local machine
59 using a remote shell program. This is invoked when the source
60 contains a : separator.
62 it() for copying from a remote rsync server to the local
63 machine. This is invoked when the source path contains a ::
64 separator or an rsync:// URL.
66 it() for copying from the local machine to a remote rsync
67 server. This is invoked when the destination path contains a ::
68 separator or an rsync:// URL.
70 it() for copying from a remote machine using a remote shell
71 program as the transport, using rsync server on the remote
72 machine. This is invoked when the source path contains a ::
73 separator and the --rsh=COMMAND (aka "-e COMMAND") option is
76 it() for copying from the local machine to a remote machine
77 using a remote shell program as the transport, using rsync
78 server on the remote machine. This is invoked when the
79 destination path contains a :: separator and the
80 --rsh=COMMAND option is also provided.
82 it() for listing files on a remote machine. This is done the
83 same way as rsync transfers except that you leave off the
87 Note that in all cases (other than listing) at least one of the source
88 and destination paths must be local.
92 See the file README for installation instructions.
94 Once installed, you can use rsync to any machine that you can access via
95 a remote shell (as well as some that you can access using the rsync
96 daemon-mode protocol). For remote transfers, a modern rsync uses ssh
97 for its communications, but it may have been configured to use a
98 different remote shell by default, such as rsh or remsh.
100 You can also specify any remote shell you like, either by using the -e
101 command line option, or by setting the RSYNC_RSH environment variable.
103 One common substitute is to use ssh, which offers a high degree of
106 Note that rsync must be installed on both the source and destination
109 manpagesection(USAGE)
111 You use rsync in the same way you use rcp. You must specify a source
112 and a destination, one of which may be remote.
114 Perhaps the best way to explain the syntax is with some examples:
116 quote(rsync *.c foo:src/)
118 This would transfer all files matching the pattern *.c from the
119 current directory to the directory src on the machine foo. If any of
120 the files already exist on the remote system then the rsync
121 remote-update protocol is used to update the file by sending only the
122 differences. See the tech report for details.
124 quote(rsync -avz foo:src/bar /data/tmp)
126 This would recursively transfer all files from the directory src/bar on the
127 machine foo into the /data/tmp/bar directory on the local machine. The
128 files are transferred in "archive" mode, which ensures that symbolic
129 links, devices, attributes, permissions, ownerships, etc. are preserved
130 in the transfer. Additionally, compression will be used to reduce the
131 size of data portions of the transfer.
133 quote(rsync -avz foo:src/bar/ /data/tmp)
135 A trailing slash on the source changes this behavior to avoid creating an
136 additional directory level at the destination. You can think of a trailing
137 / on a source as meaning "copy the contents of this directory" as opposed
138 to "copy the directory by name", but in both cases the attributes of the
139 containing directory are transferred to the containing directory on the
140 destination. In other words, each of the following commands copies the
141 files in the same way, including their setting of the attributes of
144 quote(rsync -avz /src/foo /dest)
145 quote(rsync -avz /src/foo/ /dest/foo)
147 You can also use rsync in local-only mode, where both the source and
148 destination don't have a ':' in the name. In this case it behaves like
149 an improved copy command.
151 quote(rsync somehost.mydomain.com::)
153 This would list all the anonymous rsync modules available on the host
154 somehost.mydomain.com. (See the following section for more details.)
157 manpagesection(CONNECTING TO AN RSYNC SERVER)
159 It is also possible to use rsync without a remote shell as the
160 transport. In this case you will connect to a remote rsync server
161 running on TCP port 873.
163 You may establish the connection via a web proxy by setting the
164 environment variable RSYNC_PROXY to a hostname:port pair pointing to
165 your web proxy. Note that your web proxy's configuration must support
166 proxy connections to port 873.
168 Using rsync in this way is the same as using it with a remote shell except
172 it() you use a double colon :: instead of a single colon to
173 separate the hostname from the path or an rsync:// URL.
175 it() the remote server may print a message of the day when you
178 it() if you specify no path name on the remote server then the
179 list of accessible paths on the server will be shown.
181 it() if you specify no local destination then a listing of the
182 specified files on the remote server is provided.
185 Some paths on the remote server may require authentication. If so then
186 you will receive a password prompt when you connect. You can avoid the
187 password prompt by setting the environment variable RSYNC_PASSWORD to
188 the password you want to use or using the --password-file option. This
189 may be useful when scripting rsync.
191 WARNING: On some systems environment variables are visible to all
192 users. On those systems using --password-file is recommended.
194 manpagesection(CONNECTING TO AN RSYNC SERVER OVER A REMOTE SHELL PROGRAM)
196 It is sometimes useful to be able to set up file transfers using rsync
197 server capabilities on the remote machine, while still using ssh or
198 rsh for transport. This is especially useful when you want to connect
199 to a remote machine via ssh (for encryption or to get through a
200 firewall), but you still want to have access to the rsync server
201 features (see RUNNING AN RSYNC SERVER OVER A REMOTE SHELL PROGRAM,
204 From the user's perspective, using rsync in this way is the same as
205 using it to connect to an rsync server, except that you must
206 explicitly set the remote shell program on the command line with
207 --rsh=COMMAND. (Setting RSYNC_RSH in the environment will not turn on
210 In order to distinguish between the remote-shell user and the rsync
211 server user, you can use '-l user' on your remote-shell command:
213 quote(rsync -av --rsh="ssh -l ssh-user" rsync-user@host::module[/path] local-path)
215 The "ssh-user" will be used at the ssh level; the "rsync-user" will be
216 used to check against the rsyncd.conf on the remote host.
218 manpagesection(RUNNING AN RSYNC SERVER)
220 An rsync server is configured using a configuration file. Please see the
221 rsyncd.conf(5) man page for more information. By default the configuration
222 file is called /etc/rsyncd.conf, unless rsync is running over a remote
223 shell program and is not running as root; in that case, the default name
224 is rsyncd.conf in the current directory on the remote computer
227 manpagesection(RUNNING AN RSYNC SERVER OVER A REMOTE SHELL PROGRAM)
229 See the rsyncd.conf(5) man page for full information on the rsync
230 server configuration file.
232 Several configuration options will not be available unless the remote
233 user is root (e.g. chroot, setuid/setgid, etc.). There is no need to
234 configure inetd or the services map to include the rsync server port
235 if you run an rsync server only via a remote shell program.
237 To run an rsync server out of a single-use ssh key, see this section
238 in the rsyncd.conf(5) man page.
240 manpagesection(EXAMPLES)
242 Here are some examples of how I use rsync.
244 To backup my wife's home directory, which consists of large MS Word
245 files and mail folders, I use a cron job that runs
247 quote(rsync -Cavz . arvidsjaur:backup)
249 each night over a PPP connection to a duplicate directory on my machine
252 To synchronize my samba source trees I use the following Makefile
256 rsync -avuzb --exclude '*~' samba:samba/ .
259 rsync -Cavuzb . samba:samba/
263 this allows me to sync with a CVS directory at the other end of the
264 connection. I then do cvs operations on the remote machine, which saves a
265 lot of time as the remote cvs protocol isn't very efficient.
267 I mirror a directory between my "old" and "new" ftp sites with the
270 quote(rsync -az -e ssh --delete ~ftp/pub/samba/ nimbus:"~ftp/pub/tridge/samba")
272 this is launched from cron every few hours.
274 manpagesection(OPTIONS SUMMARY)
276 Here is a short summary of the options available in rsync. Please refer
277 to the detailed description below for a complete description.
280 -v, --verbose increase verbosity
281 -q, --quiet decrease verbosity
282 -c, --checksum always checksum
283 -a, --archive archive mode, equivalent to -rlptgoD
284 -r, --recursive recurse into directories
285 -R, --relative use relative path names
286 --no-relative turn off --relative
287 --no-implied-dirs don't send implied dirs with -R
288 -b, --backup make backups (see --suffix & --backup-dir)
289 --backup-dir make backups into this directory
290 --suffix=SUFFIX backup suffix (default ~ w/o --backup-dir)
291 -u, --update update only (don't overwrite newer files)
292 --inplace update the destination files inplace
293 -K, --keep-dirlinks treat symlinked dir on receiver as dir
294 -l, --links copy symlinks as symlinks
295 -L, --copy-links copy the referent of all symlinks
296 --copy-unsafe-links copy the referent of "unsafe" symlinks
297 --safe-links ignore "unsafe" symlinks
298 -H, --hard-links preserve hard links
299 -p, --perms preserve permissions
300 -o, --owner preserve owner (root only)
301 -g, --group preserve group
302 -D, --devices preserve devices (root only)
303 -t, --times preserve times
304 -S, --sparse handle sparse files efficiently
305 -n, --dry-run show what would have been transferred
306 -W, --whole-file copy whole files, no incremental checks
307 --no-whole-file turn off --whole-file
308 -x, --one-file-system don't cross filesystem boundaries
309 -B, --block-size=SIZE checksum blocking size (default 700)
310 -e, --rsh=COMMAND specify the remote shell
311 --rsync-path=PATH specify path to rsync on the remote machine
312 --existing only update files that already exist
313 --ignore-existing ignore files that already exist on receiver
314 --delete delete files that don't exist on sender
315 --delete-excluded also delete excluded files on receiver
316 --delete-after receiver deletes after transfer, not before
317 --ignore-errors delete even if there are I/O errors
318 --max-delete=NUM don't delete more than NUM files
319 --partial keep partially transferred files
320 --force force deletion of dirs even if not empty
321 --numeric-ids don't map uid/gid values by user/group name
322 --timeout=TIME set I/O timeout in seconds
323 -I, --ignore-times turn off mod time & file size quick check
324 --size-only ignore mod time for quick check (use size)
325 --modify-window=NUM compare mod times with reduced accuracy
326 -T --temp-dir=DIR create temporary files in directory DIR
327 --compare-dest=DIR also compare received files relative to DIR
328 --link-dest=DIR create hardlinks to DIR for unchanged files
329 -P equivalent to --partial --progress
330 -z, --compress compress file data
331 -C, --cvs-exclude auto ignore files in the same way CVS does
332 --exclude=PATTERN exclude files matching PATTERN
333 --exclude-from=FILE exclude patterns listed in FILE
334 --include=PATTERN don't exclude files matching PATTERN
335 --include-from=FILE don't exclude patterns listed in FILE
336 --files-from=FILE read FILE for list of source-file names
337 -0 --from0 all file lists are delimited by nulls
338 --version print version number
339 --daemon run as an rsync daemon
340 --no-detach do not detach from the parent
341 --address=ADDRESS bind to the specified address
342 --config=FILE specify alternate rsyncd.conf file
343 --port=PORT specify alternate rsyncd port number
344 --blocking-io use blocking I/O for the remote shell
345 --no-blocking-io turn off --blocking-io
346 --stats give some file transfer stats
347 --progress show progress during transfer
348 --log-format=FORMAT log file transfers using specified format
349 --password-file=FILE get password from FILE
350 --bwlimit=KBPS limit I/O bandwidth, KBytes per second
351 --write-batch=FILE write a batch to FILE
352 --read-batch=FILE read a batch from FILE
353 --checksum-seed=NUM set block/file checksum seed
354 -4 --ipv4 prefer IPv4
355 -6 --ipv6 prefer IPv6
356 -h, --help show this help screen
363 rsync uses the GNU long options package. Many of the command line
364 options have two variants, one short and one long. These are shown
365 below, separated by commas. Some options only have a long variant.
366 The '=' for options that take a parameter is optional; whitespace
370 dit(bf(-h, --help)) Print a short help page describing the options
373 dit(bf(--version)) print the rsync version number and exit
375 dit(bf(-v, --verbose)) This option increases the amount of information you
376 are given during the transfer. By default, rsync works silently. A
377 single -v will give you information about what files are being
378 transferred and a brief summary at the end. Two -v flags will give you
379 information on what files are being skipped and slightly more
380 information at the end. More than two -v flags should only be used if
381 you are debugging rsync.
383 dit(bf(-q, --quiet)) This option decreases the amount of information you
384 are given during the transfer, notably suppressing information messages
385 from the remote server. This flag is useful when invoking rsync from
388 dit(bf(-I, --ignore-times)) Normally rsync will skip any files that are
389 already the same size and have the same modification time-stamp.
390 This option turns off this "quick check" behavior.
392 dit(bf(--size-only)) Normally rsync will not transfer any files that are
393 already the same size and have the same modification time-stamp. With the
394 --size-only option, files will not be transferred if they have the same size,
395 regardless of timestamp. This is useful when starting to use rsync
396 after using another mirroring system which may not preserve timestamps
399 dit(bf(--modify-window)) When comparing two timestamps rsync treats
400 the timestamps as being equal if they are within the value of
401 modify_window. This is normally zero, but you may find it useful to
402 set this to a larger value in some situations. In particular, when
403 transferring to Windows FAT filesystems which cannot represent times
404 with a 1 second resolution --modify-window=1 is useful.
406 dit(bf(-c, --checksum)) This forces the sender to checksum all files using
407 a 128-bit MD4 checksum before transfer. The checksum is then
408 explicitly checked on the receiver and any files of the same name
409 which already exist and have the same checksum and size on the
410 receiver are not transferred. This option can be quite slow.
412 dit(bf(-a, --archive)) This is equivalent to -rlptgoD. It is a quick
413 way of saying you want recursion and want to preserve almost
416 Note however that bf(-a) bf(does not preserve hardlinks), because
417 finding multiply-linked files is expensive. You must separately
420 dit(bf(-r, --recursive)) This tells rsync to copy directories
421 recursively. If you don't specify this then rsync won't copy
424 dit(bf(-R, --relative)) Use relative paths. This means that the full path
425 names specified on the command line are sent to the server rather than
426 just the last parts of the filenames. This is particularly useful when
427 you want to send several different directories at the same time. For
428 example, if you used the command
430 verb(rsync foo/bar/foo.c remote:/tmp/)
432 then this would create a file called foo.c in /tmp/ on the remote
433 machine. If instead you used
435 verb(rsync -R foo/bar/foo.c remote:/tmp/)
437 then a file called /tmp/foo/bar/foo.c would be created on the remote
438 machine -- the full path name is preserved.
440 dit(bf(--no-relative)) Turn off the --relative option. This is only
441 needed if you want to use --files-from without its implied --relative
444 dit(bf(--no-implied-dirs)) When combined with the --relative option, the
445 implied directories in each path are not explicitly duplicated as part
446 of the transfer. This makes the transfer more optimal and also allows
447 the two sides to have non-matching symlinks in the implied part of the
448 path. For instance, if you transfer the file "/path/foo/file" with -R,
449 the default is for rsync to ensure that "/path" and "/path/foo" on the
450 destination exactly match the directories/symlinks of the source. Using
451 the --no-implied-dirs option would omit both of these implied dirs,
452 which means that if "/path" was a real directory on one machine and a
453 symlink of the other machine, rsync would not try to change this.
455 dit(bf(-b, --backup)) With this option, preexisting destination files are
456 renamed as each file is transferred or deleted. You can control where the
457 backup file goes and what (if any) suffix gets appended using the
458 --backup-dir and --suffix options.
460 dit(bf(--backup-dir=DIR)) In combination with the --backup option, this
461 tells rsync to store all backups in the specified directory. This is
462 very useful for incremental backups. You can additionally
463 specify a backup suffix using the --suffix option
464 (otherwise the files backed up in the specified directory
465 will keep their original filenames).
466 If DIR is a relative path, it is relative to the destination directory
467 (which changes in a recursive transfer).
469 dit(bf(--suffix=SUFFIX)) This option allows you to override the default
470 backup suffix used with the --backup (-b) option. The default suffix is a ~
471 if no --backup-dir was specified, otherwise it is an empty string.
473 dit(bf(-u, --update)) This forces rsync to skip any files for which the
474 destination file already exists and has a date later than the source
477 In the currently implementation, a difference of file format is always
478 considered to be important enough for an update, no matter what date
479 is on the objects. In other words, if the source has a directory or a
480 symlink where the destination has a file, the transfer would occur
481 regardless of the timestamps. This might change in the future (feel
482 free to comment on this on the mailing list if you have an opinion).
484 dit(bf(-K, --keep-dirlinks)) On the receiving side, if a symlink is
485 pointing to a directory, it will be treated as matching a directory
488 dit(bf(--inplace)) This causes rsync not to create a new copy of the file
489 and then move it into place. Instead rsync will overwrite the existing
490 file, meaning that the rsync algorithm can't extract the full amount of
491 network reduction it might otherwise.
493 This option is useful for transfer of large files with block-based change
494 or appended data, and also on systems that are disk bound not network bound.
496 WARNING: The file's data will be in an inconsistent state during the
497 transfer (and possibly afterward if the transfer gets interrupted), so you
498 should not use this option to update files that are in use. Also note that
499 rsync will be unable to update a file inplace that is not writable by the
502 dit(bf(-l, --links)) When symlinks are encountered, recreate the
503 symlink on the destination.
505 dit(bf(-L, --copy-links)) When symlinks are encountered, the file that
506 they point to (the referent) is copied, rather than the symlink.
508 dit(bf(--copy-unsafe-links)) This tells rsync to copy the referent of
509 symbolic links that point outside the copied tree. Absolute symlinks
510 are also treated like ordinary files, and so are any symlinks in the
511 source path itself when --relative is used.
513 dit(bf(--safe-links)) This tells rsync to ignore any symbolic links
514 which point outside the copied tree. All absolute symlinks are
515 also ignored. Using this option in conjunction with --relative may
516 give unexpected results.
518 dit(bf(-H, --hard-links)) This tells rsync to recreate hard links on
519 the remote system to be the same as the local system. Without this
520 option hard links are treated like regular files.
522 Note that rsync can only detect hard links if both parts of the link
523 are in the list of files being sent.
525 This option can be quite slow, so only use it if you need it.
527 dit(bf(-W, --whole-file)) With this option the incremental rsync algorithm
528 is not used and the whole file is sent as-is instead. The transfer may be
529 faster if this option is used when the bandwidth between the source and
530 destination machines is higher than the bandwidth to disk (especially when the
531 "disk" is actually a networked filesystem). This is the default when both
532 the source and destination are specified as local paths.
534 dit(bf(--no-whole-file)) Turn off --whole-file, for use when it is the
537 dit(bf(-p, --perms)) This option causes rsync to set the destination
538 permissions to be the same as the source permissions.
540 Without this option, each new file gets its permissions set based on the
541 source file's permissions and the umask at the receiving end, while all
542 other files (including updated files) retain their existing permissions
543 (which is the same behavior as other file-copy utilities, such as cp).
545 dit(bf(-o, --owner)) This option causes rsync to set the owner of the
546 destination file to be the same as the source file. On most systems,
547 only the super-user can set file ownership. By default, the preservation
548 is done by name, but may fall back to using the ID number in some
549 circumstances. See the --numeric-ids option for a full discussion.
551 dit(bf(-g, --group)) This option causes rsync to set the group of the
552 destination file to be the same as the source file. If the receiving
553 program is not running as the super-user, only groups that the
554 receiver is a member of will be preserved. By default, the preservation
555 is done by name, but may fall back to using the ID number in some
556 circumstances. See the --numeric-ids option for a full discussion.
558 dit(bf(-D, --devices)) This option causes rsync to transfer character and
559 block device information to the remote system to recreate these
560 devices. This option is only available to the super-user.
562 dit(bf(-t, --times)) This tells rsync to transfer modification times along
563 with the files and update them on the remote system. Note that if this
564 option is not used, the optimization that excludes files that have not been
565 modified cannot be effective; in other words, a missing -t or -a will
566 cause the next transfer to behave as if it used -I, and all files will have
567 their checksums compared and show up in log messages even if they haven't
570 dit(bf(-n, --dry-run)) This tells rsync to not do any file transfers,
571 instead it will just report the actions it would have taken.
573 dit(bf(-S, --sparse)) Try to handle sparse files efficiently so they take
574 up less space on the destination.
576 NOTE: Don't use this option when the destination is a Solaris "tmpfs"
577 filesystem. It doesn't seem to handle seeks over null regions
578 correctly and ends up corrupting the files.
580 dit(bf(-x, --one-file-system)) This tells rsync not to cross filesystem
581 boundaries when recursing. This is useful for transferring the
582 contents of only one filesystem.
584 dit(bf(--existing)) This tells rsync not to create any new files -
585 only update files that already exist on the destination.
587 dit(bf(--ignore-existing))
588 This tells rsync not to update files that already exist on
591 dit(bf(--max-delete=NUM)) This tells rsync not to delete more than NUM
592 files or directories. This is useful when mirroring very large trees
593 to prevent disasters.
595 dit(bf(--delete)) This tells rsync to delete any files on the receiving
596 side that aren't on the sending side. Files that are excluded from
597 transfer are excluded from being deleted unless you use --delete-excluded.
599 This option has no effect if directory recursion is not selected.
601 This option can be dangerous if used incorrectly! It is a very good idea
602 to run first using the dry run option (-n) to see what files would be
603 deleted to make sure important files aren't listed.
605 If the sending side detects any I/O errors then the deletion of any
606 files at the destination will be automatically disabled. This is to
607 prevent temporary filesystem failures (such as NFS errors) on the
608 sending side causing a massive deletion of files on the
609 destination. You can override this with the --ignore-errors option.
611 dit(bf(--delete-excluded)) In addition to deleting the files on the
612 receiving side that are not on the sending side, this tells rsync to also
613 delete any files on the receiving side that are excluded (see --exclude).
616 dit(bf(--delete-after)) By default rsync does file deletions on the
617 receiving side before transferring files to try to ensure that there is
618 sufficient space on the receiving filesystem. If you want to delete
619 after transferring, use the --delete-after switch. Implies --delete.
621 dit(bf(--ignore-errors)) Tells --delete to go ahead and delete files
622 even when there are I/O errors.
624 dit(bf(--force)) This options tells rsync to delete directories even if
625 they are not empty when they are to be replaced by non-directories. This
626 is only relevant without --delete because deletions are now done depth-first.
627 Requires the --recursive option (which is implied by -a) to have any effect.
629 dit(bf(-B, --block-size=BLOCKSIZE)) This controls the block size used in
630 the rsync algorithm. See the technical report for details.
632 dit(bf(-e, --rsh=COMMAND)) This option allows you to choose an alternative
633 remote shell program to use for communication between the local and
634 remote copies of rsync. Typically, rsync is configured to use ssh by
635 default, but you may prefer to use rsh on a local network.
637 If this option is used with bf([user@]host::module/path), then the
638 remote shell em(COMMAND) will be used to run an rsync server on the
639 remote host, and all data will be transmitted through that remote
640 shell connection, rather than through a direct socket connection to a
641 running rsync server on the remote host. See the section "CONNECTING
642 TO AN RSYNC SERVER OVER A REMOTE SHELL PROGRAM" above.
644 Command-line arguments are permitted in COMMAND provided that COMMAND is
645 presented to rsync as a single argument. For example:
647 quote(-e "ssh -p 2234")
649 (Note that ssh users can alternately customize site-specific connect
650 options in their .ssh/config file.)
652 You can also choose the remote shell program using the RSYNC_RSH
653 environment variable, which accepts the same range of values as -e.
655 See also the --blocking-io option which is affected by this option.
657 dit(bf(--rsync-path=PATH)) Use this to specify the path to the copy of
658 rsync on the remote machine. Useful when it's not in your path. Note
659 that this is the full path to the binary, not just the directory that
662 dit(bf(-C, --cvs-exclude)) This is a useful shorthand for excluding a
663 broad range of files that you often don't want to transfer between
664 systems. It uses the same algorithm that CVS uses to determine if
665 a file should be ignored.
667 The exclude list is initialized to:
669 quote(RCS SCCS CVS CVS.adm RCSLOG cvslog.* tags TAGS .make.state
670 .nse_depinfo *~ #* .#* ,* _$* *$ *.old *.bak *.BAK *.orig *.rej
671 .del-* *.a *.olb *.o *.obj *.so *.exe *.Z *.elc *.ln core .svn/)
673 then files listed in a $HOME/.cvsignore are added to the list and any
674 files listed in the CVSIGNORE environment variable (all cvsignore names
675 are delimited by whitespace).
677 Finally, any file is ignored if it is in the same directory as a
678 .cvsignore file and matches one of the patterns listed therein.
679 See the bf(cvs(1)) manual for more information.
681 dit(bf(--exclude=PATTERN)) This option allows you to selectively exclude
682 certain files from the list of files to be transferred. This is most
683 useful in combination with a recursive transfer.
685 You may use as many --exclude options on the command line as you like
686 to build up the list of files to exclude.
688 See the EXCLUDE PATTERNS section for detailed information on this option.
690 dit(bf(--exclude-from=FILE)) This option is similar to the --exclude
691 option, but instead it adds all exclude patterns listed in the file
692 FILE to the exclude list. Blank lines in FILE and lines starting with
693 ';' or '#' are ignored.
694 If em(FILE) is bf(-) the list will be read from standard input.
696 dit(bf(--include=PATTERN)) This option tells rsync to not exclude the
697 specified pattern of filenames. This is useful as it allows you to
698 build up quite complex exclude/include rules.
700 See the EXCLUDE PATTERNS section for detailed information on this option.
702 dit(bf(--include-from=FILE)) This specifies a list of include patterns
704 If em(FILE) is "-" the list will be read from standard input.
706 dit(bf(--files-from=FILE)) Using this option allows you to specify the
707 exact list of files to transfer (as read from the specified FILE or "-"
708 for standard input). It also tweaks the default behavior of rsync to make
709 transferring just the specified files and directories easier. For
710 instance, the --relative option is enabled by default when this option
711 is used (use --no-relative if you want to turn that off), all
712 directories specified in the list are created on the destination (rather
713 than being noisily skipped without -r), and the -a (--archive) option's
714 behavior does not imply -r (--recursive) -- specify it explicitly, if
717 The file names that are read from the FILE are all relative to the
718 source dir -- any leading slashes are removed and no ".." references are
719 allowed to go higher than the source dir. For example, take this
722 quote(rsync -a --files-from=/tmp/foo /usr remote:/backup)
724 If /tmp/foo contains the string "bin" (or even "/bin"), the /usr/bin
725 directory will be created as /backup/bin on the remote host (but the
726 contents of the /usr/bin dir would not be sent unless you specified -r
727 or the names were explicitly listed in /tmp/foo). Also keep in mind
728 that the effect of the (enabled by default) --relative option is to
729 duplicate only the path info that is read from the file -- it does not
730 force the duplication of the source-spec path (/usr in this case).
732 In addition, the --files-from file can be read from the remote host
733 instead of the local host if you specify a "host:" in front of the file
734 (the host must match one end of the transfer). As a short-cut, you can
735 specify just a prefix of ":" to mean "use the remote end of the
736 transfer". For example:
738 quote(rsync -a --files-from=:/path/file-list src:/ /tmp/copy)
740 This would copy all the files specified in the /path/file-list file that
741 was located on the remote "src" host.
743 dit(bf(-0, --from0)) This tells rsync that the filenames it reads from a
744 file are terminated by a null ('\0') character, not a NL, CR, or CR+LF.
745 This affects --exclude-from, --include-from, and --files-from.
746 It does not affect --cvs-exclude (since all names read from a .cvsignore
747 file are split on whitespace).
749 dit(bf(-T, --temp-dir=DIR)) This option instructs rsync to use DIR as a
750 scratch directory when creating temporary copies of the files
751 transferred on the receiving side. The default behavior is to create
752 the temporary files in the receiving directory.
754 dit(bf(--compare-dest=DIR)) This option instructs rsync to use DIR on
755 the destination machine as an additional directory to compare destination
756 files against when doing transfers if the files are missing in the
757 destination directory. This is useful for doing transfers to a new
758 destination while leaving existing files intact, and then doing a
759 flash-cutover when all files have been successfully transferred (for
760 example by moving directories around and removing the old directory,
761 although this skips files that haven't changed; see also --link-dest).
762 This option increases the usefulness of --partial because partially
763 transferred files will remain in the new temporary destination until they
764 have a chance to be completed. If DIR is a relative path, it is relative
765 to the destination directory (which changes in a recursive transfer).
767 dit(bf(--link-dest=DIR)) This option behaves like bf(--compare-dest) but
768 also will create hard links from em(DIR) to the destination directory for
769 unchanged files. Files with changed ownership or permissions will not be
771 Like bf(--compare-dest) if DIR is a relative path, it is relative
772 to the destination directory (which changes in a recursive transfer).
776 rsync -av --link-dest=$PWD/prior_dir host:src_dir/ new_dir/
779 dit(bf(-z, --compress)) With this option, rsync compresses any data from
780 the files that it sends to the destination machine. This
781 option is useful on slow connections. The compression method used is the
782 same method that gzip uses.
784 Note this this option typically achieves better compression ratios
785 that can be achieved by using a compressing remote shell, or a
786 compressing transport, as it takes advantage of the implicit
787 information sent for matching data blocks.
789 dit(bf(--numeric-ids)) With this option rsync will transfer numeric group
790 and user IDs rather than using user and group names and mapping them
793 By default rsync will use the username and groupname to determine
794 what ownership to give files. The special uid 0 and the special group
795 0 are never mapped via user/group names even if the --numeric-ids
796 option is not specified.
798 If a user or group has no name on the source system or it has no match
799 on the destination system, then the numeric ID
800 from the source system is used instead. See also the comments on the
801 "use chroot" setting in the rsyncd.conf manpage for information on how
802 the chroot setting affects rsync's ability to look up the names of the
803 users and groups and what you can do about it.
805 dit(bf(--timeout=TIMEOUT)) This option allows you to set a maximum I/O
806 timeout in seconds. If no data is transferred for the specified time
807 then rsync will exit. The default is 0, which means no timeout.
809 dit(bf(--daemon)) This tells rsync that it is to run as a daemon. The
810 daemon may be accessed using the bf(host::module) or
811 bf(rsync://host/module/) syntax.
813 If standard input is a socket then rsync will assume that it is being
814 run via inetd, otherwise it will detach from the current terminal and
815 become a background daemon. The daemon will read the config file
816 (rsyncd.conf) on each connect made by a client and respond to
817 requests accordingly. See the rsyncd.conf(5) man page for more
820 dit(bf(--no-detach)) When running as a daemon, this option instructs
821 rsync to not detach itself and become a background process. This
822 option is required when running as a service on Cygwin, and may also
823 be useful when rsync is supervised by a program such as
824 bf(daemontools) or AIX's bf(System Resource Controller).
825 bf(--no-detach) is also recommended when rsync is run under a
826 debugger. This option has no effect if rsync is run from inetd or
829 dit(bf(--address)) By default rsync will bind to the wildcard address
830 when run as a daemon with the --daemon option or when connecting to a
831 rsync server. The --address option allows you to specify a specific IP
832 address (or hostname) to bind to. This makes virtual hosting possible
833 in conjunction with the --config option.
835 dit(bf(--config=FILE)) This specifies an alternate config file than
836 the default. This is only relevant when --daemon is specified.
837 The default is /etc/rsyncd.conf unless the daemon is running over
838 a remote shell program and the remote user is not root; in that case
839 the default is rsyncd.conf in the current directory (typically $HOME).
841 dit(bf(--port=PORT)) This specifies an alternate TCP port number to use
842 rather than the default port 873.
844 dit(bf(--blocking-io)) This tells rsync to use blocking I/O when launching
845 a remote shell transport. If the remote shell is either rsh or remsh,
846 rsync defaults to using
847 blocking I/O, otherwise it defaults to using non-blocking I/O. (Note that
848 ssh prefers non-blocking I/O.)
850 dit(bf(--no-blocking-io)) Turn off --blocking-io, for use when it is the
853 dit(bf(--log-format=FORMAT)) This allows you to specify exactly what the
854 rsync client logs to stdout on a per-file basis. The log format is
855 specified using the same format conventions as the log format option in
858 dit(bf(--stats)) This tells rsync to print a verbose set of statistics
859 on the file transfer, allowing you to tell how effective the rsync
860 algorithm is for your data.
862 dit(bf(--partial)) By default, rsync will delete any partially
863 transferred file if the transfer is interrupted. In some circumstances
864 it is more desirable to keep partially transferred files. Using the
865 --partial option tells rsync to keep the partial file which should
866 make a subsequent transfer of the rest of the file much faster.
868 dit(bf(--progress)) This option tells rsync to print information
869 showing the progress of the transfer. This gives a bored user
871 Implies --verbose without incrementing verbosity.
873 When the file is transferring, the data looks like this:
876 782448 63% 110.64kB/s 0:00:04
879 This tells you the current file size, the percentage of the transfer that
880 is complete, the current calculated file-completion rate (including both
881 data over the wire and data being matched locally), and the estimated time
882 remaining in this transfer.
884 After the a file is complete, it the data looks like this:
887 1238099 100% 146.38kB/s 0:00:08 (5, 57.1% of 396)
890 This tells you the final file size, that it's 100% complete, the final
891 transfer rate for the file, the amount of elapsed time it took to transfer
892 the file, and the addition of a total-transfer summary in parentheses.
893 These additional numbers tell you how many files have been updated, and
894 what percent of the total number of files has been scanned.
896 dit(bf(-P)) The -P option is equivalent to --partial --progress. I
897 found myself typing that combination quite often so I created an
898 option to make it easier.
900 dit(bf(--password-file)) This option allows you to provide a password
901 in a file for accessing a remote rsync server. Note that this option
902 is only useful when accessing an rsync server using the built in
903 transport, not when using a remote shell as the transport. The file
904 must not be world readable. It should contain just the password as a
907 dit(bf(--bwlimit=KBPS)) This option allows you to specify a maximum
908 transfer rate in kilobytes per second. This option is most effective when
909 using rsync with large files (several megabytes and up). Due to the nature
910 of rsync transfers, blocks of data are sent, then if rsync determines the
911 transfer was too fast, it will wait before sending the next data block. The
912 result is an average transfer rate equaling the specified limit. A value
913 of zero specifies no limit.
915 dit(bf(--write-batch=FILE)) Record a file that can later be applied to
916 another identical destination with --read-batch. See the "BATCH MODE"
919 dit(bf(--read-batch=FILE)) Apply all of the changes stored in FILE, a
920 file previously generated by --write-batch.
921 If em(FILE) is "-" the batch data will be read from standard input.
922 See the "BATCH MODE" section for details.
924 dit(bf(-4, --ipv4) or bf(-6, --ipv6)) Tells rsync to prefer IPv4/IPv6
925 when creating sockets. This only affects sockets that rsync has direct
926 control over, such as the outgoing socket when directly contacting an
927 rsync daemon, or the incoming sockets that an rsync daemon uses to
928 listen for connections. One of these options may be required in older
929 versions of Linux to work around an IPv6 bug in the kernel (if you see
930 an "address already in use" error when nothing else is using the port,
931 try specifying --ipv6 or --ipv4 when starting the daemon).
933 dit(bf(--checksum-seed=NUM)) Set the MD4 checksum seed to the integer
934 NUM. This 4 byte checksum seed is included in each block and file
935 MD4 checksum calculation. By default the checksum seed is generated
936 by the server and defaults to the current time(). This option
937 is used to set a specific checksum seed, which is useful for
938 applications that want repeatable block and file checksums, or
939 in the case where the user wants a more random checksum seed.
940 Note that setting NUM to 0 causes rsync to use the default of time()
945 manpagesection(EXCLUDE PATTERNS)
947 The exclude and include patterns specified to rsync allow for flexible
948 selection of which files to transfer and which files to skip.
950 Rsync builds an ordered list of include/exclude options as specified on
951 the command line. Rsync checks each file and directory
952 name against each exclude/include pattern in turn. The first matching
953 pattern is acted on. If it is an exclude pattern, then that file is
954 skipped. If it is an include pattern then that filename is not
955 skipped. If no matching include/exclude pattern is found then the
956 filename is not skipped.
958 The filenames matched against the exclude/include patterns are relative
959 to the "root of the transfer". If you think of the transfer as a
960 subtree of names that are being sent from sender to receiver, the root
961 is where the tree starts to be duplicated in the destination directory.
962 This root governs where patterns that start with a / match (see below).
964 Because the matching is relative to the transfer-root, changing the
965 trailing slash on a source path or changing your use of the --relative
966 option affects the path you need to use in your matching (in addition to
967 changing how much of the file tree is duplicated on the destination
968 system). The following examples demonstrate this.
970 Let's say that we want to match two source files, one with an absolute
971 path of "/home/me/foo/bar", and one with a path of "/home/you/bar/baz".
972 Here is how the various command choices differ for a 2-source transfer:
975 Example cmd: rsync -a /home/me /home/you /dest
976 +/- pattern: /me/foo/bar
977 +/- pattern: /you/bar/baz
978 Target file: /dest/me/foo/bar
979 Target file: /dest/you/bar/baz
981 Example cmd: rsync -a /home/me/ /home/you/ /dest
982 +/- pattern: /foo/bar (note missing "me")
983 +/- pattern: /bar/baz (note missing "you")
984 Target file: /dest/foo/bar
985 Target file: /dest/bar/baz
987 Example cmd: rsync -a --relative /home/me/ /home/you /dest
988 +/- pattern: /home/me/foo/bar (note full path)
989 +/- pattern: /home/you/bar/baz (ditto)
990 Target file: /dest/home/me/foo/bar
991 Target file: /dest/home/you/bar/baz
993 Example cmd: cd /home; rsync -a --relative me/foo you/ /dest
994 +/- pattern: /me/foo/bar (starts at specified path)
995 +/- pattern: /you/bar/baz (ditto)
996 Target file: /dest/me/foo/bar
997 Target file: /dest/you/bar/baz
1000 The easiest way to see what name you should include/exclude is to just
1001 look at the output when using --verbose and put a / in front of the name
1002 (use the --dry-run option if you're not yet ready to copy any files).
1004 Note that, when using the --recursive (-r) option (which is implied by -a),
1005 every subcomponent of
1006 every path is visited from the top down, so include/exclude patterns get
1007 applied recursively to each subcomponent.
1008 The exclude patterns actually short-circuit the directory traversal stage
1009 when rsync finds the files to send. If a pattern excludes a particular
1010 parent directory, it can render a deeper include pattern ineffectual
1011 because rsync did not descend through that excluded section of the
1014 Note also that the --include and --exclude options take one pattern
1015 each. To add multiple patterns use the --include-from and
1016 --exclude-from options or multiple --include and --exclude options.
1018 The patterns can take several forms. The rules are:
1022 it() if the pattern starts with a / then it is matched against the
1023 start of the filename, otherwise it is matched against the end of
1025 This is the equivalent of a leading ^ in regular expressions.
1026 Thus "/foo" would match a file called "foo" at the transfer-root
1027 (see above for how this is different from the filesystem-root).
1028 On the other hand, "foo" would match any file called "foo"
1029 anywhere in the tree because the algorithm is applied recursively from
1030 top down; it behaves as if each path component gets a turn at being the
1031 end of the file name.
1033 it() if the pattern ends with a / then it will only match a
1034 directory, not a file, link, or device.
1036 it() if the pattern contains a wildcard character from the set
1037 *?[ then expression matching is applied using the shell filename
1038 matching rules. Otherwise a simple string match is used.
1040 it() the double asterisk pattern "**" will match slashes while a
1041 single asterisk pattern "*" will stop at slashes.
1043 it() if the pattern contains a / (not counting a trailing /) or a "**"
1044 then it is matched against the full filename, including any leading
1045 directory. If the pattern doesn't contain a / or a "**", then it is
1046 matched only against the final component of the filename. Again,
1047 remember that the algorithm is applied recursively so "full filename" can
1048 actually be any portion of a path below the starting directory.
1050 it() if the pattern starts with "+ " (a plus followed by a space)
1051 then it is always considered an include pattern, even if specified as
1052 part of an exclude option. The prefix is discarded before matching.
1054 it() if the pattern starts with "- " (a minus followed by a space)
1055 then it is always considered an exclude pattern, even if specified as
1056 part of an include option. The prefix is discarded before matching.
1058 it() if the pattern is a single exclamation mark ! then the current
1059 include/exclude list is reset, removing all previously defined patterns.
1062 The +/- rules are most useful in a list that was read from a file, allowing
1063 you to have a single exclude list that contains both include and exclude
1064 options in the proper order.
1066 Remember that the matching occurs at every step in the traversal of the
1067 directory hierarchy, so you must be sure that all the parent directories of
1068 the files you want to include are not excluded. This is particularly
1069 important when using a trailing '*' rule. For instance, this won't work:
1072 + /some/path/this-file-will-not-be-found
1077 This fails because the parent directory "some" is excluded by the '*' rule,
1078 so rsync never visits any of the files in the "some" or "some/path"
1079 directories. One solution is to ask for all directories in the hierarchy
1080 to be included by using a single rule: --include='*/' (put it somewhere
1081 before the --exclude='*' rule). Another solution is to add specific
1082 include rules for all the parent dirs that need to be visited. For
1083 instance, this set of rules works fine:
1088 + /some/path/this-file-is-found
1089 + /file-also-included
1093 Here are some examples of exclude/include matching:
1096 it() --exclude "*.o" would exclude all filenames matching *.o
1097 it() --exclude "/foo" would exclude a file called foo in the transfer-root directory
1098 it() --exclude "foo/" would exclude any directory called foo
1099 it() --exclude "/foo/*/bar" would exclude any file called bar two
1100 levels below a directory called foo in the transfer-root directory
1101 it() --exclude "/foo/**/bar" would exclude any file called bar two
1102 or more levels below a directory called foo in the transfer-root directory
1103 it() --include "*/" --include "*.c" --exclude "*" would include all
1104 directories and C source files
1105 it() --include "foo/" --include "foo/bar.c" --exclude "*" would include
1106 only foo/bar.c (the foo/ directory must be explicitly included or
1107 it would be excluded by the "*")
1110 manpagesection(BATCH MODE)
1112 bf(Note:) Batch mode should be considered experimental in this version
1113 of rsync. The interface and behavior have now stabilized, though, so
1114 feel free to try this out.
1116 Batch mode can be used to apply the same set of updates to many
1117 identical systems. Suppose one has a tree which is replicated on a
1118 number of hosts. Now suppose some changes have been made to this
1119 source tree and those changes need to be propagated to the other
1120 hosts. In order to do this using batch mode, rsync is run with the
1121 write-batch option to apply the changes made to the source tree to one
1122 of the destination trees. The write-batch option causes the rsync
1123 client to store in a "batch file" all the information needed to repeat
1124 this operation against other, identical destination trees.
1126 To apply the recorded changes to another destination tree, run rsync
1127 with the read-batch option, specifying the name of the same batch
1128 file, and the destination tree. Rsync updates the destination tree
1129 using the information stored in the batch file.
1131 For convenience, one additional file is creating when the write-batch
1132 option is used. This file's name is created by appending
1133 ".sh" to the batch filename. The .sh file contains
1134 a command-line suitable for updating a destination tree using that
1135 batch file. It can be executed using a Bourne(-like) shell, optionally
1136 passing in an alternate destination tree pathname which is then used
1137 instead of the original path. This is useful when the destination tree
1138 path differs from the original destination tree path.
1140 Generating the batch file once saves having to perform the file
1141 status, checksum, and data block generation more than once when
1142 updating multiple destination trees. Multicast transport protocols can
1143 be used to transfer the batch update files in parallel to many hosts
1144 at once, instead of sending the same data to every host individually.
1149 $ rsync --write-batch=foo -a host:/source/dir/ /adest/dir/
1151 $ ssh remote ./foo.sh /bdest/dir/
1155 $ rsync --write-batch=foo -a /source/dir/ /adest/dir/
1156 $ ssh remote rsync --read-batch=- -a /bdest/dir/ <foo
1159 In these examples, rsync is used to update /adest/dir/ from /source/dir/
1160 and the information to repeat this operation is stored in "foo" and
1161 "foo.sh". The host "remote" is then updated with the batched data going
1162 into the directory /bdest/dir. The differences between the two examples
1163 reveals some of the flexibility you have in how you deal with batches:
1167 it() The first example shows that the initial copy doesn't have to be
1168 local -- you can push or pull data to/from a remote host using either the
1169 remote-shell syntax or rsync daemon syntax, as desired.
1171 it() The first example uses the created "foo.sh" file to get the right
1172 rsync options when running the read-batch command on the remote host.
1174 it() The second example reads the batch data via standard input so that
1175 the batch file doesn't need to be copied to the remote machine first.
1176 This example avoids the foo.sh script because it needed to use a modified
1177 --read-batch option, but you could edit the script file if you wished to
1178 make use of it (just be sure that no other option is trying to use
1179 standard input, such as the "--exclude-from=-" option).
1185 The read-batch option expects the destination tree that it is updating
1186 to be identical to the destination tree that was used to create the
1187 batch update fileset. When a difference between the destination trees
1188 is encountered the update might be discarded with no error (if the file
1189 appears to be up-to-date already) or the file-update may be attempted
1190 and then, if the file fails to verify, the update discarded with an
1191 error. This means that it should be safe to re-run a read-batch operation
1192 if the command got updated. If you wish to force the batched-update to
1193 always be attempted regardless of the file's size and date, use the -I
1194 option. If an error occurs, the destination tree will probably be in a
1195 partially updated state. In that case, rsync can
1196 be used in its regular (non-batch) mode of operation to fix up the
1199 The rsync version used on all destinations must be at least as new as the
1200 one used to generate the batch file.
1202 The --dry-run (-n) option does not work in batch mode and yields a runtime
1205 When reading a batch file, rsync will force the value of certain options
1206 to match the data in the batch file if you didn't set them to the same
1207 as the batch-writing command. Other options can (and should) be changed.
1209 --write-batch changes to --read-batch, --files-from is dropped, and the
1210 --include/--exclude options are not needed unless --delete is specified
1211 without --delete-excluded.
1213 The code that creates the BATCH.sh file transforms any include/exclude
1214 options into a single list that is appended as a "here" document to the
1215 shell script file. An advanced user can use this to modify the exclude
1216 list if a change in what gets deleted by --delete is desired. A normal
1217 user can ignore this detail and just use the shell script as an easy way
1218 to run the appropriate --read-batch command for the batched data.
1220 See bf(http://www.ils.unc.edu/i2dsi/unc_rsync+.html) for papers and technical
1223 manpagesection(SYMBOLIC LINKS)
1225 Three basic behaviors are possible when rsync encounters a symbolic
1226 link in the source directory.
1228 By default, symbolic links are not transferred at all. A message
1229 "skipping non-regular" file is emitted for any symlinks that exist.
1231 If bf(--links) is specified, then symlinks are recreated with the same
1232 target on the destination. Note that bf(--archive) implies
1235 If bf(--copy-links) is specified, then symlinks are "collapsed" by
1236 copying their referent, rather than the symlink.
1238 rsync also distinguishes "safe" and "unsafe" symbolic links. An
1239 example where this might be used is a web site mirror that wishes
1240 ensure the rsync module they copy does not include symbolic links to
1241 bf(/etc/passwd) in the public section of the site. Using
1242 bf(--copy-unsafe-links) will cause any links to be copied as the file
1243 they point to on the destination. Using bf(--safe-links) will cause
1244 unsafe links to be omitted altogether.
1246 Symbolic links are considered unsafe if they are absolute symlinks
1247 (start with bf(/)), empty, or if they contain enough bf("..")
1248 components to ascend from the directory being copied.
1250 manpagesection(DIAGNOSTICS)
1252 rsync occasionally produces error messages that may seem a little
1253 cryptic. The one that seems to cause the most confusion is "protocol
1254 version mismatch - is your shell clean?".
1256 This message is usually caused by your startup scripts or remote shell
1257 facility producing unwanted garbage on the stream that rsync is using
1258 for its transport. The way to diagnose this problem is to run your
1259 remote shell like this:
1262 ssh remotehost /bin/true > out.dat
1265 then look at out.dat. If everything is working correctly then out.dat
1266 should be a zero length file. If you are getting the above error from
1267 rsync then you will probably find that out.dat contains some text or
1268 data. Look at the contents and try to work out what is producing
1269 it. The most common cause is incorrectly configured shell startup
1270 scripts (such as .cshrc or .profile) that contain output statements
1271 for non-interactive logins.
1273 If you are having trouble debugging include and exclude patterns, then
1274 try specifying the -vv option. At this level of verbosity rsync will
1275 show why each individual file is included or excluded.
1277 manpagesection(EXIT VALUES)
1281 dit(bf(1)) Syntax or usage error
1282 dit(bf(2)) Protocol incompatibility
1283 dit(bf(3)) Errors selecting input/output files, dirs
1284 dit(bf(4)) Requested action not supported: an attempt
1285 was made to manipulate 64-bit files on a platform that cannot support
1286 them; or an option was specified that is supported by the client and
1288 dit(bf(5)) Error starting client-server protocol
1289 dit(bf(10)) Error in socket I/O
1290 dit(bf(11)) Error in file I/O
1291 dit(bf(12)) Error in rsync protocol data stream
1292 dit(bf(13)) Errors with program diagnostics
1293 dit(bf(14)) Error in IPC code
1294 dit(bf(20)) Received SIGUSR1 or SIGINT
1295 dit(bf(21)) Some error returned by waitpid()
1296 dit(bf(22)) Error allocating core memory buffers
1297 dit(bf(23)) Partial transfer due to error
1298 dit(bf(24)) Partial transfer due to vanished source files
1299 dit(bf(30)) Timeout in data send/receive
1302 manpagesection(ENVIRONMENT VARIABLES)
1306 dit(bf(CVSIGNORE)) The CVSIGNORE environment variable supplements any
1307 ignore patterns in .cvsignore files. See the --cvs-exclude option for
1310 dit(bf(RSYNC_RSH)) The RSYNC_RSH environment variable allows you to
1311 override the default shell used as the transport for rsync. Command line
1312 options are permitted after the command name, just as in the -e option.
1314 dit(bf(RSYNC_PROXY)) The RSYNC_PROXY environment variable allows you to
1315 redirect your rsync client to use a web proxy when connecting to a
1316 rsync daemon. You should set RSYNC_PROXY to a hostname:port pair.
1318 dit(bf(RSYNC_PASSWORD)) Setting RSYNC_PASSWORD to the required
1319 password allows you to run authenticated rsync connections to an rsync
1320 daemon without user intervention. Note that this does not supply a
1321 password to a shell transport such as ssh.
1323 dit(bf(USER) or bf(LOGNAME)) The USER or LOGNAME environment variables
1324 are used to determine the default username sent to an rsync server.
1325 If neither is set, the username defaults to "nobody".
1327 dit(bf(HOME)) The HOME environment variable is used to find the user's
1328 default .cvsignore file.
1334 /etc/rsyncd.conf or rsyncd.conf
1340 manpagediagnostics()
1344 times are transferred as unix time_t values
1346 When transferring to FAT filesystems rsync may re-sync
1348 See the comments on the --modify-window option.
1350 file permissions, devices, etc. are transferred as native numerical
1353 see also the comments on the --delete option
1355 Please report bugs! See the website at
1356 url(http://rsync.samba.org/)(http://rsync.samba.org/)
1358 manpagesection(CREDITS)
1360 rsync is distributed under the GNU public license. See the file
1361 COPYING for details.
1363 A WEB site is available at
1364 url(http://rsync.samba.org/)(http://rsync.samba.org/). The site
1365 includes an FAQ-O-Matic which may cover questions unanswered by this
1368 The primary ftp site for rsync is
1369 url(ftp://rsync.samba.org/pub/rsync)(ftp://rsync.samba.org/pub/rsync).
1371 We would be delighted to hear from you if you like this program.
1373 This program uses the excellent zlib compression library written by
1374 Jean-loup Gailly and Mark Adler.
1376 manpagesection(THANKS)
1378 Thanks to Richard Brent, Brendan Mackay, Bill Waite, Stephen Rothwell
1379 and David Bell for helpful suggestions, patches and testing of rsync.
1380 I've probably missed some people, my apologies if I have.
1382 Especial thanks also to: David Dykstra, Jos Backus, Sebastian Krahmer,
1383 Martin Pool, Wayne Davison, J.W. Schultz.
1387 rsync was originally written by Andrew Tridgell and Paul Mackerras.
1388 Many people have later contributed to it.
1390 Mailing lists for support and development are available at
1391 url(http://lists.samba.org)(lists.samba.org)