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 -K, --keep-dirlinks treat symlinked dir on receiver as dir
293 -l, --links copy symlinks as symlinks
294 -L, --copy-links copy the referent of all symlinks
295 --copy-unsafe-links copy the referent of "unsafe" symlinks
296 --safe-links ignore "unsafe" symlinks
297 -H, --hard-links preserve hard links
298 -p, --perms preserve permissions
299 -o, --owner preserve owner (root only)
300 -g, --group preserve group
301 -D, --devices preserve devices (root only)
302 -t, --times preserve times
303 -S, --sparse handle sparse files efficiently
304 -n, --dry-run show what would have been transferred
305 -W, --whole-file copy whole files, no incremental checks
306 --no-whole-file turn off --whole-file
307 -x, --one-file-system don't cross filesystem boundaries
308 -B, --block-size=SIZE checksum blocking size (default 700)
309 -e, --rsh=COMMAND specify the remote shell
310 --rsync-path=PATH specify path to rsync on the remote machine
311 --existing only update files that already exist
312 --ignore-existing ignore files that already exist on receiver
313 --delete delete files that don't exist on sender
314 --delete-excluded also delete excluded files on receiver
315 --delete-after receiver deletes after transfer, not before
316 --ignore-errors delete even if there are I/O errors
317 --max-delete=NUM don't delete more than NUM files
318 --partial keep partially transferred files
319 --force force deletion of dirs even if not empty
320 --numeric-ids don't map uid/gid values by user/group name
321 --timeout=TIME set I/O timeout in seconds
322 -I, --ignore-times turn off mod time & file size quick check
323 --size-only ignore mod time for quick check (use size)
324 --modify-window=NUM compare mod times with reduced accuracy
325 -T --temp-dir=DIR create temporary files in directory DIR
326 --compare-dest=DIR also compare received files relative to DIR
327 --link-dest=DIR create hardlinks to DIR for unchanged files
328 -P equivalent to --partial --progress
329 -z, --compress compress file data
330 -C, --cvs-exclude auto ignore files in the same way CVS does
331 --exclude=PATTERN exclude files matching PATTERN
332 --exclude-from=FILE exclude patterns listed in FILE
333 --include=PATTERN don't exclude files matching PATTERN
334 --include-from=FILE don't exclude patterns listed in FILE
335 --files-from=FILE read FILE for list of source-file names
336 -0 --from0 all file lists are delimited by nulls
337 --version print version number
338 --daemon run as an rsync daemon
339 --no-detach do not detach from the parent
340 --address=ADDRESS bind to the specified address
341 --config=FILE specify alternate rsyncd.conf file
342 --port=PORT specify alternate rsyncd port number
343 --blocking-io use blocking I/O for the remote shell
344 --no-blocking-io turn off --blocking-io
345 --stats give some file transfer stats
346 --progress show progress during transfer
347 --log-format=FORMAT log file transfers using specified format
348 --password-file=FILE get password from FILE
349 --bwlimit=KBPS limit I/O bandwidth, KBytes per second
350 --write-batch=FILE write a batch to FILE
351 --read-batch=FILE read a batch from FILE
352 --checksum-seed=NUM set block/file checksum seed
353 -4 --ipv4 prefer IPv4
354 -6 --ipv6 prefer IPv6
355 -h, --help show this help screen
362 rsync uses the GNU long options package. Many of the command line
363 options have two variants, one short and one long. These are shown
364 below, separated by commas. Some options only have a long variant.
365 The '=' for options that take a parameter is optional; whitespace
369 dit(bf(-h, --help)) Print a short help page describing the options
372 dit(bf(--version)) print the rsync version number and exit
374 dit(bf(-v, --verbose)) This option increases the amount of information you
375 are given during the transfer. By default, rsync works silently. A
376 single -v will give you information about what files are being
377 transferred and a brief summary at the end. Two -v flags will give you
378 information on what files are being skipped and slightly more
379 information at the end. More than two -v flags should only be used if
380 you are debugging rsync.
382 dit(bf(-q, --quiet)) This option decreases the amount of information you
383 are given during the transfer, notably suppressing information messages
384 from the remote server. This flag is useful when invoking rsync from
387 dit(bf(-I, --ignore-times)) Normally rsync will skip any files that are
388 already the same size and have the same modification time-stamp.
389 This option turns off this "quick check" behavior.
391 dit(bf(--size-only)) Normally rsync will not transfer any files that are
392 already the same size and have the same modification time-stamp. With the
393 --size-only option, files will not be transferred if they have the same size,
394 regardless of timestamp. This is useful when starting to use rsync
395 after using another mirroring system which may not preserve timestamps
398 dit(bf(--modify-window)) When comparing two timestamps rsync treats
399 the timestamps as being equal if they are within the value of
400 modify_window. This is normally zero, but you may find it useful to
401 set this to a larger value in some situations. In particular, when
402 transferring to Windows FAT filesystems which cannot represent times
403 with a 1 second resolution --modify-window=1 is useful.
405 dit(bf(-c, --checksum)) This forces the sender to checksum all files using
406 a 128-bit MD4 checksum before transfer. The checksum is then
407 explicitly checked on the receiver and any files of the same name
408 which already exist and have the same checksum and size on the
409 receiver are not transferred. This option can be quite slow.
411 dit(bf(-a, --archive)) This is equivalent to -rlptgoD. It is a quick
412 way of saying you want recursion and want to preserve almost
415 Note however that bf(-a) bf(does not preserve hardlinks), because
416 finding multiply-linked files is expensive. You must separately
419 dit(bf(-r, --recursive)) This tells rsync to copy directories
420 recursively. If you don't specify this then rsync won't copy
423 dit(bf(-R, --relative)) Use relative paths. This means that the full path
424 names specified on the command line are sent to the server rather than
425 just the last parts of the filenames. This is particularly useful when
426 you want to send several different directories at the same time. For
427 example, if you used the command
429 verb(rsync foo/bar/foo.c remote:/tmp/)
431 then this would create a file called foo.c in /tmp/ on the remote
432 machine. If instead you used
434 verb(rsync -R foo/bar/foo.c remote:/tmp/)
436 then a file called /tmp/foo/bar/foo.c would be created on the remote
437 machine -- the full path name is preserved.
439 dit(bf(--no-relative)) Turn off the --relative option. This is only
440 needed if you want to use --files-from without its implied --relative
443 dit(bf(--no-implied-dirs)) When combined with the --relative option, the
444 implied directories in each path are not explicitly duplicated as part
445 of the transfer. This makes the transfer more optimal and also allows
446 the two sides to have non-matching symlinks in the implied part of the
447 path. For instance, if you transfer the file "/path/foo/file" with -R,
448 the default is for rsync to ensure that "/path" and "/path/foo" on the
449 destination exactly match the directories/symlinks of the source. Using
450 the --no-implied-dirs option would omit both of these implied dirs,
451 which means that if "/path" was a real directory on one machine and a
452 symlink of the other machine, rsync would not try to change this.
454 dit(bf(-b, --backup)) With this option, preexisting destination files are
455 renamed as each file is transferred or deleted. You can control where the
456 backup file goes and what (if any) suffix gets appended using the
457 --backup-dir and --suffix options.
459 dit(bf(--backup-dir=DIR)) In combination with the --backup option, this
460 tells rsync to store all backups in the specified directory. This is
461 very useful for incremental backups. You can additionally
462 specify a backup suffix using the --suffix option
463 (otherwise the files backed up in the specified directory
464 will keep their original filenames).
465 If DIR is a relative path, it is relative to the destination directory
466 (which changes in a recursive transfer).
468 dit(bf(--suffix=SUFFIX)) This option allows you to override the default
469 backup suffix used with the --backup (-b) option. The default suffix is a ~
470 if no --backup-dir was specified, otherwise it is an empty string.
472 dit(bf(-u, --update)) This forces rsync to skip any files for which the
473 destination file already exists and has a date later than the source
476 In the currently implementation, a difference of file format is always
477 considered to be important enough for an update, no matter what date
478 is on the objects. In other words, if the source has a directory or a
479 symlink where the destination has a file, the transfer would occur
480 regardless of the timestamps. This might change in the future (feel
481 free to comment on this on the mailing list if you have an opinion).
483 dit(bf(-K, --keep-dirlinks)) On the receiving side, if a symlink is
484 pointing to a directory, it will be treated as matching a directory
487 dit(bf(-l, --links)) When symlinks are encountered, recreate the
488 symlink on the destination.
490 dit(bf(-L, --copy-links)) When symlinks are encountered, the file that
491 they point to (the referent) is copied, rather than the symlink.
493 dit(bf(--copy-unsafe-links)) This tells rsync to copy the referent of
494 symbolic links that point outside the copied tree. Absolute symlinks
495 are also treated like ordinary files, and so are any symlinks in the
496 source path itself when --relative is used.
498 dit(bf(--safe-links)) This tells rsync to ignore any symbolic links
499 which point outside the copied tree. All absolute symlinks are
500 also ignored. Using this option in conjunction with --relative may
501 give unexpected results.
503 dit(bf(-H, --hard-links)) This tells rsync to recreate hard links on
504 the remote system to be the same as the local system. Without this
505 option hard links are treated like regular files.
507 Note that rsync can only detect hard links if both parts of the link
508 are in the list of files being sent.
510 This option can be quite slow, so only use it if you need it.
512 dit(bf(-W, --whole-file)) With this option the incremental rsync algorithm
513 is not used and the whole file is sent as-is instead. The transfer may be
514 faster if this option is used when the bandwidth between the source and
515 target machines is higher than the bandwidth to disk (especially when the
516 "disk" is actually a networked filesystem). This is the default when both
517 the source and target are on the local machine.
519 dit(bf(--no-whole-file)) Turn off --whole-file, for use when it is the
522 dit(bf(-p, --perms)) This option causes rsync to set the destination
523 permissions to be the same as the source permissions.
525 Without this option, each new file gets its permissions set based on the
526 source file's permissions and the umask at the receiving end, while all
527 other files (including updated files) retain their existing permissions
528 (which is the same behavior as other file-copy utilities, such as cp).
530 dit(bf(-o, --owner)) This option causes rsync to set the owner of the
531 destination file to be the same as the source file. On most systems,
532 only the super-user can set file ownership. By default, the preservation
533 is done by name, but may fall back to using the ID number in some
534 circumstances. See the --numeric-ids option for a full discussion.
536 dit(bf(-g, --group)) This option causes rsync to set the group of the
537 destination file to be the same as the source file. If the receiving
538 program is not running as the super-user, only groups that the
539 receiver is a member of will be preserved. By default, the preservation
540 is done by name, but may fall back to using the ID number in some
541 circumstances. See the --numeric-ids option for a full discussion.
543 dit(bf(-D, --devices)) This option causes rsync to transfer character and
544 block device information to the remote system to recreate these
545 devices. This option is only available to the super-user.
547 dit(bf(-t, --times)) This tells rsync to transfer modification times along
548 with the files and update them on the remote system. Note that if this
549 option is not used, the optimization that excludes files that have not been
550 modified cannot be effective; in other words, a missing -t or -a will
551 cause the next transfer to behave as if it used -I, and all files will have
552 their checksums compared and show up in log messages even if they haven't
555 dit(bf(-n, --dry-run)) This tells rsync to not do any file transfers,
556 instead it will just report the actions it would have taken.
558 dit(bf(-S, --sparse)) Try to handle sparse files efficiently so they take
559 up less space on the destination.
561 NOTE: Don't use this option when the destination is a Solaris "tmpfs"
562 filesystem. It doesn't seem to handle seeks over null regions
563 correctly and ends up corrupting the files.
565 dit(bf(-x, --one-file-system)) This tells rsync not to cross filesystem
566 boundaries when recursing. This is useful for transferring the
567 contents of only one filesystem.
569 dit(bf(--existing)) This tells rsync not to create any new files -
570 only update files that already exist on the destination.
572 dit(bf(--ignore-existing))
573 This tells rsync not to update files that already exist on
576 dit(bf(--max-delete=NUM)) This tells rsync not to delete more than NUM
577 files or directories. This is useful when mirroring very large trees
578 to prevent disasters.
580 dit(bf(--delete)) This tells rsync to delete any files on the receiving
581 side that aren't on the sending side. Files that are excluded from
582 transfer are excluded from being deleted unless you use --delete-excluded.
584 This option has no effect if directory recursion is not selected.
586 This option can be dangerous if used incorrectly! It is a very good idea
587 to run first using the dry run option (-n) to see what files would be
588 deleted to make sure important files aren't listed.
590 If the sending side detects any I/O errors then the deletion of any
591 files at the destination will be automatically disabled. This is to
592 prevent temporary filesystem failures (such as NFS errors) on the
593 sending side causing a massive deletion of files on the
594 destination. You can override this with the --ignore-errors option.
596 dit(bf(--delete-excluded)) In addition to deleting the files on the
597 receiving side that are not on the sending side, this tells rsync to also
598 delete any files on the receiving side that are excluded (see --exclude).
601 dit(bf(--delete-after)) By default rsync does file deletions on the
602 receiving side before transferring files to try to ensure that there is
603 sufficient space on the receiving filesystem. If you want to delete
604 after transferring, use the --delete-after switch. Implies --delete.
606 dit(bf(--ignore-errors)) Tells --delete to go ahead and delete files
607 even when there are I/O errors.
609 dit(bf(--force)) This options tells rsync to delete directories even if
610 they are not empty when they are to be replaced by non-directories. This
611 is only relevant without --delete because deletions are now done depth-first.
612 Requires the --recursive option (which is implied by -a) to have any effect.
614 dit(bf(-B, --block-size=BLOCKSIZE)) This controls the block size used in
615 the rsync algorithm. See the technical report for details.
617 dit(bf(-e, --rsh=COMMAND)) This option allows you to choose an alternative
618 remote shell program to use for communication between the local and
619 remote copies of rsync. Typically, rsync is configured to use ssh by
620 default, but you may prefer to use rsh on a local network.
622 If this option is used with bf([user@]host::module/path), then the
623 remote shell em(COMMAND) will be used to run an rsync server on the
624 remote host, and all data will be transmitted through that remote
625 shell connection, rather than through a direct socket connection to a
626 running rsync server on the remote host. See the section "CONNECTING
627 TO AN RSYNC SERVER OVER A REMOTE SHELL PROGRAM" above.
629 Command-line arguments are permitted in COMMAND provided that COMMAND is
630 presented to rsync as a single argument. For example:
632 quote(-e "ssh -p 2234")
634 (Note that ssh users can alternately customize site-specific connect
635 options in their .ssh/config file.)
637 You can also choose the remote shell program using the RSYNC_RSH
638 environment variable, which accepts the same range of values as -e.
640 See also the --blocking-io option which is affected by this option.
642 dit(bf(--rsync-path=PATH)) Use this to specify the path to the copy of
643 rsync on the remote machine. Useful when it's not in your path. Note
644 that this is the full path to the binary, not just the directory that
647 dit(bf(-C, --cvs-exclude)) This is a useful shorthand for excluding a
648 broad range of files that you often don't want to transfer between
649 systems. It uses the same algorithm that CVS uses to determine if
650 a file should be ignored.
652 The exclude list is initialized to:
654 quote(RCS SCCS CVS CVS.adm RCSLOG cvslog.* tags TAGS .make.state
655 .nse_depinfo *~ #* .#* ,* _$* *$ *.old *.bak *.BAK *.orig *.rej
656 .del-* *.a *.olb *.o *.obj *.so *.exe *.Z *.elc *.ln core .svn/)
658 then files listed in a $HOME/.cvsignore are added to the list and any
659 files listed in the CVSIGNORE environment variable (all cvsignore names
660 are delimited by whitespace).
662 Finally, any file is ignored if it is in the same directory as a
663 .cvsignore file and matches one of the patterns listed therein.
664 See the bf(cvs(1)) manual for more information.
666 dit(bf(--exclude=PATTERN)) This option allows you to selectively exclude
667 certain files from the list of files to be transferred. This is most
668 useful in combination with a recursive transfer.
670 You may use as many --exclude options on the command line as you like
671 to build up the list of files to exclude.
673 See the EXCLUDE PATTERNS section for detailed information on this option.
675 dit(bf(--exclude-from=FILE)) This option is similar to the --exclude
676 option, but instead it adds all exclude patterns listed in the file
677 FILE to the exclude list. Blank lines in FILE and lines starting with
678 ';' or '#' are ignored.
679 If em(FILE) is bf(-) the list will be read from standard input.
681 dit(bf(--include=PATTERN)) This option tells rsync to not exclude the
682 specified pattern of filenames. This is useful as it allows you to
683 build up quite complex exclude/include rules.
685 See the EXCLUDE PATTERNS section for detailed information on this option.
687 dit(bf(--include-from=FILE)) This specifies a list of include patterns
689 If em(FILE) is bf(-) the list will be read from standard input.
691 dit(bf(--files-from=FILE)) Using this option allows you to specify the
692 exact list of files to transfer (as read from the specified FILE or "-"
693 for stdin). It also tweaks the default behavior of rsync to make
694 transferring just the specified files and directories easier. For
695 instance, the --relative option is enabled by default when this option
696 is used (use --no-relative if you want to turn that off), all
697 directories specified in the list are created on the destination (rather
698 than being noisily skipped without -r), and the -a (--archive) option's
699 behavior does not imply -r (--recursive) -- specify it explicitly, if
702 The file names that are read from the FILE are all relative to the
703 source dir -- any leading slashes are removed and no ".." references are
704 allowed to go higher than the source dir. For example, take this
707 quote(rsync -a --files-from=/tmp/foo /usr remote:/backup)
709 If /tmp/foo contains the string "bin" (or even "/bin"), the /usr/bin
710 directory will be created as /backup/bin on the remote host (but the
711 contents of the /usr/bin dir would not be sent unless you specified -r
712 or the names were explicitly listed in /tmp/foo). Also keep in mind
713 that the effect of the (enabled by default) --relative option is to
714 duplicate only the path info that is read from the file -- it does not
715 force the duplication of the source-spec path (/usr in this case).
717 In addition, the --files-from file can be read from the remote host
718 instead of the local host if you specify a "host:" in front of the file
719 (the host must match one end of the transfer). As a short-cut, you can
720 specify just a prefix of ":" to mean "use the remote end of the
721 transfer". For example:
723 quote(rsync -a --files-from=:/path/file-list src:/ /tmp/copy)
725 This would copy all the files specified in the /path/file-list file that
726 was located on the remote "src" host.
728 dit(bf(-0, --from0)) This tells rsync that the filenames it reads from a
729 file are terminated by a null ('\0') character, not a NL, CR, or CR+LF.
730 This affects --exclude-from, --include-from, and --files-from.
731 It does not affect --cvs-exclude (since all names read from a .cvsignore
732 file are split on whitespace).
734 dit(bf(-T, --temp-dir=DIR)) This option instructs rsync to use DIR as a
735 scratch directory when creating temporary copies of the files
736 transferred on the receiving side. The default behavior is to create
737 the temporary files in the receiving directory.
739 dit(bf(--compare-dest=DIR)) This option instructs rsync to use DIR on
740 the destination machine as an additional directory to compare destination
741 files against when doing transfers if the files are missing in the
742 destination directory. This is useful for doing transfers to a new
743 destination while leaving existing files intact, and then doing a
744 flash-cutover when all files have been successfully transferred (for
745 example by moving directories around and removing the old directory,
746 although this skips files that haven't changed; see also --link-dest).
747 This option increases the usefulness of --partial because partially
748 transferred files will remain in the new temporary destination until they
749 have a chance to be completed. If DIR is a relative path, it is relative
750 to the destination directory (which changes in a recursive transfer).
752 dit(bf(--link-dest=DIR)) This option behaves like bf(--compare-dest) but
753 also will create hard links from em(DIR) to the destination directory for
754 unchanged files. Files with changed ownership or permissions will not be
756 Like bf(--compare-dest) if DIR is a relative path, it is relative
757 to the destination directory (which changes in a recursive transfer).
761 rsync -av --link-dest=$PWD/prior_dir host:src_dir/ new_dir/
764 dit(bf(-z, --compress)) With this option, rsync compresses any data from
765 the files that it sends to the destination machine. This
766 option is useful on slow connections. The compression method used is the
767 same method that gzip uses.
769 Note this this option typically achieves better compression ratios
770 that can be achieved by using a compressing remote shell, or a
771 compressing transport, as it takes advantage of the implicit
772 information sent for matching data blocks.
774 dit(bf(--numeric-ids)) With this option rsync will transfer numeric group
775 and user IDs rather than using user and group names and mapping them
778 By default rsync will use the username and groupname to determine
779 what ownership to give files. The special uid 0 and the special group
780 0 are never mapped via user/group names even if the --numeric-ids
781 option is not specified.
783 If a user or group has no name on the source system or it has no match
784 on the destination system, then the numeric ID
785 from the source system is used instead. See also the comments on the
786 "use chroot" setting in the rsyncd.conf manpage for information on how
787 the chroot setting affects rsync's ability to look up the names of the
788 users and groups and what you can do about it.
790 dit(bf(--timeout=TIMEOUT)) This option allows you to set a maximum I/O
791 timeout in seconds. If no data is transferred for the specified time
792 then rsync will exit. The default is 0, which means no timeout.
794 dit(bf(--daemon)) This tells rsync that it is to run as a daemon. The
795 daemon may be accessed using the bf(host::module) or
796 bf(rsync://host/module/) syntax.
798 If standard input is a socket then rsync will assume that it is being
799 run via inetd, otherwise it will detach from the current terminal and
800 become a background daemon. The daemon will read the config file
801 (rsyncd.conf) on each connect made by a client and respond to
802 requests accordingly. See the rsyncd.conf(5) man page for more
805 dit(bf(--no-detach)) When running as a daemon, this option instructs
806 rsync to not detach itself and become a background process. This
807 option is required when running as a service on Cygwin, and may also
808 be useful when rsync is supervised by a program such as
809 bf(daemontools) or AIX's bf(System Resource Controller).
810 bf(--no-detach) is also recommended when rsync is run under a
811 debugger. This option has no effect if rsync is run from inetd or
814 dit(bf(--address)) By default rsync will bind to the wildcard address
815 when run as a daemon with the --daemon option or when connecting to a
816 rsync server. The --address option allows you to specify a specific IP
817 address (or hostname) to bind to. This makes virtual hosting possible
818 in conjunction with the --config option.
820 dit(bf(--config=FILE)) This specifies an alternate config file than
821 the default. This is only relevant when --daemon is specified.
822 The default is /etc/rsyncd.conf unless the daemon is running over
823 a remote shell program and the remote user is not root; in that case
824 the default is rsyncd.conf in the current directory (typically $HOME).
826 dit(bf(--port=PORT)) This specifies an alternate TCP port number to use
827 rather than the default port 873.
829 dit(bf(--blocking-io)) This tells rsync to use blocking I/O when launching
830 a remote shell transport. If the remote shell is either rsh or remsh,
831 rsync defaults to using
832 blocking I/O, otherwise it defaults to using non-blocking I/O. (Note that
833 ssh prefers non-blocking I/O.)
835 dit(bf(--no-blocking-io)) Turn off --blocking-io, for use when it is the
838 dit(bf(--log-format=FORMAT)) This allows you to specify exactly what the
839 rsync client logs to stdout on a per-file basis. The log format is
840 specified using the same format conventions as the log format option in
843 dit(bf(--stats)) This tells rsync to print a verbose set of statistics
844 on the file transfer, allowing you to tell how effective the rsync
845 algorithm is for your data.
847 dit(bf(--partial)) By default, rsync will delete any partially
848 transferred file if the transfer is interrupted. In some circumstances
849 it is more desirable to keep partially transferred files. Using the
850 --partial option tells rsync to keep the partial file which should
851 make a subsequent transfer of the rest of the file much faster.
853 dit(bf(--progress)) This option tells rsync to print information
854 showing the progress of the transfer. This gives a bored user
856 Implies --verbose without incrementing verbosity.
858 When the file is transferring, the data looks like this:
861 782448 63% 110.64kB/s 0:00:04
864 This tells you the current file size, the percentage of the transfer that
865 is complete, the current calculated file-completion rate (including both
866 data over the wire and data being matched locally), and the estimated time
867 remaining in this transfer.
869 After the a file is complete, it the data looks like this:
872 1238099 100% 146.38kB/s 0:00:08 (5, 57.1% of 396)
875 This tells you the final file size, that it's 100% complete, the final
876 transfer rate for the file, the amount of elapsed time it took to transfer
877 the file, and the addition of a total-transfer summary in parentheses.
878 These additional numbers tell you how many files have been updated, and
879 what percent of the total number of files has been scanned.
881 dit(bf(-P)) The -P option is equivalent to --partial --progress. I
882 found myself typing that combination quite often so I created an
883 option to make it easier.
885 dit(bf(--password-file)) This option allows you to provide a password
886 in a file for accessing a remote rsync server. Note that this option
887 is only useful when accessing an rsync server using the built in
888 transport, not when using a remote shell as the transport. The file
889 must not be world readable. It should contain just the password as a
892 dit(bf(--bwlimit=KBPS)) This option allows you to specify a maximum
893 transfer rate in kilobytes per second. This option is most effective when
894 using rsync with large files (several megabytes and up). Due to the nature
895 of rsync transfers, blocks of data are sent, then if rsync determines the
896 transfer was too fast, it will wait before sending the next data block. The
897 result is an average transfer rate equaling the specified limit. A value
898 of zero specifies no limit.
900 dit(bf(--write-batch=FILE)) Record a file that can later be applied to
901 anonther identical destination with --read-batch. See the "BATCH MODE"
904 dit(bf(--read-batch=FILE)) Apply all of the changes stored in FILE, a
905 file previously generated by --write-batch. See the "BATCH MODE"
908 dit(bf(-4, --ipv4) or bf(-6, --ipv6)) Tells rsync to prefer IPv4/IPv6
909 when creating sockets. This only affects sockets that rsync has direct
910 control over, such as the outgoing socket when directly contacting an
911 rsync daemon, or the incoming sockets that an rsync daemon uses to
912 listen for connections. One of these options may be required in older
913 versions of Linux to work around an IPv6 bug in the kernel (if you see
914 an "address already in use" error when nothing else is using the port,
915 try specifying --ipv6 or --ipv4 when starting the daemon).
917 dit(bf(--checksum-seed=NUM)) Set the MD4 checksum seed to the integer
918 NUM. This 4 byte checksum seed is included in each block and file
919 MD4 checksum calculation. By default the checksum seed is generated
920 by the server and defaults to the current time(). This option
921 is used to set a specific checksum seed, which is useful for
922 applications that want repeatable block and file checksums, or
923 in the case where the user wants a more random checksum seed.
924 Note that setting NUM to 0 causes rsync to use the default of time()
929 manpagesection(EXCLUDE PATTERNS)
931 The exclude and include patterns specified to rsync allow for flexible
932 selection of which files to transfer and which files to skip.
934 Rsync builds an ordered list of include/exclude options as specified on
935 the command line. Rsync checks each file and directory
936 name against each exclude/include pattern in turn. The first matching
937 pattern is acted on. If it is an exclude pattern, then that file is
938 skipped. If it is an include pattern then that filename is not
939 skipped. If no matching include/exclude pattern is found then the
940 filename is not skipped.
942 The filenames matched against the exclude/include patterns are relative
943 to the "root of the transfer". If you think of the transfer as a
944 subtree of names that are being sent from sender to receiver, the root
945 is where the tree starts to be duplicated in the destination directory.
946 This root governs where patterns that start with a / match (see below).
948 Because the matching is relative to the transfer-root, changing the
949 trailing slash on a source path or changing your use of the --relative
950 option affects the path you need to use in your matching (in addition to
951 changing how much of the file tree is duplicated on the destination
952 system). The following examples demonstrate this.
954 Let's say that we want to match two source files, one with an absolute
955 path of "/home/me/foo/bar", and one with a path of "/home/you/bar/baz".
956 Here is how the various command choices differ for a 2-source transfer:
959 Example cmd: rsync -a /home/me /home/you /dest
960 +/- pattern: /me/foo/bar
961 +/- pattern: /you/bar/baz
962 Target file: /dest/me/foo/bar
963 Target file: /dest/you/bar/baz
965 Example cmd: rsync -a /home/me/ /home/you/ /dest
966 +/- pattern: /foo/bar (note missing "me")
967 +/- pattern: /bar/baz (note missing "you")
968 Target file: /dest/foo/bar
969 Target file: /dest/bar/baz
971 Example cmd: rsync -a --relative /home/me/ /home/you /dest
972 +/- pattern: /home/me/foo/bar (note full path)
973 +/- pattern: /home/you/bar/baz (ditto)
974 Target file: /dest/home/me/foo/bar
975 Target file: /dest/home/you/bar/baz
977 Example cmd: cd /home; rsync -a --relative me/foo you/ /dest
978 +/- pattern: /me/foo/bar (starts at specified path)
979 +/- pattern: /you/bar/baz (ditto)
980 Target file: /dest/me/foo/bar
981 Target file: /dest/you/bar/baz
984 The easiest way to see what name you should include/exclude is to just
985 look at the output when using --verbose and put a / in front of the name
986 (use the --dry-run option if you're not yet ready to copy any files).
988 Note that, when using the --recursive (-r) option (which is implied by -a),
989 every subcomponent of
990 every path is visited from the top down, so include/exclude patterns get
991 applied recursively to each subcomponent.
992 The exclude patterns actually short-circuit the directory traversal stage
993 when rsync finds the files to send. If a pattern excludes a particular
994 parent directory, it can render a deeper include pattern ineffectual
995 because rsync did not descend through that excluded section of the
998 Note also that the --include and --exclude options take one pattern
999 each. To add multiple patterns use the --include-from and
1000 --exclude-from options or multiple --include and --exclude options.
1002 The patterns can take several forms. The rules are:
1006 it() if the pattern starts with a / then it is matched against the
1007 start of the filename, otherwise it is matched against the end of
1009 This is the equivalent of a leading ^ in regular expressions.
1010 Thus "/foo" would match a file called "foo" at the transfer-root
1011 (see above for how this is different from the filesystem-root).
1012 On the other hand, "foo" would match any file called "foo"
1013 anywhere in the tree because the algorithm is applied recursively from
1014 top down; it behaves as if each path component gets a turn at being the
1015 end of the file name.
1017 it() if the pattern ends with a / then it will only match a
1018 directory, not a file, link, or device.
1020 it() if the pattern contains a wildcard character from the set
1021 *?[ then expression matching is applied using the shell filename
1022 matching rules. Otherwise a simple string match is used.
1024 it() the double asterisk pattern "**" will match slashes while a
1025 single asterisk pattern "*" will stop at slashes.
1027 it() if the pattern contains a / (not counting a trailing /) or a "**"
1028 then it is matched against the full filename, including any leading
1029 directory. If the pattern doesn't contain a / or a "**", then it is
1030 matched only against the final component of the filename. Again,
1031 remember that the algorithm is applied recursively so "full filename" can
1032 actually be any portion of a path below the starting directory.
1034 it() if the pattern starts with "+ " (a plus followed by a space)
1035 then it is always considered an include pattern, even if specified as
1036 part of an exclude option. The prefix is discarded before matching.
1038 it() if the pattern starts with "- " (a minus followed by a space)
1039 then it is always considered an exclude pattern, even if specified as
1040 part of an include option. The prefix is discarded before matching.
1042 it() if the pattern is a single exclamation mark ! then the current
1043 include/exclude list is reset, removing all previously defined patterns.
1046 The +/- rules are most useful in a list that was read from a file, allowing
1047 you to have a single exclude list that contains both include and exclude
1048 options in the proper order.
1050 Remember that the matching occurs at every step in the traversal of the
1051 directory hierarchy, so you must be sure that all the parent directories of
1052 the files you want to include are not excluded. This is particularly
1053 important when using a trailing '*' rule. For instance, this won't work:
1056 + /some/path/this-file-will-not-be-found
1061 This fails because the parent directory "some" is excluded by the '*' rule,
1062 so rsync never visits any of the files in the "some" or "some/path"
1063 directories. One solution is to ask for all directories in the hierarchy
1064 to be included by using a single rule: --include='*/' (put it somewhere
1065 before the --exclude='*' rule). Another solution is to add specific
1066 include rules for all the parent dirs that need to be visited. For
1067 instance, this set of rules works fine:
1072 + /some/path/this-file-is-found
1073 + /file-also-included
1077 Here are some examples of exclude/include matching:
1080 it() --exclude "*.o" would exclude all filenames matching *.o
1081 it() --exclude "/foo" would exclude a file called foo in the transfer-root directory
1082 it() --exclude "foo/" would exclude any directory called foo
1083 it() --exclude "/foo/*/bar" would exclude any file called bar two
1084 levels below a directory called foo in the transfer-root directory
1085 it() --exclude "/foo/**/bar" would exclude any file called bar two
1086 or more levels below a directory called foo in the transfer-root directory
1087 it() --include "*/" --include "*.c" --exclude "*" would include all
1088 directories and C source files
1089 it() --include "foo/" --include "foo/bar.c" --exclude "*" would include
1090 only foo/bar.c (the foo/ directory must be explicitly included or
1091 it would be excluded by the "*")
1094 manpagesection(BATCH MODE)
1096 bf(Note:) Batch mode should be considered experimental in this version
1097 of rsync. The interface or behavior may change before it stabilizes.
1099 Batch mode can be used to apply the same set of updates to many
1100 identical systems. Suppose one has a tree which is replicated on a
1101 number of hosts. Now suppose some changes have been made to this
1102 source tree and those changes need to be propagated to the other
1103 hosts. In order to do this using batch mode, rsync is run with the
1104 write-batch option to apply the changes made to the source tree to one
1105 of the destination trees. The write-batch option causes the rsync
1106 client to store in a "batch file" all the information needed to repeat
1107 this operation against other, identical destination trees.
1109 To apply the recorded changes to another destination tree, run rsync
1110 with the read-batch option, specifying the name of the same batch
1111 file, and the destination tree. Rsync updates the destination tree
1112 using the information stored in the batch file.
1114 For convenience, one additional file is creating when the write-batch
1115 option is used. This file's name is created by appending
1116 ".rsync_argvs" to the batch filename. The .rsync_argvs file contains
1117 a command-line suitable for updating a destination tree using that
1118 batch file. It can be executed using a Bourne(-like) shell, optionally
1119 passing in an alternate destination tree pathname which is then used
1120 instead of the original path. This is useful when the destination tree
1121 path differs from the original destination tree path.
1123 Generating the batch file once saves having to perform the file
1124 status, checksum, and data block generation more than once when
1125 updating multiple destination trees. Multicast transport protocols can
1126 be used to transfer the batch update files in parallel to many hosts
1127 at once, instead of sending the same data to every host individually.
1132 $ rsync --write-batch=batch -a /source/dir/ /adest/dir/
1133 $ rcp batch* remote:
1134 $ ssh remote rsync --read-batch=batch -a /bdest/dir/
1136 $ ssh remote ./batch.rsync_argvs /bdest/dir/
1139 In this example, rsync is used to update /adest/dir/ with /source/dir/
1140 and the information to repeat this operation is stored in "batch" and
1141 "batch.rsync_argvs". These files are then copied to the machine named
1142 "remote". Rsync is then invoked on "remote" to update /bdest/dir/ the
1143 same way as /adest/dir/. The last line shows the rsync_argvs file
1144 being used to invoke rsync.
1148 The read-batch option expects the destination tree it is meant to update
1149 to be identical to the destination tree that was used to create the
1150 batch update fileset. When a difference between the destination trees
1151 is encountered the update will fail at that point, leaving the
1152 destination tree in a partially updated state. In that case, rsync can
1153 be used in its regular (non-batch) mode of operation to fix up the
1156 The rsync version used on all destinations must be at least as new as the
1157 one used to generate the batch file.
1159 The -n/--dryrun option does not work in batch mode and yields a runtime
1162 You should use an equivalent set of options when reading a batch file that
1163 you used when generating it with a few exceptions. For instance
1164 --write-batch changes to --read-batch, --files-from is dropped, and the
1165 --include/--exclude options are not needed unless --delete is specified
1166 without --delete-excluded. Other options that affect how the update
1167 happens should generally remain the same as it is possible to confuse rsync
1168 into expecting a different data stream than the one that is contained in
1169 the batch file. For example, it would not work to change the setting of
1170 the -H or -c option, but it would work to add or remove the --delete
1173 See bf(http://www.ils.unc.edu/i2dsi/unc_rsync+.html) for papers and technical
1176 manpagesection(SYMBOLIC LINKS)
1178 Three basic behaviors are possible when rsync encounters a symbolic
1179 link in the source directory.
1181 By default, symbolic links are not transferred at all. A message
1182 "skipping non-regular" file is emitted for any symlinks that exist.
1184 If bf(--links) is specified, then symlinks are recreated with the same
1185 target on the destination. Note that bf(--archive) implies
1188 If bf(--copy-links) is specified, then symlinks are "collapsed" by
1189 copying their referent, rather than the symlink.
1191 rsync also distinguishes "safe" and "unsafe" symbolic links. An
1192 example where this might be used is a web site mirror that wishes
1193 ensure the rsync module they copy does not include symbolic links to
1194 bf(/etc/passwd) in the public section of the site. Using
1195 bf(--copy-unsafe-links) will cause any links to be copied as the file
1196 they point to on the destination. Using bf(--safe-links) will cause
1197 unsafe links to be omitted altogether.
1199 Symbolic links are considered unsafe if they are absolute symlinks
1200 (start with bf(/)), empty, or if they contain enough bf("..")
1201 components to ascend from the directory being copied.
1203 manpagesection(DIAGNOSTICS)
1205 rsync occasionally produces error messages that may seem a little
1206 cryptic. The one that seems to cause the most confusion is "protocol
1207 version mismatch - is your shell clean?".
1209 This message is usually caused by your startup scripts or remote shell
1210 facility producing unwanted garbage on the stream that rsync is using
1211 for its transport. The way to diagnose this problem is to run your
1212 remote shell like this:
1215 ssh remotehost /bin/true > out.dat
1218 then look at out.dat. If everything is working correctly then out.dat
1219 should be a zero length file. If you are getting the above error from
1220 rsync then you will probably find that out.dat contains some text or
1221 data. Look at the contents and try to work out what is producing
1222 it. The most common cause is incorrectly configured shell startup
1223 scripts (such as .cshrc or .profile) that contain output statements
1224 for non-interactive logins.
1226 If you are having trouble debugging include and exclude patterns, then
1227 try specifying the -vv option. At this level of verbosity rsync will
1228 show why each individual file is included or excluded.
1230 manpagesection(EXIT VALUES)
1234 dit(bf(1)) Syntax or usage error
1235 dit(bf(2)) Protocol incompatibility
1236 dit(bf(3)) Errors selecting input/output files, dirs
1237 dit(bf(4)) Requested action not supported: an attempt
1238 was made to manipulate 64-bit files on a platform that cannot support
1239 them; or an option was specified that is supported by the client and
1241 dit(bf(5)) Error starting client-server protocol
1242 dit(bf(10)) Error in socket I/O
1243 dit(bf(11)) Error in file I/O
1244 dit(bf(12)) Error in rsync protocol data stream
1245 dit(bf(13)) Errors with program diagnostics
1246 dit(bf(14)) Error in IPC code
1247 dit(bf(20)) Received SIGUSR1 or SIGINT
1248 dit(bf(21)) Some error returned by waitpid()
1249 dit(bf(22)) Error allocating core memory buffers
1250 dit(bf(23)) Partial transfer due to error
1251 dit(bf(24)) Partial transfer due to vanished source files
1252 dit(bf(30)) Timeout in data send/receive
1255 manpagesection(ENVIRONMENT VARIABLES)
1259 dit(bf(CVSIGNORE)) The CVSIGNORE environment variable supplements any
1260 ignore patterns in .cvsignore files. See the --cvs-exclude option for
1263 dit(bf(RSYNC_RSH)) The RSYNC_RSH environment variable allows you to
1264 override the default shell used as the transport for rsync. Command line
1265 options are permitted after the command name, just as in the -e option.
1267 dit(bf(RSYNC_PROXY)) The RSYNC_PROXY environment variable allows you to
1268 redirect your rsync client to use a web proxy when connecting to a
1269 rsync daemon. You should set RSYNC_PROXY to a hostname:port pair.
1271 dit(bf(RSYNC_PASSWORD)) Setting RSYNC_PASSWORD to the required
1272 password allows you to run authenticated rsync connections to an rsync
1273 daemon without user intervention. Note that this does not supply a
1274 password to a shell transport such as ssh.
1276 dit(bf(USER) or bf(LOGNAME)) The USER or LOGNAME environment variables
1277 are used to determine the default username sent to an rsync server.
1278 If neither is set, the username defaults to "nobody".
1280 dit(bf(HOME)) The HOME environment variable is used to find the user's
1281 default .cvsignore file.
1287 /etc/rsyncd.conf or rsyncd.conf
1293 manpagediagnostics()
1297 times are transferred as unix time_t values
1299 When transferring to FAT filesystems rsync may re-sync
1301 See the comments on the --modify-window option.
1303 file permissions, devices, etc. are transferred as native numerical
1306 see also the comments on the --delete option
1308 Please report bugs! See the website at
1309 url(http://rsync.samba.org/)(http://rsync.samba.org/)
1311 manpagesection(CREDITS)
1313 rsync is distributed under the GNU public license. See the file
1314 COPYING for details.
1316 A WEB site is available at
1317 url(http://rsync.samba.org/)(http://rsync.samba.org/). The site
1318 includes an FAQ-O-Matic which may cover questions unanswered by this
1321 The primary ftp site for rsync is
1322 url(ftp://rsync.samba.org/pub/rsync)(ftp://rsync.samba.org/pub/rsync).
1324 We would be delighted to hear from you if you like this program.
1326 This program uses the excellent zlib compression library written by
1327 Jean-loup Gailly and Mark Adler.
1329 manpagesection(THANKS)
1331 Thanks to Richard Brent, Brendan Mackay, Bill Waite, Stephen Rothwell
1332 and David Bell for helpful suggestions, patches and testing of rsync.
1333 I've probably missed some people, my apologies if I have.
1335 Especial thanks also to: David Dykstra, Jos Backus, Sebastian Krahmer,
1336 Martin Pool, Wayne Davison.
1340 rsync was originally written by Andrew Tridgell and Paul Mackerras.
1341 Many people have later contributed to it.
1343 Mailing lists for support and development are available at
1344 url(http://lists.samba.org)(lists.samba.org)