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