Commit | Line | Data |
---|---|---|
9e3c856a | 1 | mailto(rsync-bugs@samba.org) |
3d6feada | 2 | manpage(rsync)(1)(25 Jan 2002)()() |
41059f75 AT |
3 | manpagename(rsync)(faster, flexible replacement for rcp) |
4 | manpagesynopsis() | |
5 | ||
9ef53907 | 6 | rsync [OPTION]... SRC [SRC]... [USER@]HOST:DEST |
41059f75 | 7 | |
9ef53907 | 8 | rsync [OPTION]... [USER@]HOST:SRC DEST |
41059f75 | 9 | |
9ef53907 | 10 | rsync [OPTION]... SRC [SRC]... DEST |
41059f75 | 11 | |
9ef53907 | 12 | rsync [OPTION]... [USER@]HOST::SRC [DEST] |
41059f75 | 13 | |
9ef53907 | 14 | rsync [OPTION]... SRC [SRC]... [USER@]HOST::DEST |
41059f75 | 15 | |
9ef53907 | 16 | rsync [OPTION]... rsync://[USER@]HOST[:PORT]/SRC [DEST] |
039faa86 | 17 | |
8d69d571 WD |
18 | rsync [OPTION]... SRC [SRC]... rsync://[USER@]HOST[:PORT]/DEST |
19 | ||
41059f75 AT |
20 | manpagedescription() |
21 | ||
22 | rsync is a program that behaves in much the same way that rcp does, | |
23 | but has many more options and uses the rsync remote-update protocol to | |
eb06fa95 | 24 | greatly speed up file transfers when the destination file already |
41059f75 AT |
25 | exists. |
26 | ||
27 | The rsync remote-update protocol allows rsync to transfer just the | |
28 | differences between two sets of files across the network link, using | |
29 | an efficient checksum-search algorithm described in the technical | |
30 | report that accompanies this package. | |
31 | ||
32 | Some of the additional features of rsync are: | |
33 | ||
34 | itemize( | |
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 rsh or ssh | |
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 | ||
45 | manpagesection(GENERAL) | |
46 | ||
bef49340 | 47 | There are eight different ways of using rsync. They are: |
41059f75 AT |
48 | |
49 | itemize( | |
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 rsh or | |
55 | ssh). 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 | |
6c7c2ef3 | 59 | using a remote shell program. This is invoked when the source |
41059f75 AT |
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 :: | |
946347b8 | 64 | separator or a rsync:// URL. |
41059f75 AT |
65 | |
66 | it() for copying from the local machine to a remote rsync | |
67 | server. This is invoked when the destination path contains a :: | |
8d69d571 | 68 | separator or a rsync:// URL. |
039faa86 | 69 | |
bef49340 WD |
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=COMMMAND option is also provided. | |
81 | ||
039faa86 AT |
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. | |
41059f75 AT |
85 | ) |
86 | ||
14d43f1f DD |
87 | Note that in all cases (other than listing) at least one of the source |
88 | and destination paths must be local. | |
41059f75 AT |
89 | |
90 | manpagesection(SETUP) | |
91 | ||
92 | See the file README for installation instructions. | |
93 | ||
1bbf83c0 WD |
94 | Once installed, you can use rsync to any machine that you can access via |
95 | a remote shell (as well as some that you can access using the rsync | |
96 | daemon-mode protocol). For remote transfers, rsync typically uses rsh | |
97 | for its communications, but it may have been configured to use a | |
98 | different remote shell by default, such as ssh. | |
41059f75 | 99 | |
1bbf83c0 | 100 | You can also specify any remote shell you like, either by using the -e |
41059f75 AT |
101 | command line option, or by setting the RSYNC_RSH environment variable. |
102 | ||
103 | One common substitute is to use ssh, which offers a high degree of | |
104 | security. | |
105 | ||
8e987130 AT |
106 | Note that rsync must be installed on both the source and destination |
107 | machines. | |
108 | ||
41059f75 AT |
109 | manpagesection(USAGE) |
110 | ||
111 | You use rsync in the same way you use rcp. You must specify a source | |
112 | and a destination, one of which may be remote. | |
113 | ||
114 | Perhaps the best way to explain the syntax is some examples: | |
115 | ||
116 | quote(rsync *.c foo:src/) | |
117 | ||
118 | this would transfer all files matching the pattern *.c from the | |
119 | current directory to the directory src on the machine foo. If any of | |
120 | the files already exist on the remote system then the rsync | |
121 | remote-update protocol is used to update the file by sending only the | |
122 | differences. See the tech report for details. | |
123 | ||
124 | quote(rsync -avz foo:src/bar /data/tmp) | |
125 | ||
14d43f1f | 126 | this would recursively transfer all files from the directory src/bar on the |
41059f75 AT |
127 | machine foo into the /data/tmp/bar directory on the local machine. The |
128 | files are transferred in "archive" mode, which ensures that symbolic | |
129 | links, devices, attributes, permissions, ownerships etc are preserved | |
14d43f1f | 130 | in the transfer. Additionally, compression will be used to reduce the |
41059f75 AT |
131 | size of data portions of the transfer. |
132 | ||
133 | quote(rsync -avz foo:src/bar/ /data/tmp) | |
134 | ||
14d43f1f | 135 | a trailing slash on the source changes this behavior to transfer |
41059f75 | 136 | all files from the directory src/bar on the machine foo into the |
14d43f1f | 137 | /data/tmp/. A trailing / on a source name means "copy the |
41059f75 AT |
138 | contents of this directory". Without a trailing slash it means "copy |
139 | the directory". This difference becomes particularly important when | |
140 | using the --delete option. | |
141 | ||
142 | You can also use rsync in local-only mode, where both the source and | |
143 | destination don't have a ':' in the name. In this case it behaves like | |
144 | an improved copy command. | |
145 | ||
14d43f1f DD |
146 | quote(rsync somehost.mydomain.com::) |
147 | ||
148 | this would list all the anonymous rsync modules available on the host | |
149 | somehost.mydomain.com. (See the following section for more details.) | |
150 | ||
41059f75 AT |
151 | |
152 | manpagesection(CONNECTING TO AN RSYNC SERVER) | |
153 | ||
1bbf83c0 | 154 | It is also possible to use rsync without a remote shell as the |
41059f75 AT |
155 | transport. In this case you will connect to a remote rsync server |
156 | running on TCP port 873. | |
157 | ||
eb06fa95 | 158 | You may establish the connection via a web proxy by setting the |
4c3b4b25 | 159 | environment variable RSYNC_PROXY to a hostname:port pair pointing to |
eb06fa95 MP |
160 | your web proxy. Note that your web proxy's configuration must allow |
161 | proxying to port 873. | |
4c3b4b25 | 162 | |
1bbf83c0 | 163 | Using rsync in this way is the same as using it with a remote shell except |
41059f75 AT |
164 | that: |
165 | ||
166 | itemize( | |
167 | it() you use a double colon :: instead of a single colon to | |
8d69d571 | 168 | separate the hostname from the path or a rsync:// URL. |
41059f75 AT |
169 | |
170 | it() the remote server may print a message of the day when you | |
14d43f1f | 171 | connect. |
41059f75 AT |
172 | |
173 | it() if you specify no path name on the remote server then the | |
174 | list of accessible paths on the server will be shown. | |
14d43f1f | 175 | |
f7632fc6 | 176 | it() if you specify no local destination then a listing of the |
14d43f1f | 177 | specified files on the remote server is provided. |
41059f75 AT |
178 | ) |
179 | ||
4c3d16be AT |
180 | Some paths on the remote server may require authentication. If so then |
181 | you will receive a password prompt when you connect. You can avoid the | |
182 | password prompt by setting the environment variable RSYNC_PASSWORD to | |
65575e96 AT |
183 | the password you want to use or using the --password-file option. This |
184 | may be useful when scripting rsync. | |
4c3d16be | 185 | |
3bc67f0c | 186 | WARNING: On some systems environment variables are visible to all |
65575e96 | 187 | users. On those systems using --password-file is recommended. |
3bc67f0c | 188 | |
bef49340 WD |
189 | manpagesection(CONNECTING TO AN RSYNC SERVER OVER A REMOTE SHELL PROGRAM) |
190 | ||
191 | It is sometimes useful to be able to set up file transfers using rsync | |
192 | server capabilities on the remote machine, while still using rsh or | |
193 | ssh for transport. This is especially useful when you want to connect | |
194 | to a remote machine via ssh (for encryption or to get through a | |
195 | firewall), but you still want to have access to the rsync server | |
196 | features (see RUNNING AN RSYNC SERVER OVER A REMOTE SHELL PROGRAM, | |
197 | below). | |
198 | ||
199 | From the user's perspective, using rsync in this way is the same as | |
200 | using it to connect to an rsync server, except that you must | |
201 | explicitly set the remote shell program on the command line with | |
202 | --rsh=COMMAND. (Setting RSYNC_RSH in the environment will not turn on | |
203 | this functionality.) | |
204 | ||
205 | In order to distinguish between the remote-shell user and the rsync | |
206 | server user, you can use '-l user' on your remote-shell command: | |
207 | ||
208 | quote(rsync -av --rsh="ssh -l ssh-user" rsync-user@host::module[/path] local-path) | |
209 | ||
210 | The "ssh-user" will be used at the ssh level; the "rsync-user" will be | |
211 | used to check against the rsyncd.conf on the remote host. | |
212 | ||
41059f75 AT |
213 | manpagesection(RUNNING AN RSYNC SERVER) |
214 | ||
215 | An rsync server is configured using a config file which by default is | |
216 | called /etc/rsyncd.conf. Please see the rsyncd.conf(5) man page for more | |
217 | information. | |
218 | ||
bef49340 WD |
219 | manpagesection(RUNNING AN RSYNC SERVER OVER A REMOTE SHELL PROGRAM) |
220 | ||
221 | See the rsyncd.conf(5) man page for full information on the rsync | |
222 | server configuration file. | |
223 | ||
224 | Several configuration options will not be available unless the remote | |
225 | user is root (e.g. chroot, setuid/setgid, etc.). There is no need to | |
226 | configure inetd or the services map to include the rsync server port | |
227 | if you run an rsync server only via a remote shell program. | |
228 | ||
229 | To run an rsync server out of a single-use ssh key, use the | |
230 | "command=em(COMMAND)" syntax in the remote user's | |
231 | authorized_keys entry, where command would be | |
232 | ||
233 | quote(rsync --server --daemon .) | |
234 | ||
235 | NOTE: rsync's argument parsing expects the trailing ".", so make sure | |
236 | that it's there. If you want to use a rsyncd.conf(5)-style | |
237 | configuration file other than /etc/rsyncd.conf, you can added a | |
238 | --config-file option to the em(command): | |
239 | ||
240 | quote(rsync --server --daemon --config-file=em(file) .) | |
241 | ||
41059f75 AT |
242 | manpagesection(EXAMPLES) |
243 | ||
244 | Here are some examples of how I use rsync. | |
245 | ||
14d43f1f DD |
246 | To backup my wife's home directory, which consists of large MS Word |
247 | files and mail folders, I use a cron job that runs | |
41059f75 AT |
248 | |
249 | quote(rsync -Cavz . arvidsjaur:backup) | |
250 | ||
251 | each night over a PPP link to a duplicate directory on my machine | |
252 | "arvidsjaur". | |
253 | ||
254 | To synchronize my samba source trees I use the following Makefile | |
255 | targets: | |
256 | ||
257 | quote( get:nl() | |
258 | rsync -avuzb --exclude '*~' samba:samba/ . | |
259 | ||
260 | put:nl() | |
261 | rsync -Cavuzb . samba:samba/ | |
262 | ||
263 | sync: get put) | |
264 | ||
265 | this allows me to sync with a CVS directory at the other end of the | |
266 | link. I then do cvs operations on the remote machine, which saves a | |
267 | lot of time as the remote cvs protocol isn't very efficient. | |
268 | ||
269 | I mirror a directory between my "old" and "new" ftp sites with the | |
270 | command | |
271 | ||
272 | quote(rsync -az -e ssh --delete ~ftp/pub/samba/ nimbus:"~ftp/pub/tridge/samba") | |
273 | ||
274 | this is launched from cron every few hours. | |
275 | ||
c95da96a AT |
276 | manpagesection(OPTIONS SUMMARY) |
277 | ||
14d43f1f | 278 | Here is a short summary of the options available in rsync. Please refer |
c95da96a AT |
279 | to the detailed description below for a complete description. |
280 | ||
281 | verb( | |
282 | -v, --verbose increase verbosity | |
b86f0cef | 283 | -q, --quiet decrease verbosity |
c95da96a AT |
284 | -c, --checksum always checksum |
285 | -a, --archive archive mode | |
286 | -r, --recursive recurse into directories | |
287 | -R, --relative use relative path names | |
9ef53907 | 288 | -b, --backup make backups (default ~ suffix) |
5b56cc19 | 289 | --backup-dir make backups into this directory |
759ac870 | 290 | --suffix=SUFFIX define backup suffix |
c95da96a | 291 | -u, --update update only (don't overwrite newer files) |
eb06fa95 MP |
292 | -l, --links copy symlinks as symlinks |
293 | -L, --copy-links copy the referent of symlinks | |
b5313607 | 294 | --copy-unsafe-links copy links outside the source tree |
d853783f | 295 | --safe-links ignore links outside the destination tree |
c95da96a AT |
296 | -H, --hard-links preserve hard links |
297 | -p, --perms preserve permissions | |
298 | -o, --owner preserve owner (root only) | |
299 | -g, --group preserve group | |
300 | -D, --devices preserve devices (root only) | |
301 | -t, --times preserve times | |
302 | -S, --sparse handle sparse files efficiently | |
303 | -n, --dry-run show what would have been transferred | |
304 | -W, --whole-file copy whole files, no incremental checks | |
93689aa5 | 305 | --no-whole-file turn off --whole-file |
c95da96a | 306 | -x, --one-file-system don't cross filesystem boundaries |
9ef53907 | 307 | -B, --block-size=SIZE checksum blocking size (default 700) |
1bbf83c0 | 308 | -e, --rsh=COMMAND specify the remote shell to use |
d9fcc198 | 309 | --rsync-path=PATH specify path to rsync on the remote machine |
c95da96a | 310 | -C, --cvs-exclude auto ignore files in the same way CVS does |
1347d512 | 311 | --existing only update files that already exist |
3d6feada | 312 | --ignore-existing ignore files that already exist on the receiving side |
c95da96a | 313 | --delete delete files that don't exist on the sending side |
b33b791e | 314 | --delete-excluded also delete excluded files on the receiving side |
1347d512 | 315 | --delete-after delete after transferring, not before |
ef55c686 | 316 | --ignore-errors delete even if there are IO errors |
0b73ca12 | 317 | --max-delete=NUM don't delete more than NUM files |
c95da96a AT |
318 | --partial keep partially transferred files |
319 | --force force deletion of directories even if not empty | |
320 | --numeric-ids don't map uid/gid values by user/group name | |
321 | --timeout=TIME set IO timeout in seconds | |
322 | -I, --ignore-times don't exclude files that match length and time | |
f83f0548 | 323 | --size-only only use file size when determining if a file should be transferred |
5b56cc19 | 324 | --modify-window=NUM Timestamp window (seconds) for file match (default=0) |
c95da96a | 325 | -T --temp-dir=DIR create temporary files in directory DIR |
375a4556 | 326 | --compare-dest=DIR also compare destination files relative to DIR |
59c95e42 | 327 | --link-dest=DIR create hardlinks to DIR for unchanged files |
d9fcc198 | 328 | -P equivalent to --partial --progress |
c95da96a | 329 | -z, --compress compress file data |
2acf81eb | 330 | --exclude=PATTERN exclude files matching PATTERN |
9ef53907 | 331 | --exclude-from=FILE exclude patterns listed in FILE |
2acf81eb | 332 | --include=PATTERN don't exclude files matching PATTERN |
9ef53907 | 333 | --include-from=FILE don't exclude patterns listed in FILE |
c95da96a AT |
334 | --version print version number |
335 | --daemon run as a rsync daemon | |
bbd6f4ba | 336 | --no-detach do not detach from the parent |
2a951cd2 | 337 | --address=ADDRESS bind to the specified address |
c95da96a AT |
338 | --config=FILE specify alternate rsyncd.conf file |
339 | --port=PORT specify alternate rsyncd port number | |
64c704f0 | 340 | --blocking-io use blocking IO for the remote shell |
93689aa5 | 341 | --no-blocking-io turn off --blocking-io |
c95da96a | 342 | --stats give some file transfer stats |
eb86d661 | 343 | --progress show progress during transfer |
b6062654 | 344 | --log-format=FORMAT log file transfers using specified format |
9ef53907 | 345 | --password-file=FILE get password from FILE |
ef5d23eb | 346 | --bwlimit=KBPS limit I/O bandwidth, KBytes per second |
088aac85 DD |
347 | --read-batch=PREFIX read batch fileset starting with PREFIX |
348 | --write-batch=PREFIX write batch fileset starting with PREFIX | |
c95da96a | 349 | -h, --help show this help screen |
6902ed17 MP |
350 | |
351 | ||
c95da96a AT |
352 | ) |
353 | ||
41059f75 AT |
354 | manpageoptions() |
355 | ||
356 | rsync uses the GNU long options package. Many of the command line | |
357 | options have two variants, one short and one long. These are shown | |
14d43f1f | 358 | below, separated by commas. Some options only have a long variant. |
b5679335 DD |
359 | The '=' for options that take a parameter is optional; whitespace |
360 | can be used instead. | |
41059f75 AT |
361 | |
362 | startdit() | |
363 | dit(bf(-h, --help)) Print a short help page describing the options | |
364 | available in rsync | |
365 | ||
366 | dit(bf(--version)) print the rsync version number and exit | |
367 | ||
368 | dit(bf(-v, --verbose)) This option increases the amount of information you | |
14d43f1f | 369 | are given during the transfer. By default, rsync works silently. A |
41059f75 AT |
370 | single -v will give you information about what files are being |
371 | transferred and a brief summary at the end. Two -v flags will give you | |
372 | information on what files are being skipped and slightly more | |
373 | information at the end. More than two -v flags should only be used if | |
14d43f1f | 374 | you are debugging rsync. |
41059f75 | 375 | |
b86f0cef DD |
376 | dit(bf(-q, --quiet)) This option decreases the amount of information you |
377 | are given during the transfer, notably suppressing information messages | |
378 | from the remote server. This flag is useful when invoking rsync from | |
379 | cron. | |
380 | ||
41059f75 AT |
381 | dit(bf(-I, --ignore-times)) Normally rsync will skip any files that are |
382 | already the same length and have the same time-stamp. This option turns | |
383 | off this behavior. | |
384 | ||
a7d068ab | 385 | dit(bf(--size-only)) Normally rsync will skip any files that are |
f83f0548 AT |
386 | already the same length and have the same time-stamp. With the |
387 | --size-only option files will be skipped if they have the same size, | |
388 | regardless of timestamp. This is useful when starting to use rsync | |
389 | after using another mirroring system which may not preserve timestamps | |
390 | exactly. | |
391 | ||
5b56cc19 AT |
392 | dit(bf(--modify-window)) When comparing two timestamps rsync treats |
393 | the timestamps as being equal if they are within the value of | |
394 | modify_window. This is normally zero, but you may find it useful to | |
395 | set this to a larger value in some situations. In particular, when | |
396 | transferring to/from FAT filesystems which cannot represent times with | |
397 | a 1 second resolution this option is useful. | |
398 | ||
41059f75 AT |
399 | dit(bf(-c, --checksum)) This forces the sender to checksum all files using |
400 | a 128-bit MD4 checksum before transfer. The checksum is then | |
401 | explicitly checked on the receiver and any files of the same name | |
402 | which already exist and have the same checksum and size on the | |
403 | receiver are skipped. This option can be quite slow. | |
404 | ||
e7bf3e5e MP |
405 | dit(bf(-a, --archive)) This is equivalent to -rlptgoD. It is a quick |
406 | way of saying you want recursion and want to preserve almost | |
407 | everything. | |
408 | ||
409 | Note however that bf(-a) bf(does not preserve hardlinks), because | |
410 | finding multiply-linked files is expensive. You must separately | |
411 | specify bf(-H). | |
41059f75 | 412 | |
24986abd AT |
413 | dit(bf(-r, --recursive)) This tells rsync to copy directories |
414 | recursively. If you don't specify this then rsync won't copy | |
415 | directories at all. | |
41059f75 AT |
416 | |
417 | dit(bf(-R, --relative)) Use relative paths. This means that the full path | |
418 | names specified on the command line are sent to the server rather than | |
419 | just the last parts of the filenames. This is particularly useful when | |
14d43f1f DD |
420 | you want to send several different directories at the same time. For |
421 | example, if you used the command | |
41059f75 AT |
422 | |
423 | verb(rsync foo/bar/foo.c remote:/tmp/) | |
424 | ||
425 | then this would create a file called foo.c in /tmp/ on the remote | |
426 | machine. If instead you used | |
427 | ||
428 | verb(rsync -R foo/bar/foo.c remote:/tmp/) | |
429 | ||
430 | then a file called /tmp/foo/bar/foo.c would be created on the remote | |
431 | machine. The full path name is preserved. | |
432 | ||
433 | dit(bf(-b, --backup)) With this option preexisting destination files are | |
434 | renamed with a ~ extension as each file is transferred. You can | |
435 | control the backup suffix using the --suffix option. | |
436 | ||
66203a98 AT |
437 | dit(bf(--backup-dir=DIR)) In combination with the --backup option, this |
438 | tells rsync to store all backups in the specified directory. This is | |
759ac870 DD |
439 | very useful for incremental backups. You can additionally |
440 | specify a backup suffix using the --suffix option | |
441 | (otherwise the files backed up in the specified directory | |
442 | will keep their original filenames). | |
66203a98 | 443 | |
b5679335 | 444 | dit(bf(--suffix=SUFFIX)) This option allows you to override the default |
9ef53907 | 445 | backup suffix used with the -b option. The default is a ~. |
759ac870 DD |
446 | If --backup-dir and --suffix are both specified, |
447 | the SUFFIX is appended to the filename even in the backup directory. | |
9ef53907 | 448 | |
41059f75 AT |
449 | dit(bf(-u, --update)) This forces rsync to skip any files for which the |
450 | destination file already exists and has a date later than the source | |
451 | file. | |
452 | ||
eb06fa95 MP |
453 | dit(bf(-l, --links)) When symlinks are encountered, recreate the |
454 | symlink on the destination. | |
41059f75 | 455 | |
eb06fa95 MP |
456 | dit(bf(-L, --copy-links)) When symlinks are encountered, the file that |
457 | they point to is copied, rather than the symlink. | |
b5313607 | 458 | |
eb06fa95 MP |
459 | dit(bf(--copy-unsafe-links)) This tells rsync to copy the referent of |
460 | symbolic links that point outside the source tree. Absolute symlinks | |
461 | are also treated like ordinary files, and so are any symlinks in the | |
462 | source path itself when --relative is used. | |
41059f75 | 463 | |
d310a212 AT |
464 | dit(bf(--safe-links)) This tells rsync to ignore any symbolic links |
465 | which point outside the destination tree. All absolute symlinks are | |
466 | also ignored. Using this option in conjunction with --relative may | |
14d43f1f | 467 | give unexpected results. |
d310a212 | 468 | |
41059f75 AT |
469 | dit(bf(-H, --hard-links)) This tells rsync to recreate hard links on |
470 | the remote system to be the same as the local system. Without this | |
471 | option hard links are treated like regular files. | |
472 | ||
473 | Note that rsync can only detect hard links if both parts of the link | |
474 | are in the list of files being sent. | |
475 | ||
476 | This option can be quite slow, so only use it if you need it. | |
477 | ||
478 | dit(bf(-W, --whole-file)) With this option the incremental rsync algorithm | |
a1a440c2 DD |
479 | is not used and the whole file is sent as-is instead. The transfer may be |
480 | faster if this option is used when the bandwidth between the source and | |
481 | target machines is higher than the bandwidth to disk (especially when the | |
482 | "disk" is actually a networked file system). This is the default when both | |
483 | the source and target are on the local machine. | |
41059f75 | 484 | |
93689aa5 DD |
485 | dit(bf(--no-whole-file)) Turn off --whole-file, for use when it is the |
486 | default. | |
487 | ||
41059f75 AT |
488 | dit(bf(-p, --perms)) This option causes rsync to update the remote |
489 | permissions to be the same as the local permissions. | |
490 | ||
eb06fa95 MP |
491 | dit(bf(-o, --owner)) This option causes rsync to set the owner of the |
492 | destination file to be the same as the source file. On most systems, | |
fca9a9b0 DD |
493 | only the super-user can set file ownership. Note that if the remote system |
494 | is a daemon using chroot, the --numeric-ids option is implied because the | |
495 | remote system cannot get access to the usernames from /etc/passwd. | |
41059f75 | 496 | |
eb06fa95 MP |
497 | dit(bf(-g, --group)) This option causes rsync to set the group of the |
498 | destination file to be the same as the source file. If the receiving | |
499 | program is not running as the super-user, only groups that the | |
500 | receiver is a member of will be preserved (by group name, not group id | |
501 | number). | |
41059f75 AT |
502 | |
503 | dit(bf(-D, --devices)) This option causes rsync to transfer character and | |
504 | block device information to the remote system to recreate these | |
505 | devices. This option is only available to the super-user. | |
506 | ||
507 | dit(bf(-t, --times)) This tells rsync to transfer modification times along | |
baf3e504 DD |
508 | with the files and update them on the remote system. Note that if this |
509 | option is not used, the optimization that excludes files that have not been | |
510 | modified cannot be effective; in other words, a missing -t or -a will | |
511 | cause the next transfer to behave as if it used -I, and all files will have | |
512 | their checksums compared and show up in log messages even if they haven't | |
513 | changed. | |
41059f75 AT |
514 | |
515 | dit(bf(-n, --dry-run)) This tells rsync to not do any file transfers, | |
516 | instead it will just report the actions it would have taken. | |
517 | ||
518 | dit(bf(-S, --sparse)) Try to handle sparse files efficiently so they take | |
519 | up less space on the destination. | |
520 | ||
d310a212 AT |
521 | NOTE: Don't use this option when the destination is a Solaris "tmpfs" |
522 | filesystem. It doesn't seem to handle seeks over null regions | |
523 | correctly and ends up corrupting the files. | |
524 | ||
41059f75 AT |
525 | dit(bf(-x, --one-file-system)) This tells rsync not to cross filesystem |
526 | boundaries when recursing. This is useful for transferring the | |
527 | contents of only one filesystem. | |
528 | ||
1347d512 AT |
529 | dit(bf(--existing)) This tells rsync not to create any new files - |
530 | only update files that already exist on the destination. | |
531 | ||
3d6feada MP |
532 | dit(bf(--ignore-existing)) |
533 | This tells rsync not to update files that already exist on | |
534 | the destination. | |
535 | ||
0b73ca12 AT |
536 | dit(bf(--max-delete=NUM)) This tells rsync not to delete more than NUM |
537 | files or directories. This is useful when mirroring very large trees | |
538 | to prevent disasters. | |
539 | ||
41059f75 | 540 | dit(bf(--delete)) This tells rsync to delete any files on the receiving |
b33b791e DD |
541 | side that aren't on the sending side. Files that are excluded from |
542 | transfer are excluded from being deleted unless you use --delete-excluded. | |
41059f75 | 543 | |
24986abd AT |
544 | This option has no effect if directory recursion is not selected. |
545 | ||
b33b791e DD |
546 | This option can be dangerous if used incorrectly! It is a very good idea |
547 | to run first using the dry run option (-n) to see what files would be | |
548 | deleted to make sure important files aren't listed. | |
41059f75 | 549 | |
3e578a19 AT |
550 | If the sending side detects any IO errors then the deletion of any |
551 | files at the destination will be automatically disabled. This is to | |
552 | prevent temporary filesystem failures (such as NFS errors) on the | |
553 | sending side causing a massive deletion of files on the | |
2c5548d2 | 554 | destination. You can override this with the --ignore-errors option. |
41059f75 | 555 | |
b33b791e DD |
556 | dit(bf(--delete-excluded)) In addition to deleting the files on the |
557 | receiving side that are not on the sending side, this tells rsync to also | |
558 | delete any files on the receiving side that are excluded (see --exclude). | |
786c3687 | 559 | Implies --delete. |
b33b791e | 560 | |
57df171b AT |
561 | dit(bf(--delete-after)) By default rsync does file deletions before |
562 | transferring files to try to ensure that there is sufficient space on | |
563 | the receiving filesystem. If you want to delete after transferring | |
786c3687 | 564 | then use the --delete-after switch. Implies --delete. |
57df171b | 565 | |
2c5548d2 DD |
566 | dit(bf(--ignore-errors)) Tells --delete to go ahead and delete files |
567 | even when there are IO errors. | |
568 | ||
b695d088 DD |
569 | dit(bf(--force)) This options tells rsync to delete directories even if |
570 | they are not empty when they are to be replaced by non-directories. This | |
571 | is only relevant without --delete because deletions are now done depth-first. | |
572 | Requires the --recursive option (which is implied by -a) to have any effect. | |
41059f75 | 573 | |
ad911a7a | 574 | dit(bf(-B , --block-size=BLOCKSIZE)) This controls the block size used in |
41059f75 AT |
575 | the rsync algorithm. See the technical report for details. |
576 | ||
b5679335 | 577 | dit(bf(-e, --rsh=COMMAND)) This option allows you to choose an alternative |
41059f75 | 578 | remote shell program to use for communication between the local and |
1bbf83c0 WD |
579 | remote copies of rsync. Typically, rsync is configured to use rsh by |
580 | default, but you may prefer to use ssh because of its high security. | |
41059f75 | 581 | |
bef49340 WD |
582 | If this option is used with bf([user@]host::module/path), then the |
583 | remote shell em(COMMMAND) will be used to run an rsync server on the | |
584 | remote host, and all data will be transmitted through that remote | |
585 | shell connection, rather than through a direct socket connection to a | |
2d4ca358 DD |
586 | running rsync server on the remote host. See the section "CONNECTING |
587 | TO AN RSYNC SERVER OVER A REMOTE SHELL PROGRAM" above. | |
bef49340 | 588 | |
ea7f8108 WD |
589 | Command-line arguments are permitted in COMMAND provided that COMMAND is |
590 | presented to rsync as a single argument. For example: | |
98393ae2 | 591 | |
ea7f8108 | 592 | quote(-e "ssh -p 2234") |
98393ae2 WD |
593 | |
594 | (Note that ssh users can alternately customize site-specific connect | |
595 | options in their .ssh/config file.) | |
596 | ||
41059f75 | 597 | You can also choose the remote shell program using the RSYNC_RSH |
ea7f8108 | 598 | environment variable, which accepts the same range of values as -e. |
41059f75 | 599 | |
735a816e DD |
600 | See also the --blocking-io option which is affected by this option. |
601 | ||
b5679335 | 602 | dit(bf(--rsync-path=PATH)) Use this to specify the path to the copy of |
d73ee7b7 AT |
603 | rsync on the remote machine. Useful when it's not in your path. Note |
604 | that this is the full path to the binary, not just the directory that | |
605 | the binary is in. | |
41059f75 | 606 | |
b5679335 | 607 | dit(bf(--exclude=PATTERN)) This option allows you to selectively exclude |
41059f75 AT |
608 | certain files from the list of files to be transferred. This is most |
609 | useful in combination with a recursive transfer. | |
610 | ||
41059f75 AT |
611 | You may use as many --exclude options on the command line as you like |
612 | to build up the list of files to exclude. | |
613 | ||
14d43f1f | 614 | See the section on exclude patterns for information on the syntax of |
43bd68e5 | 615 | this option. |
41059f75 | 616 | |
b5679335 | 617 | dit(bf(--exclude-from=FILE)) This option is similar to the --exclude |
c48b22c8 AT |
618 | option, but instead it adds all exclude patterns listed in the file |
619 | FILE to the exclude list. Blank lines in FILE and lines starting with | |
620 | ';' or '#' are ignored. | |
f8a94f0d DD |
621 | If em(FILE) is bf(-) the list will be read from standard input. |
622 | ||
41059f75 | 623 | |
b5679335 | 624 | dit(bf(--include=PATTERN)) This option tells rsync to not exclude the |
43bd68e5 AT |
625 | specified pattern of filenames. This is useful as it allows you to |
626 | build up quite complex exclude/include rules. | |
627 | ||
628 | See the section of exclude patterns for information on the syntax of | |
629 | this option. | |
630 | ||
b5679335 | 631 | dit(bf(--include-from=FILE)) This specifies a list of include patterns |
43bd68e5 | 632 | from a file. |
f8a94f0d DD |
633 | If em(FILE) is bf(-) the list will be read from standard input. |
634 | ||
43bd68e5 | 635 | |
41059f75 AT |
636 | dit(bf(-C, --cvs-exclude)) This is a useful shorthand for excluding a |
637 | broad range of files that you often don't want to transfer between | |
638 | systems. It uses the same algorithm that CVS uses to determine if | |
639 | a file should be ignored. | |
640 | ||
641 | The exclude list is initialized to: | |
642 | ||
643 | quote(RCS SCCS CVS CVS.adm RCSLOG cvslog.* tags TAGS .make.state | |
644 | .nse_depinfo *~ #* .#* ,* *.old *.bak *.BAK *.orig *.rej .del-* | |
645 | *.a *.o *.obj *.so *.Z *.elc *.ln core) | |
646 | ||
647 | then files listed in a $HOME/.cvsignore are added to the list and any | |
648 | files listed in the CVSIGNORE environment variable (space delimited). | |
649 | ||
eb06fa95 MP |
650 | Finally, any file is ignored if it is in the same directory as a |
651 | .cvsignore file and matches one of the patterns listed therein. See | |
652 | the bf(cvs(1)) manual for more information. | |
41059f75 | 653 | |
b5679335 | 654 | dit(bf(--csum-length=LENGTH)) By default the primary checksum used in |
41059f75 AT |
655 | rsync is a very strong 16 byte MD4 checksum. In most cases you will |
656 | find that a truncated version of this checksum is quite efficient, and | |
657 | this will decrease the size of the checksum data sent over the link, | |
de2fd20e | 658 | making things faster. |
41059f75 AT |
659 | |
660 | You can choose the number of bytes in the truncated checksum using the | |
661 | --csum-length option. Any value less than or equal to 16 is valid. | |
662 | ||
663 | Note that if you use this option then you run the risk of ending up | |
664 | with an incorrect target file. The risk with a value of 16 is | |
665 | microscopic and can be safely ignored (the universe will probably end | |
666 | before it fails) but with smaller values the risk is higher. | |
667 | ||
de2fd20e AT |
668 | Current versions of rsync actually use an adaptive algorithm for the |
669 | checksum length by default, using a 16 byte file checksum to determine | |
670 | if a 2nd pass is required with a longer block checksum. Only use this | |
671 | option if you have read the source code and know what you are doing. | |
672 | ||
b5679335 | 673 | dit(bf(-T, --temp-dir=DIR)) This option instructs rsync to use DIR as a |
375a4556 | 674 | scratch directory when creating temporary copies of the files |
41059f75 AT |
675 | transferred on the receiving side. The default behavior is to create |
676 | the temporary files in the receiving directory. | |
677 | ||
3473b5b4 DD |
678 | dit(bf(--compare-dest=DIR)) This option instructs rsync to use DIR on |
679 | the destination machine as an additional directory to compare destination | |
680 | files against when doing transfers. This is useful for doing transfers to | |
681 | a new destination while leaving existing files intact, and then doing a | |
682 | flash-cutover when all files have been successfully transferred (for | |
683 | example by moving directories around and removing the old directory, | |
684 | although this requires also doing the transfer with -I to avoid skipping | |
685 | files that haven't changed). This option increases the usefulness of | |
686 | --partial because partially transferred files will remain in the new | |
687 | temporary destination until they have a chance to be completed. If DIR is | |
688 | a relative path, it is relative to the destination directory. | |
375a4556 | 689 | |
59c95e42 DD |
690 | dit(bf(--link-dest=DIR)) This option behaves like bf(--compare-dest) but |
691 | also will create hard links from em(DIR) to the destination directory for | |
692 | unchanged files. Files with changed ownership or permissions will not be | |
693 | linked. | |
694 | ||
41059f75 | 695 | dit(bf(-z, --compress)) With this option, rsync compresses any data from |
089e73f8 | 696 | the files that it sends to the destination machine. This |
41059f75 AT |
697 | option is useful on slow links. The compression method used is the |
698 | same method that gzip uses. | |
699 | ||
700 | Note this this option typically achieves better compression ratios | |
701 | that can be achieved by using a compressing remote shell, or a | |
702 | compressing transport, as it takes advantage of the implicit | |
703 | information sent for matching data blocks. | |
704 | ||
705 | dit(bf(--numeric-ids)) With this option rsync will transfer numeric group | |
706 | and user ids rather than using user and group names and mapping them | |
707 | at both ends. | |
708 | ||
709 | By default rsync will use the user name and group name to determine | |
710 | what ownership to give files. The special uid 0 and the special group | |
14d43f1f | 711 | 0 are never mapped via user/group names even if the --numeric-ids |
41059f75 AT |
712 | option is not specified. |
713 | ||
eb06fa95 MP |
714 | If the source system is a daemon using chroot, or if a user or group |
715 | name does not exist on the destination system, then the numeric id | |
716 | from the source system is used instead. | |
41059f75 | 717 | |
de2fd20e AT |
718 | dit(bf(--timeout=TIMEOUT)) This option allows you to set a maximum IO |
719 | timeout in seconds. If no data is transferred for the specified time | |
720 | then rsync will exit. The default is 0, which means no timeout. | |
41059f75 | 721 | |
eb06fa95 MP |
722 | dit(bf(--daemon)) This tells rsync that it is to run as a daemon. The |
723 | daemon may be accessed using the bf(host::module) or | |
724 | bf(rsync://host/module/) syntax. | |
725 | ||
726 | If standard input is a socket then rsync will assume that it is being | |
727 | run via inetd, otherwise it will detach from the current terminal and | |
728 | become a background daemon. The daemon will read the config file | |
729 | (/etc/rsyncd.conf) on each connect made by a client and respond to | |
730 | requests accordingly. See the rsyncd.conf(5) man page for more | |
731 | details. | |
41059f75 | 732 | |
bbd6f4ba MP |
733 | dit(bf(--no-detach)) When running as a daemon, this option instructs |
734 | rsync to not detach itself and become a background process. This | |
735 | option is required when running as a service on Cygwin, and may also | |
736 | be useful when rsync is supervised by a program such as | |
737 | bf(daemontools) or AIX's bf(System Resource Controller). | |
738 | bf(--no-detach) is also recommended when rsync is run under a | |
739 | debugger. This option has no effect if rsync is run from inetd or | |
740 | sshd. | |
741 | ||
5c9730a4 | 742 | dit(bf(--address)) By default rsync will bind to the wildcard address |
e30f0657 AT |
743 | when run as a daemon with the --daemon option or when connecting to a |
744 | rsync server. The --address option allows you to specify a specific IP | |
745 | address (or hostname) to bind to. This makes virtual hosting possible | |
746 | in conjunction with the --config option. | |
5c9730a4 | 747 | |
b5679335 | 748 | dit(bf(--config=FILE)) This specifies an alternate config file than |
5315b793 | 749 | the default /etc/rsyncd.conf. This is only relevant when --daemon is |
41059f75 AT |
750 | specified. |
751 | ||
b5679335 | 752 | dit(bf(--port=PORT)) This specifies an alternate TCP port number to use |
14d43f1f | 753 | rather than the default port 873. |
41059f75 | 754 | |
735a816e DD |
755 | dit(bf(--blocking-io)) This tells rsync to use blocking IO when launching |
756 | a remote shell transport. If -e or --rsh are not specified or are set to | |
757 | the default "rsh", this defaults to blocking IO, otherwise it defaults to | |
758 | non-blocking IO. You may find the --blocking-io option is needed for some | |
1bbf83c0 WD |
759 | remote shells that can't handle non-blocking IO. (Note that ssh prefers |
760 | non-blocking IO.) | |
64c704f0 | 761 | |
93689aa5 DD |
762 | dit(bf(--no-blocking-io)) Turn off --blocking-io, for use when it is the |
763 | default. | |
764 | ||
3a64ad1f | 765 | dit(bf(--log-format=FORMAT)) This allows you to specify exactly what the |
14d43f1f | 766 | rsync client logs to stdout on a per-file basis. The log format is |
3a64ad1f DD |
767 | specified using the same format conventions as the log format option in |
768 | rsyncd.conf. | |
b6062654 | 769 | |
b72f24c7 AT |
770 | dit(bf(--stats)) This tells rsync to print a verbose set of statistics |
771 | on the file transfer, allowing you to tell how effective the rsync | |
e19452a9 | 772 | algorithm is for your data. |
b72f24c7 | 773 | |
d9fcc198 AT |
774 | dit(bf(--partial)) By default, rsync will delete any partially |
775 | transferred file if the transfer is interrupted. In some circumstances | |
776 | it is more desirable to keep partially transferred files. Using the | |
777 | --partial option tells rsync to keep the partial file which should | |
778 | make a subsequent transfer of the rest of the file much faster. | |
779 | ||
eb86d661 AT |
780 | dit(bf(--progress)) This option tells rsync to print information |
781 | showing the progress of the transfer. This gives a bored user | |
782 | something to watch. | |
783 | ||
7b10f91d AT |
784 | This option is normally combined with -v. Using this option without |
785 | the -v option will produce weird results on your display. | |
786 | ||
d9fcc198 AT |
787 | dit(bf(-P)) The -P option is equivalent to --partial --progress. I |
788 | found myself typing that combination quite often so I created an | |
789 | option to make it easier. | |
790 | ||
65575e96 AT |
791 | dit(bf(--password-file)) This option allows you to provide a password |
792 | in a file for accessing a remote rsync server. Note that this option | |
793 | is only useful when accessing a rsync server using the built in | |
794 | transport, not when using a remote shell as the transport. The file | |
fc7952e7 AT |
795 | must not be world readable. It should contain just the password as a |
796 | single line. | |
65575e96 | 797 | |
ef5d23eb DD |
798 | dit(bf(--bwlimit=KBPS)) This option allows you to specify a maximum |
799 | transfer rate in kilobytes per second. This option is most effective when | |
800 | using rsync with large files (several megabytes and up). Due to the nature | |
801 | of rsync transfers, blocks of data are sent, then if rsync determines the | |
802 | transfer was too fast, it will wait before sending the next data block. The | |
803 | result is an average transfer rate equalling the specified limit. A value | |
804 | of zero specifies no limit. | |
805 | ||
088aac85 DD |
806 | dit(bf(--write-batch=PREFIX)) Generate a set of files that can be |
807 | transferred as a batch update. Each filename in the set starts with | |
808 | PREFIX. See the "BATCH MODE" section for details. | |
6902ed17 | 809 | |
088aac85 DD |
810 | dit(bf(--read-batch=PREFIX)) Apply a previously generated change batch, |
811 | using the fileset whose filenames start with PREFIX. See the "BATCH | |
812 | MODE" section for details. | |
6902ed17 | 813 | |
41059f75 AT |
814 | enddit() |
815 | ||
43bd68e5 AT |
816 | manpagesection(EXCLUDE PATTERNS) |
817 | ||
818 | The exclude and include patterns specified to rsync allow for flexible | |
14d43f1f | 819 | selection of which files to transfer and which files to skip. |
43bd68e5 | 820 | |
eb06fa95 | 821 | rsync builds an ordered list of include/exclude options as specified on |
14d43f1f | 822 | the command line. When a filename is encountered, rsync checks the |
43bd68e5 | 823 | name against each exclude/include pattern in turn. The first matching |
23489269 | 824 | pattern is acted on. If it is an exclude pattern, then that file is |
43bd68e5 AT |
825 | skipped. If it is an include pattern then that filename is not |
826 | skipped. If no matching include/exclude pattern is found then the | |
827 | filename is not skipped. | |
828 | ||
27b9a19b DD |
829 | Note that when used with -r (which is implied by -a), every subcomponent of |
830 | every path is visited from top down, so include/exclude patterns get | |
831 | applied recursively to each subcomponent. | |
832 | ||
833 | Note also that the --include and --exclude options take one pattern | |
2fb139c1 AT |
834 | each. To add multiple patterns use the --include-from and |
835 | --exclude-from options or multiple --include and --exclude options. | |
836 | ||
14d43f1f | 837 | The patterns can take several forms. The rules are: |
43bd68e5 AT |
838 | |
839 | itemize( | |
840 | it() if the pattern starts with a / then it is matched against the | |
841 | start of the filename, otherwise it is matched against the end of | |
27b9a19b DD |
842 | the filename. Thus "/foo" would match a file called "foo" at the base of |
843 | the tree. On the other hand, "foo" would match any file called "foo" | |
844 | anywhere in the tree because the algorithm is applied recursively from | |
845 | top down; it behaves as if each path component gets a turn at being the | |
846 | end of the file name. | |
43bd68e5 AT |
847 | |
848 | it() if the pattern ends with a / then it will only match a | |
849 | directory, not a file, link or device. | |
850 | ||
851 | it() if the pattern contains a wildcard character from the set | |
a8b9d4ed DD |
852 | *?[ then expression matching is applied using the shell filename |
853 | matching rules. Otherwise a simple string match is used. | |
43bd68e5 | 854 | |
27b9a19b DD |
855 | it() if the pattern includes a double asterisk "**" then all wildcards in |
856 | the pattern will match slashes, otherwise they will stop at slashes. | |
857 | ||
43bd68e5 AT |
858 | it() if the pattern contains a / (not counting a trailing /) then it |
859 | is matched against the full filename, including any leading | |
860 | directory. If the pattern doesn't contain a / then it is matched | |
27b9a19b DD |
861 | only against the final component of the filename. Again, remember |
862 | that the algorithm is applied recursively so "full filename" can | |
863 | actually be any portion of a path. | |
43bd68e5 AT |
864 | |
865 | it() if the pattern starts with "+ " (a plus followed by a space) | |
5a554d5b | 866 | then it is always considered an include pattern, even if specified as |
43bd68e5 AT |
867 | part of an exclude option. The "+ " part is discarded before matching. |
868 | ||
869 | it() if the pattern starts with "- " (a minus followed by a space) | |
5a554d5b | 870 | then it is always considered an exclude pattern, even if specified as |
43bd68e5 | 871 | part of an include option. The "- " part is discarded before matching. |
de2fd20e AT |
872 | |
873 | it() if the pattern is a single exclamation mark ! then the current | |
eb06fa95 | 874 | include/exclude list is reset, removing all previously defined patterns. |
43bd68e5 AT |
875 | ) |
876 | ||
877 | The +/- rules are most useful in exclude lists, allowing you to have a | |
878 | single exclude list that contains both include and exclude options. | |
27b9a19b DD |
879 | |
880 | If you end an exclude list with --exclude '*', note that since the | |
881 | algorithm is applied recursively that unless you explicitly include | |
882 | parent directories of files you want to include then the algorithm | |
883 | will stop at the parent directories and never see the files below | |
884 | them. To include all directories, use --include '*/' before the | |
885 | --exclude '*'. | |
43bd68e5 | 886 | |
328fcf11 | 887 | Here are some exclude/include examples: |
43bd68e5 AT |
888 | |
889 | itemize( | |
890 | it() --exclude "*.o" would exclude all filenames matching *.o | |
891 | it() --exclude "/foo" would exclude a file in the base directory called foo | |
892 | it() --exclude "foo/" would exclude any directory called foo | |
a8b9d4ed DD |
893 | it() --exclude "/foo/*/bar" would exclude any file called bar two |
894 | levels below a base directory called foo | |
895 | it() --exclude "/foo/**/bar" would exclude any file called bar two | |
896 | or more levels below a base directory called foo | |
43bd68e5 | 897 | it() --include "*/" --include "*.c" --exclude "*" would include all |
5d5811f7 DD |
898 | directories and C source files |
899 | it() --include "foo/" --include "foo/bar.c" --exclude "*" would include | |
900 | only foo/bar.c (the foo/ directory must be explicitly included or | |
901 | it would be excluded by the "*") | |
43bd68e5 AT |
902 | ) |
903 | ||
6902ed17 MP |
904 | manpagesection(BATCH MODE) |
905 | ||
2e3c1417 | 906 | bf(Note:) Batch mode should be considered experimental in this version |
088aac85 DD |
907 | of rsync. The interface or behaviour may change before it stabilizes. |
908 | ||
909 | Batch mode can be used to apply the same set of updates to many | |
910 | identical systems. Suppose one has a tree which is replicated on a | |
911 | number of hosts. Now suppose some changes have been made to this | |
912 | source tree and those changes need to be propagated to the other | |
913 | hosts. In order to do this using batch mode, rsync is run with the | |
914 | write-batch option to apply the changes made to the source tree to one | |
915 | of the destination trees. The write-batch option causes the rsync | |
916 | client to store the information needed to repeat this operation against | |
917 | other destination trees in a batch update fileset (see below). The | |
918 | filename of each file in the fileset starts with a prefix specified by | |
919 | the user as an argument to the write-batch option. This fileset is | |
920 | then copied to each remote host, where rsync is run with the read-batch | |
921 | option, again specifying the same prefix, and the destination tree. | |
922 | Rsync updates the destination tree using the information stored in the | |
923 | batch update fileset. | |
924 | ||
925 | The fileset consists of 4 files: | |
2e3c1417 | 926 | |
088aac85 DD |
927 | itemize( |
928 | it() bf(<prefix>.rsync_argvs) command-line arguments | |
929 | it() bf(<prefix>.rsync_flist) rsync internal file metadata | |
930 | it() bf(<prefix>.rsync_csums) rsync checksums | |
931 | it() bf(<prefix>.rsync_delta) data blocks for file update & change | |
6902ed17 MP |
932 | ) |
933 | ||
088aac85 DD |
934 | The .rsync_argvs file contains a command-line suitable for updating a |
935 | destination tree using that batch update fileset. It can be executed | |
936 | using a Bourne(-like) shell, optionally passing in an alternate | |
937 | destination tree pathname which is then used instead of the original | |
938 | path. This is useful when the destination tree path differs from the | |
939 | original destination tree path. | |
6902ed17 | 940 | |
088aac85 DD |
941 | Generating the batch update fileset once saves having to perform the |
942 | file status, checksum and data block generation more than once when | |
943 | updating multiple destination trees. Multicast transport protocols can | |
944 | be used to transfer the batch update files in parallel to many hosts at | |
945 | once, instead of sending the same data to every host individually. | |
946 | ||
947 | Example: | |
948 | ||
949 | verb( | |
950 | $ rsync --write_batch=pfx -a /source/dir/ /adest/dir/ | |
951 | $ rcp pfx.rsync_* remote: | |
952 | $ rsh remote rsync --read_batch=pfx -a /bdest/dir/ | |
953 | # or alternatively | |
954 | $ rsh remote ./pfx.rsync_argvs /bdest/dir/ | |
6902ed17 MP |
955 | ) |
956 | ||
088aac85 DD |
957 | In this example, rsync is used to update /adest/dir/ with /source/dir/ |
958 | and the information to repeat this operation is stored in the files | |
959 | pfx.rsync_*. These files are then copied to the machine named "remote". | |
960 | Rsync is then invoked on "remote" to update /bdest/dir/ the same way as | |
961 | /adest/dir/. The last line shows the rsync_argvs file being used to | |
962 | invoke rsync. | |
963 | ||
964 | Caveats: | |
965 | ||
966 | The read-batch option expects the destination tree it is meant to update | |
967 | to be identical to the destination tree that was used to create the | |
968 | batch update fileset. When a difference between the destination trees | |
969 | is encountered the update will fail at that point, leaving the | |
970 | destination tree in a partially updated state. In that case, rsync can | |
971 | be used in its regular (non-batch) mode of operation to fix up the | |
972 | destination tree. | |
973 | ||
974 | The rsync version used on all destinations should be identical to the | |
975 | one used on the original destination. | |
976 | ||
977 | The -z/--compress option does not work in batch mode and yields a usage | |
978 | error. A separate compression tool can be used instead to reduce the | |
979 | size of the batch update files for transport to the destination. | |
980 | ||
981 | The -n/--dryrun option does not work in batch mode and yields a runtime | |
982 | error. | |
983 | ||
6902ed17 MP |
984 | See bf(http://www.ils.unc.edu/i2dsi/unc_rsync+.html) for papers and technical |
985 | reports. | |
986 | ||
eb06fa95 MP |
987 | manpagesection(SYMBOLIC LINKS) |
988 | ||
989 | Three basic behaviours are possible when rsync encounters a symbolic | |
990 | link in the source directory. | |
991 | ||
992 | By default, symbolic links are not transferred at all. A message | |
993 | "skipping non-regular" file is emitted for any symlinks that exist. | |
994 | ||
995 | If bf(--links) is specified, then symlinks are recreated with the same | |
996 | target on the destination. Note that bf(--archive) implies | |
997 | bf(--links). | |
998 | ||
999 | If bf(--copy-links) is specified, then symlinks are "collapsed" by | |
1000 | copying their referent, rather than the symlink. | |
1001 | ||
1002 | rsync also distinguishes "safe" and "unsafe" symbolic links. An | |
1003 | example where this might be used is a web site mirror that wishes | |
1004 | ensure the rsync module they copy does not include symbolic links to | |
1005 | bf(/etc/passwd) in the public section of the site. Using | |
1006 | bf(--copy-unsafe-links) will cause any links to be copied as the file | |
1007 | they point to on the destination. Using bf(--safe-links) will cause | |
1008 | unsafe links to be ommitted altogether. | |
1009 | ||
7bd0cf5b MP |
1010 | Symbolic links are considered unsafe if they are absolute symlinks |
1011 | (start with bf(/)), empty, or if they contain enough bf("..") | |
1012 | components to ascend from the directory being copied. | |
1013 | ||
d310a212 AT |
1014 | manpagesection(DIAGNOSTICS) |
1015 | ||
14d43f1f | 1016 | rsync occasionally produces error messages that may seem a little |
d310a212 AT |
1017 | cryptic. The one that seems to cause the most confusion is "protocol |
1018 | version mismatch - is your shell clean?". | |
1019 | ||
1020 | This message is usually caused by your startup scripts or remote shell | |
1021 | facility producing unwanted garbage on the stream that rsync is using | |
14d43f1f | 1022 | for its transport. The way to diagnose this problem is to run your |
d310a212 AT |
1023 | remote shell like this: |
1024 | ||
1025 | verb( | |
1026 | rsh remotehost /bin/true > out.dat | |
1027 | ) | |
1028 | ||
1029 | then look at out.dat. If everything is working correctly then out.dat | |
2cfeab21 | 1030 | should be a zero length file. If you are getting the above error from |
d310a212 AT |
1031 | rsync then you will probably find that out.dat contains some text or |
1032 | data. Look at the contents and try to work out what is producing | |
14d43f1f | 1033 | it. The most common cause is incorrectly configured shell startup |
d310a212 AT |
1034 | scripts (such as .cshrc or .profile) that contain output statements |
1035 | for non-interactive logins. | |
1036 | ||
e6c64e79 MP |
1037 | If you are having trouble debugging include and exclude patterns, then |
1038 | try specifying the -vv option. At this level of verbosity rsync will | |
1039 | show why each individual file is included or excluded. | |
1040 | ||
55b64e4b MP |
1041 | manpagesection(EXIT VALUES) |
1042 | ||
1043 | startdit() | |
8212336a MP |
1044 | dit(bf(RERR_SYNTAX 1)) Syntax or usage error |
1045 | dit(bf(RERR_PROTOCOL 2)) Protocol incompatibility | |
1046 | dit(bf(RERR_FILESELECT 3)) Errors selecting input/output files, dirs | |
1047 | ||
1048 | dit(bf(RERR_UNSUPPORTED 4)) Requested action not supported: an attempt | |
1049 | was made to manipulate 64-bit files on a platform that cannot support | |
1050 | them; or an option was speciifed that is supported by the client and | |
1051 | not by the server. | |
1052 | ||
1053 | dit(bf(RERR_SOCKETIO 10)) Error in socket IO | |
1054 | dit(bf(RERR_FILEIO 11)) Error in file IO | |
1055 | dit(bf(RERR_STREAMIO 12)) Error in rsync protocol data stream | |
1056 | dit(bf(RERR_MESSAGEIO 13)) Errors with program diagnostics | |
1057 | dit(bf(RERR_IPC 14)) Error in IPC code | |
1058 | dit(bf(RERR_SIGNAL 20)) Received SIGUSR1 or SIGINT | |
1059 | dit(bf(RERR_WAITCHILD 21)) Some error returned by waitpid() | |
1060 | dit(bf(RERR_MALLOC 22)) Error allocating core memory buffers | |
1061 | dit(bf(RERR_TIMEOUT 30)) Timeout in data send/receive | |
55b64e4b MP |
1062 | enddit() |
1063 | ||
de2fd20e AT |
1064 | manpagesection(ENVIRONMENT VARIABLES) |
1065 | ||
1066 | startdit() | |
1067 | ||
1068 | dit(bf(CVSIGNORE)) The CVSIGNORE environment variable supplements any | |
1069 | ignore patterns in .cvsignore files. See the --cvs-exclude option for | |
1070 | more details. | |
1071 | ||
1072 | dit(bf(RSYNC_RSH)) The RSYNC_RSH environment variable allows you to | |
ea7f8108 WD |
1073 | override the default shell used as the transport for rsync. Command line |
1074 | options are permitted after the command name, just as in the -e option. | |
de2fd20e | 1075 | |
4c3b4b25 AT |
1076 | dit(bf(RSYNC_PROXY)) The RSYNC_PROXY environment variable allows you to |
1077 | redirect your rsync client to use a web proxy when connecting to a | |
1078 | rsync daemon. You should set RSYNC_PROXY to a hostname:port pair. | |
1079 | ||
de2fd20e AT |
1080 | dit(bf(RSYNC_PASSWORD)) Setting RSYNC_PASSWORD to the required |
1081 | password allows you to run authenticated rsync connections to a rsync | |
1082 | daemon without user intervention. Note that this does not supply a | |
1083 | password to a shell transport such as ssh. | |
1084 | ||
1085 | dit(bf(USER) or bf(LOGNAME)) The USER or LOGNAME environment variables | |
1086 | are used to determine the default username sent to a rsync server. | |
1087 | ||
14d43f1f | 1088 | dit(bf(HOME)) The HOME environment variable is used to find the user's |
de2fd20e AT |
1089 | default .cvsignore file. |
1090 | ||
1091 | enddit() | |
1092 | ||
41059f75 AT |
1093 | manpagefiles() |
1094 | ||
1095 | /etc/rsyncd.conf | |
1096 | ||
1097 | manpageseealso() | |
1098 | ||
1099 | rsyncd.conf(5) | |
1100 | ||
1101 | manpagediagnostics() | |
1102 | ||
1103 | manpagebugs() | |
1104 | ||
1105 | times are transferred as unix time_t values | |
1106 | ||
1107 | file permissions, devices etc are transferred as native numerical | |
1108 | values | |
1109 | ||
a87b3b2a | 1110 | see also the comments on the --delete option |
41059f75 AT |
1111 | |
1112 | Please report bugs! The rsync bug tracking system is online at | |
9e3c856a | 1113 | url(http://rsync.samba.org/rsync/)(http://rsync.samba.org/rsync/) |
41059f75 AT |
1114 | |
1115 | manpagesection(VERSION) | |
1116 | This man page is current for version 2.0 of rsync | |
1117 | ||
1118 | manpagesection(CREDITS) | |
1119 | ||
1120 | rsync is distributed under the GNU public license. See the file | |
1121 | COPYING for details. | |
1122 | ||
41059f75 | 1123 | A WEB site is available at |
3cd5eb3b MP |
1124 | url(http://rsync.samba.org/)(http://rsync.samba.org/). The site |
1125 | includes an FAQ-O-Matic which may cover questions unanswered by this | |
1126 | manual page. | |
9e3c856a AT |
1127 | |
1128 | The primary ftp site for rsync is | |
1129 | url(ftp://rsync.samba.org/pub/rsync)(ftp://rsync.samba.org/pub/rsync). | |
41059f75 AT |
1130 | |
1131 | We would be delighted to hear from you if you like this program. | |
1132 | ||
9e3c856a AT |
1133 | This program uses the excellent zlib compression library written by |
1134 | Jean-loup Gailly and Mark Adler. | |
41059f75 AT |
1135 | |
1136 | manpagesection(THANKS) | |
1137 | ||
1138 | Thanks to Richard Brent, Brendan Mackay, Bill Waite, Stephen Rothwell | |
7ff701e8 MP |
1139 | and David Bell for helpful suggestions, patches and testing of rsync. |
1140 | I've probably missed some people, my apologies if I have. | |
1141 | ||
1142 | Especial thanks also to: David Dykstra, Jos Backus, Sebastian Krahmer. | |
41059f75 AT |
1143 | |
1144 | ||
1145 | manpageauthor() | |
1146 | ||
7ff701e8 MP |
1147 | rsync was written by Andrew Tridgell <tridge@samba.org> and Paul |
1148 | Mackerras. | |
3cd5eb3b | 1149 | |
7ff701e8 | 1150 | rsync is now maintained by Martin Pool <mbp@samba.org>. |
3cd5eb3b | 1151 | |
a5d74a18 | 1152 | Mailing lists for support and development are available at |
7ff701e8 MP |
1153 | url(http://lists.samba.org)(lists.samba.org) |
1154 | ||
1155 | If you suspect you have found a security vulnerability in rsync, | |
1156 | please send it directly to Martin Pool and Andrew Tridgell. For other | |
1157 | enquiries, please use the mailing list. |