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