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