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