1 mailto(rsync-bugs@samba.org)
2 manpage(rsync)(1)(1 Mar 1999)()()
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]
20 rsync is a program that behaves in much the same way that rcp does,
21 but has many more options and uses the rsync remote-update protocol to
22 greatly speedup file transfers when the destination file already
25 The rsync remote-update protocol allows rsync to transfer just the
26 differences between two sets of files across the network link, using
27 an efficient checksum-search algorithm described in the technical
28 report that accompanies this package.
30 Some of the additional features of rsync are:
33 it() support for copying links, devices, owners, groups and permissions
34 it() exclude and exclude-from options similar to GNU tar
35 it() a CVS exclude mode for ignoring the same files that CVS would ignore
36 it() can use any transparent remote shell, including rsh or ssh
37 it() does not require root privileges
38 it() pipelining of file transfers to minimize latency costs
39 it() support for anonymous or authenticated rsync servers (ideal for
43 manpagesection(GENERAL)
45 There are six different ways of using rsync. They are:
48 it() for copying local files. This is invoked when neither
49 source nor destination path contains a : separator
51 it() for copying from the local machine to a remote machine using
52 a remote shell program as the transport (such as rsh or
53 ssh). This is invoked when the destination path contains a
56 it() for copying from a remote machine to the local machine
57 using a remote shell program. This is invoked when the source
58 contains a : separator.
60 it() for copying from a remote rsync server to the local
61 machine. This is invoked when the source path contains a ::
62 separator or a rsync:// URL.
64 it() for copying from the local machine to a remote rsync
65 server. This is invoked when the destination path contains a ::
68 it() for listing files on a remote machine. This is done the
69 same way as rsync transfers except that you leave off the
73 Note that in all cases (other than listing) at least one of the source
74 and destination paths must be local.
78 See the file README for installation instructions.
80 Once installed you can use rsync to any machine that you can use rsh
81 to. rsync uses rsh for its communications, unless both the source and
82 destination are local.
84 You can also specify an alternative to rsh, by either using the -e
85 command line option, or by setting the RSYNC_RSH environment variable.
87 One common substitute is to use ssh, which offers a high degree of
90 Note that rsync must be installed on both the source and destination
95 You use rsync in the same way you use rcp. You must specify a source
96 and a destination, one of which may be remote.
98 Perhaps the best way to explain the syntax is some examples:
100 quote(rsync *.c foo:src/)
102 this would transfer all files matching the pattern *.c from the
103 current directory to the directory src on the machine foo. If any of
104 the files already exist on the remote system then the rsync
105 remote-update protocol is used to update the file by sending only the
106 differences. See the tech report for details.
108 quote(rsync -avz foo:src/bar /data/tmp)
110 this would recursively transfer all files from the directory src/bar on the
111 machine foo into the /data/tmp/bar directory on the local machine. The
112 files are transferred in "archive" mode, which ensures that symbolic
113 links, devices, attributes, permissions, ownerships etc are preserved
114 in the transfer. Additionally, compression will be used to reduce the
115 size of data portions of the transfer.
117 quote(rsync -avz foo:src/bar/ /data/tmp)
119 a trailing slash on the source changes this behavior to transfer
120 all files from the directory src/bar on the machine foo into the
121 /data/tmp/. A trailing / on a source name means "copy the
122 contents of this directory". Without a trailing slash it means "copy
123 the directory". This difference becomes particularly important when
124 using the --delete option.
126 You can also use rsync in local-only mode, where both the source and
127 destination don't have a ':' in the name. In this case it behaves like
128 an improved copy command.
130 quote(rsync somehost.mydomain.com::)
132 this would list all the anonymous rsync modules available on the host
133 somehost.mydomain.com. (See the following section for more details.)
136 manpagesection(CONNECTING TO AN RSYNC SERVER)
138 It is also possible to use rsync without using rsh or ssh as the
139 transport. In this case you will connect to a remote rsync server
140 running on TCP port 873.
142 You may establish the connetcion via a web proxy by setting the
143 environment variable RSYNC_PROXY to a hostname:port pair pointing to
144 your web proxy. Note that your web proxy must allow proxying to port
145 873, this must be configured in your proxy servers ruleset.
147 Using rsync in this way is the same as using it with rsh or ssh except
151 it() you use a double colon :: instead of a single colon to
152 separate the hostname from the path.
154 it() the remote server may print a message of the day when you
157 it() if you specify no path name on the remote server then the
158 list of accessible paths on the server will be shown.
160 it() if you specify no local destination then a listing of the
161 specified files on the remote server is provided.
164 Some paths on the remote server may require authentication. If so then
165 you will receive a password prompt when you connect. You can avoid the
166 password prompt by setting the environment variable RSYNC_PASSWORD to
167 the password you want to use or using the --password-file option. This
168 may be useful when scripting rsync.
170 WARNING: On some systems environment variables are visible to all
171 users. On those systems using --password-file is recommended.
173 manpagesection(RUNNING AN RSYNC SERVER)
175 An rsync server is configured using a config file which by default is
176 called /etc/rsyncd.conf. Please see the rsyncd.conf(5) man page for more
179 manpagesection(EXAMPLES)
181 Here are some examples of how I use rsync.
183 To backup my wife's home directory, which consists of large MS Word
184 files and mail folders, I use a cron job that runs
186 quote(rsync -Cavz . arvidsjaur:backup)
188 each night over a PPP link to a duplicate directory on my machine
191 To synchronize my samba source trees I use the following Makefile
195 rsync -avuzb --exclude '*~' samba:samba/ .
198 rsync -Cavuzb . samba:samba/
202 this allows me to sync with a CVS directory at the other end of the
203 link. I then do cvs operations on the remote machine, which saves a
204 lot of time as the remote cvs protocol isn't very efficient.
206 I mirror a directory between my "old" and "new" ftp sites with the
209 quote(rsync -az -e ssh --delete ~ftp/pub/samba/ nimbus:"~ftp/pub/tridge/samba")
211 this is launched from cron every few hours.
213 manpagesection(OPTIONS SUMMARY)
215 Here is a short summary of the options available in rsync. Please refer
216 to the detailed description below for a complete description.
219 Usage: rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST
220 or rsync [OPTION]... [USER@]HOST:SRC DEST
221 or rsync [OPTION]... SRC [SRC]... DEST
222 or rsync [OPTION]... [USER@]HOST::SRC [DEST]
223 or rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST
224 or rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]
225 SRC on single-colon remote HOST will be expanded by remote shell
226 SRC on server remote HOST may contain shell wildcards or multiple
227 sources separated by space as long as they have same top-level
230 -v, --verbose increase verbosity
231 -q, --quiet decrease verbosity
232 -c, --checksum always checksum
233 -a, --archive archive mode
234 -r, --recursive recurse into directories
235 -R, --relative use relative path names
236 -b, --backup make backups (default ~ suffix)
237 --suffix=SUFFIX override backup suffix
238 -u, --update update only (don't overwrite newer files)
239 -l, --links preserve soft links
240 -L, --copy-links treat soft links like regular files
241 --copy-unsafe-links copy links outside the source tree
242 --safe-links ignore links outside the destination tree
243 -H, --hard-links preserve hard links
244 -p, --perms preserve permissions
245 -o, --owner preserve owner (root only)
246 -g, --group preserve group
247 -D, --devices preserve devices (root only)
248 -t, --times preserve times
249 -S, --sparse handle sparse files efficiently
250 -n, --dry-run show what would have been transferred
251 -W, --whole-file copy whole files, no incremental checks
252 -x, --one-file-system don't cross filesystem boundaries
253 -B, --block-size=SIZE checksum blocking size (default 700)
254 -e, --rsh=COMMAND specify rsh replacement
255 --rsync-path=PATH specify path to rsync on the remote machine
256 -C, --cvs-exclude auto ignore files in the same way CVS does
257 --delete delete files that don't exist on the sending side
258 --delete-excluded also delete excluded files on the receiving side
259 --partial keep partially transferred files
260 --force force deletion of directories even if not empty
261 --numeric-ids don't map uid/gid values by user/group name
262 --timeout=TIME set IO timeout in seconds
263 -I, --ignore-times don't exclude files that match length and time
264 --size-only only use file size when determining if a file should be transferred
265 -T --temp-dir=DIR create temporary files in directory DIR
266 --compare-dest=DIR also compare destination files relative to DIR
267 -P equivalent to --partial --progress
268 -z, --compress compress file data
269 --exclude=PATTERN exclude files matching PATTERN
270 --exclude-from=FILE exclude patterns listed in FILE
271 --include=PATTERN don't exclude files matching PATTERN
272 --include-from=FILE don't exclude patterns listed in FILE
273 --version print version number
274 --daemon run as a rsync daemon
275 --config=FILE specify alternate rsyncd.conf file
276 --port=PORT specify alternate rsyncd port number
277 --stats give some file transfer stats
278 --progress show progress during transfer
279 --log-format=FORMAT log file transfers using specified format
280 --password-file=FILE get password from FILE
281 -h, --help show this help screen
286 rsync uses the GNU long options package. Many of the command line
287 options have two variants, one short and one long. These are shown
288 below, separated by commas. Some options only have a long variant.
289 The '=' for options that take a parameter is optional; whitespace
293 dit(bf(-h, --help)) Print a short help page describing the options
296 dit(bf(--version)) print the rsync version number and exit
298 dit(bf(-v, --verbose)) This option increases the amount of information you
299 are given during the transfer. By default, rsync works silently. A
300 single -v will give you information about what files are being
301 transferred and a brief summary at the end. Two -v flags will give you
302 information on what files are being skipped and slightly more
303 information at the end. More than two -v flags should only be used if
304 you are debugging rsync.
306 dit(bf(-q, --quiet)) This option decreases the amount of information you
307 are given during the transfer, notably suppressing information messages
308 from the remote server. This flag is useful when invoking rsync from
311 dit(bf(-I, --ignore-times)) Normally rsync will skip any files that are
312 already the same length and have the same time-stamp. This option turns
315 dit(bf(-I, --size-only)) Normally rsync will skip any files that are
316 already the same length and have the same time-stamp. With the
317 --size-only option files will be skipped if they have the same size,
318 regardless of timestamp. This is useful when starting to use rsync
319 after using another mirroring system which may not preserve timestamps
322 dit(bf(-c, --checksum)) This forces the sender to checksum all files using
323 a 128-bit MD4 checksum before transfer. The checksum is then
324 explicitly checked on the receiver and any files of the same name
325 which already exist and have the same checksum and size on the
326 receiver are skipped. This option can be quite slow.
328 dit(bf(-a, --archive)) This is equivalent to -rlptg. It is a quick way
329 of saying you want recursion and want to preserve everything.
331 Note: if the user launching rsync is root then the -o (preserve
332 uid) and -D (preserve devices) options are also implied.
334 dit(bf(-r, --recursive)) This tells rsync to copy directories
335 recursively. If you don't specify this then rsync won't copy
338 dit(bf(-R, --relative)) Use relative paths. This means that the full path
339 names specified on the command line are sent to the server rather than
340 just the last parts of the filenames. This is particularly useful when
341 you want to send several different directories at the same time. For
342 example, if you used the command
344 verb(rsync foo/bar/foo.c remote:/tmp/)
346 then this would create a file called foo.c in /tmp/ on the remote
347 machine. If instead you used
349 verb(rsync -R foo/bar/foo.c remote:/tmp/)
351 then a file called /tmp/foo/bar/foo.c would be created on the remote
352 machine. The full path name is preserved.
354 dit(bf(-b, --backup)) With this option preexisting destination files are
355 renamed with a ~ extension as each file is transferred. You can
356 control the backup suffix using the --suffix option.
358 dit(bf(--suffix=SUFFIX)) This option allows you to override the default
359 backup suffix used with the -b option. The default is a ~.
361 dit(bf(-u, --update)) This forces rsync to skip any files for which the
362 destination file already exists and has a date later than the source
365 dit(bf(-l, --links)) This tells rsync to recreate symbolic links on the
366 remote system to be the same as the local system. Without this
367 option, all symbolic links are skipped.
369 dit(bf(-L, --copy-links)) This tells rsync to treat symbolic links just
372 dit(bf(--copy-unsafe-links)) This tells rsync to treat symbolic links that
373 point outside the source tree like ordinary files. Absolute symlinks are
374 also treated like ordinary files, and so are any symlinks in the source
375 path itself when --relative is used.
377 dit(bf(--safe-links)) This tells rsync to ignore any symbolic links
378 which point outside the destination tree. All absolute symlinks are
379 also ignored. Using this option in conjunction with --relative may
380 give unexpected results.
382 dit(bf(-H, --hard-links)) This tells rsync to recreate hard links on
383 the remote system to be the same as the local system. Without this
384 option hard links are treated like regular files.
386 Note that rsync can only detect hard links if both parts of the link
387 are in the list of files being sent.
389 This option can be quite slow, so only use it if you need it.
391 dit(bf(-W, --whole-file)) With this option the incremental rsync algorithm
392 is not used and the whole file is sent as-is instead. This may be
393 useful when using rsync with a local machine.
395 dit(bf(-p, --perms)) This option causes rsync to update the remote
396 permissions to be the same as the local permissions.
398 dit(bf(-o, --owner)) This option causes rsync to update the remote owner
399 of the file to be the same as the local owner. This is only available
400 to the super-user. Note that if the source system is a daemon using chroot,
401 the --numeric-ids option is implied because the source system cannot get
402 access to the usernames.
404 dit(bf(-g, --group)) This option causes rsync to update the remote group
405 of the file to be the same as the local group. If the receving system is
406 not running as the super-user, only groups that the receiver is a member of
407 will be preserved (by group name, not group id number).
409 dit(bf(-D, --devices)) This option causes rsync to transfer character and
410 block device information to the remote system to recreate these
411 devices. This option is only available to the super-user.
413 dit(bf(-t, --times)) This tells rsync to transfer modification times along
414 with the files and update them on the remote system. Note that if this
415 option is not used, the optimization that excludes files that have not been
416 modified cannot be effective; in other words, a missing -t or -a will
417 cause the next transfer to behave as if it used -I, and all files will have
418 their checksums compared and show up in log messages even if they haven't
421 dit(bf(-n, --dry-run)) This tells rsync to not do any file transfers,
422 instead it will just report the actions it would have taken.
424 dit(bf(-S, --sparse)) Try to handle sparse files efficiently so they take
425 up less space on the destination.
427 NOTE: Don't use this option when the destination is a Solaris "tmpfs"
428 filesystem. It doesn't seem to handle seeks over null regions
429 correctly and ends up corrupting the files.
431 dit(bf(-x, --one-file-system)) This tells rsync not to cross filesystem
432 boundaries when recursing. This is useful for transferring the
433 contents of only one filesystem.
435 dit(bf(--delete)) This tells rsync to delete any files on the receiving
436 side that aren't on the sending side. Files that are excluded from
437 transfer are excluded from being deleted unless you use --delete-excluded.
439 This option has no effect if directory recursion is not selected.
441 This option can be dangerous if used incorrectly! It is a very good idea
442 to run first using the dry run option (-n) to see what files would be
443 deleted to make sure important files aren't listed.
445 If the sending side detects any IO errors then the deletion of any
446 files at the destination will be automatically disabled. This is to
447 prevent temporary filesystem failures (such as NFS errors) on the
448 sending side causing a massive deletion of files on the
451 dit(bf(--delete-excluded)) In addition to deleting the files on the
452 receiving side that are not on the sending side, this tells rsync to also
453 delete any files on the receiving side that are excluded (see --exclude).
455 dit(bf(--force)) This options tells rsync to delete directories even if
456 they are not empty. This applies to both the --delete option and to
457 cases where rsync tries to copy a normal file but the destination
458 contains a directory of the same name.
460 Since this option was added, deletions were reordered to be done depth-first
461 so it is hardly ever needed anymore except in very obscure cases.
463 dit(bf(-B , --block_size=BLOCKSIZE)) This controls the block size used in
464 the rsync algorithm. See the technical report for details.
466 dit(bf(-e, --rsh=COMMAND)) This option allows you to choose an alternative
467 remote shell program to use for communication between the local and
468 remote copies of rsync. By default, rsync will use rsh, but you may
469 like to instead use ssh because of its high security.
471 You can also choose the remote shell program using the RSYNC_RSH
472 environment variable.
474 dit(bf(--rsync-path=PATH)) Use this to specify the path to the copy of
475 rsync on the remote machine. Useful when it's not in your path. Note
476 that this is the full path to the binary, not just the directory that
479 dit(bf(--exclude=PATTERN)) This option allows you to selectively exclude
480 certain files from the list of files to be transferred. This is most
481 useful in combination with a recursive transfer.
483 You may use as many --exclude options on the command line as you like
484 to build up the list of files to exclude.
486 See the section on exclude patterns for information on the syntax of
489 dit(bf(--exclude-from=FILE)) This option is similar to the --exclude
490 option, but instead it adds all filenames listed in the file FILE to
491 the exclude list. Blank lines in FILE and lines starting with ';' or '#'
494 dit(bf(--include=PATTERN)) This option tells rsync to not exclude the
495 specified pattern of filenames. This is useful as it allows you to
496 build up quite complex exclude/include rules.
498 See the section of exclude patterns for information on the syntax of
501 dit(bf(--include-from=FILE)) This specifies a list of include patterns
504 dit(bf(-C, --cvs-exclude)) This is a useful shorthand for excluding a
505 broad range of files that you often don't want to transfer between
506 systems. It uses the same algorithm that CVS uses to determine if
507 a file should be ignored.
509 The exclude list is initialized to:
511 quote(RCS SCCS CVS CVS.adm RCSLOG cvslog.* tags TAGS .make.state
512 .nse_depinfo *~ #* .#* ,* *.old *.bak *.BAK *.orig *.rej .del-*
513 *.a *.o *.obj *.so *.Z *.elc *.ln core)
515 then files listed in a $HOME/.cvsignore are added to the list and any
516 files listed in the CVSIGNORE environment variable (space delimited).
518 Finally in each directory any files listed in the .cvsignore file in
519 that directory are added to the list.
521 dit(bf(--csum-length=LENGTH)) By default the primary checksum used in
522 rsync is a very strong 16 byte MD4 checksum. In most cases you will
523 find that a truncated version of this checksum is quite efficient, and
524 this will decrease the size of the checksum data sent over the link,
525 making things faster.
527 You can choose the number of bytes in the truncated checksum using the
528 --csum-length option. Any value less than or equal to 16 is valid.
530 Note that if you use this option then you run the risk of ending up
531 with an incorrect target file. The risk with a value of 16 is
532 microscopic and can be safely ignored (the universe will probably end
533 before it fails) but with smaller values the risk is higher.
535 Current versions of rsync actually use an adaptive algorithm for the
536 checksum length by default, using a 16 byte file checksum to determine
537 if a 2nd pass is required with a longer block checksum. Only use this
538 option if you have read the source code and know what you are doing.
540 dit(bf(-T, --temp-dir=DIR)) This option instructs rsync to use DIR as a
541 scratch directory when creating temporary copies of the files
542 transferred on the receiving side. The default behavior is to create
543 the temporary files in the receiving directory.
545 dit(bf(--compare-dest=DIR)) This option instructs rsync to use DIR as an
546 additional directory to compare destination files against when doing
547 transfers. This is useful for doing transfers to a new destination while
548 leaving existing files intact, and then doing a flash-cutover when all
549 files have been successfully transferred (for example by moving directories
550 around and removing the old directory, although this requires also doing
551 the transfer with -I to avoid skipping files that haven't changed). This
552 option increases the usefulness of --partial because partially transferred
553 files will remain in the new temporary destination until they have a chance
554 to be completed. If DIR is a relative path, it is relative to the
555 destination directory.
557 dit(bf(-z, --compress)) With this option, rsync compresses any data from
558 the source file(s) which it sends to the destination machine. This
559 option is useful on slow links. The compression method used is the
560 same method that gzip uses.
562 Note this this option typically achieves better compression ratios
563 that can be achieved by using a compressing remote shell, or a
564 compressing transport, as it takes advantage of the implicit
565 information sent for matching data blocks.
567 dit(bf(--numeric-ids)) With this option rsync will transfer numeric group
568 and user ids rather than using user and group names and mapping them
571 By default rsync will use the user name and group name to determine
572 what ownership to give files. The special uid 0 and the special group
573 0 are never mapped via user/group names even if the --numeric-ids
574 option is not specified.
576 If the source system is a daemon using chroot, or if a user or group name
577 does not exist on the destination system, then the numeric id from the
578 source system is used instead.
580 dit(bf(--timeout=TIMEOUT)) This option allows you to set a maximum IO
581 timeout in seconds. If no data is transferred for the specified time
582 then rsync will exit. The default is 0, which means no timeout.
584 dit(bf(--daemon)) This tells rsync that it is to run as a rsync
585 daemon. If standard input is a socket then rsync will assume that it
586 is being run via inetd, otherwise it will detach from the current
587 terminal and become a background daemon. The daemon will read the
588 config file (/etc/rsyncd.conf) on each connect made by a client and
589 respond to requests accordingly. See the rsyncd.conf(5) man page for more
592 dit(bf(--config=FILE)) This specifies an alternate config file than
593 the default /etc/rsyncd.conf. This is only relevant when --daemon is
596 dit(bf(--port=PORT)) This specifies an alternate TCP port number to use
597 rather than the default port 873.
599 dit(bf(--log-format=FORMAT)) This allows you to specify exactly what the
600 rsync client logs to stdout on a per-file basis. The log format is
601 specified using the same format conventions as the log format option in
604 dit(bf(--stats)) This tells rsync to print a verbose set of statistics
605 on the file transfer, allowing you to tell how effective the rsync
606 algorithm is for your data.
608 dit(bf(--partial)) By default, rsync will delete any partially
609 transferred file if the transfer is interrupted. In some circumstances
610 it is more desirable to keep partially transferred files. Using the
611 --partial option tells rsync to keep the partial file which should
612 make a subsequent transfer of the rest of the file much faster.
614 dit(bf(--progress)) This option tells rsync to print information
615 showing the progress of the transfer. This gives a bored user
618 This option is normally combined with -v. Using this option without
619 the -v option will produce weird results on your display.
621 dit(bf(-P)) The -P option is equivalent to --partial --progress. I
622 found myself typing that combination quite often so I created an
623 option to make it easier.
625 dit(bf(--password-file)) This option allows you to provide a password
626 in a file for accessing a remote rsync server. Note that this option
627 is only useful when accessing a rsync server using the built in
628 transport, not when using a remote shell as the transport. The file
629 must not be world readable.
633 manpagesection(EXCLUDE PATTERNS)
635 The exclude and include patterns specified to rsync allow for flexible
636 selection of which files to transfer and which files to skip.
638 rsync builds a ordered list of include/exclude options as specified on
639 the command line. When a filename is encountered, rsync checks the
640 name against each exclude/include pattern in turn. The first matching
641 pattern is acted on. If it is an exclude pattern than that file is
642 skipped. If it is an include pattern then that filename is not
643 skipped. If no matching include/exclude pattern is found then the
644 filename is not skipped.
646 The patterns can take several forms. The rules are:
649 it() if the pattern starts with a / then it is matched against the
650 start of the filename, otherwise it is matched against the end of
651 the filename. Thus /foo would match a file called foo
652 at the base of the tree whereas foo would match any file
653 called foo anywhere in the tree.
655 it() if the pattern ends with a / then it will only match a
656 directory, not a file, link or device.
658 it() if the pattern contains a wildcard character from the set
659 *?[ then expression matching is applied using the shell filename
660 matching rules. Otherwise a simple string match is used.
662 it() if the pattern contains a / (not counting a trailing /) then it
663 is matched against the full filename, including any leading
664 directory. If the pattern doesn't contain a / then it is matched
665 only against the final component of the filename. Furthermore, if
666 the pattern includes a double asterisk "**" then all wildcards in
667 the pattern will match slashes, otherwise they will stop at slashes.
669 it() if the pattern starts with "+ " (a plus followed by a space)
670 then it is always considered an include pattern, even if specified as
671 part of an exclude option. The "+ " part is discarded before matching.
673 it() if the pattern starts with "- " (a minus followed by a space)
674 then it is always considered an exclude pattern, even if specified as
675 part of an include option. The "- " part is discarded before matching.
677 it() if the pattern is a single exclamation mark ! then the current
678 exclude list is reset, removing all previous exclude patterns.
681 The +/- rules are most useful in exclude lists, allowing you to have a
682 single exclude list that contains both include and exclude options.
684 Here are some examples:
687 it() --exclude "*.o" would exclude all filenames matching *.o
688 it() --exclude "/foo" would exclude a file in the base directory called foo
689 it() --exclude "foo/" would exclude any directory called foo
690 it() --exclude "/foo/*/bar" would exclude any file called bar two
691 levels below a base directory called foo
692 it() --exclude "/foo/**/bar" would exclude any file called bar two
693 or more levels below a base directory called foo
694 it() --include "*/" --include "*.c" --exclude "*" would include all
695 directories and C source files
696 it() --include "foo/" --include "foo/bar.c" --exclude "*" would include
697 only foo/bar.c (the foo/ directory must be explicitly included or
698 it would be excluded by the "*")
701 manpagesection(DIAGNOSTICS)
703 rsync occasionally produces error messages that may seem a little
704 cryptic. The one that seems to cause the most confusion is "protocol
705 version mismatch - is your shell clean?".
707 This message is usually caused by your startup scripts or remote shell
708 facility producing unwanted garbage on the stream that rsync is using
709 for its transport. The way to diagnose this problem is to run your
710 remote shell like this:
713 rsh remotehost /bin/true > out.dat
716 then look at out.dat. If everything is working correctly then out.dat
717 should be a zero length file. If you are getting the above error from
718 rsync then you will probably find that out.dat contains some text or
719 data. Look at the contents and try to work out what is producing
720 it. The most common cause is incorrectly configured shell startup
721 scripts (such as .cshrc or .profile) that contain output statements
722 for non-interactive logins.
724 manpagesection(ENVIRONMENT VARIABLES)
728 dit(bf(CVSIGNORE)) The CVSIGNORE environment variable supplements any
729 ignore patterns in .cvsignore files. See the --cvs-exclude option for
732 dit(bf(RSYNC_RSH)) The RSYNC_RSH environment variable allows you to
733 override the default shell used as the transport for rsync. This can
734 be used instead of the -e option.
736 dit(bf(RSYNC_PROXY)) The RSYNC_PROXY environment variable allows you to
737 redirect your rsync client to use a web proxy when connecting to a
738 rsync daemon. You should set RSYNC_PROXY to a hostname:port pair.
740 dit(bf(RSYNC_PASSWORD)) Setting RSYNC_PASSWORD to the required
741 password allows you to run authenticated rsync connections to a rsync
742 daemon without user intervention. Note that this does not supply a
743 password to a shell transport such as ssh.
745 dit(bf(USER) or bf(LOGNAME)) The USER or LOGNAME environment variables
746 are used to determine the default username sent to a rsync server.
748 dit(bf(HOME)) The HOME environment variable is used to find the user's
749 default .cvsignore file.
765 times are transferred as unix time_t values
767 file permissions, devices etc are transferred as native numerical
770 see also the comments on the --delete option
772 Please report bugs! The rsync bug tracking system is online at
773 url(http://rsync.samba.org/rsync/)(http://rsync.samba.org/rsync/)
775 manpagesection(VERSION)
776 This man page is current for version 2.0 of rsync
778 manpagesection(CREDITS)
780 rsync is distributed under the GNU public license. See the file
783 A WEB site is available at
784 url(http://rsync.samba.org/)(http://rsync.samba.org/)
786 The primary ftp site for rsync is
787 url(ftp://rsync.samba.org/pub/rsync)(ftp://rsync.samba.org/pub/rsync).
789 We would be delighted to hear from you if you like this program.
791 This program uses the excellent zlib compression library written by
792 Jean-loup Gailly and Mark Adler.
794 manpagesection(THANKS)
796 Thanks to Richard Brent, Brendan Mackay, Bill Waite, Stephen Rothwell
797 and David Bell for helpful suggestions and testing of rsync. I've
798 probably missed some people, my apologies if I have.
803 rsync was written by Andrew Tridgell and Paul Mackerras. They may be
804 contacted via email at tridge@samba.org and
805 Paul.Mackerras@cs.anu.edu.au