Moved the read_batch abort check below the code that handles the
[rsync/rsync.git] / rsync.yo
... / ...
CommitLineData
1mailto(rsync-bugs@samba.org)
2manpage(rsync)(1)(30 Apr 2004)()()
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
18rsync [OPTION]... SRC [SRC]... rsync://[USER@]HOST[:PORT]/DEST
19
20manpagedescription()
21
22rsync is a program that behaves in much the same way that rcp does,
23but has many more options and uses the rsync remote-update protocol to
24greatly speed up file transfers when the destination file already
25exists.
26
27The rsync remote-update protocol allows rsync to transfer just the
28differences between two sets of files across the network connection, using
29an efficient checksum-search algorithm described in the technical
30report that accompanies this package.
31
32Some of the additional features of rsync are:
33
34itemize(
35 it() support for copying links, devices, owners, groups, and permissions
36 it() exclude and exclude-from options similar to GNU tar
37 it() a CVS exclude mode for ignoring the same files that CVS would ignore
38 it() can use any transparent remote shell, including ssh or rsh
39 it() does not require root privileges
40 it() pipelining of file transfers to minimize latency costs
41 it() support for anonymous or authenticated rsync servers (ideal for
42 mirroring)
43)
44
45manpagesection(GENERAL)
46
47There are eight different ways of using rsync. They are:
48
49itemize(
50 it() for copying local files. This is invoked when neither
51 source nor destination path contains a : separator
52
53 it() for copying from the local machine to a remote machine using
54 a remote shell program as the transport (such as ssh or
55 rsh). This is invoked when the destination path contains a
56 single : separator.
57
58 it() for copying from a remote machine to the local machine
59 using a remote shell program. This is invoked when the source
60 contains a : separator.
61
62 it() for copying from a remote rsync server to the local
63 machine. This is invoked when the source path contains a ::
64 separator or an rsync:// URL.
65
66 it() for copying from the local machine to a remote rsync
67 server. This is invoked when the destination path contains a ::
68 separator or an rsync:// URL.
69
70 it() for copying from a remote machine using a remote shell
71 program as the transport, using rsync server on the remote
72 machine. This is invoked when the source path contains a ::
73 separator and the --rsh=COMMAND (aka "-e COMMAND") option is
74 also provided.
75
76 it() for copying from the local machine to a remote machine
77 using a remote shell program as the transport, using rsync
78 server on the remote machine. This is invoked when the
79 destination path contains a :: separator and the
80 --rsh=COMMAND option is also provided.
81
82 it() for listing files on a remote machine. This is done the
83 same way as rsync transfers except that you leave off the
84 local destination.
85)
86
87Note that in all cases (other than listing) at least one of the source
88and destination paths must be local.
89
90manpagesection(SETUP)
91
92See the file README for installation instructions.
93
94Once installed, you can use rsync to any machine that you can access via
95a remote shell (as well as some that you can access using the rsync
96daemon-mode protocol). For remote transfers, a modern rsync uses ssh
97for its communications, but it may have been configured to use a
98different remote shell by default, such as rsh or remsh.
99
100You can also specify any remote shell you like, either by using the -e
101command line option, or by setting the RSYNC_RSH environment variable.
102
103One common substitute is to use ssh, which offers a high degree of
104security.
105
106Note that rsync must be installed on both the source and destination
107machines.
108
109manpagesection(USAGE)
110
111You use rsync in the same way you use rcp. You must specify a source
112and a destination, one of which may be remote.
113
114Perhaps the best way to explain the syntax is with some examples:
115
116quote(rsync *.c foo:src/)
117
118This would transfer all files matching the pattern *.c from the
119current directory to the directory src on the machine foo. If any of
120the files already exist on the remote system then the rsync
121remote-update protocol is used to update the file by sending only the
122differences. See the tech report for details.
123
124quote(rsync -avz foo:src/bar /data/tmp)
125
126This would recursively transfer all files from the directory src/bar on the
127machine foo into the /data/tmp/bar directory on the local machine. The
128files are transferred in "archive" mode, which ensures that symbolic
129links, devices, attributes, permissions, ownerships, etc. are preserved
130in the transfer. Additionally, compression will be used to reduce the
131size of data portions of the transfer.
132
133quote(rsync -avz foo:src/bar/ /data/tmp)
134
135A trailing slash on the source changes this behavior to avoid creating an
136additional directory level at the destination. You can think of a trailing
137/ on a source as meaning "copy the contents of this directory" as opposed
138to "copy the directory by name", but in both cases the attributes of the
139containing directory are transferred to the containing directory on the
140destination. In other words, each of the following commands copies the
141files in the same way, including their setting of the attributes of
142/dest/foo:
143
144quote(rsync -avz /src/foo /dest)
145quote(rsync -avz /src/foo/ /dest/foo)
146
147You can also use rsync in local-only mode, where both the source and
148destination don't have a ':' in the name. In this case it behaves like
149an improved copy command.
150
151quote(rsync somehost.mydomain.com::)
152
153This would list all the anonymous rsync modules available on the host
154somehost.mydomain.com. (See the following section for more details.)
155
156
157manpagesection(CONNECTING TO AN RSYNC SERVER)
158
159It is also possible to use rsync without a remote shell as the
160transport. In this case you will connect to a remote rsync server
161running on TCP port 873.
162
163You may establish the connection via a web proxy by setting the
164environment variable RSYNC_PROXY to a hostname:port pair pointing to
165your web proxy. Note that your web proxy's configuration must support
166proxy connections to port 873.
167
168Using rsync in this way is the same as using it with a remote shell except
169that:
170
171itemize(
172 it() you use a double colon :: instead of a single colon to
173 separate the hostname from the path or an rsync:// URL.
174
175 it() the remote server may print a message of the day when you
176 connect.
177
178 it() if you specify no path name on the remote server then the
179 list of accessible paths on the server will be shown.
180
181 it() if you specify no local destination then a listing of the
182 specified files on the remote server is provided.
183)
184
185Some paths on the remote server may require authentication. If so then
186you will receive a password prompt when you connect. You can avoid the
187password prompt by setting the environment variable RSYNC_PASSWORD to
188the password you want to use or using the --password-file option. This
189may be useful when scripting rsync.
190
191WARNING: On some systems environment variables are visible to all
192users. On those systems using --password-file is recommended.
193
194manpagesection(CONNECTING TO AN RSYNC SERVER OVER A REMOTE SHELL PROGRAM)
195
196It is sometimes useful to be able to set up file transfers using rsync
197server capabilities on the remote machine, while still using ssh or
198rsh for transport. This is especially useful when you want to connect
199to a remote machine via ssh (for encryption or to get through a
200firewall), but you still want to have access to the rsync server
201features (see RUNNING AN RSYNC SERVER OVER A REMOTE SHELL PROGRAM,
202below).
203
204From the user's perspective, using rsync in this way is the same as
205using it to connect to an rsync server, except that you must
206explicitly set the remote shell program on the command line with
207--rsh=COMMAND. (Setting RSYNC_RSH in the environment will not turn on
208this functionality.)
209
210In order to distinguish between the remote-shell user and the rsync
211server user, you can use '-l user' on your remote-shell command:
212
213quote(rsync -av --rsh="ssh -l ssh-user" rsync-user@host::module[/path] local-path)
214
215The "ssh-user" will be used at the ssh level; the "rsync-user" will be
216used to check against the rsyncd.conf on the remote host.
217
218manpagesection(RUNNING AN RSYNC SERVER)
219
220An rsync server is configured using a configuration file. Please see the
221rsyncd.conf(5) man page for more information. By default the configuration
222file is called /etc/rsyncd.conf, unless rsync is running over a remote
223shell program and is not running as root; in that case, the default name
224is rsyncd.conf in the current directory on the remote computer
225(typically $HOME).
226
227manpagesection(RUNNING AN RSYNC SERVER OVER A REMOTE SHELL PROGRAM)
228
229See the rsyncd.conf(5) man page for full information on the rsync
230server configuration file.
231
232Several configuration options will not be available unless the remote
233user is root (e.g. chroot, setuid/setgid, etc.). There is no need to
234configure inetd or the services map to include the rsync server port
235if you run an rsync server only via a remote shell program.
236
237To run an rsync server out of a single-use ssh key, see this section
238in the rsyncd.conf(5) man page.
239
240manpagesection(EXAMPLES)
241
242Here are some examples of how I use rsync.
243
244To backup my wife's home directory, which consists of large MS Word
245files and mail folders, I use a cron job that runs
246
247quote(rsync -Cavz . arvidsjaur:backup)
248
249each night over a PPP connection to a duplicate directory on my machine
250"arvidsjaur".
251
252To synchronize my samba source trees I use the following Makefile
253targets:
254
255quote( get:nl()
256 rsync -avuzb --exclude '*~' samba:samba/ .
257
258 put:nl()
259 rsync -Cavuzb . samba:samba/
260
261 sync: get put)
262
263this allows me to sync with a CVS directory at the other end of the
264connection. I then do cvs operations on the remote machine, which saves a
265lot of time as the remote cvs protocol isn't very efficient.
266
267I mirror a directory between my "old" and "new" ftp sites with the
268command
269
270quote(rsync -az -e ssh --delete ~ftp/pub/samba/ nimbus:"~ftp/pub/tridge/samba")
271
272this is launched from cron every few hours.
273
274manpagesection(OPTIONS SUMMARY)
275
276Here is a short summary of the options available in rsync. Please refer
277to the detailed description below for a complete description.
278
279verb(
280 -v, --verbose increase verbosity
281 -q, --quiet decrease verbosity
282 -c, --checksum always checksum
283 -a, --archive archive mode, equivalent to -rlptgoD
284 -r, --recursive recurse into directories
285 -R, --relative use relative path names
286 --no-relative turn off --relative
287 --no-implied-dirs don't send implied dirs with -R
288 -b, --backup make backups (see --suffix & --backup-dir)
289 --backup-dir make backups into this directory
290 --suffix=SUFFIX backup suffix (default ~ w/o --backup-dir)
291 -u, --update update only (don't overwrite newer files)
292 --inplace update the destination file inplace
293 -K, --keep-dirlinks treat symlinked dir on receiver as dir
294 -l, --links copy symlinks as symlinks
295 -L, --copy-links copy the referent of all symlinks
296 --copy-unsafe-links copy the referent of "unsafe" symlinks
297 --safe-links ignore "unsafe" symlinks
298 -H, --hard-links preserve hard links
299 -p, --perms preserve permissions
300 -o, --owner preserve owner (root only)
301 -g, --group preserve group
302 -D, --devices preserve devices (root only)
303 -t, --times preserve times
304 -S, --sparse handle sparse files efficiently
305 -n, --dry-run show what would have been transferred
306 -W, --whole-file copy whole files, no incremental checks
307 --no-whole-file turn off --whole-file
308 -x, --one-file-system don't cross filesystem boundaries
309 -B, --block-size=SIZE checksum blocking size (default 700)
310 -e, --rsh=COMMAND specify the remote shell
311 --rsync-path=PATH specify path to rsync on the remote machine
312 --existing only update files that already exist
313 --ignore-existing ignore files that already exist on receiver
314 --delete delete files that don't exist on sender
315 --delete-excluded also delete excluded files on receiver
316 --delete-after receiver deletes after transfer, not before
317 --ignore-errors delete even if there are I/O errors
318 --max-delete=NUM don't delete more than NUM files
319 --partial keep partially transferred files
320 --force force deletion of dirs even if not empty
321 --numeric-ids don't map uid/gid values by user/group name
322 --timeout=TIME set I/O timeout in seconds
323 -I, --ignore-times turn off mod time & file size quick check
324 --size-only ignore mod time for quick check (use size)
325 --modify-window=NUM compare mod times with reduced accuracy
326 -T --temp-dir=DIR create temporary files in directory DIR
327 --compare-dest=DIR also compare received files relative to DIR
328 --link-dest=DIR create hardlinks to DIR for unchanged files
329 -P equivalent to --partial --progress
330 -z, --compress compress file data
331 -C, --cvs-exclude auto ignore files in the same way CVS does
332 --exclude=PATTERN exclude files matching PATTERN
333 --exclude-from=FILE exclude patterns listed in FILE
334 --include=PATTERN don't exclude files matching PATTERN
335 --include-from=FILE don't exclude patterns listed in FILE
336 --files-from=FILE read FILE for list of source-file names
337 -0 --from0 all file lists are delimited by nulls
338 --version print version number
339 --daemon run as an rsync daemon
340 --no-detach do not detach from the parent
341 --address=ADDRESS bind to the specified address
342 --config=FILE specify alternate rsyncd.conf file
343 --port=PORT specify alternate rsyncd port number
344 --blocking-io use blocking I/O for the remote shell
345 --no-blocking-io turn off --blocking-io
346 --stats give some file transfer stats
347 --progress show progress during transfer
348 --log-format=FORMAT log file transfers using specified format
349 --password-file=FILE get password from FILE
350 --bwlimit=KBPS limit I/O bandwidth, KBytes per second
351 --write-batch=FILE write a batch to FILE
352 --read-batch=FILE read a batch from FILE
353 --checksum-seed=NUM set block/file checksum seed
354 -4 --ipv4 prefer IPv4
355 -6 --ipv6 prefer IPv6
356 -h, --help show this help screen
357
358
359)
360
361manpageoptions()
362
363rsync uses the GNU long options package. Many of the command line
364options have two variants, one short and one long. These are shown
365below, separated by commas. Some options only have a long variant.
366The '=' for options that take a parameter is optional; whitespace
367can be used instead.
368
369startdit()
370dit(bf(-h, --help)) Print a short help page describing the options
371available in rsync
372
373dit(bf(--version)) print the rsync version number and exit
374
375dit(bf(-v, --verbose)) This option increases the amount of information you
376are given during the transfer. By default, rsync works silently. A
377single -v will give you information about what files are being
378transferred and a brief summary at the end. Two -v flags will give you
379information on what files are being skipped and slightly more
380information at the end. More than two -v flags should only be used if
381you are debugging rsync.
382
383dit(bf(-q, --quiet)) This option decreases the amount of information you
384are given during the transfer, notably suppressing information messages
385from the remote server. This flag is useful when invoking rsync from
386cron.
387
388dit(bf(-I, --ignore-times)) Normally rsync will skip any files that are
389already the same size and have the same modification time-stamp.
390This option turns off this "quick check" behavior.
391
392dit(bf(--size-only)) Normally rsync will not transfer any files that are
393already the same size and have the same modification time-stamp. With the
394--size-only option, files will not be transferred if they have the same size,
395regardless of timestamp. This is useful when starting to use rsync
396after using another mirroring system which may not preserve timestamps
397exactly.
398
399dit(bf(--modify-window)) When comparing two timestamps rsync treats
400the timestamps as being equal if they are within the value of
401modify_window. This is normally zero, but you may find it useful to
402set this to a larger value in some situations. In particular, when
403transferring to Windows FAT filesystems which cannot represent times
404with a 1 second resolution --modify-window=1 is useful.
405
406dit(bf(-c, --checksum)) This forces the sender to checksum all files using
407a 128-bit MD4 checksum before transfer. The checksum is then
408explicitly checked on the receiver and any files of the same name
409which already exist and have the same checksum and size on the
410receiver are not transferred. This option can be quite slow.
411
412dit(bf(-a, --archive)) This is equivalent to -rlptgoD. It is a quick
413way of saying you want recursion and want to preserve almost
414everything.
415
416Note however that bf(-a) bf(does not preserve hardlinks), because
417finding multiply-linked files is expensive. You must separately
418specify bf(-H).
419
420dit(bf(-r, --recursive)) This tells rsync to copy directories
421recursively. If you don't specify this then rsync won't copy
422directories at all.
423
424dit(bf(-R, --relative)) Use relative paths. This means that the full path
425names specified on the command line are sent to the server rather than
426just the last parts of the filenames. This is particularly useful when
427you want to send several different directories at the same time. For
428example, if you used the command
429
430verb(rsync foo/bar/foo.c remote:/tmp/)
431
432then this would create a file called foo.c in /tmp/ on the remote
433machine. If instead you used
434
435verb(rsync -R foo/bar/foo.c remote:/tmp/)
436
437then a file called /tmp/foo/bar/foo.c would be created on the remote
438machine -- the full path name is preserved.
439
440dit(bf(--no-relative)) Turn off the --relative option. This is only
441needed if you want to use --files-from without its implied --relative
442file processing.
443
444dit(bf(--no-implied-dirs)) When combined with the --relative option, the
445implied directories in each path are not explicitly duplicated as part
446of the transfer. This makes the transfer more optimal and also allows
447the two sides to have non-matching symlinks in the implied part of the
448path. For instance, if you transfer the file "/path/foo/file" with -R,
449the default is for rsync to ensure that "/path" and "/path/foo" on the
450destination exactly match the directories/symlinks of the source. Using
451the --no-implied-dirs option would omit both of these implied dirs,
452which means that if "/path" was a real directory on one machine and a
453symlink of the other machine, rsync would not try to change this.
454
455dit(bf(-b, --backup)) With this option, preexisting destination files are
456renamed as each file is transferred or deleted. You can control where the
457backup file goes and what (if any) suffix gets appended using the
458--backup-dir and --suffix options.
459
460dit(bf(--backup-dir=DIR)) In combination with the --backup option, this
461tells rsync to store all backups in the specified directory. This is
462very useful for incremental backups. You can additionally
463specify a backup suffix using the --suffix option
464(otherwise the files backed up in the specified directory
465will keep their original filenames).
466If DIR is a relative path, it is relative to the destination directory
467(which changes in a recursive transfer).
468
469dit(bf(--suffix=SUFFIX)) This option allows you to override the default
470backup suffix used with the --backup (-b) option. The default suffix is a ~
471if no --backup-dir was specified, otherwise it is an empty string.
472
473dit(bf(-u, --update)) This forces rsync to skip any files for which the
474destination file already exists and has a date later than the source
475file.
476
477In the currently implementation, a difference of file format is always
478considered to be important enough for an update, no matter what date
479is on the objects. In other words, if the source has a directory or a
480symlink where the destination has a file, the transfer would occur
481regardless of the timestamps. This might change in the future (feel
482free to comment on this on the mailing list if you have an opinion).
483
484dit(bf(-K, --keep-dirlinks)) On the receiving side, if a symlink is
485pointing to a directory, it will be treated as matching a directory
486from the sender.
487
488dit(bf(--inplace)) This causes rsync not to create a new copy of the file
489and then move it into place. Instead rsync will overwrite the existing
490file, meaning that the rsync algorithm can't extract the full ammount of
491network reduction it might otherwise.
492
493This option is useful for transfer of large files with block based changes
494and also on systems that are disk bound not network bound.
495
496WARNING: If the transfer is interrupted, you will have an inconsistent file
497and the transfer should be run again.
498
499dit(bf(-l, --links)) When symlinks are encountered, recreate the
500symlink on the destination.
501
502dit(bf(-L, --copy-links)) When symlinks are encountered, the file that
503they point to (the referent) is copied, rather than the symlink.
504
505dit(bf(--copy-unsafe-links)) This tells rsync to copy the referent of
506symbolic links that point outside the copied tree. Absolute symlinks
507are also treated like ordinary files, and so are any symlinks in the
508source path itself when --relative is used.
509
510dit(bf(--safe-links)) This tells rsync to ignore any symbolic links
511which point outside the copied tree. All absolute symlinks are
512also ignored. Using this option in conjunction with --relative may
513give unexpected results.
514
515dit(bf(-H, --hard-links)) This tells rsync to recreate hard links on
516the remote system to be the same as the local system. Without this
517option hard links are treated like regular files.
518
519Note that rsync can only detect hard links if both parts of the link
520are in the list of files being sent.
521
522This option can be quite slow, so only use it if you need it.
523
524dit(bf(-W, --whole-file)) With this option the incremental rsync algorithm
525is not used and the whole file is sent as-is instead. The transfer may be
526faster if this option is used when the bandwidth between the source and
527destination machines is higher than the bandwidth to disk (especially when the
528"disk" is actually a networked filesystem). This is the default when both
529the source and destination are specified as local paths.
530
531dit(bf(--no-whole-file)) Turn off --whole-file, for use when it is the
532default.
533
534dit(bf(-p, --perms)) This option causes rsync to set the destination
535permissions to be the same as the source permissions.
536
537Without this option, each new file gets its permissions set based on the
538source file's permissions and the umask at the receiving end, while all
539other files (including updated files) retain their existing permissions
540(which is the same behavior as other file-copy utilities, such as cp).
541
542dit(bf(-o, --owner)) This option causes rsync to set the owner of the
543destination file to be the same as the source file. On most systems,
544only the super-user can set file ownership. By default, the preservation
545is done by name, but may fall back to using the ID number in some
546circumstances. See the --numeric-ids option for a full discussion.
547
548dit(bf(-g, --group)) This option causes rsync to set the group of the
549destination file to be the same as the source file. If the receiving
550program is not running as the super-user, only groups that the
551receiver is a member of will be preserved. By default, the preservation
552is done by name, but may fall back to using the ID number in some
553circumstances. See the --numeric-ids option for a full discussion.
554
555dit(bf(-D, --devices)) This option causes rsync to transfer character and
556block device information to the remote system to recreate these
557devices. This option is only available to the super-user.
558
559dit(bf(-t, --times)) This tells rsync to transfer modification times along
560with the files and update them on the remote system. Note that if this
561option is not used, the optimization that excludes files that have not been
562modified cannot be effective; in other words, a missing -t or -a will
563cause the next transfer to behave as if it used -I, and all files will have
564their checksums compared and show up in log messages even if they haven't
565changed.
566
567dit(bf(-n, --dry-run)) This tells rsync to not do any file transfers,
568instead it will just report the actions it would have taken.
569
570dit(bf(-S, --sparse)) Try to handle sparse files efficiently so they take
571up less space on the destination.
572
573NOTE: Don't use this option when the destination is a Solaris "tmpfs"
574filesystem. It doesn't seem to handle seeks over null regions
575correctly and ends up corrupting the files.
576
577dit(bf(-x, --one-file-system)) This tells rsync not to cross filesystem
578boundaries when recursing. This is useful for transferring the
579contents of only one filesystem.
580
581dit(bf(--existing)) This tells rsync not to create any new files -
582only update files that already exist on the destination.
583
584dit(bf(--ignore-existing))
585This tells rsync not to update files that already exist on
586the destination.
587
588dit(bf(--max-delete=NUM)) This tells rsync not to delete more than NUM
589files or directories. This is useful when mirroring very large trees
590to prevent disasters.
591
592dit(bf(--delete)) This tells rsync to delete any files on the receiving
593side that aren't on the sending side. Files that are excluded from
594transfer are excluded from being deleted unless you use --delete-excluded.
595
596This option has no effect if directory recursion is not selected.
597
598This option can be dangerous if used incorrectly! It is a very good idea
599to run first using the dry run option (-n) to see what files would be
600deleted to make sure important files aren't listed.
601
602If the sending side detects any I/O errors then the deletion of any
603files at the destination will be automatically disabled. This is to
604prevent temporary filesystem failures (such as NFS errors) on the
605sending side causing a massive deletion of files on the
606destination. You can override this with the --ignore-errors option.
607
608dit(bf(--delete-excluded)) In addition to deleting the files on the
609receiving side that are not on the sending side, this tells rsync to also
610delete any files on the receiving side that are excluded (see --exclude).
611Implies --delete.
612
613dit(bf(--delete-after)) By default rsync does file deletions on the
614receiving side before transferring files to try to ensure that there is
615sufficient space on the receiving filesystem. If you want to delete
616after transferring, use the --delete-after switch. Implies --delete.
617
618dit(bf(--ignore-errors)) Tells --delete to go ahead and delete files
619even when there are I/O errors.
620
621dit(bf(--force)) This options tells rsync to delete directories even if
622they are not empty when they are to be replaced by non-directories. This
623is only relevant without --delete because deletions are now done depth-first.
624Requires the --recursive option (which is implied by -a) to have any effect.
625
626dit(bf(-B, --block-size=BLOCKSIZE)) This controls the block size used in
627the rsync algorithm. See the technical report for details.
628
629dit(bf(-e, --rsh=COMMAND)) This option allows you to choose an alternative
630remote shell program to use for communication between the local and
631remote copies of rsync. Typically, rsync is configured to use ssh by
632default, but you may prefer to use rsh on a local network.
633
634If this option is used with bf([user@]host::module/path), then the
635remote shell em(COMMAND) will be used to run an rsync server on the
636remote host, and all data will be transmitted through that remote
637shell connection, rather than through a direct socket connection to a
638running rsync server on the remote host. See the section "CONNECTING
639TO AN RSYNC SERVER OVER A REMOTE SHELL PROGRAM" above.
640
641Command-line arguments are permitted in COMMAND provided that COMMAND is
642presented to rsync as a single argument. For example:
643
644quote(-e "ssh -p 2234")
645
646(Note that ssh users can alternately customize site-specific connect
647options in their .ssh/config file.)
648
649You can also choose the remote shell program using the RSYNC_RSH
650environment variable, which accepts the same range of values as -e.
651
652See also the --blocking-io option which is affected by this option.
653
654dit(bf(--rsync-path=PATH)) Use this to specify the path to the copy of
655rsync on the remote machine. Useful when it's not in your path. Note
656that this is the full path to the binary, not just the directory that
657the binary is in.
658
659dit(bf(-C, --cvs-exclude)) This is a useful shorthand for excluding a
660broad range of files that you often don't want to transfer between
661systems. It uses the same algorithm that CVS uses to determine if
662a file should be ignored.
663
664The exclude list is initialized to:
665
666quote(RCS SCCS CVS CVS.adm RCSLOG cvslog.* tags TAGS .make.state
667.nse_depinfo *~ #* .#* ,* _$* *$ *.old *.bak *.BAK *.orig *.rej
668.del-* *.a *.olb *.o *.obj *.so *.exe *.Z *.elc *.ln core .svn/)
669
670then files listed in a $HOME/.cvsignore are added to the list and any
671files listed in the CVSIGNORE environment variable (all cvsignore names
672are delimited by whitespace).
673
674Finally, any file is ignored if it is in the same directory as a
675.cvsignore file and matches one of the patterns listed therein.
676See the bf(cvs(1)) manual for more information.
677
678dit(bf(--exclude=PATTERN)) This option allows you to selectively exclude
679certain files from the list of files to be transferred. This is most
680useful in combination with a recursive transfer.
681
682You may use as many --exclude options on the command line as you like
683to build up the list of files to exclude.
684
685See the EXCLUDE PATTERNS section for detailed information on this option.
686
687dit(bf(--exclude-from=FILE)) This option is similar to the --exclude
688option, but instead it adds all exclude patterns listed in the file
689FILE to the exclude list. Blank lines in FILE and lines starting with
690';' or '#' are ignored.
691If em(FILE) is bf(-) the list will be read from standard input.
692
693dit(bf(--include=PATTERN)) This option tells rsync to not exclude the
694specified pattern of filenames. This is useful as it allows you to
695build up quite complex exclude/include rules.
696
697See the EXCLUDE PATTERNS section for detailed information on this option.
698
699dit(bf(--include-from=FILE)) This specifies a list of include patterns
700from a file.
701If em(FILE) is "-" the list will be read from standard input.
702
703dit(bf(--files-from=FILE)) Using this option allows you to specify the
704exact list of files to transfer (as read from the specified FILE or "-"
705for standard input). It also tweaks the default behavior of rsync to make
706transferring just the specified files and directories easier. For
707instance, the --relative option is enabled by default when this option
708is used (use --no-relative if you want to turn that off), all
709directories specified in the list are created on the destination (rather
710than being noisily skipped without -r), and the -a (--archive) option's
711behavior does not imply -r (--recursive) -- specify it explicitly, if
712you want it.
713
714The file names that are read from the FILE are all relative to the
715source dir -- any leading slashes are removed and no ".." references are
716allowed to go higher than the source dir. For example, take this
717command:
718
719quote(rsync -a --files-from=/tmp/foo /usr remote:/backup)
720
721If /tmp/foo contains the string "bin" (or even "/bin"), the /usr/bin
722directory will be created as /backup/bin on the remote host (but the
723contents of the /usr/bin dir would not be sent unless you specified -r
724or the names were explicitly listed in /tmp/foo). Also keep in mind
725that the effect of the (enabled by default) --relative option is to
726duplicate only the path info that is read from the file -- it does not
727force the duplication of the source-spec path (/usr in this case).
728
729In addition, the --files-from file can be read from the remote host
730instead of the local host if you specify a "host:" in front of the file
731(the host must match one end of the transfer). As a short-cut, you can
732specify just a prefix of ":" to mean "use the remote end of the
733transfer". For example:
734
735quote(rsync -a --files-from=:/path/file-list src:/ /tmp/copy)
736
737This would copy all the files specified in the /path/file-list file that
738was located on the remote "src" host.
739
740dit(bf(-0, --from0)) This tells rsync that the filenames it reads from a
741file are terminated by a null ('\0') character, not a NL, CR, or CR+LF.
742This affects --exclude-from, --include-from, and --files-from.
743It does not affect --cvs-exclude (since all names read from a .cvsignore
744file are split on whitespace).
745
746dit(bf(-T, --temp-dir=DIR)) This option instructs rsync to use DIR as a
747scratch directory when creating temporary copies of the files
748transferred on the receiving side. The default behavior is to create
749the temporary files in the receiving directory.
750
751dit(bf(--compare-dest=DIR)) This option instructs rsync to use DIR on
752the destination machine as an additional directory to compare destination
753files against when doing transfers if the files are missing in the
754destination directory. This is useful for doing transfers to a new
755destination while leaving existing files intact, and then doing a
756flash-cutover when all files have been successfully transferred (for
757example by moving directories around and removing the old directory,
758although this skips files that haven't changed; see also --link-dest).
759This option increases the usefulness of --partial because partially
760transferred files will remain in the new temporary destination until they
761have a chance to be completed. If DIR is a relative path, it is relative
762to the destination directory (which changes in a recursive transfer).
763
764dit(bf(--link-dest=DIR)) This option behaves like bf(--compare-dest) but
765also will create hard links from em(DIR) to the destination directory for
766unchanged files. Files with changed ownership or permissions will not be
767linked.
768Like bf(--compare-dest) if DIR is a relative path, it is relative
769to the destination directory (which changes in a recursive transfer).
770An example:
771
772verb(
773 rsync -av --link-dest=$PWD/prior_dir host:src_dir/ new_dir/
774)
775
776dit(bf(-z, --compress)) With this option, rsync compresses any data from
777the files that it sends to the destination machine. This
778option is useful on slow connections. The compression method used is the
779same method that gzip uses.
780
781Note this this option typically achieves better compression ratios
782that can be achieved by using a compressing remote shell, or a
783compressing transport, as it takes advantage of the implicit
784information sent for matching data blocks.
785
786dit(bf(--numeric-ids)) With this option rsync will transfer numeric group
787and user IDs rather than using user and group names and mapping them
788at both ends.
789
790By default rsync will use the username and groupname to determine
791what ownership to give files. The special uid 0 and the special group
7920 are never mapped via user/group names even if the --numeric-ids
793option is not specified.
794
795If a user or group has no name on the source system or it has no match
796on the destination system, then the numeric ID
797from the source system is used instead. See also the comments on the
798"use chroot" setting in the rsyncd.conf manpage for information on how
799the chroot setting affects rsync's ability to look up the names of the
800users and groups and what you can do about it.
801
802dit(bf(--timeout=TIMEOUT)) This option allows you to set a maximum I/O
803timeout in seconds. If no data is transferred for the specified time
804then rsync will exit. The default is 0, which means no timeout.
805
806dit(bf(--daemon)) This tells rsync that it is to run as a daemon. The
807daemon may be accessed using the bf(host::module) or
808bf(rsync://host/module/) syntax.
809
810If standard input is a socket then rsync will assume that it is being
811run via inetd, otherwise it will detach from the current terminal and
812become a background daemon. The daemon will read the config file
813(rsyncd.conf) on each connect made by a client and respond to
814requests accordingly. See the rsyncd.conf(5) man page for more
815details.
816
817dit(bf(--no-detach)) When running as a daemon, this option instructs
818rsync to not detach itself and become a background process. This
819option is required when running as a service on Cygwin, and may also
820be useful when rsync is supervised by a program such as
821bf(daemontools) or AIX's bf(System Resource Controller).
822bf(--no-detach) is also recommended when rsync is run under a
823debugger. This option has no effect if rsync is run from inetd or
824sshd.
825
826dit(bf(--address)) By default rsync will bind to the wildcard address
827when run as a daemon with the --daemon option or when connecting to a
828rsync server. The --address option allows you to specify a specific IP
829address (or hostname) to bind to. This makes virtual hosting possible
830in conjunction with the --config option.
831
832dit(bf(--config=FILE)) This specifies an alternate config file than
833the default. This is only relevant when --daemon is specified.
834The default is /etc/rsyncd.conf unless the daemon is running over
835a remote shell program and the remote user is not root; in that case
836the default is rsyncd.conf in the current directory (typically $HOME).
837
838dit(bf(--port=PORT)) This specifies an alternate TCP port number to use
839rather than the default port 873.
840
841dit(bf(--blocking-io)) This tells rsync to use blocking I/O when launching
842a remote shell transport. If the remote shell is either rsh or remsh,
843rsync defaults to using
844blocking I/O, otherwise it defaults to using non-blocking I/O. (Note that
845ssh prefers non-blocking I/O.)
846
847dit(bf(--no-blocking-io)) Turn off --blocking-io, for use when it is the
848default.
849
850dit(bf(--log-format=FORMAT)) This allows you to specify exactly what the
851rsync client logs to stdout on a per-file basis. The log format is
852specified using the same format conventions as the log format option in
853rsyncd.conf.
854
855dit(bf(--stats)) This tells rsync to print a verbose set of statistics
856on the file transfer, allowing you to tell how effective the rsync
857algorithm is for your data.
858
859dit(bf(--partial)) By default, rsync will delete any partially
860transferred file if the transfer is interrupted. In some circumstances
861it is more desirable to keep partially transferred files. Using the
862--partial option tells rsync to keep the partial file which should
863make a subsequent transfer of the rest of the file much faster.
864
865dit(bf(--progress)) This option tells rsync to print information
866showing the progress of the transfer. This gives a bored user
867something to watch.
868Implies --verbose without incrementing verbosity.
869
870When the file is transferring, the data looks like this:
871
872verb(
873 782448 63% 110.64kB/s 0:00:04
874)
875
876This tells you the current file size, the percentage of the transfer that
877is complete, the current calculated file-completion rate (including both
878data over the wire and data being matched locally), and the estimated time
879remaining in this transfer.
880
881After the a file is complete, it the data looks like this:
882
883verb(
884 1238099 100% 146.38kB/s 0:00:08 (5, 57.1% of 396)
885)
886
887This tells you the final file size, that it's 100% complete, the final
888transfer rate for the file, the amount of elapsed time it took to transfer
889the file, and the addition of a total-transfer summary in parentheses.
890These additional numbers tell you how many files have been updated, and
891what percent of the total number of files has been scanned.
892
893dit(bf(-P)) The -P option is equivalent to --partial --progress. I
894found myself typing that combination quite often so I created an
895option to make it easier.
896
897dit(bf(--password-file)) This option allows you to provide a password
898in a file for accessing a remote rsync server. Note that this option
899is only useful when accessing an rsync server using the built in
900transport, not when using a remote shell as the transport. The file
901must not be world readable. It should contain just the password as a
902single line.
903
904dit(bf(--bwlimit=KBPS)) This option allows you to specify a maximum
905transfer rate in kilobytes per second. This option is most effective when
906using rsync with large files (several megabytes and up). Due to the nature
907of rsync transfers, blocks of data are sent, then if rsync determines the
908transfer was too fast, it will wait before sending the next data block. The
909result is an average transfer rate equaling the specified limit. A value
910of zero specifies no limit.
911
912dit(bf(--write-batch=FILE)) Record a file that can later be applied to
913anonther identical destination with --read-batch. See the "BATCH MODE"
914section for details.
915
916dit(bf(--read-batch=FILE)) Apply all of the changes stored in FILE, a
917file previously generated by --write-batch.
918If em(FILE) is "-" the list will be read from standard input.
919See the "BATCH MODE" section for details.
920
921dit(bf(-4, --ipv4) or bf(-6, --ipv6)) Tells rsync to prefer IPv4/IPv6
922when creating sockets. This only affects sockets that rsync has direct
923control over, such as the outgoing socket when directly contacting an
924rsync daemon, or the incoming sockets that an rsync daemon uses to
925listen for connections. One of these options may be required in older
926versions of Linux to work around an IPv6 bug in the kernel (if you see
927an "address already in use" error when nothing else is using the port,
928try specifying --ipv6 or --ipv4 when starting the daemon).
929
930dit(bf(--checksum-seed=NUM)) Set the MD4 checksum seed to the integer
931NUM. This 4 byte checksum seed is included in each block and file
932MD4 checksum calculation. By default the checksum seed is generated
933by the server and defaults to the current time(). This option
934is used to set a specific checksum seed, which is useful for
935applications that want repeatable block and file checksums, or
936in the case where the user wants a more random checksum seed.
937Note that setting NUM to 0 causes rsync to use the default of time()
938for checksum seed.
939
940enddit()
941
942manpagesection(EXCLUDE PATTERNS)
943
944The exclude and include patterns specified to rsync allow for flexible
945selection of which files to transfer and which files to skip.
946
947Rsync builds an ordered list of include/exclude options as specified on
948the command line. Rsync checks each file and directory
949name against each exclude/include pattern in turn. The first matching
950pattern is acted on. If it is an exclude pattern, then that file is
951skipped. If it is an include pattern then that filename is not
952skipped. If no matching include/exclude pattern is found then the
953filename is not skipped.
954
955The filenames matched against the exclude/include patterns are relative
956to the "root of the transfer". If you think of the transfer as a
957subtree of names that are being sent from sender to receiver, the root
958is where the tree starts to be duplicated in the destination directory.
959This root governs where patterns that start with a / match (see below).
960
961Because the matching is relative to the transfer-root, changing the
962trailing slash on a source path or changing your use of the --relative
963option affects the path you need to use in your matching (in addition to
964changing how much of the file tree is duplicated on the destination
965system). The following examples demonstrate this.
966
967Let's say that we want to match two source files, one with an absolute
968path of "/home/me/foo/bar", and one with a path of "/home/you/bar/baz".
969Here is how the various command choices differ for a 2-source transfer:
970
971verb(
972 Example cmd: rsync -a /home/me /home/you /dest
973 +/- pattern: /me/foo/bar
974 +/- pattern: /you/bar/baz
975 Target file: /dest/me/foo/bar
976 Target file: /dest/you/bar/baz
977
978 Example cmd: rsync -a /home/me/ /home/you/ /dest
979 +/- pattern: /foo/bar (note missing "me")
980 +/- pattern: /bar/baz (note missing "you")
981 Target file: /dest/foo/bar
982 Target file: /dest/bar/baz
983
984 Example cmd: rsync -a --relative /home/me/ /home/you /dest
985 +/- pattern: /home/me/foo/bar (note full path)
986 +/- pattern: /home/you/bar/baz (ditto)
987 Target file: /dest/home/me/foo/bar
988 Target file: /dest/home/you/bar/baz
989
990 Example cmd: cd /home; rsync -a --relative me/foo you/ /dest
991 +/- pattern: /me/foo/bar (starts at specified path)
992 +/- pattern: /you/bar/baz (ditto)
993 Target file: /dest/me/foo/bar
994 Target file: /dest/you/bar/baz
995)
996
997The easiest way to see what name you should include/exclude is to just
998look at the output when using --verbose and put a / in front of the name
999(use the --dry-run option if you're not yet ready to copy any files).
1000
1001Note that, when using the --recursive (-r) option (which is implied by -a),
1002every subcomponent of
1003every path is visited from the top down, so include/exclude patterns get
1004applied recursively to each subcomponent.
1005The exclude patterns actually short-circuit the directory traversal stage
1006when rsync finds the files to send. If a pattern excludes a particular
1007parent directory, it can render a deeper include pattern ineffectual
1008because rsync did not descend through that excluded section of the
1009hierarchy.
1010
1011Note also that the --include and --exclude options take one pattern
1012each. To add multiple patterns use the --include-from and
1013--exclude-from options or multiple --include and --exclude options.
1014
1015The patterns can take several forms. The rules are:
1016
1017itemize(
1018
1019 it() if the pattern starts with a / then it is matched against the
1020 start of the filename, otherwise it is matched against the end of
1021 the filename.
1022 This is the equivalent of a leading ^ in regular expressions.
1023 Thus "/foo" would match a file called "foo" at the transfer-root
1024 (see above for how this is different from the filesystem-root).
1025 On the other hand, "foo" would match any file called "foo"
1026 anywhere in the tree because the algorithm is applied recursively from
1027 top down; it behaves as if each path component gets a turn at being the
1028 end of the file name.
1029
1030 it() if the pattern ends with a / then it will only match a
1031 directory, not a file, link, or device.
1032
1033 it() if the pattern contains a wildcard character from the set
1034 *?[ then expression matching is applied using the shell filename
1035 matching rules. Otherwise a simple string match is used.
1036
1037 it() the double asterisk pattern "**" will match slashes while a
1038 single asterisk pattern "*" will stop at slashes.
1039
1040 it() if the pattern contains a / (not counting a trailing /) or a "**"
1041 then it is matched against the full filename, including any leading
1042 directory. If the pattern doesn't contain a / or a "**", then it is
1043 matched only against the final component of the filename. Again,
1044 remember that the algorithm is applied recursively so "full filename" can
1045 actually be any portion of a path below the starting directory.
1046
1047 it() if the pattern starts with "+ " (a plus followed by a space)
1048 then it is always considered an include pattern, even if specified as
1049 part of an exclude option. The prefix is discarded before matching.
1050
1051 it() if the pattern starts with "- " (a minus followed by a space)
1052 then it is always considered an exclude pattern, even if specified as
1053 part of an include option. The prefix is discarded before matching.
1054
1055 it() if the pattern is a single exclamation mark ! then the current
1056 include/exclude list is reset, removing all previously defined patterns.
1057)
1058
1059The +/- rules are most useful in a list that was read from a file, allowing
1060you to have a single exclude list that contains both include and exclude
1061options in the proper order.
1062
1063Remember that the matching occurs at every step in the traversal of the
1064directory hierarchy, so you must be sure that all the parent directories of
1065the files you want to include are not excluded. This is particularly
1066important when using a trailing '*' rule. For instance, this won't work:
1067
1068verb(
1069 + /some/path/this-file-will-not-be-found
1070 + /file-is-included
1071 - *
1072)
1073
1074This fails because the parent directory "some" is excluded by the '*' rule,
1075so rsync never visits any of the files in the "some" or "some/path"
1076directories. One solution is to ask for all directories in the hierarchy
1077to be included by using a single rule: --include='*/' (put it somewhere
1078before the --exclude='*' rule). Another solution is to add specific
1079include rules for all the parent dirs that need to be visited. For
1080instance, this set of rules works fine:
1081
1082verb(
1083 + /some/
1084 + /some/path/
1085 + /some/path/this-file-is-found
1086 + /file-also-included
1087 - *
1088)
1089
1090Here are some examples of exclude/include matching:
1091
1092itemize(
1093 it() --exclude "*.o" would exclude all filenames matching *.o
1094 it() --exclude "/foo" would exclude a file called foo in the transfer-root directory
1095 it() --exclude "foo/" would exclude any directory called foo
1096 it() --exclude "/foo/*/bar" would exclude any file called bar two
1097 levels below a directory called foo in the transfer-root directory
1098 it() --exclude "/foo/**/bar" would exclude any file called bar two
1099 or more levels below a directory called foo in the transfer-root directory
1100 it() --include "*/" --include "*.c" --exclude "*" would include all
1101 directories and C source files
1102 it() --include "foo/" --include "foo/bar.c" --exclude "*" would include
1103 only foo/bar.c (the foo/ directory must be explicitly included or
1104 it would be excluded by the "*")
1105)
1106
1107manpagesection(BATCH MODE)
1108
1109bf(Note:) Batch mode should be considered experimental in this version
1110of rsync. The interface or behavior may change before it stabilizes.
1111
1112Batch mode can be used to apply the same set of updates to many
1113identical systems. Suppose one has a tree which is replicated on a
1114number of hosts. Now suppose some changes have been made to this
1115source tree and those changes need to be propagated to the other
1116hosts. In order to do this using batch mode, rsync is run with the
1117write-batch option to apply the changes made to the source tree to one
1118of the destination trees. The write-batch option causes the rsync
1119client to store in a "batch file" all the information needed to repeat
1120this operation against other, identical destination trees.
1121
1122To apply the recorded changes to another destination tree, run rsync
1123with the read-batch option, specifying the name of the same batch
1124file, and the destination tree. Rsync updates the destination tree
1125using the information stored in the batch file.
1126
1127For convenience, one additional file is creating when the write-batch
1128option is used. This file's name is created by appending
1129".rsync_argvs" to the batch filename. The .rsync_argvs file contains
1130a command-line suitable for updating a destination tree using that
1131batch file. It can be executed using a Bourne(-like) shell, optionally
1132passing in an alternate destination tree pathname which is then used
1133instead of the original path. This is useful when the destination tree
1134path differs from the original destination tree path.
1135
1136Generating the batch file once saves having to perform the file
1137status, checksum, and data block generation more than once when
1138updating multiple destination trees. Multicast transport protocols can
1139be used to transfer the batch update files in parallel to many hosts
1140at once, instead of sending the same data to every host individually.
1141
1142Examples:
1143
1144verb(
1145 $ rsync --write-batch=batch -a /source/dir/ /adest/dir/
1146 $ ssh remote rsync --read-batch=- -a /bdest/dir/ <batch
1147)
1148
1149verb(
1150 $ rsync --write-batch=batch -a host:/source/dir/ /adest/dir/
1151 $ scp batch remote:
1152 $ ssh remote rsync --read-batch=batch -a /bdest/dir/
1153)
1154
1155verb(
1156 $ rsync --write-batch=batch -a /source/dir/ host:/adest/dir/
1157 $ scp batch* remote:
1158 $ ssh remote ./batch.rsync_argvs /bdest/dir/
1159)
1160
1161In these examples, rsync is used to update /adest/dir/ with /source/dir/
1162and the information to repeat this operation is stored in "batch" and
1163"batch.rsync_argvs". The host "remote" is then updated with the batched
1164update going into the directory /bdest/dir. The differences between the
1165three examples is in how the batch gets to the remote machine (via remote
1166stdin or by being copied first), whether the initial transfer was local or
1167remote, and in how the batch-reading rsync command is invoked.
1168
1169Caveats:
1170
1171The read-batch option expects the destination tree it is meant to update
1172to be identical to the destination tree that was used to create the
1173batch update fileset. When a difference between the destination trees
1174is encountered the update will fail at that point, leaving the
1175destination tree in a partially updated state. In that case, rsync can
1176be used in its regular (non-batch) mode of operation to fix up the
1177destination tree.
1178
1179The rsync version used on all destinations must be at least as new as the
1180one used to generate the batch file.
1181
1182The -n/--dryrun option does not work in batch mode and yields a runtime
1183error.
1184
1185You should use an equivalent set of options when reading a batch file that
1186you used when generating it with a few exceptions. For instance
1187--write-batch changes to --read-batch, --files-from is dropped, and the
1188--include/--exclude options are not needed unless --delete is specified
1189without --delete-excluded. Other options that affect how the update
1190happens should generally remain the same as it is possible to confuse rsync
1191into expecting a different data stream than the one that is contained in
1192the batch file. For example, it would not work to change the setting of
1193the -H or -c option, but it would work to add or remove the --delete
1194option.
1195
1196See bf(http://www.ils.unc.edu/i2dsi/unc_rsync+.html) for papers and technical
1197reports.
1198
1199manpagesection(SYMBOLIC LINKS)
1200
1201Three basic behaviors are possible when rsync encounters a symbolic
1202link in the source directory.
1203
1204By default, symbolic links are not transferred at all. A message
1205"skipping non-regular" file is emitted for any symlinks that exist.
1206
1207If bf(--links) is specified, then symlinks are recreated with the same
1208target on the destination. Note that bf(--archive) implies
1209bf(--links).
1210
1211If bf(--copy-links) is specified, then symlinks are "collapsed" by
1212copying their referent, rather than the symlink.
1213
1214rsync also distinguishes "safe" and "unsafe" symbolic links. An
1215example where this might be used is a web site mirror that wishes
1216ensure the rsync module they copy does not include symbolic links to
1217bf(/etc/passwd) in the public section of the site. Using
1218bf(--copy-unsafe-links) will cause any links to be copied as the file
1219they point to on the destination. Using bf(--safe-links) will cause
1220unsafe links to be omitted altogether.
1221
1222Symbolic links are considered unsafe if they are absolute symlinks
1223(start with bf(/)), empty, or if they contain enough bf("..")
1224components to ascend from the directory being copied.
1225
1226manpagesection(DIAGNOSTICS)
1227
1228rsync occasionally produces error messages that may seem a little
1229cryptic. The one that seems to cause the most confusion is "protocol
1230version mismatch - is your shell clean?".
1231
1232This message is usually caused by your startup scripts or remote shell
1233facility producing unwanted garbage on the stream that rsync is using
1234for its transport. The way to diagnose this problem is to run your
1235remote shell like this:
1236
1237verb(
1238 ssh remotehost /bin/true > out.dat
1239)
1240
1241then look at out.dat. If everything is working correctly then out.dat
1242should be a zero length file. If you are getting the above error from
1243rsync then you will probably find that out.dat contains some text or
1244data. Look at the contents and try to work out what is producing
1245it. The most common cause is incorrectly configured shell startup
1246scripts (such as .cshrc or .profile) that contain output statements
1247for non-interactive logins.
1248
1249If you are having trouble debugging include and exclude patterns, then
1250try specifying the -vv option. At this level of verbosity rsync will
1251show why each individual file is included or excluded.
1252
1253manpagesection(EXIT VALUES)
1254
1255startdit()
1256dit(bf(0)) Success
1257dit(bf(1)) Syntax or usage error
1258dit(bf(2)) Protocol incompatibility
1259dit(bf(3)) Errors selecting input/output files, dirs
1260dit(bf(4)) Requested action not supported: an attempt
1261was made to manipulate 64-bit files on a platform that cannot support
1262them; or an option was specified that is supported by the client and
1263not by the server.
1264dit(bf(5)) Error starting client-server protocol
1265dit(bf(10)) Error in socket I/O
1266dit(bf(11)) Error in file I/O
1267dit(bf(12)) Error in rsync protocol data stream
1268dit(bf(13)) Errors with program diagnostics
1269dit(bf(14)) Error in IPC code
1270dit(bf(20)) Received SIGUSR1 or SIGINT
1271dit(bf(21)) Some error returned by waitpid()
1272dit(bf(22)) Error allocating core memory buffers
1273dit(bf(23)) Partial transfer due to error
1274dit(bf(24)) Partial transfer due to vanished source files
1275dit(bf(30)) Timeout in data send/receive
1276enddit()
1277
1278manpagesection(ENVIRONMENT VARIABLES)
1279
1280startdit()
1281
1282dit(bf(CVSIGNORE)) The CVSIGNORE environment variable supplements any
1283ignore patterns in .cvsignore files. See the --cvs-exclude option for
1284more details.
1285
1286dit(bf(RSYNC_RSH)) The RSYNC_RSH environment variable allows you to
1287override the default shell used as the transport for rsync. Command line
1288options are permitted after the command name, just as in the -e option.
1289
1290dit(bf(RSYNC_PROXY)) The RSYNC_PROXY environment variable allows you to
1291redirect your rsync client to use a web proxy when connecting to a
1292rsync daemon. You should set RSYNC_PROXY to a hostname:port pair.
1293
1294dit(bf(RSYNC_PASSWORD)) Setting RSYNC_PASSWORD to the required
1295password allows you to run authenticated rsync connections to an rsync
1296daemon without user intervention. Note that this does not supply a
1297password to a shell transport such as ssh.
1298
1299dit(bf(USER) or bf(LOGNAME)) The USER or LOGNAME environment variables
1300are used to determine the default username sent to an rsync server.
1301If neither is set, the username defaults to "nobody".
1302
1303dit(bf(HOME)) The HOME environment variable is used to find the user's
1304default .cvsignore file.
1305
1306enddit()
1307
1308manpagefiles()
1309
1310/etc/rsyncd.conf or rsyncd.conf
1311
1312manpageseealso()
1313
1314rsyncd.conf(5)
1315
1316manpagediagnostics()
1317
1318manpagebugs()
1319
1320times are transferred as unix time_t values
1321
1322When transferring to FAT filesystems rsync may re-sync
1323unmodified files.
1324See the comments on the --modify-window option.
1325
1326file permissions, devices, etc. are transferred as native numerical
1327values
1328
1329see also the comments on the --delete option
1330
1331Please report bugs! See the website at
1332url(http://rsync.samba.org/)(http://rsync.samba.org/)
1333
1334manpagesection(CREDITS)
1335
1336rsync is distributed under the GNU public license. See the file
1337COPYING for details.
1338
1339A WEB site is available at
1340url(http://rsync.samba.org/)(http://rsync.samba.org/). The site
1341includes an FAQ-O-Matic which may cover questions unanswered by this
1342manual page.
1343
1344The primary ftp site for rsync is
1345url(ftp://rsync.samba.org/pub/rsync)(ftp://rsync.samba.org/pub/rsync).
1346
1347We would be delighted to hear from you if you like this program.
1348
1349This program uses the excellent zlib compression library written by
1350Jean-loup Gailly and Mark Adler.
1351
1352manpagesection(THANKS)
1353
1354Thanks to Richard Brent, Brendan Mackay, Bill Waite, Stephen Rothwell
1355and David Bell for helpful suggestions, patches and testing of rsync.
1356I've probably missed some people, my apologies if I have.
1357
1358Especial thanks also to: David Dykstra, Jos Backus, Sebastian Krahmer,
1359Martin Pool, Wayne Davison.
1360
1361manpageauthor()
1362
1363rsync was originally written by Andrew Tridgell and Paul Mackerras.
1364Many people have later contributed to it.
1365
1366Mailing lists for support and development are available at
1367url(http://lists.samba.org)(lists.samba.org)