Commit | Line | Data |
---|---|---|
41059f75 AT |
1 | mailto(rsync-bugs@samba.anu.edu.au) |
2 | manpage(rsync)(1)(13 May 1998)()() | |
3 | manpagename(rsync)(faster, flexible replacement for rcp) | |
4 | manpagesynopsis() | |
5 | ||
6 | rsync [options] [user@]host:path path | |
7 | ||
8 | rsync [options] path [user@]host:path | |
9 | ||
10 | rsync [options] path path | |
11 | ||
37863201 | 12 | rsync [options] [user@]host::module[/path] path |
41059f75 | 13 | |
37863201 | 14 | rsync [options] path [user@]host::module[/path] |
41059f75 | 15 | |
039faa86 AT |
16 | rsync [options] rsync://host/module/path path |
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 | |
57 | using a remote shell program. This is invoked when the local path | |
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 :: | |
039faa86 AT |
62 | separator. You can also use a rsync:// URL if no username |
63 | is required. | |
41059f75 AT |
64 | |
65 | it() for copying from the local machine to a remote rsync | |
66 | server. This is invoked when the destination path contains a :: | |
67 | separator. | |
039faa86 AT |
68 | |
69 | it() for listing files on a remote machine. This is done the | |
70 | same way as rsync transfers except that you leave off the | |
71 | local destination. | |
41059f75 AT |
72 | ) |
73 | ||
74 | Note that in all cases at least one of the source and destination | |
75 | paths must be local. | |
76 | ||
77 | manpagesection(SETUP) | |
78 | ||
79 | See the file README for installation instructions. | |
80 | ||
81 | Once installed you can use rsync to any machine that you can use rsh | |
82 | to. rsync uses rsh for its communications, unless both the source and | |
83 | destination are local. | |
84 | ||
85 | You can also specify a alternative to rsh, by either using the -e | |
86 | command line option, or by setting the RSYNC_RSH environment variable. | |
87 | ||
88 | One common substitute is to use ssh, which offers a high degree of | |
89 | security. | |
90 | ||
8e987130 AT |
91 | Note that rsync must be installed on both the source and destination |
92 | machines. | |
93 | ||
41059f75 AT |
94 | manpagesection(USAGE) |
95 | ||
96 | You use rsync in the same way you use rcp. You must specify a source | |
97 | and a destination, one of which may be remote. | |
98 | ||
99 | Perhaps the best way to explain the syntax is some examples: | |
100 | ||
101 | quote(rsync *.c foo:src/) | |
102 | ||
103 | this would transfer all files matching the pattern *.c from the | |
104 | current directory to the directory src on the machine foo. If any of | |
105 | the files already exist on the remote system then the rsync | |
106 | remote-update protocol is used to update the file by sending only the | |
107 | differences. See the tech report for details. | |
108 | ||
109 | quote(rsync -avz foo:src/bar /data/tmp) | |
110 | ||
111 | recursively transfer all files from the directory src/bar on the | |
112 | machine foo into the /data/tmp/bar directory on the local machine. The | |
113 | files are transferred in "archive" mode, which ensures that symbolic | |
114 | links, devices, attributes, permissions, ownerships etc are preserved | |
115 | in the transfer. Additionally compression will be used to reduce the | |
116 | size of data portions of the transfer. | |
117 | ||
118 | quote(rsync -avz foo:src/bar/ /data/tmp) | |
119 | ||
120 | With a trailing slash on the source this behavior changes to transfer | |
121 | all files from the directory src/bar on the machine foo into the | |
122 | /data/tmp/. With a trailing / on a source name it means "copy the | |
123 | contents of this directory". Without a trailing slash it means "copy | |
124 | the directory". This difference becomes particularly important when | |
125 | using the --delete option. | |
126 | ||
127 | You can also use rsync in local-only mode, where both the source and | |
128 | destination don't have a ':' in the name. In this case it behaves like | |
129 | an improved copy command. | |
130 | ||
131 | ||
132 | manpagesection(CONNECTING TO AN RSYNC SERVER) | |
133 | ||
134 | It is also possible to use rsync without using rsh or ssh as the | |
135 | transport. In this case you will connect to a remote rsync server | |
136 | running on TCP port 873. | |
137 | ||
138 | Using rsync in this was is the same as using it with rsh or ssh except | |
139 | that: | |
140 | ||
141 | itemize( | |
142 | it() you use a double colon :: instead of a single colon to | |
143 | separate the hostname from the path. | |
144 | ||
145 | it() the remote server may print a message of the day when you | |
146 | connect | |
147 | ||
148 | it() if you specify no path name on the remote server then the | |
149 | list of accessible paths on the server will be shown. | |
f7632fc6 AT |
150 | |
151 | it() if you specify no local destination then a listing of the | |
152 | specified files on the remote server is provided | |
41059f75 AT |
153 | ) |
154 | ||
4c3d16be AT |
155 | Some paths on the remote server may require authentication. If so then |
156 | you will receive a password prompt when you connect. You can avoid the | |
157 | password prompt by setting the environment variable RSYNC_PASSWORD to | |
158 | the password you want to use. This may be useful when scripting rsync. | |
159 | ||
41059f75 AT |
160 | manpagesection(RUNNING AN RSYNC SERVER) |
161 | ||
162 | An rsync server is configured using a config file which by default is | |
163 | called /etc/rsyncd.conf. Please see the rsyncd.conf(5) man page for more | |
164 | information. | |
165 | ||
166 | manpagesection(EXAMPLES) | |
167 | ||
168 | Here are some examples of how I use rsync. | |
169 | ||
170 | To backup my wife's home directory, which consists of large MS word | |
171 | files and mail folders I use a cron job that runs | |
172 | ||
173 | quote(rsync -Cavz . arvidsjaur:backup) | |
174 | ||
175 | each night over a PPP link to a duplicate directory on my machine | |
176 | "arvidsjaur". | |
177 | ||
178 | To synchronize my samba source trees I use the following Makefile | |
179 | targets: | |
180 | ||
181 | quote( get:nl() | |
182 | rsync -avuzb --exclude '*~' samba:samba/ . | |
183 | ||
184 | put:nl() | |
185 | rsync -Cavuzb . samba:samba/ | |
186 | ||
187 | sync: get put) | |
188 | ||
189 | this allows me to sync with a CVS directory at the other end of the | |
190 | link. I then do cvs operations on the remote machine, which saves a | |
191 | lot of time as the remote cvs protocol isn't very efficient. | |
192 | ||
193 | I mirror a directory between my "old" and "new" ftp sites with the | |
194 | command | |
195 | ||
196 | quote(rsync -az -e ssh --delete ~ftp/pub/samba/ nimbus:"~ftp/pub/tridge/samba") | |
197 | ||
198 | this is launched from cron every few hours. | |
199 | ||
c95da96a AT |
200 | manpagesection(OPTIONS SUMMARY) |
201 | ||
202 | Here is a short summary of the options avalable in rsync. Please refer | |
203 | to the detailed description below for a complete description. | |
204 | ||
205 | verb( | |
d853783f AT |
206 | Usage: rsync [OPTION]... SRC [USER@]HOST:DEST |
207 | or rsync [OPTION]... [USER@]HOST:SRC DEST | |
208 | or rsync [OPTION]... SRC DEST | |
209 | or rsync [OPTION]... [USER@]HOST::SRC DEST | |
210 | or rsync [OPTION]... SRC [USER@]HOST::DEST | |
211 | ||
212 | Options | |
c95da96a AT |
213 | -v, --verbose increase verbosity |
214 | -c, --checksum always checksum | |
215 | -a, --archive archive mode | |
216 | -r, --recursive recurse into directories | |
217 | -R, --relative use relative path names | |
218 | -b, --backup make backups (default ~ extension) | |
219 | -u, --update update only (don't overwrite newer files) | |
220 | -l, --links preserve soft links | |
221 | -L, --copy-links treat soft links like regular files | |
d853783f | 222 | --safe-links ignore links outside the destination tree |
c95da96a AT |
223 | -H, --hard-links preserve hard links |
224 | -p, --perms preserve permissions | |
225 | -o, --owner preserve owner (root only) | |
226 | -g, --group preserve group | |
227 | -D, --devices preserve devices (root only) | |
228 | -t, --times preserve times | |
229 | -S, --sparse handle sparse files efficiently | |
230 | -n, --dry-run show what would have been transferred | |
231 | -W, --whole-file copy whole files, no incremental checks | |
232 | -x, --one-file-system don't cross filesystem boundaries | |
233 | -B, --block-size=SIZE checksum blocking size | |
234 | -e, --rsh=COMMAND specify rsh replacement | |
235 | --rsync-path=PATH specify path to rsync on the remote machine | |
236 | -C, --cvs-exclude auto ignore files in the same way CVS does | |
237 | --delete delete files that don't exist on the sending side | |
238 | --partial keep partially transferred files | |
239 | --force force deletion of directories even if not empty | |
240 | --numeric-ids don't map uid/gid values by user/group name | |
241 | --timeout=TIME set IO timeout in seconds | |
242 | -I, --ignore-times don't exclude files that match length and time | |
243 | -T --temp-dir=DIR create temporary files in directory DIR | |
375a4556 | 244 | --compare-dest=DIR also compare destination files relative to DIR |
c95da96a AT |
245 | -z, --compress compress file data |
246 | --exclude=PATTERN exclude file FILE | |
247 | --exclude-from=PATTERN exclude files listed in FILE | |
248 | --include=PATTERN don't exclude file FILE | |
249 | --include-from=PATTERN don't exclude files listed in FILE | |
250 | --suffix=SUFFIX override backup suffix | |
251 | --version print version number | |
252 | --daemon run as a rsync daemon | |
253 | --config=FILE specify alternate rsyncd.conf file | |
254 | --port=PORT specify alternate rsyncd port number | |
255 | --stats give some file transfer stats | |
eb86d661 | 256 | --progress show progress during transfer |
b6062654 | 257 | --log-format=FORMAT log file transfers using specified format |
c95da96a AT |
258 | -h, --help show this help screen |
259 | ) | |
260 | ||
41059f75 AT |
261 | manpageoptions() |
262 | ||
263 | rsync uses the GNU long options package. Many of the command line | |
264 | options have two variants, one short and one long. These are shown | |
265 | below separated by commas. Some options only have a long variant. | |
266 | ||
267 | startdit() | |
268 | dit(bf(-h, --help)) Print a short help page describing the options | |
269 | available in rsync | |
270 | ||
271 | dit(bf(--version)) print the rsync version number and exit | |
272 | ||
273 | dit(bf(-v, --verbose)) This option increases the amount of information you | |
274 | are given during the transfer. By default rsync works silently. A | |
275 | single -v will give you information about what files are being | |
276 | transferred and a brief summary at the end. Two -v flags will give you | |
277 | information on what files are being skipped and slightly more | |
278 | information at the end. More than two -v flags should only be used if | |
279 | you are debugging rsync | |
280 | ||
281 | dit(bf(-I, --ignore-times)) Normally rsync will skip any files that are | |
282 | already the same length and have the same time-stamp. This option turns | |
283 | off this behavior. | |
284 | ||
285 | dit(bf(-c, --checksum)) This forces the sender to checksum all files using | |
286 | a 128-bit MD4 checksum before transfer. The checksum is then | |
287 | explicitly checked on the receiver and any files of the same name | |
288 | which already exist and have the same checksum and size on the | |
289 | receiver are skipped. This option can be quite slow. | |
290 | ||
5243c216 | 291 | dit(bf(-a, --archive)) This is equivalent to -rlptDg. It is a quick way |
41059f75 AT |
292 | of saying I want recursion and want to preserve everything. |
293 | ||
5243c216 AT |
294 | Note: if the user launching rsync is root then the -o option (preserve |
295 | uid) is also implied. | |
296 | ||
41059f75 AT |
297 | dit(bf(-r, --recursive)) This tells rsync to copy directories recursively |
298 | ||
299 | dit(bf(-R, --relative)) Use relative paths. This means that the full path | |
300 | names specified on the command line are sent to the server rather than | |
301 | just the last parts of the filenames. This is particularly useful when | |
302 | you want to sent several different directories at the same time. For | |
303 | example if you used the command | |
304 | ||
305 | verb(rsync foo/bar/foo.c remote:/tmp/) | |
306 | ||
307 | then this would create a file called foo.c in /tmp/ on the remote | |
308 | machine. If instead you used | |
309 | ||
310 | verb(rsync -R foo/bar/foo.c remote:/tmp/) | |
311 | ||
312 | then a file called /tmp/foo/bar/foo.c would be created on the remote | |
313 | machine. The full path name is preserved. | |
314 | ||
315 | dit(bf(-b, --backup)) With this option preexisting destination files are | |
316 | renamed with a ~ extension as each file is transferred. You can | |
317 | control the backup suffix using the --suffix option. | |
318 | ||
319 | dit(bf(-u, --update)) This forces rsync to skip any files for which the | |
320 | destination file already exists and has a date later than the source | |
321 | file. | |
322 | ||
323 | dit(bf(-l, --links)) This tells rsync to recreate symbolic links on the | |
324 | remote system to be the same as the local system. Without this | |
325 | option all symbolic links are skipped. | |
326 | ||
327 | dit(bf(-L, --copy-links)) This tells rsync to treat symbolic links just | |
328 | like ordinary files. | |
329 | ||
d310a212 AT |
330 | dit(bf(--safe-links)) This tells rsync to ignore any symbolic links |
331 | which point outside the destination tree. All absolute symlinks are | |
332 | also ignored. Using this option in conjunction with --relative may | |
333 | give unexpecetd results. | |
334 | ||
41059f75 AT |
335 | dit(bf(-H, --hard-links)) This tells rsync to recreate hard links on |
336 | the remote system to be the same as the local system. Without this | |
337 | option hard links are treated like regular files. | |
338 | ||
339 | Note that rsync can only detect hard links if both parts of the link | |
340 | are in the list of files being sent. | |
341 | ||
342 | This option can be quite slow, so only use it if you need it. | |
343 | ||
344 | dit(bf(-W, --whole-file)) With this option the incremental rsync algorithm | |
345 | is not used and the whole file is sent as-is instead. This may be | |
346 | useful when using rsync with a local machine. | |
347 | ||
c95da96a AT |
348 | dit(bf(--partial)) By default rsync will delete any partially |
349 | transferred file if the transfer is interrupted. In some circumstances | |
350 | it is more desirable to keep partially transferred files. Using the | |
351 | --partial option tells rsync to keep the partial file which should | |
352 | make a subsequent transfer of the rest of the file much faster. | |
353 | ||
41059f75 AT |
354 | dit(bf(-p, --perms)) This option causes rsync to update the remote |
355 | permissions to be the same as the local permissions. | |
356 | ||
357 | dit(bf(-o, --owner)) This option causes rsync to update the remote owner | |
358 | of the file to be the same as the local owner. This is only available | |
8bb5aa8f DD |
359 | to the super-user. Note that if the source system is a daemon using chroot, |
360 | the --numeric-ids option is implied because the source system cannot get | |
361 | access to the user names. | |
41059f75 AT |
362 | |
363 | dit(bf(-g, --group)) This option causes rsync to update the remote group | |
8bb5aa8f DD |
364 | of the file to be the same as the local group. Note that if the source |
365 | system is a daemon using chroot, the --numeric-ids option is implied because | |
366 | the source system cannot get access to the group names. | |
41059f75 AT |
367 | |
368 | dit(bf(-D, --devices)) This option causes rsync to transfer character and | |
369 | block device information to the remote system to recreate these | |
370 | devices. This option is only available to the super-user. | |
371 | ||
372 | dit(bf(-t, --times)) This tells rsync to transfer modification times along | |
373 | with the files and update them on the remote system | |
374 | ||
375 | dit(bf(-n, --dry-run)) This tells rsync to not do any file transfers, | |
376 | instead it will just report the actions it would have taken. | |
377 | ||
378 | dit(bf(-S, --sparse)) Try to handle sparse files efficiently so they take | |
379 | up less space on the destination. | |
380 | ||
d310a212 AT |
381 | NOTE: Don't use this option when the destination is a Solaris "tmpfs" |
382 | filesystem. It doesn't seem to handle seeks over null regions | |
383 | correctly and ends up corrupting the files. | |
384 | ||
41059f75 AT |
385 | dit(bf(-x, --one-file-system)) This tells rsync not to cross filesystem |
386 | boundaries when recursing. This is useful for transferring the | |
387 | contents of only one filesystem. | |
388 | ||
389 | dit(bf(--delete)) This tells rsync to delete any files on the receiving | |
390 | side that aren't on the sending side. This option can be dangerous if | |
391 | used incorrectly! | |
392 | ||
393 | It is a very good idea to run first using the dry run option (-n) to | |
394 | see what files would be deleted to make sure important files aren't | |
395 | listed. | |
396 | ||
397 | rsync 1.6.4 changed the behavior of --delete to make it less | |
398 | dangerous. rsync now only scans directories on the receiving side | |
399 | that are explicitly transferred from the sending side. Only files in | |
400 | these directories are deleted. | |
401 | ||
402 | Still, it is probably easy to get burnt with this option. The moral | |
403 | of the story is to use the -n option until you get used to the | |
404 | behavior of --delete. | |
405 | ||
3e578a19 AT |
406 | If the sending side detects any IO errors then the deletion of any |
407 | files at the destination will be automatically disabled. This is to | |
408 | prevent temporary filesystem failures (such as NFS errors) on the | |
409 | sending side causing a massive deletion of files on the | |
410 | destination. | |
41059f75 AT |
411 | |
412 | dit(bf(--force)) This options tells rsync to delete directories even if | |
413 | they are not empty. This applies to both the --delete option and to | |
414 | cases where rsync tries to copy a normal file but the destination | |
415 | contains a directory of the same name. Normally rsync will refuse to | |
416 | do a recursive directory deletion in such cases, by using --force | |
417 | the recursive deletion will be done. | |
418 | ||
419 | Use this option with caution! | |
420 | ||
421 | dit(bf(-B , --block_size BLOCKSIZE)) This controls the block size used in | |
422 | the rsync algorithm. See the technical report for details. | |
423 | ||
424 | dit(bf(-e, --rsh COMMAND)) This option allows you to choose an alternative | |
425 | remote shell program to use for communication between the local and | |
426 | remote copies of rsync. By default rsync will use rsh, but you may | |
427 | like to instead use ssh because of its high security. | |
428 | ||
429 | You can also choose the remote shell program using the RSYNC_RSH | |
430 | environment variable. | |
431 | ||
432 | dit(bf(--rsync-path PATH)) Use this to specify the path to the copy of | |
433 | rsync on the remote machine. Useful when its not in your path. | |
434 | ||
43bd68e5 | 435 | dit(bf(--exclude pattern)) This option allows you to selectively exclude |
41059f75 AT |
436 | certain files from the list of files to be transferred. This is most |
437 | useful in combination with a recursive transfer. | |
438 | ||
41059f75 AT |
439 | You may use as many --exclude options on the command line as you like |
440 | to build up the list of files to exclude. | |
441 | ||
43bd68e5 AT |
442 | See the section of exclude patterns for information on the syntax of |
443 | this option. | |
41059f75 AT |
444 | |
445 | dit(bf(--exclude-from FILE)) This option is similar to the --exclude | |
446 | option, but instead it adds all filenames listed in the file FILE to | |
447 | the exclude list. | |
448 | ||
43bd68e5 AT |
449 | dit(bf(--include pattern)) This option tells rsync to not exclude the |
450 | specified pattern of filenames. This is useful as it allows you to | |
451 | build up quite complex exclude/include rules. | |
452 | ||
453 | See the section of exclude patterns for information on the syntax of | |
454 | this option. | |
455 | ||
456 | dit(bf(--include-from FILE)) This specifies a list of include patterns | |
457 | from a file. | |
458 | ||
41059f75 AT |
459 | dit(bf(-C, --cvs-exclude)) This is a useful shorthand for excluding a |
460 | broad range of files that you often don't want to transfer between | |
461 | systems. It uses the same algorithm that CVS uses to determine if | |
462 | a file should be ignored. | |
463 | ||
464 | The exclude list is initialized to: | |
465 | ||
466 | quote(RCS SCCS CVS CVS.adm RCSLOG cvslog.* tags TAGS .make.state | |
467 | .nse_depinfo *~ #* .#* ,* *.old *.bak *.BAK *.orig *.rej .del-* | |
468 | *.a *.o *.obj *.so *.Z *.elc *.ln core) | |
469 | ||
470 | then files listed in a $HOME/.cvsignore are added to the list and any | |
471 | files listed in the CVSIGNORE environment variable (space delimited). | |
472 | ||
473 | Finally in each directory any files listed in the .cvsignore file in | |
474 | that directory are added to the list. | |
475 | ||
476 | dit(bf(--suffix SUFFIX)) This option allows you to override the default | |
477 | backup suffix used with the -b option. The default is a ~. | |
478 | ||
479 | dit(bf(--csum-length LENGTH)) By default the primary checksum used in | |
480 | rsync is a very strong 16 byte MD4 checksum. In most cases you will | |
481 | find that a truncated version of this checksum is quite efficient, and | |
482 | this will decrease the size of the checksum data sent over the link, | |
de2fd20e | 483 | making things faster. |
41059f75 AT |
484 | |
485 | You can choose the number of bytes in the truncated checksum using the | |
486 | --csum-length option. Any value less than or equal to 16 is valid. | |
487 | ||
488 | Note that if you use this option then you run the risk of ending up | |
489 | with an incorrect target file. The risk with a value of 16 is | |
490 | microscopic and can be safely ignored (the universe will probably end | |
491 | before it fails) but with smaller values the risk is higher. | |
492 | ||
de2fd20e AT |
493 | Current versions of rsync actually use an adaptive algorithm for the |
494 | checksum length by default, using a 16 byte file checksum to determine | |
495 | if a 2nd pass is required with a longer block checksum. Only use this | |
496 | option if you have read the source code and know what you are doing. | |
497 | ||
375a4556 DD |
498 | dit(bf(-T, --temp-dir DIR)) This option instructs rsync to use DIR as a |
499 | scratch directory when creating temporary copies of the files | |
41059f75 AT |
500 | transferred on the receiving side. The default behavior is to create |
501 | the temporary files in the receiving directory. | |
502 | ||
375a4556 DD |
503 | dit(bf(--compare-dest DIR)) This option instructs rsync to use DIR as an |
504 | additional directory to compare destination files against when doing | |
505 | transfers. This is useful for doing transfers to a new destination while | |
506 | leaving existing files intact, and then doing a flash-cutover when all | |
507 | files have been successfully transfered (for example by moving directories | |
508 | around and removing the old directory). This option increases the | |
509 | usefulness of --partial because partially transferred files will remain in | |
510 | the new temporary destination until they have a chance to be completed. | |
511 | If DIR is a relative path, it is relative to the destination directory. | |
512 | ||
41059f75 AT |
513 | dit(bf(-z, --compress)) With this option, rsync compresses any data from |
514 | the source file(s) which it sends to the destination machine. This | |
515 | option is useful on slow links. The compression method used is the | |
516 | same method that gzip uses. | |
517 | ||
518 | Note this this option typically achieves better compression ratios | |
519 | that can be achieved by using a compressing remote shell, or a | |
520 | compressing transport, as it takes advantage of the implicit | |
521 | information sent for matching data blocks. | |
522 | ||
523 | dit(bf(--numeric-ids)) With this option rsync will transfer numeric group | |
524 | and user ids rather than using user and group names and mapping them | |
525 | at both ends. | |
526 | ||
527 | By default rsync will use the user name and group name to determine | |
528 | what ownership to give files. The special uid 0 and the special group | |
529 | 0 and never mapped via user/group names even if the --numeric-ids | |
530 | option is not specified. | |
531 | ||
8bb5aa8f DD |
532 | If the source system is a daemon using chroot, or if a user or group name |
533 | does not exist on the destination system, then the numeric id from the | |
534 | source system is used instead. | |
41059f75 | 535 | |
de2fd20e AT |
536 | dit(bf(--timeout=TIMEOUT)) This option allows you to set a maximum IO |
537 | timeout in seconds. If no data is transferred for the specified time | |
538 | then rsync will exit. The default is 0, which means no timeout. | |
41059f75 AT |
539 | |
540 | dit(bf(--daemon)) This tells rsync that it is to run as a rsync | |
541 | daemon. If standard input is a socket then rsync will assume that it | |
542 | is being run via inetd, otherwise it will detach from the current | |
5315b793 | 543 | terminal and become a background daemon. The daemon will read the |
41059f75 AT |
544 | config file (/etc/rsyncd.conf) on each connect made by a client and |
545 | respond to requests accordingly. See the rsyncd.conf(5) man page for more | |
546 | details. | |
547 | ||
548 | dit(bf(--config FILE)) This specifies an alternate config file than | |
5315b793 | 549 | the default /etc/rsyncd.conf. This is only relevant when --daemon is |
41059f75 AT |
550 | specified. |
551 | ||
552 | dit(bf(--port PORT)) This specifies an alternate TCP port number to use | |
553 | rather than the default port 873. | |
554 | ||
b6062654 AT |
555 | dit(bf(--log-format=FORMAT)) Normally rsync just logs filenames as |
556 | they are transferred. This allows you to specify exactly what gets | |
557 | logged on a per file basis. The log format is specified using the same | |
558 | format conventions as the log format option in rsyncd.conf. | |
559 | ||
b72f24c7 AT |
560 | dit(bf(--stats)) This tells rsync to print a verbose set of statistics |
561 | on the file transfer, allowing you to tell how effective the rsync | |
56cdbccb AT |
562 | algorithm is for your data. This option only works in conjunction with |
563 | the -v (verbose) option. | |
b72f24c7 | 564 | |
eb86d661 AT |
565 | dit(bf(--progress)) This option tells rsync to print information |
566 | showing the progress of the transfer. This gives a bored user | |
567 | something to watch. | |
568 | ||
41059f75 AT |
569 | enddit() |
570 | ||
43bd68e5 AT |
571 | manpagesection(EXCLUDE PATTERNS) |
572 | ||
573 | The exclude and include patterns specified to rsync allow for flexible | |
574 | selection of what files to transfer and what files to skip. | |
575 | ||
576 | rsync build a ordered list of include/exclude options as specified on | |
577 | the command line. When a filename is encountered rsync then checks the | |
578 | name against each exclude/include pattern in turn. The first matching | |
579 | pattern is acted on. If it is an exclude pattern than that file is | |
580 | skipped. If it is an include pattern then that filename is not | |
581 | skipped. If no matching include/exclude pattern is found then the | |
582 | filename is not skipped. | |
583 | ||
584 | The patterns themselves can take several forms. The rules are: | |
585 | ||
586 | itemize( | |
587 | it() if the pattern starts with a / then it is matched against the | |
588 | start of the filename, otherwise it is matched against the end of | |
589 | the filename. Thus /foo would match a file called foo | |
590 | at the base of the tree whereas foo would match any file | |
591 | called foo anywhere in the tree. | |
592 | ||
593 | it() if the pattern ends with a / then it will only match a | |
594 | directory, not a file, link or device. | |
595 | ||
596 | it() if the pattern contains a wildcard character from the set | |
597 | *?[ then regular expression matching is applied using the | |
598 | normal shell filename matching rules. Otherwise a simple string | |
599 | match is used. | |
600 | ||
601 | it() if the pattern contains a / (not counting a trailing /) then it | |
602 | is matched against the full filename, including any leading | |
603 | directory. If the pattern doesn't contain a / then it is matched | |
604 | only against the final component of the filename. | |
605 | ||
606 | it() if the pattern starts with "+ " (a plus followed by a space) | |
607 | then it is always considered a include pattern, even if specified as | |
608 | part of an exclude option. The "+ " part is discarded before matching. | |
609 | ||
610 | it() if the pattern starts with "- " (a minus followed by a space) | |
611 | then it is always considered a exclude pattern, even if specified as | |
612 | part of an include option. The "- " part is discarded before matching. | |
de2fd20e AT |
613 | |
614 | it() if the pattern is a single exclamation mark ! then the current | |
615 | exclude list is reset, removing all previous exclude patterns. | |
43bd68e5 AT |
616 | ) |
617 | ||
618 | The +/- rules are most useful in exclude lists, allowing you to have a | |
619 | single exclude list that contains both include and exclude options. | |
620 | ||
621 | Here are some examples: | |
622 | ||
623 | itemize( | |
624 | it() --exclude "*.o" would exclude all filenames matching *.o | |
625 | it() --exclude "/foo" would exclude a file in the base directory called foo | |
626 | it() --exclude "foo/" would exclude any directory called foo | |
627 | it() --include "*/" --include "*.c" --exclude "*" would include all | |
628 | directories and C source files. | |
629 | ) | |
630 | ||
d310a212 AT |
631 | manpagesection(DIAGNOSTICS) |
632 | ||
633 | rsync occasinally produces error messages that may seem a little | |
634 | cryptic. The one that seems to cause the most confusion is "protocol | |
635 | version mismatch - is your shell clean?". | |
636 | ||
637 | This message is usually caused by your startup scripts or remote shell | |
638 | facility producing unwanted garbage on the stream that rsync is using | |
639 | for its transport. The way ot diagnose this problem is to run your | |
640 | remote shell like this: | |
641 | ||
642 | verb( | |
643 | rsh remotehost /bin/true > out.dat | |
644 | ) | |
645 | ||
646 | then look at out.dat. If everything is working correctly then out.dat | |
647 | should be a zero length file. You you are getting the above error from | |
648 | rsync then you will probably find that out.dat contains some text or | |
649 | data. Look at the contents and try to work out what is producing | |
650 | it. The most common cause is incorrectly configued shell startup | |
651 | scripts (such as .cshrc or .profile) that contain output statements | |
652 | for non-interactive logins. | |
653 | ||
de2fd20e AT |
654 | manpagesection(ENVIRONMENT VARIABLES) |
655 | ||
656 | startdit() | |
657 | ||
658 | dit(bf(CVSIGNORE)) The CVSIGNORE environment variable supplements any | |
659 | ignore patterns in .cvsignore files. See the --cvs-exclude option for | |
660 | more details. | |
661 | ||
662 | dit(bf(RSYNC_RSH)) The RSYNC_RSH environment variable allows you to | |
663 | override the default shell used as the transport for rsync. This can | |
664 | be used instead of the -e option. | |
665 | ||
666 | dit(bf(RSYNC_PASSWORD)) Setting RSYNC_PASSWORD to the required | |
667 | password allows you to run authenticated rsync connections to a rsync | |
668 | daemon without user intervention. Note that this does not supply a | |
669 | password to a shell transport such as ssh. | |
670 | ||
671 | dit(bf(USER) or bf(LOGNAME)) The USER or LOGNAME environment variables | |
672 | are used to determine the default username sent to a rsync server. | |
673 | ||
674 | dit(bf(HOME)) The HOME environment variable is used to find the users | |
675 | default .cvsignore file. | |
676 | ||
677 | enddit() | |
678 | ||
41059f75 AT |
679 | manpagefiles() |
680 | ||
681 | /etc/rsyncd.conf | |
682 | ||
683 | manpageseealso() | |
684 | ||
685 | rsyncd.conf(5) | |
686 | ||
687 | manpagediagnostics() | |
688 | ||
689 | manpagebugs() | |
690 | ||
691 | times are transferred as unix time_t values | |
692 | ||
693 | file permissions, devices etc are transferred as native numerical | |
694 | values | |
695 | ||
a87b3b2a | 696 | see also the comments on the --delete option |
41059f75 AT |
697 | |
698 | Please report bugs! The rsync bug tracking system is online at | |
699 | url(http://samba.anu.edu.au/rsync/)(http://samba.anu.edu.au/rsync/) | |
700 | ||
701 | manpagesection(VERSION) | |
702 | This man page is current for version 2.0 of rsync | |
703 | ||
704 | manpagesection(CREDITS) | |
705 | ||
706 | rsync is distributed under the GNU public license. See the file | |
707 | COPYING for details. | |
708 | ||
709 | The primary ftp site for rsync is | |
710 | url(ftp://samba.anu.edu.au/pub/rsync)(ftp://samba.anu.edu.au/pub/rsync). | |
711 | ||
712 | A WEB site is available at | |
713 | url(http://samba.anu.edu.au/rsync/)(http://samba.anu.edu.au/rsync/) | |
714 | ||
715 | We would be delighted to hear from you if you like this program. | |
716 | ||
717 | This program uses the zlib compression library written by Jean-loup | |
718 | Gailly and Mark Adler. | |
719 | ||
720 | manpagesection(THANKS) | |
721 | ||
722 | Thanks to Richard Brent, Brendan Mackay, Bill Waite, Stephen Rothwell | |
723 | and David Bell for helpful suggestions and testing of rsync. I've | |
724 | probably missed some people, my apologies if I have. | |
725 | ||
726 | ||
727 | manpageauthor() | |
728 | ||
729 | rsync was written by Andrew Tridgell and Paul Mackerras. They may be | |
730 | contacted via email at tridge@samba.anu.edu.au and | |
731 | Paul.Mackerras@cs.anu.edu.au | |
732 |