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