made the "max connections" and "lock file" local rather than global
[rsync/rsync.git] / rsync.yo
1 mailto(rsync-bugs@samba.org)
2 manpage(rsync)(1)(7 Jan 1999)()()
3 manpagename(rsync)(faster, flexible replacement for rcp)
4 manpagesynopsis()
5
6 rsync [options] [user@]host:path path
7
8 rsync [options] path [user@]host:path
9
10 rsync [options] path path
11
12 rsync [options] [user@]host::module[/path] path
13
14 rsync [options] path [user@]host::module[/path]
15
16 rsync [options] rsync://[user@]host[:port]/module/path path
17
18 manpagedescription()
19
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
23 exists.
24
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.
29
30 Some of the additional features of rsync are:
31
32 itemize(
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
40        mirroring)
41 )
42
43 manpagesection(GENERAL)
44
45 There are six different ways of using rsync. They are:
46
47 itemize(
48         it() for copying local files. This is invoked when neither
49              source nor destination path contains a : separator
50
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
54         single : separator.
55
56         it() for copying from a remote machine to the local machine
57         using a remote shell program. This is invoked when the source
58         contains a : separator.
59
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.
63
64         it() for copying from the local machine to a remote rsync
65         server. This is invoked when the destination path contains a ::
66         separator. 
67
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
70         local destination.  
71 )
72
73 Note that in all cases (other than listing) at least one of the source
74 and destination paths must be local.
75
76 manpagesection(SETUP)
77
78 See the file README for installation instructions.
79
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.
83
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.
86
87 One common substitute is to use ssh, which offers a high degree of
88 security.
89
90 Note that rsync must be installed on both the source and destination
91 machines. 
92
93 manpagesection(USAGE)
94
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.
97
98 Perhaps the best way to explain the syntax is some examples:
99
100 quote(rsync *.c foo:src/)
101
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.
107
108 quote(rsync -avz foo:src/bar /data/tmp)
109
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.
116
117 quote(rsync -avz foo:src/bar/ /data/tmp)
118
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.
125
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.
129
130 quote(rsync somehost.mydomain.com::)
131
132 this would list all the anonymous rsync modules available on the host
133 somehost.mydomain.com.  (See the following section for more details.)
134
135
136 manpagesection(CONNECTING TO AN RSYNC SERVER)
137
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. 
141
142 Using rsync in this way is the same as using it with rsh or ssh except
143 that:
144
145 itemize(
146         it() you use a double colon :: instead of a single colon to
147         separate the hostname from the path. 
148
149         it() the remote server may print a message of the day when you
150         connect.
151
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.
154
155         it() if you specify no local destination then a listing of the
156         specified files on the remote server is provided.
157 )
158
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. This may be useful when scripting rsync.
163
164 WARNING: On some systems environment variables are visible to all
165 users. 
166
167 manpagesection(RUNNING AN RSYNC SERVER)
168
169 An rsync server is configured using a config file which by default is
170 called /etc/rsyncd.conf. Please see the rsyncd.conf(5) man page for more
171 information. 
172
173 manpagesection(EXAMPLES)
174
175 Here are some examples of how I use rsync.
176
177 To backup my wife's home directory, which consists of large MS Word
178 files and mail folders, I use a cron job that runs
179
180 quote(rsync -Cavz . arvidsjaur:backup)
181
182 each night over a PPP link to a duplicate directory on my machine
183 "arvidsjaur".
184
185 To synchronize my samba source trees I use the following Makefile
186 targets:
187
188 quote(      get:nl()
189        rsync -avuzb --exclude '*~' samba:samba/ .
190
191       put:nl()
192        rsync -Cavuzb . samba:samba/
193
194       sync: get put)
195
196 this allows me to sync with a CVS directory at the other end of the
197 link. I then do cvs operations on the remote machine, which saves a
198 lot of time as the remote cvs protocol isn't very efficient.
199
200 I mirror a directory between my "old" and "new" ftp sites with the
201 command
202
203 quote(rsync -az -e ssh --delete ~ftp/pub/samba/ nimbus:"~ftp/pub/tridge/samba")
204
205 this is launched from cron every few hours.
206
207 manpagesection(OPTIONS SUMMARY)
208
209 Here is a short summary of the options available in rsync. Please refer
210 to the detailed description below for a complete description.
211
212 verb(
213 Usage: rsync [OPTION]... SRC [USER@]HOST:DEST
214   or   rsync [OPTION]... [USER@]HOST:SRC DEST
215   or   rsync [OPTION]... SRC DEST
216   or   rsync [OPTION]... [USER@]HOST::SRC [DEST]
217   or   rsync [OPTION]... SRC [USER@]HOST::DEST
218   or   rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST]
219
220 Options
221  -v, --verbose               increase verbosity
222  -c, --checksum              always checksum
223  -a, --archive               archive mode
224  -r, --recursive             recurse into directories
225  -R, --relative              use relative path names
226  -b, --backup                make backups (default ~ extension)
227  -u, --update                update only (don't overwrite newer files)
228  -l, --links                 preserve soft links
229  -L, --copy-links            treat soft links like regular files
230      --safe-links            ignore links outside the destination tree
231  -H, --hard-links            preserve hard links
232  -p, --perms                 preserve permissions
233  -o, --owner                 preserve owner (root only)
234  -g, --group                 preserve group
235  -D, --devices               preserve devices (root only)
236  -t, --times                 preserve times
237  -S, --sparse                handle sparse files efficiently
238  -n, --dry-run               show what would have been transferred
239  -W, --whole-file            copy whole files, no incremental checks
240  -x, --one-file-system       don't cross filesystem boundaries
241  -B, --block-size=SIZE       checksum blocking size
242  -e, --rsh=COMMAND           specify rsh replacement
243      --rsync-path=PATH       specify path to rsync on the remote machine
244  -C, --cvs-exclude           auto ignore files in the same way CVS does
245      --delete                delete files that don't exist on the sending side
246      --partial               keep partially transferred files
247      --force                 force deletion of directories even if not empty
248      --numeric-ids           don't map uid/gid values by user/group name
249      --timeout=TIME          set IO timeout in seconds
250  -I, --ignore-times          don't exclude files that match length and time
251  -T  --temp-dir=DIR          create temporary files in directory DIR
252      --compare-dest=DIR      also compare destination files relative to DIR
253  -z, --compress              compress file data
254      --exclude=PATTERN       exclude files matching PATTERN
255      --exclude-from=FILE     exclude files listed in FILE
256      --include=PATTERN       don't exclude files matching PATTERN
257      --include-from=FILE     don't exclude files listed in FILE
258      --suffix=SUFFIX         override backup suffix
259      --version               print version number
260      --daemon                run as a rsync daemon
261      --config=FILE           specify alternate rsyncd.conf file
262      --port=PORT             specify alternate rsyncd port number
263      --stats                 give some file transfer stats
264      --progress              show progress during transfer
265      --log-format=FORMAT     log file transfers using specified format
266  -h, --help                  show this help screen
267 )
268
269 manpageoptions()
270
271 rsync uses the GNU long options package. Many of the command line
272 options have two variants, one short and one long.  These are shown
273 below, separated by commas. Some options only have a long variant.
274
275 startdit()
276 dit(bf(-h, --help)) Print a short help page describing the options
277 available in rsync
278
279 dit(bf(--version)) print the rsync version number and exit
280
281 dit(bf(-v, --verbose)) This option increases the amount of information you
282 are given during the transfer.  By default, rsync works silently. A
283 single -v will give you information about what files are being
284 transferred and a brief summary at the end. Two -v flags will give you
285 information on what files are being skipped and slightly more
286 information at the end. More than two -v flags should only be used if
287 you are debugging rsync.
288
289 dit(bf(-I, --ignore-times)) Normally rsync will skip any files that are
290 already the same length and have the same time-stamp. This option turns
291 off this behavior.
292
293 dit(bf(-c, --checksum)) This forces the sender to checksum all files using
294 a 128-bit MD4 checksum before transfer. The checksum is then
295 explicitly checked on the receiver and any files of the same name
296 which already exist and have the same checksum and size on the
297 receiver are skipped.  This option can be quite slow.
298
299 dit(bf(-a, --archive)) This is equivalent to -rlptDg. It is a quick way
300 of saying you want recursion and want to preserve everything.
301
302 Note: if the user launching rsync is root then the -o option (preserve
303 uid) is also implied.
304
305 dit(bf(-r, --recursive)) This tells rsync to copy directories recursively.
306
307 dit(bf(-R, --relative)) Use relative paths. This means that the full path
308 names specified on the command line are sent to the server rather than
309 just the last parts of the filenames. This is particularly useful when
310 you want to send several different directories at the same time. For
311 example, if you used the command
312
313 verb(rsync foo/bar/foo.c remote:/tmp/)
314
315 then this would create a file called foo.c in /tmp/ on the remote
316 machine. If instead you used
317
318 verb(rsync -R foo/bar/foo.c remote:/tmp/)
319
320 then a file called /tmp/foo/bar/foo.c would be created on the remote
321 machine. The full path name is preserved.
322
323 dit(bf(-b, --backup)) With this option preexisting destination files are
324 renamed with a ~ extension as each file is transferred.  You can
325 control the backup suffix using the --suffix option.
326
327 dit(bf(-u, --update)) This forces rsync to skip any files for which the
328 destination file already exists and has a date later than the source
329 file.
330
331 dit(bf(-l, --links)) This tells rsync to recreate symbolic links on the
332 remote system  to  be the same as the local system. Without this
333 option, all symbolic links are skipped.
334
335 dit(bf(-L, --copy-links)) This tells rsync to treat symbolic links just
336 like  ordinary files.
337
338 dit(bf(--safe-links)) This tells rsync to ignore any symbolic links
339 which point outside the destination tree. All absolute symlinks are
340 also ignored. Using this option in conjunction with --relative may
341 give unexpected results. 
342
343 dit(bf(-H, --hard-links)) This tells rsync to recreate hard  links  on
344 the  remote system  to  be the same as the local system. Without this
345 option hard links are treated like regular files.
346
347 Note that rsync can only detect hard links if both parts of the link
348 are in the list of files being sent.
349
350 This option can be quite slow, so only use it if you need it.
351
352 dit(bf(-W, --whole-file)) With this option the incremental rsync algorithm
353 is  not used  and  the whole file is sent as-is instead. This may be
354 useful when using rsync with a local machine.
355
356 dit(bf(--partial)) By default, rsync will delete any partially
357 transferred file if the transfer is interrupted. In some circumstances
358 it is more desirable to keep partially transferred files. Using the
359 --partial option tells rsync to keep the partial file which should
360 make a subsequent transfer of the rest of the file much faster.
361
362 dit(bf(-p, --perms)) This option causes rsync to update the remote
363 permissions to be the same as the local permissions.
364
365 dit(bf(-o, --owner)) This option causes rsync to update the  remote  owner
366 of the  file to be the same as the local owner. This is only available
367 to the super-user.  Note that if the source system is a daemon using chroot,
368 the --numeric-ids option is implied because the source system cannot get
369 access to the usernames.
370
371 dit(bf(-g, --group)) This option causes rsync to update the  remote  group
372 of the file to be the same as the local group.  Note that if the source
373 system is a daemon using chroot, the --numeric-ids option is implied because
374 the source system cannot get access to the group names.
375
376 dit(bf(-D, --devices)) This option causes rsync to transfer character and
377 block device information to the remote system to recreate these
378 devices. This option is only available to the super-user.
379
380 dit(bf(-t, --times)) This tells rsync to transfer modification times along
381 with the files and update them on the remote system.  Note that if this
382 option is not used, the optimization that excludes files that have not been
383 modified cannot be effective; in other words, a missing -t or -a will
384 cause the next transfer to behave as if it used -I, and all files will have
385 their checksums compared and show up in log messages even if they haven't
386 changed.
387
388 dit(bf(-n, --dry-run)) This tells rsync to not do any file transfers,
389 instead it will just report the actions it would have taken.
390
391 dit(bf(-S, --sparse)) Try to handle sparse files efficiently so they take
392 up less space on the destination.
393
394 NOTE: Don't use this option when the destination is a Solaris "tmpfs"
395 filesystem. It doesn't seem to handle seeks over null regions
396 correctly and ends up corrupting the files.
397
398 dit(bf(-x, --one-file-system)) This tells rsync not to cross filesystem
399 boundaries  when recursing.  This  is useful for transferring the
400 contents of only one filesystem.
401
402 dit(bf(--delete)) This tells rsync to delete any files on the receiving
403 side that aren't on the sending side. This option can be dangerous if
404 used incorrectly!
405
406 It is a very good idea to run first using the dry run option (-n) to
407 see what files would be deleted to make sure important files aren't
408 listed.
409
410 rsync 1.6.4 changed the behavior of --delete to make it less
411 dangerous.  rsync now only scans directories on the receiving side
412 that are explicitly transferred from the sending side.  Only files in
413 these directories are deleted.
414
415 Still, it is probably easy to get burnt with this option.  The moral
416 of the story is to use the -n option until you get used to the
417 behavior of --delete.
418
419 If the sending side detects any IO errors then the deletion of any
420 files at the destination will be automatically disabled. This is to
421 prevent temporary filesystem failures (such as NFS errors) on the
422 sending side causing a massive deletion of files on the
423 destination. 
424
425 dit(bf(--force)) This options tells rsync to delete directories even if
426 they are not empty.  This applies to both the --delete option and to
427 cases where rsync tries to copy a normal file but the destination
428 contains a directory of the same name. Normally rsync will refuse to
429 do a recursive directory deletion in such cases, by using --force
430 the recursive deletion will be done.
431
432 Use this option with caution!
433
434 dit(bf(-B , --block_size BLOCKSIZE)) This controls the block size used in
435 the rsync algorithm. See the technical report for details.
436
437 dit(bf(-e, --rsh COMMAND)) This option allows you to choose an alternative
438 remote shell program to use for communication between the local and
439 remote copies of rsync. By default, rsync will use rsh, but you may
440 like to instead use ssh because of its high security.
441
442 You can also choose the remote shell program using the RSYNC_RSH
443 environment variable.
444
445 dit(bf(--rsync-path PATH)) Use this to specify the path to the copy of
446 rsync on the remote machine. Useful when it's not in your path.
447
448 dit(bf(--exclude pattern)) This option allows you to selectively exclude
449 certain files from the list of files to be transferred. This is most
450 useful in combination with a recursive transfer.
451
452 You may use as many --exclude options on the command line as you like
453 to build up the list of files to exclude.
454
455 See the section on exclude patterns for information on the syntax of 
456 this option.
457
458 dit(bf(--exclude-from FILE)) This option is similar to the --exclude
459 option, but instead it adds all filenames listed in the file FILE to
460 the exclude list.
461
462 dit(bf(--include pattern)) This option tells rsync to not exclude the
463 specified pattern of filenames. This is useful as it allows you to
464 build up quite complex exclude/include rules.
465
466 See the section of exclude patterns for information on the syntax of 
467 this option.
468
469 dit(bf(--include-from FILE)) This specifies a list of include patterns
470 from a file.
471
472 dit(bf(-C, --cvs-exclude)) This is a useful shorthand for excluding a
473 broad range of files that you often don't want to transfer between
474 systems. It uses the same algorithm that CVS uses to determine if
475 a file should be ignored.
476
477 The exclude list is initialized to:
478
479 quote(RCS SCCS CVS CVS.adm RCSLOG cvslog.* tags TAGS .make.state
480 .nse_depinfo *~ #* .#* ,* *.old *.bak *.BAK *.orig *.rej .del-*
481 *.a *.o *.obj *.so *.Z *.elc *.ln core)
482
483 then files listed in a $HOME/.cvsignore are added to the list and any
484 files listed in the CVSIGNORE environment variable (space delimited).
485
486 Finally in each directory any files listed in the .cvsignore file in
487 that directory are added to the list.
488
489 dit(bf(--suffix SUFFIX)) This option allows you to override the default
490 backup suffix used with the -b option. The default is a ~.
491
492 dit(bf(--csum-length LENGTH)) By default the primary checksum used in
493 rsync is a very strong 16 byte MD4 checksum. In most cases you will
494 find that a truncated version of this checksum is quite efficient, and
495 this will decrease the size of the checksum data sent over the link,
496 making things faster. 
497
498 You can choose the number of bytes in the truncated checksum using the
499 --csum-length option. Any value less than or equal to 16 is valid.
500
501 Note that if you use this option then you run the risk of ending up
502 with an incorrect target file. The risk with a value of 16 is
503 microscopic and can be safely ignored (the universe will probably end
504 before it fails) but with smaller values the risk is higher.
505
506 Current versions of rsync actually use an adaptive algorithm for the
507 checksum length by default, using a 16 byte file checksum to determine
508 if a 2nd pass is required with a longer block checksum. Only use this
509 option if you have read the source code and know what you are doing.
510
511 dit(bf(-T, --temp-dir DIR)) This option instructs rsync to use DIR as a
512 scratch directory when creating temporary copies of the files
513 transferred on the receiving side.  The default behavior is to create
514 the temporary files in the receiving directory.
515
516 dit(bf(--compare-dest DIR)) This option instructs rsync to use DIR as an
517 additional directory to compare destination files against when doing
518 transfers.  This is useful for doing transfers to a new destination while
519 leaving existing files intact, and then doing a flash-cutover when all
520 files have been successfully transferred (for example by moving directories
521 around and removing the old directory, although this requires also doing
522 the transfer with -I to avoid skipping files that haven't changed).  This
523 option increases the usefulness of --partial because partially transferred
524 files will remain in the new temporary destination until they have a chance
525 to be completed.  If DIR is a relative path, it is relative to the
526 destination directory.
527
528 dit(bf(-z, --compress)) With this option, rsync compresses any data from
529 the source file(s) which it sends to the destination machine.  This
530 option is useful on slow links.  The compression method used is the
531 same method that gzip uses.
532
533 Note this this option typically achieves better compression ratios
534 that can be achieved by using a compressing remote shell, or a
535 compressing transport, as it takes advantage of the implicit
536 information sent for matching data blocks.
537
538 dit(bf(--numeric-ids)) With this option rsync will transfer numeric group
539 and user ids rather than using user and group names and mapping them
540 at both ends.
541
542 By default rsync will use the user name and group name to determine
543 what ownership to give files. The special uid 0 and the special group
544 0 are never mapped via user/group names even if the --numeric-ids
545 option is not specified.
546
547 If the source system is a daemon using chroot, or if a user or group name
548 does not exist on the destination system, then the numeric id from the
549 source system is used instead.
550
551 dit(bf(--timeout=TIMEOUT)) This option allows you to set a maximum IO
552 timeout in seconds. If no data is transferred for the specified time
553 then rsync will exit. The default is 0, which means no timeout.
554
555 dit(bf(--daemon)) This tells rsync that it is to run as a rsync
556 daemon. If standard input is a socket then rsync will assume that it
557 is being run via inetd, otherwise it will detach from the current
558 terminal and become a background daemon. The daemon will read the
559 config file (/etc/rsyncd.conf) on each connect made by a client and
560 respond to requests accordingly. See the rsyncd.conf(5) man page for more
561 details. 
562
563 dit(bf(--config FILE)) This specifies an alternate config file than
564 the default /etc/rsyncd.conf. This is only relevant when --daemon is
565 specified. 
566
567 dit(bf(--port PORT)) This specifies an alternate TCP port number to use
568 rather than the default port 873.
569
570 dit(bf(--log-format=FORMAT)) This allows you to specify exactly what the
571 rsync client logs to stdout on a per-file basis. The log format is
572 specified using the same format conventions as the log format option in
573 rsyncd.conf.
574
575 dit(bf(--stats)) This tells rsync to print a verbose set of statistics
576 on the file transfer, allowing you to tell how effective the rsync
577 algorithm is for your data. This option only works in conjunction with
578 the -v (verbose) option.
579
580 dit(bf(--progress)) This option tells rsync to print information
581 showing the progress of the transfer. This gives a bored user
582 something to watch.
583
584 enddit()
585
586 manpagesection(EXCLUDE PATTERNS)
587
588 The exclude and include patterns specified to rsync allow for flexible
589 selection of which files to transfer and which files to skip.
590
591 rsync builds a ordered list of include/exclude options as specified on
592 the command line. When a filename is encountered, rsync checks the
593 name against each exclude/include pattern in turn. The first matching
594 pattern is acted on. If it is an exclude pattern than that file is
595 skipped. If it is an include pattern then that filename is not
596 skipped. If no matching include/exclude pattern is found then the
597 filename is not skipped.
598
599 The patterns can take several forms. The rules are:
600
601 itemize(
602   it() if the pattern starts with a / then it is matched against the
603   start of the filename, otherwise it is matched against the end of
604   the filename. Thus /foo would match a file called foo
605   at the base of the tree whereas foo would match any file
606   called foo anywhere in the tree.
607
608   it() if the pattern ends with a / then it will only match a
609   directory, not a file, link or device.
610
611   it() if the pattern contains a wildcard character from the set
612   *?[ then regular expression matching is applied using the
613   normal shell filename matching rules. Otherwise a simple string
614   match is used.
615
616   it() if the pattern contains a / (not counting a trailing /) then it
617   is matched against the full filename, including any leading
618   directory. If the pattern doesn't contain a / then it is matched
619   only against the final component of the filename.
620
621   it() if the pattern starts with "+ " (a plus followed by a space)
622   then it is always considered an include pattern, even if specified as
623   part of an exclude option. The "+ " part is discarded before matching.
624
625   it() if the pattern starts with "- " (a minus followed by a space)
626   then it is always considered an exclude pattern, even if specified as
627   part of an include option. The "- " part is discarded before matching.
628
629   it() if the pattern is a single exclamation mark ! then the current
630   exclude list is reset, removing all previous exclude patterns.
631 )
632
633 The +/- rules are most useful in exclude lists, allowing you to have a
634 single exclude list that contains both include and exclude options.
635
636 Here are some examples:
637
638 itemize(
639   it() --exclude "*.o" would exclude all filenames matching *.o
640   it() --exclude "/foo" would exclude a file in the base directory called foo
641   it() --exclude "foo/" would exclude any directory called foo
642   it() --include "*/" --include "*.c" --exclude "*" would include all 
643   directories and C source files
644   it() --include "foo/" --include "foo/bar.c" --exclude "*" would include
645   only foo/bar.c (the foo/ directory must be explicitly included or
646   it would be excluded by the "*")
647 )
648
649 manpagesection(DIAGNOSTICS)
650
651 rsync occasionally produces error messages that may seem a little
652 cryptic. The one that seems to cause the most confusion is "protocol
653 version mismatch - is your shell clean?".
654
655 This message is usually caused by your startup scripts or remote shell
656 facility producing unwanted garbage on the stream that rsync is using
657 for its transport. The way to diagnose this problem is to run your
658 remote shell like this:
659
660 verb(
661    rsh remotehost /bin/true > out.dat
662 )
663        
664 then look at out.dat. If everything is working correctly then out.dat
665 should be a zero length file. If you are getting the above error from
666 rsync then you will probably find that out.dat contains some text or
667 data. Look at the contents and try to work out what is producing
668 it. The most common cause is incorrectly configured shell startup
669 scripts (such as .cshrc or .profile) that contain output statements
670 for non-interactive logins.
671
672 manpagesection(ENVIRONMENT VARIABLES)
673
674 startdit()
675
676 dit(bf(CVSIGNORE)) The CVSIGNORE environment variable supplements any
677 ignore patterns in .cvsignore files. See the --cvs-exclude option for
678 more details.
679
680 dit(bf(RSYNC_RSH)) The RSYNC_RSH environment variable allows you to
681 override the default shell used as the transport for rsync. This can
682 be used instead of the -e option.
683
684 dit(bf(RSYNC_PASSWORD)) Setting RSYNC_PASSWORD to the required
685 password allows you to run authenticated rsync connections to a rsync
686 daemon without user intervention. Note that this does not supply a
687 password to a shell transport such as ssh.
688
689 dit(bf(USER) or bf(LOGNAME)) The USER or LOGNAME environment variables
690 are used to determine the default username sent to a rsync server.
691
692 dit(bf(HOME)) The HOME environment variable is used to find the user's
693 default .cvsignore file.
694
695 enddit()
696
697 manpagefiles()
698
699 /etc/rsyncd.conf
700
701 manpageseealso()
702
703 rsyncd.conf(5)
704
705 manpagediagnostics()
706
707 manpagebugs()
708
709 times are transferred as unix time_t values
710
711 file permissions, devices etc are transferred as native numerical
712 values
713
714 see also the comments on the --delete option
715
716 Please report bugs! The rsync bug tracking system is online at
717 url(http://rsync.samba.org/rsync/)(http://rsync.samba.org/rsync/)
718
719 manpagesection(VERSION)
720 This man page is current for version 2.0 of rsync
721
722 manpagesection(CREDITS)
723
724 rsync is distributed under the GNU public license.  See the file
725 COPYING for details.
726
727 A WEB site is available at
728 url(http://rsync.samba.org/)(http://rsync.samba.org/)
729
730 The primary ftp site for rsync is
731 url(ftp://rsync.samba.org/pub/rsync)(ftp://rsync.samba.org/pub/rsync).
732
733 We would be delighted to hear from you if you like this program.
734
735 This program uses the excellent zlib compression library written by
736 Jean-loup Gailly and Mark Adler.
737
738 manpagesection(THANKS)
739
740 Thanks to Richard Brent, Brendan Mackay, Bill Waite, Stephen Rothwell
741 and David Bell for helpful suggestions and testing of rsync. I've
742 probably missed some people, my apologies if I have.
743
744
745 manpageauthor()
746
747 rsync was written by Andrew Tridgell and Paul Mackerras.  They may be
748 contacted via email at tridge@samba.org and
749 Paul.Mackerras@cs.anu.edu.au
750