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