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