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 Using rsync in this way is the same as using it with rsh or ssh except
146 it() you use a double colon :: instead of a single colon to
147 separate the hostname from the path.
149 it() the remote server may print a message of the day when you
152 it() if you specify no path name on the remote server then the
153 list of accessible paths on the server will be shown.
155 it() if you specify no local destination then a listing of the
156 specified files on the remote server is provided.
159 Some paths on the remote server may require authentication. If so then
160 you will receive a password prompt when you connect. You can avoid the
161 password prompt by setting the environment variable RSYNC_PASSWORD to
162 the password you want to use or using the --password-file option. This
163 may be useful when scripting rsync.
165 WARNING: On some systems environment variables are visible to all
166 users. On those systems using --password-file is recommended.
168 manpagesection(RUNNING AN RSYNC SERVER)
170 An rsync server is configured using a config file which by default is
171 called /etc/rsyncd.conf. Please see the rsyncd.conf(5) man page for more
174 manpagesection(EXAMPLES)
176 Here are some examples of how I use rsync.
178 To backup my wife's home directory, which consists of large MS Word
179 files and mail folders, I use a cron job that runs
181 quote(rsync -Cavz . arvidsjaur:backup)
183 each night over a PPP link to a duplicate directory on my machine
186 To synchronize my samba source trees I use the following Makefile
190 rsync -avuzb --exclude '*~' samba:samba/ .
193 rsync -Cavuzb . samba:samba/
197 this allows me to sync with a CVS directory at the other end of the
198 link. I then do cvs operations on the remote machine, which saves a
199 lot of time as the remote cvs protocol isn't very efficient.
201 I mirror a directory between my "old" and "new" ftp sites with the
204 quote(rsync -az -e ssh --delete ~ftp/pub/samba/ nimbus:"~ftp/pub/tridge/samba")
206 this is launched from cron every few hours.
208 manpagesection(OPTIONS SUMMARY)
210 Here is a short summary of the options available in rsync. Please refer
211 to the detailed description below for a complete description.
214 Usage: rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST
215 or rsync [OPTION]... [USER@]HOST:SRC DEST
216 or rsync [OPTION]... SRC [SRC]... DEST
217 or rsync [OPTION]... [USER@]HOST::SRC [DEST]
218 or rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST
219 or rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]
220 SRC on single-colon remote HOST will be expanded by remote shell
221 SRC on server remote HOST may contain shell wildcards or multiple
222 sources separated by space as long as they have same top-level
225 -v, --verbose increase verbosity
226 -q, --quiet decrease verbosity
227 -c, --checksum always checksum
228 -a, --archive archive mode
229 -r, --recursive recurse into directories
230 -R, --relative use relative path names
231 -b, --backup make backups (default ~ suffix)
232 --suffix=SUFFIX override backup suffix
233 -u, --update update only (don't overwrite newer files)
234 -l, --links preserve soft links
235 -L, --copy-links treat soft links like regular files
236 --copy-unsafe-links copy links outside the source tree
237 --safe-links ignore links outside the destination tree
238 -H, --hard-links preserve hard links
239 -p, --perms preserve permissions
240 -o, --owner preserve owner (root only)
241 -g, --group preserve group
242 -D, --devices preserve devices (root only)
243 -t, --times preserve times
244 -S, --sparse handle sparse files efficiently
245 -n, --dry-run show what would have been transferred
246 -W, --whole-file copy whole files, no incremental checks
247 -x, --one-file-system don't cross filesystem boundaries
248 -B, --block-size=SIZE checksum blocking size (default 700)
249 -e, --rsh=COMMAND specify rsh replacement
250 --rsync-path=PATH specify path to rsync on the remote machine
251 -C, --cvs-exclude auto ignore files in the same way CVS does
252 --delete delete files that don't exist on the sending side
253 --delete-excluded also delete excluded files on the receiving side
254 --partial keep partially transferred files
255 --force force deletion of directories even if not empty
256 --numeric-ids don't map uid/gid values by user/group name
257 --timeout=TIME set IO timeout in seconds
258 -I, --ignore-times don't exclude files that match length and time
259 --size-only only use file size when determining if a file should be transferred
260 -T --temp-dir=DIR create temporary files in directory DIR
261 --compare-dest=DIR also compare destination files relative to DIR
262 -z, --compress compress file data
263 --exclude=PATTERN exclude files matching PATTERN
264 --exclude-from=FILE exclude patterns listed in FILE
265 --include=PATTERN don't exclude files matching PATTERN
266 --include-from=FILE don't exclude patterns listed in FILE
267 --version print version number
268 --daemon run as a rsync daemon
269 --config=FILE specify alternate rsyncd.conf file
270 --port=PORT specify alternate rsyncd port number
271 --stats give some file transfer stats
272 --progress show progress during transfer
273 --log-format=FORMAT log file transfers using specified format
274 --password-file=FILE get password from FILE
275 -h, --help show this help screen
280 rsync uses the GNU long options package. Many of the command line
281 options have two variants, one short and one long. These are shown
282 below, separated by commas. Some options only have a long variant.
283 The '=' for options that take a parameter is optional; whitespace
287 dit(bf(-h, --help)) Print a short help page describing the options
290 dit(bf(--version)) print the rsync version number and exit
292 dit(bf(-v, --verbose)) This option increases the amount of information you
293 are given during the transfer. By default, rsync works silently. A
294 single -v will give you information about what files are being
295 transferred and a brief summary at the end. Two -v flags will give you
296 information on what files are being skipped and slightly more
297 information at the end. More than two -v flags should only be used if
298 you are debugging rsync.
300 dit(bf(-q, --quiet)) This option decreases the amount of information you
301 are given during the transfer, notably suppressing information messages
302 from the remote server. This flag is useful when invoking rsync from
305 dit(bf(-I, --ignore-times)) Normally rsync will skip any files that are
306 already the same length and have the same time-stamp. This option turns
309 dit(bf(-I, --size-only)) Normally rsync will skip any files that are
310 already the same length and have the same time-stamp. With the
311 --size-only option files will be skipped if they have the same size,
312 regardless of timestamp. This is useful when starting to use rsync
313 after using another mirroring system which may not preserve timestamps
316 dit(bf(-c, --checksum)) This forces the sender to checksum all files using
317 a 128-bit MD4 checksum before transfer. The checksum is then
318 explicitly checked on the receiver and any files of the same name
319 which already exist and have the same checksum and size on the
320 receiver are skipped. This option can be quite slow.
322 dit(bf(-a, --archive)) This is equivalent to -rlptg. It is a quick way
323 of saying you want recursion and want to preserve everything.
325 Note: if the user launching rsync is root then the -o (preserve
326 uid) and -D (preserve devices) options are also implied.
328 dit(bf(-r, --recursive)) This tells rsync to copy directories
329 recursively. If you don't specify this then rsync won't copy
332 dit(bf(-R, --relative)) Use relative paths. This means that the full path
333 names specified on the command line are sent to the server rather than
334 just the last parts of the filenames. This is particularly useful when
335 you want to send several different directories at the same time. For
336 example, if you used the command
338 verb(rsync foo/bar/foo.c remote:/tmp/)
340 then this would create a file called foo.c in /tmp/ on the remote
341 machine. If instead you used
343 verb(rsync -R foo/bar/foo.c remote:/tmp/)
345 then a file called /tmp/foo/bar/foo.c would be created on the remote
346 machine. The full path name is preserved.
348 dit(bf(-b, --backup)) With this option preexisting destination files are
349 renamed with a ~ extension as each file is transferred. You can
350 control the backup suffix using the --suffix option.
352 dit(bf(--suffix=SUFFIX)) This option allows you to override the default
353 backup suffix used with the -b option. The default is a ~.
355 dit(bf(-u, --update)) This forces rsync to skip any files for which the
356 destination file already exists and has a date later than the source
359 dit(bf(-l, --links)) This tells rsync to recreate symbolic links on the
360 remote system to be the same as the local system. Without this
361 option, all symbolic links are skipped.
363 dit(bf(-L, --copy-links)) This tells rsync to treat symbolic links just
366 dit(bf(--copy-unsafe-links)) This tells rsync to treat symbolic links that
367 point outside the source tree like ordinary files. Absolute symlinks are
368 also treated like ordinary files, and so are any symlinks in the source
369 path itself when --relative is used.
371 dit(bf(--safe-links)) This tells rsync to ignore any symbolic links
372 which point outside the destination tree. All absolute symlinks are
373 also ignored. Using this option in conjunction with --relative may
374 give unexpected results.
376 dit(bf(-H, --hard-links)) This tells rsync to recreate hard links on
377 the remote system to be the same as the local system. Without this
378 option hard links are treated like regular files.
380 Note that rsync can only detect hard links if both parts of the link
381 are in the list of files being sent.
383 This option can be quite slow, so only use it if you need it.
385 dit(bf(-W, --whole-file)) With this option the incremental rsync algorithm
386 is not used and the whole file is sent as-is instead. This may be
387 useful when using rsync with a local machine.
389 dit(bf(--partial)) By default, rsync will delete any partially
390 transferred file if the transfer is interrupted. In some circumstances
391 it is more desirable to keep partially transferred files. Using the
392 --partial option tells rsync to keep the partial file which should
393 make a subsequent transfer of the rest of the file much faster.
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 rsync 1.6.4 changed the behavior of --delete to make it less
446 dangerous. rsync now only scans directories on the receiving side
447 that are explicitly transferred from the sending side. Only files in
448 these directories are deleted.
450 Still, it is probably easy to get burnt with this option. The moral
451 of the story is to use the -n option until you get used to the
452 behavior of --delete.
454 If the sending side detects any IO errors then the deletion of any
455 files at the destination will be automatically disabled. This is to
456 prevent temporary filesystem failures (such as NFS errors) on the
457 sending side causing a massive deletion of files on the
460 dit(bf(--delete-excluded)) In addition to deleting the files on the
461 receiving side that are not on the sending side, this tells rsync to also
462 delete any files on the receiving side that are excluded (see --exclude).
464 dit(bf(--force)) This options tells rsync to delete directories even if
465 they are not empty. This applies to both the --delete option and to
466 cases where rsync tries to copy a normal file but the destination
467 contains a directory of the same name.
469 Since this option was added, deletions were reordered to be done depth-first
470 so it is hardly ever needed anymore except in very obscure cases.
472 dit(bf(-B , --block_size=BLOCKSIZE)) This controls the block size used in
473 the rsync algorithm. See the technical report for details.
475 dit(bf(-e, --rsh=COMMAND)) This option allows you to choose an alternative
476 remote shell program to use for communication between the local and
477 remote copies of rsync. By default, rsync will use rsh, but you may
478 like to instead use ssh because of its high security.
480 You can also choose the remote shell program using the RSYNC_RSH
481 environment variable.
483 dit(bf(--rsync-path=PATH)) Use this to specify the path to the copy of
484 rsync on the remote machine. Useful when it's not in your path.
486 dit(bf(--exclude=PATTERN)) This option allows you to selectively exclude
487 certain files from the list of files to be transferred. This is most
488 useful in combination with a recursive transfer.
490 You may use as many --exclude options on the command line as you like
491 to build up the list of files to exclude.
493 See the section on exclude patterns for information on the syntax of
496 dit(bf(--exclude-from=FILE)) This option is similar to the --exclude
497 option, but instead it adds all filenames listed in the file FILE to
498 the exclude list. Blank lines in FILE and lines starting with ';' or '#'
501 dit(bf(--include=PATTERN)) This option tells rsync to not exclude the
502 specified pattern of filenames. This is useful as it allows you to
503 build up quite complex exclude/include rules.
505 See the section of exclude patterns for information on the syntax of
508 dit(bf(--include-from=FILE)) This specifies a list of include patterns
511 dit(bf(-C, --cvs-exclude)) This is a useful shorthand for excluding a
512 broad range of files that you often don't want to transfer between
513 systems. It uses the same algorithm that CVS uses to determine if
514 a file should be ignored.
516 The exclude list is initialized to:
518 quote(RCS SCCS CVS CVS.adm RCSLOG cvslog.* tags TAGS .make.state
519 .nse_depinfo *~ #* .#* ,* *.old *.bak *.BAK *.orig *.rej .del-*
520 *.a *.o *.obj *.so *.Z *.elc *.ln core)
522 then files listed in a $HOME/.cvsignore are added to the list and any
523 files listed in the CVSIGNORE environment variable (space delimited).
525 Finally in each directory any files listed in the .cvsignore file in
526 that directory are added to the list.
528 dit(bf(--csum-length=LENGTH)) By default the primary checksum used in
529 rsync is a very strong 16 byte MD4 checksum. In most cases you will
530 find that a truncated version of this checksum is quite efficient, and
531 this will decrease the size of the checksum data sent over the link,
532 making things faster.
534 You can choose the number of bytes in the truncated checksum using the
535 --csum-length option. Any value less than or equal to 16 is valid.
537 Note that if you use this option then you run the risk of ending up
538 with an incorrect target file. The risk with a value of 16 is
539 microscopic and can be safely ignored (the universe will probably end
540 before it fails) but with smaller values the risk is higher.
542 Current versions of rsync actually use an adaptive algorithm for the
543 checksum length by default, using a 16 byte file checksum to determine
544 if a 2nd pass is required with a longer block checksum. Only use this
545 option if you have read the source code and know what you are doing.
547 dit(bf(-T, --temp-dir=DIR)) This option instructs rsync to use DIR as a
548 scratch directory when creating temporary copies of the files
549 transferred on the receiving side. The default behavior is to create
550 the temporary files in the receiving directory.
552 dit(bf(--compare-dest=DIR)) This option instructs rsync to use DIR as an
553 additional directory to compare destination files against when doing
554 transfers. This is useful for doing transfers to a new destination while
555 leaving existing files intact, and then doing a flash-cutover when all
556 files have been successfully transferred (for example by moving directories
557 around and removing the old directory, although this requires also doing
558 the transfer with -I to avoid skipping files that haven't changed). This
559 option increases the usefulness of --partial because partially transferred
560 files will remain in the new temporary destination until they have a chance
561 to be completed. If DIR is a relative path, it is relative to the
562 destination directory.
564 dit(bf(-z, --compress)) With this option, rsync compresses any data from
565 the source file(s) which it sends to the destination machine. This
566 option is useful on slow links. The compression method used is the
567 same method that gzip uses.
569 Note this this option typically achieves better compression ratios
570 that can be achieved by using a compressing remote shell, or a
571 compressing transport, as it takes advantage of the implicit
572 information sent for matching data blocks.
574 dit(bf(--numeric-ids)) With this option rsync will transfer numeric group
575 and user ids rather than using user and group names and mapping them
578 By default rsync will use the user name and group name to determine
579 what ownership to give files. The special uid 0 and the special group
580 0 are never mapped via user/group names even if the --numeric-ids
581 option is not specified.
583 If the source system is a daemon using chroot, or if a user or group name
584 does not exist on the destination system, then the numeric id from the
585 source system is used instead.
587 dit(bf(--timeout=TIMEOUT)) This option allows you to set a maximum IO
588 timeout in seconds. If no data is transferred for the specified time
589 then rsync will exit. The default is 0, which means no timeout.
591 dit(bf(--daemon)) This tells rsync that it is to run as a rsync
592 daemon. If standard input is a socket then rsync will assume that it
593 is being run via inetd, otherwise it will detach from the current
594 terminal and become a background daemon. The daemon will read the
595 config file (/etc/rsyncd.conf) on each connect made by a client and
596 respond to requests accordingly. See the rsyncd.conf(5) man page for more
599 dit(bf(--config=FILE)) This specifies an alternate config file than
600 the default /etc/rsyncd.conf. This is only relevant when --daemon is
603 dit(bf(--port=PORT)) This specifies an alternate TCP port number to use
604 rather than the default port 873.
606 dit(bf(--log-format=FORMAT)) This allows you to specify exactly what the
607 rsync client logs to stdout on a per-file basis. The log format is
608 specified using the same format conventions as the log format option in
611 dit(bf(--stats)) This tells rsync to print a verbose set of statistics
612 on the file transfer, allowing you to tell how effective the rsync
613 algorithm is for your data.
615 dit(bf(--progress)) This option tells rsync to print information
616 showing the progress of the transfer. This gives a bored user
619 dit(bf(--password-file)) This option allows you to provide a password
620 in a file for accessing a remote rsync server. Note that this option
621 is only useful when accessing a rsync server using the built in
622 transport, not when using a remote shell as the transport. The file
623 must not be world readable.
627 manpagesection(EXCLUDE PATTERNS)
629 The exclude and include patterns specified to rsync allow for flexible
630 selection of which files to transfer and which files to skip.
632 rsync builds a ordered list of include/exclude options as specified on
633 the command line. When a filename is encountered, rsync checks the
634 name against each exclude/include pattern in turn. The first matching
635 pattern is acted on. If it is an exclude pattern than that file is
636 skipped. If it is an include pattern then that filename is not
637 skipped. If no matching include/exclude pattern is found then the
638 filename is not skipped.
640 The patterns can take several forms. The rules are:
643 it() if the pattern starts with a / then it is matched against the
644 start of the filename, otherwise it is matched against the end of
645 the filename. Thus /foo would match a file called foo
646 at the base of the tree whereas foo would match any file
647 called foo anywhere in the tree.
649 it() if the pattern ends with a / then it will only match a
650 directory, not a file, link or device.
652 it() if the pattern contains a wildcard character from the set
653 *?[ then expression matching is applied using the shell filename
654 matching rules. Otherwise a simple string match is used.
656 it() if the pattern contains a / (not counting a trailing /) then it
657 is matched against the full filename, including any leading
658 directory. If the pattern doesn't contain a / then it is matched
659 only against the final component of the filename. Furthermore, if
660 the pattern includes a double asterisk "**" then all wildcards in
661 the pattern will match slashes, otherwise they will stop at slashes.
663 it() if the pattern starts with "+ " (a plus followed by a space)
664 then it is always considered an include pattern, even if specified as
665 part of an exclude option. The "+ " part is discarded before matching.
667 it() if the pattern starts with "- " (a minus followed by a space)
668 then it is always considered an exclude pattern, even if specified as
669 part of an include option. The "- " part is discarded before matching.
671 it() if the pattern is a single exclamation mark ! then the current
672 exclude list is reset, removing all previous exclude patterns.
675 The +/- rules are most useful in exclude lists, allowing you to have a
676 single exclude list that contains both include and exclude options.
678 Here are some examples:
681 it() --exclude "*.o" would exclude all filenames matching *.o
682 it() --exclude "/foo" would exclude a file in the base directory called foo
683 it() --exclude "foo/" would exclude any directory called foo
684 it() --exclude "/foo/*/bar" would exclude any file called bar two
685 levels below a base directory called foo
686 it() --exclude "/foo/**/bar" would exclude any file called bar two
687 or more levels below a base directory called foo
688 it() --include "*/" --include "*.c" --exclude "*" would include all
689 directories and C source files
690 it() --include "foo/" --include "foo/bar.c" --exclude "*" would include
691 only foo/bar.c (the foo/ directory must be explicitly included or
692 it would be excluded by the "*")
695 manpagesection(DIAGNOSTICS)
697 rsync occasionally produces error messages that may seem a little
698 cryptic. The one that seems to cause the most confusion is "protocol
699 version mismatch - is your shell clean?".
701 This message is usually caused by your startup scripts or remote shell
702 facility producing unwanted garbage on the stream that rsync is using
703 for its transport. The way to diagnose this problem is to run your
704 remote shell like this:
707 rsh remotehost /bin/true > out.dat
710 then look at out.dat. If everything is working correctly then out.dat
711 should be a zero length file. If you are getting the above error from
712 rsync then you will probably find that out.dat contains some text or
713 data. Look at the contents and try to work out what is producing
714 it. The most common cause is incorrectly configured shell startup
715 scripts (such as .cshrc or .profile) that contain output statements
716 for non-interactive logins.
718 manpagesection(ENVIRONMENT VARIABLES)
722 dit(bf(CVSIGNORE)) The CVSIGNORE environment variable supplements any
723 ignore patterns in .cvsignore files. See the --cvs-exclude option for
726 dit(bf(RSYNC_RSH)) The RSYNC_RSH environment variable allows you to
727 override the default shell used as the transport for rsync. This can
728 be used instead of the -e option.
730 dit(bf(RSYNC_PASSWORD)) Setting RSYNC_PASSWORD to the required
731 password allows you to run authenticated rsync connections to a rsync
732 daemon without user intervention. Note that this does not supply a
733 password to a shell transport such as ssh.
735 dit(bf(USER) or bf(LOGNAME)) The USER or LOGNAME environment variables
736 are used to determine the default username sent to a rsync server.
738 dit(bf(HOME)) The HOME environment variable is used to find the user's
739 default .cvsignore file.
755 times are transferred as unix time_t values
757 file permissions, devices etc are transferred as native numerical
760 see also the comments on the --delete option
762 Please report bugs! The rsync bug tracking system is online at
763 url(http://rsync.samba.org/rsync/)(http://rsync.samba.org/rsync/)
765 manpagesection(VERSION)
766 This man page is current for version 2.0 of rsync
768 manpagesection(CREDITS)
770 rsync is distributed under the GNU public license. See the file
773 A WEB site is available at
774 url(http://rsync.samba.org/)(http://rsync.samba.org/)
776 The primary ftp site for rsync is
777 url(ftp://rsync.samba.org/pub/rsync)(ftp://rsync.samba.org/pub/rsync).
779 We would be delighted to hear from you if you like this program.
781 This program uses the excellent zlib compression library written by
782 Jean-loup Gailly and Mark Adler.
784 manpagesection(THANKS)
786 Thanks to Richard Brent, Brendan Mackay, Bill Waite, Stephen Rothwell
787 and David Bell for helpful suggestions and testing of rsync. I've
788 probably missed some people, my apologies if I have.
793 rsync was written by Andrew Tridgell and Paul Mackerras. They may be
794 contacted via email at tridge@samba.org and
795 Paul.Mackerras@cs.anu.edu.au