Commit | Line | Data |
---|---|---|
9e3c856a | 1 | mailto(rsync-bugs@samba.org) |
460f6b99 | 2 | manpage(rsync)(1)(1 Mar 1999)()() |
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 | |
41059f75 AT |
18 | manpagedescription() |
19 | ||
20 | rsync is a program that behaves in much the same way that rcp does, | |
21 | but has many more options and uses the rsync remote-update protocol to | |
22 | greatly speedup file transfers when the destination file already | |
23 | exists. | |
24 | ||
25 | The rsync remote-update protocol allows rsync to transfer just the | |
26 | differences between two sets of files across the network link, using | |
27 | an efficient checksum-search algorithm described in the technical | |
28 | report that accompanies this package. | |
29 | ||
30 | Some of the additional features of rsync are: | |
31 | ||
32 | itemize( | |
33 | it() support for copying links, devices, owners, groups and permissions | |
34 | it() exclude and exclude-from options similar to GNU tar | |
35 | it() a CVS exclude mode for ignoring the same files that CVS would ignore | |
36 | it() can use any transparent remote shell, including rsh or ssh | |
37 | it() does not require root privileges | |
38 | it() pipelining of file transfers to minimize latency costs | |
39 | it() support for anonymous or authenticated rsync servers (ideal for | |
40 | mirroring) | |
41 | ) | |
42 | ||
43 | manpagesection(GENERAL) | |
44 | ||
039faa86 | 45 | There are six different ways of using rsync. They are: |
41059f75 AT |
46 | |
47 | itemize( | |
48 | it() for copying local files. This is invoked when neither | |
49 | source nor destination path contains a : separator | |
50 | ||
51 | it() for copying from the local machine to a remote machine using | |
52 | a remote shell program as the transport (such as rsh or | |
53 | ssh). This is invoked when the destination path contains a | |
54 | single : separator. | |
55 | ||
56 | it() for copying from a remote machine to the local machine | |
6c7c2ef3 | 57 | using a remote shell program. This is invoked when the source |
41059f75 AT |
58 | contains a : separator. |
59 | ||
60 | it() for copying from a remote rsync server to the local | |
61 | machine. This is invoked when the source path contains a :: | |
946347b8 | 62 | separator or a rsync:// URL. |
41059f75 AT |
63 | |
64 | it() for copying from the local machine to a remote rsync | |
65 | server. This is invoked when the destination path contains a :: | |
66 | separator. | |
039faa86 AT |
67 | |
68 | it() for listing files on a remote machine. This is done the | |
69 | same way as rsync transfers except that you leave off the | |
70 | local destination. | |
41059f75 AT |
71 | ) |
72 | ||
14d43f1f DD |
73 | Note that in all cases (other than listing) at least one of the source |
74 | and destination paths must be local. | |
41059f75 AT |
75 | |
76 | manpagesection(SETUP) | |
77 | ||
78 | See the file README for installation instructions. | |
79 | ||
80 | Once installed you can use rsync to any machine that you can use rsh | |
81 | to. rsync uses rsh for its communications, unless both the source and | |
82 | destination are local. | |
83 | ||
14d43f1f | 84 | You can also specify an alternative to rsh, by either using the -e |
41059f75 AT |
85 | command line option, or by setting the RSYNC_RSH environment variable. |
86 | ||
87 | One common substitute is to use ssh, which offers a high degree of | |
88 | security. | |
89 | ||
8e987130 AT |
90 | Note that rsync must be installed on both the source and destination |
91 | machines. | |
92 | ||
41059f75 AT |
93 | manpagesection(USAGE) |
94 | ||
95 | You use rsync in the same way you use rcp. You must specify a source | |
96 | and a destination, one of which may be remote. | |
97 | ||
98 | Perhaps the best way to explain the syntax is some examples: | |
99 | ||
100 | quote(rsync *.c foo:src/) | |
101 | ||
102 | this would transfer all files matching the pattern *.c from the | |
103 | current directory to the directory src on the machine foo. If any of | |
104 | the files already exist on the remote system then the rsync | |
105 | remote-update protocol is used to update the file by sending only the | |
106 | differences. See the tech report for details. | |
107 | ||
108 | quote(rsync -avz foo:src/bar /data/tmp) | |
109 | ||
14d43f1f | 110 | this would recursively transfer all files from the directory src/bar on the |
41059f75 AT |
111 | machine foo into the /data/tmp/bar directory on the local machine. The |
112 | files are transferred in "archive" mode, which ensures that symbolic | |
113 | links, devices, attributes, permissions, ownerships etc are preserved | |
14d43f1f | 114 | in the transfer. Additionally, compression will be used to reduce the |
41059f75 AT |
115 | size of data portions of the transfer. |
116 | ||
117 | quote(rsync -avz foo:src/bar/ /data/tmp) | |
118 | ||
14d43f1f | 119 | a trailing slash on the source changes this behavior to transfer |
41059f75 | 120 | all files from the directory src/bar on the machine foo into the |
14d43f1f | 121 | /data/tmp/. A trailing / on a source name means "copy the |
41059f75 AT |
122 | contents of this directory". Without a trailing slash it means "copy |
123 | the directory". This difference becomes particularly important when | |
124 | using the --delete option. | |
125 | ||
126 | You can also use rsync in local-only mode, where both the source and | |
127 | destination don't have a ':' in the name. In this case it behaves like | |
128 | an improved copy command. | |
129 | ||
14d43f1f DD |
130 | quote(rsync somehost.mydomain.com::) |
131 | ||
132 | this would list all the anonymous rsync modules available on the host | |
133 | somehost.mydomain.com. (See the following section for more details.) | |
134 | ||
41059f75 AT |
135 | |
136 | manpagesection(CONNECTING TO AN RSYNC SERVER) | |
137 | ||
138 | It is also possible to use rsync without using rsh or ssh as the | |
139 | transport. In this case you will connect to a remote rsync server | |
140 | running on TCP port 873. | |
141 | ||
4c3b4b25 AT |
142 | You may establish the connetcion via a web proxy by setting the |
143 | environment variable RSYNC_PROXY to a hostname:port pair pointing to | |
144 | your web proxy. Note that your web proxy must allow proxying to port | |
145 | 873, this must be configured in your proxy servers ruleset. | |
146 | ||
14d43f1f | 147 | Using rsync in this way is the same as using it with rsh or ssh except |
41059f75 AT |
148 | that: |
149 | ||
150 | itemize( | |
151 | it() you use a double colon :: instead of a single colon to | |
152 | separate the hostname from the path. | |
153 | ||
154 | it() the remote server may print a message of the day when you | |
14d43f1f | 155 | connect. |
41059f75 AT |
156 | |
157 | it() if you specify no path name on the remote server then the | |
158 | list of accessible paths on the server will be shown. | |
14d43f1f | 159 | |
f7632fc6 | 160 | it() if you specify no local destination then a listing of the |
14d43f1f | 161 | specified files on the remote server is provided. |
41059f75 AT |
162 | ) |
163 | ||
4c3d16be AT |
164 | Some paths on the remote server may require authentication. If so then |
165 | you will receive a password prompt when you connect. You can avoid the | |
166 | password prompt by setting the environment variable RSYNC_PASSWORD to | |
65575e96 AT |
167 | the password you want to use or using the --password-file option. This |
168 | may be useful when scripting rsync. | |
4c3d16be | 169 | |
3bc67f0c | 170 | WARNING: On some systems environment variables are visible to all |
65575e96 | 171 | users. On those systems using --password-file is recommended. |
3bc67f0c | 172 | |
41059f75 AT |
173 | manpagesection(RUNNING AN RSYNC SERVER) |
174 | ||
175 | An rsync server is configured using a config file which by default is | |
176 | called /etc/rsyncd.conf. Please see the rsyncd.conf(5) man page for more | |
177 | information. | |
178 | ||
179 | manpagesection(EXAMPLES) | |
180 | ||
181 | Here are some examples of how I use rsync. | |
182 | ||
14d43f1f DD |
183 | To backup my wife's home directory, which consists of large MS Word |
184 | files and mail folders, I use a cron job that runs | |
41059f75 AT |
185 | |
186 | quote(rsync -Cavz . arvidsjaur:backup) | |
187 | ||
188 | each night over a PPP link to a duplicate directory on my machine | |
189 | "arvidsjaur". | |
190 | ||
191 | To synchronize my samba source trees I use the following Makefile | |
192 | targets: | |
193 | ||
194 | quote( get:nl() | |
195 | rsync -avuzb --exclude '*~' samba:samba/ . | |
196 | ||
197 | put:nl() | |
198 | rsync -Cavuzb . samba:samba/ | |
199 | ||
200 | sync: get put) | |
201 | ||
202 | this allows me to sync with a CVS directory at the other end of the | |
203 | link. I then do cvs operations on the remote machine, which saves a | |
204 | lot of time as the remote cvs protocol isn't very efficient. | |
205 | ||
206 | I mirror a directory between my "old" and "new" ftp sites with the | |
207 | command | |
208 | ||
209 | quote(rsync -az -e ssh --delete ~ftp/pub/samba/ nimbus:"~ftp/pub/tridge/samba") | |
210 | ||
211 | this is launched from cron every few hours. | |
212 | ||
c95da96a AT |
213 | manpagesection(OPTIONS SUMMARY) |
214 | ||
14d43f1f | 215 | Here is a short summary of the options available in rsync. Please refer |
c95da96a AT |
216 | to the detailed description below for a complete description. |
217 | ||
218 | verb( | |
219 | -v, --verbose increase verbosity | |
b86f0cef | 220 | -q, --quiet decrease verbosity |
c95da96a AT |
221 | -c, --checksum always checksum |
222 | -a, --archive archive mode | |
223 | -r, --recursive recurse into directories | |
224 | -R, --relative use relative path names | |
9ef53907 | 225 | -b, --backup make backups (default ~ suffix) |
66203a98 | 226 | --backup-dir=DIR put backups in the specified directory |
9ef53907 | 227 | --suffix=SUFFIX override backup suffix |
c95da96a AT |
228 | -u, --update update only (don't overwrite newer files) |
229 | -l, --links preserve soft links | |
230 | -L, --copy-links treat soft links like regular files | |
b5313607 | 231 | --copy-unsafe-links copy links outside the source tree |
d853783f | 232 | --safe-links ignore links outside the destination tree |
c95da96a AT |
233 | -H, --hard-links preserve hard links |
234 | -p, --perms preserve permissions | |
235 | -o, --owner preserve owner (root only) | |
236 | -g, --group preserve group | |
237 | -D, --devices preserve devices (root only) | |
238 | -t, --times preserve times | |
239 | -S, --sparse handle sparse files efficiently | |
240 | -n, --dry-run show what would have been transferred | |
241 | -W, --whole-file copy whole files, no incremental checks | |
242 | -x, --one-file-system don't cross filesystem boundaries | |
9ef53907 | 243 | -B, --block-size=SIZE checksum blocking size (default 700) |
c95da96a | 244 | -e, --rsh=COMMAND specify rsh replacement |
d9fcc198 | 245 | --rsync-path=PATH specify path to rsync on the remote machine |
c95da96a | 246 | -C, --cvs-exclude auto ignore files in the same way CVS does |
1347d512 | 247 | --existing only update files that already exist |
c95da96a | 248 | --delete delete files that don't exist on the sending side |
b33b791e | 249 | --delete-excluded also delete excluded files on the receiving side |
1347d512 | 250 | --delete-after delete after transferring, not before |
ef55c686 | 251 | --ignore-errors delete even if there are IO errors |
0b73ca12 | 252 | --max-delete=NUM don't delete more than NUM files |
c95da96a AT |
253 | --partial keep partially transferred files |
254 | --force force deletion of directories even if not empty | |
255 | --numeric-ids don't map uid/gid values by user/group name | |
256 | --timeout=TIME set IO timeout in seconds | |
257 | -I, --ignore-times don't exclude files that match length and time | |
f83f0548 | 258 | --size-only only use file size when determining if a file should be transferred |
c95da96a | 259 | -T --temp-dir=DIR create temporary files in directory DIR |
375a4556 | 260 | --compare-dest=DIR also compare destination files relative to DIR |
d9fcc198 | 261 | -P equivalent to --partial --progress |
c95da96a | 262 | -z, --compress compress file data |
2acf81eb | 263 | --exclude=PATTERN exclude files matching PATTERN |
9ef53907 | 264 | --exclude-from=FILE exclude patterns listed in FILE |
2acf81eb | 265 | --include=PATTERN don't exclude files matching PATTERN |
9ef53907 | 266 | --include-from=FILE don't exclude patterns listed in FILE |
c95da96a AT |
267 | --version print version number |
268 | --daemon run as a rsync daemon | |
5c9730a4 | 269 | --address bind to the specified address |
c95da96a AT |
270 | --config=FILE specify alternate rsyncd.conf file |
271 | --port=PORT specify alternate rsyncd port number | |
64c704f0 | 272 | --blocking-io use blocking IO for the remote shell |
c95da96a | 273 | --stats give some file transfer stats |
eb86d661 | 274 | --progress show progress during transfer |
b6062654 | 275 | --log-format=FORMAT log file transfers using specified format |
9ef53907 | 276 | --password-file=FILE get password from FILE |
ef5d23eb | 277 | --bwlimit=KBPS limit I/O bandwidth, KBytes per second |
c95da96a AT |
278 | -h, --help show this help screen |
279 | ) | |
280 | ||
41059f75 AT |
281 | manpageoptions() |
282 | ||
283 | rsync uses the GNU long options package. Many of the command line | |
284 | options have two variants, one short and one long. These are shown | |
14d43f1f | 285 | below, separated by commas. Some options only have a long variant. |
b5679335 DD |
286 | The '=' for options that take a parameter is optional; whitespace |
287 | can be used instead. | |
41059f75 AT |
288 | |
289 | startdit() | |
290 | dit(bf(-h, --help)) Print a short help page describing the options | |
291 | available in rsync | |
292 | ||
293 | dit(bf(--version)) print the rsync version number and exit | |
294 | ||
295 | dit(bf(-v, --verbose)) This option increases the amount of information you | |
14d43f1f | 296 | are given during the transfer. By default, rsync works silently. A |
41059f75 AT |
297 | single -v will give you information about what files are being |
298 | transferred and a brief summary at the end. Two -v flags will give you | |
299 | information on what files are being skipped and slightly more | |
300 | information at the end. More than two -v flags should only be used if | |
14d43f1f | 301 | you are debugging rsync. |
41059f75 | 302 | |
b86f0cef DD |
303 | dit(bf(-q, --quiet)) This option decreases the amount of information you |
304 | are given during the transfer, notably suppressing information messages | |
305 | from the remote server. This flag is useful when invoking rsync from | |
306 | cron. | |
307 | ||
41059f75 AT |
308 | dit(bf(-I, --ignore-times)) Normally rsync will skip any files that are |
309 | already the same length and have the same time-stamp. This option turns | |
310 | off this behavior. | |
311 | ||
a7d068ab | 312 | dit(bf(--size-only)) Normally rsync will skip any files that are |
f83f0548 AT |
313 | already the same length and have the same time-stamp. With the |
314 | --size-only option files will be skipped if they have the same size, | |
315 | regardless of timestamp. This is useful when starting to use rsync | |
316 | after using another mirroring system which may not preserve timestamps | |
317 | exactly. | |
318 | ||
41059f75 AT |
319 | dit(bf(-c, --checksum)) This forces the sender to checksum all files using |
320 | a 128-bit MD4 checksum before transfer. The checksum is then | |
321 | explicitly checked on the receiver and any files of the same name | |
322 | which already exist and have the same checksum and size on the | |
323 | receiver are skipped. This option can be quite slow. | |
324 | ||
e20c5e95 | 325 | dit(bf(-a, --archive)) This is equivalent to -rlptgoD. It is a quick way |
14d43f1f | 326 | of saying you want recursion and want to preserve everything. |
41059f75 | 327 | |
24986abd AT |
328 | dit(bf(-r, --recursive)) This tells rsync to copy directories |
329 | recursively. If you don't specify this then rsync won't copy | |
330 | directories at all. | |
41059f75 AT |
331 | |
332 | dit(bf(-R, --relative)) Use relative paths. This means that the full path | |
333 | names specified on the command line are sent to the server rather than | |
334 | just the last parts of the filenames. This is particularly useful when | |
14d43f1f DD |
335 | you want to send several different directories at the same time. For |
336 | example, if you used the command | |
41059f75 AT |
337 | |
338 | verb(rsync foo/bar/foo.c remote:/tmp/) | |
339 | ||
340 | then this would create a file called foo.c in /tmp/ on the remote | |
341 | machine. If instead you used | |
342 | ||
343 | verb(rsync -R foo/bar/foo.c remote:/tmp/) | |
344 | ||
345 | then a file called /tmp/foo/bar/foo.c would be created on the remote | |
346 | machine. The full path name is preserved. | |
347 | ||
348 | dit(bf(-b, --backup)) With this option preexisting destination files are | |
349 | renamed with a ~ extension as each file is transferred. You can | |
350 | control the backup suffix using the --suffix option. | |
351 | ||
66203a98 AT |
352 | dit(bf(--backup-dir=DIR)) In combination with the --backup option, this |
353 | tells rsync to store all backups in the specified directory. This is | |
354 | very useful for incremental backups. | |
355 | ||
b5679335 | 356 | dit(bf(--suffix=SUFFIX)) This option allows you to override the default |
9ef53907 DD |
357 | backup suffix used with the -b option. The default is a ~. |
358 | ||
41059f75 AT |
359 | dit(bf(-u, --update)) This forces rsync to skip any files for which the |
360 | destination file already exists and has a date later than the source | |
361 | file. | |
362 | ||
363 | dit(bf(-l, --links)) This tells rsync to recreate symbolic links on the | |
364 | remote system to be the same as the local system. Without this | |
14d43f1f | 365 | option, all symbolic links are skipped. |
41059f75 AT |
366 | |
367 | dit(bf(-L, --copy-links)) This tells rsync to treat symbolic links just | |
b5313607 DD |
368 | like ordinary files. |
369 | ||
370 | dit(bf(--copy-unsafe-links)) This tells rsync to treat symbolic links that | |
371 | point outside the source tree like ordinary files. Absolute symlinks are | |
372 | also treated like ordinary files, and so are any symlinks in the source | |
373 | path itself when --relative is used. | |
41059f75 | 374 | |
d310a212 AT |
375 | dit(bf(--safe-links)) This tells rsync to ignore any symbolic links |
376 | which point outside the destination tree. All absolute symlinks are | |
377 | also ignored. Using this option in conjunction with --relative may | |
14d43f1f | 378 | give unexpected results. |
d310a212 | 379 | |
41059f75 AT |
380 | dit(bf(-H, --hard-links)) This tells rsync to recreate hard links on |
381 | the remote system to be the same as the local system. Without this | |
382 | option hard links are treated like regular files. | |
383 | ||
384 | Note that rsync can only detect hard links if both parts of the link | |
385 | are in the list of files being sent. | |
386 | ||
387 | This option can be quite slow, so only use it if you need it. | |
388 | ||
389 | dit(bf(-W, --whole-file)) With this option the incremental rsync algorithm | |
390 | is not used and the whole file is sent as-is instead. This may be | |
391 | useful when using rsync with a local machine. | |
392 | ||
393 | dit(bf(-p, --perms)) This option causes rsync to update the remote | |
394 | permissions to be the same as the local permissions. | |
395 | ||
396 | dit(bf(-o, --owner)) This option causes rsync to update the remote owner | |
397 | of the file to be the same as the local owner. This is only available | |
8bb5aa8f DD |
398 | to the super-user. Note that if the source system is a daemon using chroot, |
399 | the --numeric-ids option is implied because the source system cannot get | |
14d43f1f | 400 | access to the usernames. |
41059f75 AT |
401 | |
402 | dit(bf(-g, --group)) This option causes rsync to update the remote group | |
460f6b99 DD |
403 | of the file to be the same as the local group. If the receving system is |
404 | not running as the super-user, only groups that the receiver is a member of | |
405 | will be preserved (by group name, not group id number). | |
41059f75 AT |
406 | |
407 | dit(bf(-D, --devices)) This option causes rsync to transfer character and | |
408 | block device information to the remote system to recreate these | |
409 | devices. This option is only available to the super-user. | |
410 | ||
411 | dit(bf(-t, --times)) This tells rsync to transfer modification times along | |
baf3e504 DD |
412 | with the files and update them on the remote system. Note that if this |
413 | option is not used, the optimization that excludes files that have not been | |
414 | modified cannot be effective; in other words, a missing -t or -a will | |
415 | cause the next transfer to behave as if it used -I, and all files will have | |
416 | their checksums compared and show up in log messages even if they haven't | |
417 | changed. | |
41059f75 AT |
418 | |
419 | dit(bf(-n, --dry-run)) This tells rsync to not do any file transfers, | |
420 | instead it will just report the actions it would have taken. | |
421 | ||
422 | dit(bf(-S, --sparse)) Try to handle sparse files efficiently so they take | |
423 | up less space on the destination. | |
424 | ||
d310a212 AT |
425 | NOTE: Don't use this option when the destination is a Solaris "tmpfs" |
426 | filesystem. It doesn't seem to handle seeks over null regions | |
427 | correctly and ends up corrupting the files. | |
428 | ||
41059f75 AT |
429 | dit(bf(-x, --one-file-system)) This tells rsync not to cross filesystem |
430 | boundaries when recursing. This is useful for transferring the | |
431 | contents of only one filesystem. | |
432 | ||
1347d512 AT |
433 | dit(bf(--existing)) This tells rsync not to create any new files - |
434 | only update files that already exist on the destination. | |
435 | ||
0b73ca12 AT |
436 | dit(bf(--max-delete=NUM)) This tells rsync not to delete more than NUM |
437 | files or directories. This is useful when mirroring very large trees | |
438 | to prevent disasters. | |
439 | ||
41059f75 | 440 | dit(bf(--delete)) This tells rsync to delete any files on the receiving |
b33b791e DD |
441 | side that aren't on the sending side. Files that are excluded from |
442 | transfer are excluded from being deleted unless you use --delete-excluded. | |
41059f75 | 443 | |
24986abd AT |
444 | This option has no effect if directory recursion is not selected. |
445 | ||
b33b791e DD |
446 | This option can be dangerous if used incorrectly! It is a very good idea |
447 | to run first using the dry run option (-n) to see what files would be | |
448 | deleted to make sure important files aren't listed. | |
41059f75 | 449 | |
3e578a19 AT |
450 | If the sending side detects any IO errors then the deletion of any |
451 | files at the destination will be automatically disabled. This is to | |
452 | prevent temporary filesystem failures (such as NFS errors) on the | |
453 | sending side causing a massive deletion of files on the | |
454 | destination. | |
41059f75 | 455 | |
b33b791e DD |
456 | dit(bf(--delete-excluded)) In addition to deleting the files on the |
457 | receiving side that are not on the sending side, this tells rsync to also | |
458 | delete any files on the receiving side that are excluded (see --exclude). | |
459 | ||
57df171b AT |
460 | dit(bf(--delete-after)) By default rsync does file deletions before |
461 | transferring files to try to ensure that there is sufficient space on | |
462 | the receiving filesystem. If you want to delete after transferring | |
463 | then use the --delete-after switch. | |
464 | ||
41059f75 AT |
465 | dit(bf(--force)) This options tells rsync to delete directories even if |
466 | they are not empty. This applies to both the --delete option and to | |
467 | cases where rsync tries to copy a normal file but the destination | |
15800c7e | 468 | contains a directory of the same name. |
41059f75 | 469 | |
15800c7e DD |
470 | Since this option was added, deletions were reordered to be done depth-first |
471 | so it is hardly ever needed anymore except in very obscure cases. | |
41059f75 | 472 | |
b5679335 | 473 | dit(bf(-B , --block_size=BLOCKSIZE)) This controls the block size used in |
41059f75 AT |
474 | the rsync algorithm. See the technical report for details. |
475 | ||
b5679335 | 476 | dit(bf(-e, --rsh=COMMAND)) This option allows you to choose an alternative |
41059f75 | 477 | remote shell program to use for communication between the local and |
14d43f1f | 478 | remote copies of rsync. By default, rsync will use rsh, but you may |
41059f75 AT |
479 | like to instead use ssh because of its high security. |
480 | ||
481 | You can also choose the remote shell program using the RSYNC_RSH | |
482 | environment variable. | |
483 | ||
b5679335 | 484 | dit(bf(--rsync-path=PATH)) Use this to specify the path to the copy of |
d73ee7b7 AT |
485 | rsync on the remote machine. Useful when it's not in your path. Note |
486 | that this is the full path to the binary, not just the directory that | |
487 | the binary is in. | |
41059f75 | 488 | |
b5679335 | 489 | dit(bf(--exclude=PATTERN)) This option allows you to selectively exclude |
41059f75 AT |
490 | certain files from the list of files to be transferred. This is most |
491 | useful in combination with a recursive transfer. | |
492 | ||
41059f75 AT |
493 | You may use as many --exclude options on the command line as you like |
494 | to build up the list of files to exclude. | |
495 | ||
14d43f1f | 496 | See the section on exclude patterns for information on the syntax of |
43bd68e5 | 497 | this option. |
41059f75 | 498 | |
b5679335 | 499 | dit(bf(--exclude-from=FILE)) This option is similar to the --exclude |
41059f75 | 500 | option, but instead it adds all filenames listed in the file FILE to |
122f19a6 DD |
501 | the exclude list. Blank lines in FILE and lines starting with ';' or '#' |
502 | are ignored. | |
41059f75 | 503 | |
b5679335 | 504 | dit(bf(--include=PATTERN)) This option tells rsync to not exclude the |
43bd68e5 AT |
505 | specified pattern of filenames. This is useful as it allows you to |
506 | build up quite complex exclude/include rules. | |
507 | ||
508 | See the section of exclude patterns for information on the syntax of | |
509 | this option. | |
510 | ||
b5679335 | 511 | dit(bf(--include-from=FILE)) This specifies a list of include patterns |
43bd68e5 AT |
512 | from a file. |
513 | ||
41059f75 AT |
514 | dit(bf(-C, --cvs-exclude)) This is a useful shorthand for excluding a |
515 | broad range of files that you often don't want to transfer between | |
516 | systems. It uses the same algorithm that CVS uses to determine if | |
517 | a file should be ignored. | |
518 | ||
519 | The exclude list is initialized to: | |
520 | ||
521 | quote(RCS SCCS CVS CVS.adm RCSLOG cvslog.* tags TAGS .make.state | |
522 | .nse_depinfo *~ #* .#* ,* *.old *.bak *.BAK *.orig *.rej .del-* | |
523 | *.a *.o *.obj *.so *.Z *.elc *.ln core) | |
524 | ||
525 | then files listed in a $HOME/.cvsignore are added to the list and any | |
526 | files listed in the CVSIGNORE environment variable (space delimited). | |
527 | ||
528 | Finally in each directory any files listed in the .cvsignore file in | |
529 | that directory are added to the list. | |
530 | ||
b5679335 | 531 | dit(bf(--csum-length=LENGTH)) By default the primary checksum used in |
41059f75 AT |
532 | rsync is a very strong 16 byte MD4 checksum. In most cases you will |
533 | find that a truncated version of this checksum is quite efficient, and | |
534 | this will decrease the size of the checksum data sent over the link, | |
de2fd20e | 535 | making things faster. |
41059f75 AT |
536 | |
537 | You can choose the number of bytes in the truncated checksum using the | |
538 | --csum-length option. Any value less than or equal to 16 is valid. | |
539 | ||
540 | Note that if you use this option then you run the risk of ending up | |
541 | with an incorrect target file. The risk with a value of 16 is | |
542 | microscopic and can be safely ignored (the universe will probably end | |
543 | before it fails) but with smaller values the risk is higher. | |
544 | ||
de2fd20e AT |
545 | Current versions of rsync actually use an adaptive algorithm for the |
546 | checksum length by default, using a 16 byte file checksum to determine | |
547 | if a 2nd pass is required with a longer block checksum. Only use this | |
548 | option if you have read the source code and know what you are doing. | |
549 | ||
b5679335 | 550 | dit(bf(-T, --temp-dir=DIR)) This option instructs rsync to use DIR as a |
375a4556 | 551 | scratch directory when creating temporary copies of the files |
41059f75 AT |
552 | transferred on the receiving side. The default behavior is to create |
553 | the temporary files in the receiving directory. | |
554 | ||
b5679335 | 555 | dit(bf(--compare-dest=DIR)) This option instructs rsync to use DIR as an |
375a4556 DD |
556 | additional directory to compare destination files against when doing |
557 | transfers. This is useful for doing transfers to a new destination while | |
558 | leaving existing files intact, and then doing a flash-cutover when all | |
14d43f1f | 559 | files have been successfully transferred (for example by moving directories |
baf3e504 DD |
560 | around and removing the old directory, although this requires also doing |
561 | the transfer with -I to avoid skipping files that haven't changed). This | |
562 | option increases the usefulness of --partial because partially transferred | |
563 | files will remain in the new temporary destination until they have a chance | |
564 | to be completed. If DIR is a relative path, it is relative to the | |
565 | destination directory. | |
375a4556 | 566 | |
41059f75 AT |
567 | dit(bf(-z, --compress)) With this option, rsync compresses any data from |
568 | the source file(s) which it sends to the destination machine. This | |
569 | option is useful on slow links. The compression method used is the | |
570 | same method that gzip uses. | |
571 | ||
572 | Note this this option typically achieves better compression ratios | |
573 | that can be achieved by using a compressing remote shell, or a | |
574 | compressing transport, as it takes advantage of the implicit | |
575 | information sent for matching data blocks. | |
576 | ||
577 | dit(bf(--numeric-ids)) With this option rsync will transfer numeric group | |
578 | and user ids rather than using user and group names and mapping them | |
579 | at both ends. | |
580 | ||
581 | By default rsync will use the user name and group name to determine | |
582 | what ownership to give files. The special uid 0 and the special group | |
14d43f1f | 583 | 0 are never mapped via user/group names even if the --numeric-ids |
41059f75 AT |
584 | option is not specified. |
585 | ||
8bb5aa8f DD |
586 | If the source system is a daemon using chroot, or if a user or group name |
587 | does not exist on the destination system, then the numeric id from the | |
588 | source system is used instead. | |
41059f75 | 589 | |
de2fd20e AT |
590 | dit(bf(--timeout=TIMEOUT)) This option allows you to set a maximum IO |
591 | timeout in seconds. If no data is transferred for the specified time | |
592 | then rsync will exit. The default is 0, which means no timeout. | |
41059f75 AT |
593 | |
594 | dit(bf(--daemon)) This tells rsync that it is to run as a rsync | |
595 | daemon. If standard input is a socket then rsync will assume that it | |
596 | is being run via inetd, otherwise it will detach from the current | |
5315b793 | 597 | terminal and become a background daemon. The daemon will read the |
41059f75 AT |
598 | config file (/etc/rsyncd.conf) on each connect made by a client and |
599 | respond to requests accordingly. See the rsyncd.conf(5) man page for more | |
600 | details. | |
601 | ||
5c9730a4 | 602 | dit(bf(--address)) By default rsync will bind to the wildcard address |
e30f0657 AT |
603 | when run as a daemon with the --daemon option or when connecting to a |
604 | rsync server. The --address option allows you to specify a specific IP | |
605 | address (or hostname) to bind to. This makes virtual hosting possible | |
606 | in conjunction with the --config option. | |
5c9730a4 | 607 | |
b5679335 | 608 | dit(bf(--config=FILE)) This specifies an alternate config file than |
5315b793 | 609 | the default /etc/rsyncd.conf. This is only relevant when --daemon is |
41059f75 AT |
610 | specified. |
611 | ||
b5679335 | 612 | dit(bf(--port=PORT)) This specifies an alternate TCP port number to use |
14d43f1f | 613 | rather than the default port 873. |
41059f75 | 614 | |
64c704f0 AT |
615 | dit(bf(--blocking-io)) This specifies whether rsync will use blocking |
616 | IO when launching a remote shell transport. You may find this is | |
617 | needed for some remote shells that can't handle the default | |
618 | non-blocking IO. | |
619 | ||
3a64ad1f | 620 | dit(bf(--log-format=FORMAT)) This allows you to specify exactly what the |
14d43f1f | 621 | rsync client logs to stdout on a per-file basis. The log format is |
3a64ad1f DD |
622 | specified using the same format conventions as the log format option in |
623 | rsyncd.conf. | |
b6062654 | 624 | |
b72f24c7 AT |
625 | dit(bf(--stats)) This tells rsync to print a verbose set of statistics |
626 | on the file transfer, allowing you to tell how effective the rsync | |
e19452a9 | 627 | algorithm is for your data. |
b72f24c7 | 628 | |
d9fcc198 AT |
629 | dit(bf(--partial)) By default, rsync will delete any partially |
630 | transferred file if the transfer is interrupted. In some circumstances | |
631 | it is more desirable to keep partially transferred files. Using the | |
632 | --partial option tells rsync to keep the partial file which should | |
633 | make a subsequent transfer of the rest of the file much faster. | |
634 | ||
eb86d661 AT |
635 | dit(bf(--progress)) This option tells rsync to print information |
636 | showing the progress of the transfer. This gives a bored user | |
637 | something to watch. | |
638 | ||
7b10f91d AT |
639 | This option is normally combined with -v. Using this option without |
640 | the -v option will produce weird results on your display. | |
641 | ||
d9fcc198 AT |
642 | dit(bf(-P)) The -P option is equivalent to --partial --progress. I |
643 | found myself typing that combination quite often so I created an | |
644 | option to make it easier. | |
645 | ||
65575e96 AT |
646 | dit(bf(--password-file)) This option allows you to provide a password |
647 | in a file for accessing a remote rsync server. Note that this option | |
648 | is only useful when accessing a rsync server using the built in | |
649 | transport, not when using a remote shell as the transport. The file | |
fc7952e7 AT |
650 | must not be world readable. It should contain just the password as a |
651 | single line. | |
65575e96 | 652 | |
ef5d23eb DD |
653 | dit(bf(--bwlimit=KBPS)) This option allows you to specify a maximum |
654 | transfer rate in kilobytes per second. This option is most effective when | |
655 | using rsync with large files (several megabytes and up). Due to the nature | |
656 | of rsync transfers, blocks of data are sent, then if rsync determines the | |
657 | transfer was too fast, it will wait before sending the next data block. The | |
658 | result is an average transfer rate equalling the specified limit. A value | |
659 | of zero specifies no limit. | |
660 | ||
41059f75 AT |
661 | enddit() |
662 | ||
43bd68e5 AT |
663 | manpagesection(EXCLUDE PATTERNS) |
664 | ||
665 | The exclude and include patterns specified to rsync allow for flexible | |
14d43f1f | 666 | selection of which files to transfer and which files to skip. |
43bd68e5 | 667 | |
14d43f1f DD |
668 | rsync builds a ordered list of include/exclude options as specified on |
669 | the command line. When a filename is encountered, rsync checks the | |
43bd68e5 AT |
670 | name against each exclude/include pattern in turn. The first matching |
671 | pattern is acted on. If it is an exclude pattern than that file is | |
672 | skipped. If it is an include pattern then that filename is not | |
673 | skipped. If no matching include/exclude pattern is found then the | |
674 | filename is not skipped. | |
675 | ||
27b9a19b DD |
676 | Note that when used with -r (which is implied by -a), every subcomponent of |
677 | every path is visited from top down, so include/exclude patterns get | |
678 | applied recursively to each subcomponent. | |
679 | ||
680 | Note also that the --include and --exclude options take one pattern | |
2fb139c1 AT |
681 | each. To add multiple patterns use the --include-from and |
682 | --exclude-from options or multiple --include and --exclude options. | |
683 | ||
14d43f1f | 684 | The patterns can take several forms. The rules are: |
43bd68e5 AT |
685 | |
686 | itemize( | |
687 | it() if the pattern starts with a / then it is matched against the | |
688 | start of the filename, otherwise it is matched against the end of | |
27b9a19b DD |
689 | the filename. Thus "/foo" would match a file called "foo" at the base of |
690 | the tree. On the other hand, "foo" would match any file called "foo" | |
691 | anywhere in the tree because the algorithm is applied recursively from | |
692 | top down; it behaves as if each path component gets a turn at being the | |
693 | end of the file name. | |
43bd68e5 AT |
694 | |
695 | it() if the pattern ends with a / then it will only match a | |
696 | directory, not a file, link or device. | |
697 | ||
698 | it() if the pattern contains a wildcard character from the set | |
a8b9d4ed DD |
699 | *?[ then expression matching is applied using the shell filename |
700 | matching rules. Otherwise a simple string match is used. | |
43bd68e5 | 701 | |
27b9a19b DD |
702 | it() if the pattern includes a double asterisk "**" then all wildcards in |
703 | the pattern will match slashes, otherwise they will stop at slashes. | |
704 | ||
43bd68e5 AT |
705 | it() if the pattern contains a / (not counting a trailing /) then it |
706 | is matched against the full filename, including any leading | |
707 | directory. If the pattern doesn't contain a / then it is matched | |
27b9a19b DD |
708 | only against the final component of the filename. Again, remember |
709 | that the algorithm is applied recursively so "full filename" can | |
710 | actually be any portion of a path. | |
43bd68e5 AT |
711 | |
712 | it() if the pattern starts with "+ " (a plus followed by a space) | |
5a554d5b | 713 | then it is always considered an include pattern, even if specified as |
43bd68e5 AT |
714 | part of an exclude option. The "+ " part is discarded before matching. |
715 | ||
716 | it() if the pattern starts with "- " (a minus followed by a space) | |
5a554d5b | 717 | then it is always considered an exclude pattern, even if specified as |
43bd68e5 | 718 | part of an include option. The "- " part is discarded before matching. |
de2fd20e AT |
719 | |
720 | it() if the pattern is a single exclamation mark ! then the current | |
721 | exclude list is reset, removing all previous exclude patterns. | |
43bd68e5 AT |
722 | ) |
723 | ||
724 | The +/- rules are most useful in exclude lists, allowing you to have a | |
725 | single exclude list that contains both include and exclude options. | |
27b9a19b DD |
726 | |
727 | If you end an exclude list with --exclude '*', note that since the | |
728 | algorithm is applied recursively that unless you explicitly include | |
729 | parent directories of files you want to include then the algorithm | |
730 | will stop at the parent directories and never see the files below | |
731 | them. To include all directories, use --include '*/' before the | |
732 | --exclude '*'. | |
43bd68e5 | 733 | |
328fcf11 | 734 | Here are some exclude/include examples: |
43bd68e5 AT |
735 | |
736 | itemize( | |
737 | it() --exclude "*.o" would exclude all filenames matching *.o | |
738 | it() --exclude "/foo" would exclude a file in the base directory called foo | |
739 | it() --exclude "foo/" would exclude any directory called foo | |
a8b9d4ed DD |
740 | it() --exclude "/foo/*/bar" would exclude any file called bar two |
741 | levels below a base directory called foo | |
742 | it() --exclude "/foo/**/bar" would exclude any file called bar two | |
743 | or more levels below a base directory called foo | |
43bd68e5 | 744 | it() --include "*/" --include "*.c" --exclude "*" would include all |
5d5811f7 DD |
745 | directories and C source files |
746 | it() --include "foo/" --include "foo/bar.c" --exclude "*" would include | |
747 | only foo/bar.c (the foo/ directory must be explicitly included or | |
748 | it would be excluded by the "*") | |
43bd68e5 AT |
749 | ) |
750 | ||
d310a212 AT |
751 | manpagesection(DIAGNOSTICS) |
752 | ||
14d43f1f | 753 | rsync occasionally produces error messages that may seem a little |
d310a212 AT |
754 | cryptic. The one that seems to cause the most confusion is "protocol |
755 | version mismatch - is your shell clean?". | |
756 | ||
757 | This message is usually caused by your startup scripts or remote shell | |
758 | facility producing unwanted garbage on the stream that rsync is using | |
14d43f1f | 759 | for its transport. The way to diagnose this problem is to run your |
d310a212 AT |
760 | remote shell like this: |
761 | ||
762 | verb( | |
763 | rsh remotehost /bin/true > out.dat | |
764 | ) | |
765 | ||
766 | then look at out.dat. If everything is working correctly then out.dat | |
2cfeab21 | 767 | should be a zero length file. If you are getting the above error from |
d310a212 AT |
768 | rsync then you will probably find that out.dat contains some text or |
769 | data. Look at the contents and try to work out what is producing | |
14d43f1f | 770 | it. The most common cause is incorrectly configured shell startup |
d310a212 AT |
771 | scripts (such as .cshrc or .profile) that contain output statements |
772 | for non-interactive logins. | |
773 | ||
de2fd20e AT |
774 | manpagesection(ENVIRONMENT VARIABLES) |
775 | ||
776 | startdit() | |
777 | ||
778 | dit(bf(CVSIGNORE)) The CVSIGNORE environment variable supplements any | |
779 | ignore patterns in .cvsignore files. See the --cvs-exclude option for | |
780 | more details. | |
781 | ||
782 | dit(bf(RSYNC_RSH)) The RSYNC_RSH environment variable allows you to | |
783 | override the default shell used as the transport for rsync. This can | |
784 | be used instead of the -e option. | |
785 | ||
4c3b4b25 AT |
786 | dit(bf(RSYNC_PROXY)) The RSYNC_PROXY environment variable allows you to |
787 | redirect your rsync client to use a web proxy when connecting to a | |
788 | rsync daemon. You should set RSYNC_PROXY to a hostname:port pair. | |
789 | ||
de2fd20e AT |
790 | dit(bf(RSYNC_PASSWORD)) Setting RSYNC_PASSWORD to the required |
791 | password allows you to run authenticated rsync connections to a rsync | |
792 | daemon without user intervention. Note that this does not supply a | |
793 | password to a shell transport such as ssh. | |
794 | ||
795 | dit(bf(USER) or bf(LOGNAME)) The USER or LOGNAME environment variables | |
796 | are used to determine the default username sent to a rsync server. | |
797 | ||
14d43f1f | 798 | dit(bf(HOME)) The HOME environment variable is used to find the user's |
de2fd20e AT |
799 | default .cvsignore file. |
800 | ||
801 | enddit() | |
802 | ||
41059f75 AT |
803 | manpagefiles() |
804 | ||
805 | /etc/rsyncd.conf | |
806 | ||
807 | manpageseealso() | |
808 | ||
809 | rsyncd.conf(5) | |
810 | ||
811 | manpagediagnostics() | |
812 | ||
813 | manpagebugs() | |
814 | ||
815 | times are transferred as unix time_t values | |
816 | ||
817 | file permissions, devices etc are transferred as native numerical | |
818 | values | |
819 | ||
a87b3b2a | 820 | see also the comments on the --delete option |
41059f75 AT |
821 | |
822 | Please report bugs! The rsync bug tracking system is online at | |
9e3c856a | 823 | url(http://rsync.samba.org/rsync/)(http://rsync.samba.org/rsync/) |
41059f75 AT |
824 | |
825 | manpagesection(VERSION) | |
826 | This man page is current for version 2.0 of rsync | |
827 | ||
828 | manpagesection(CREDITS) | |
829 | ||
830 | rsync is distributed under the GNU public license. See the file | |
831 | COPYING for details. | |
832 | ||
41059f75 | 833 | A WEB site is available at |
9e3c856a AT |
834 | url(http://rsync.samba.org/)(http://rsync.samba.org/) |
835 | ||
836 | The primary ftp site for rsync is | |
837 | url(ftp://rsync.samba.org/pub/rsync)(ftp://rsync.samba.org/pub/rsync). | |
41059f75 AT |
838 | |
839 | We would be delighted to hear from you if you like this program. | |
840 | ||
9e3c856a AT |
841 | This program uses the excellent zlib compression library written by |
842 | Jean-loup Gailly and Mark Adler. | |
41059f75 AT |
843 | |
844 | manpagesection(THANKS) | |
845 | ||
846 | Thanks to Richard Brent, Brendan Mackay, Bill Waite, Stephen Rothwell | |
847 | and David Bell for helpful suggestions and testing of rsync. I've | |
848 | probably missed some people, my apologies if I have. | |
849 | ||
850 | ||
851 | manpageauthor() | |
852 | ||
853 | rsync was written by Andrew Tridgell and Paul Mackerras. They may be | |
9e3c856a | 854 | contacted via email at tridge@samba.org and |
41059f75 AT |
855 | Paul.Mackerras@cs.anu.edu.au |
856 |