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