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