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