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 | ||
12 | rsync [options] [user@]host::path path | |
13 | ||
14 | rsync [options] path [user@]host::path | |
15 | ||
16 | manpagedescription() | |
17 | ||
18 | rsync is a program that behaves in much the same way that rcp does, | |
19 | but has many more options and uses the rsync remote-update protocol to | |
20 | greatly speedup file transfers when the destination file already | |
21 | exists. | |
22 | ||
23 | The rsync remote-update protocol allows rsync to transfer just the | |
24 | differences between two sets of files across the network link, using | |
25 | an efficient checksum-search algorithm described in the technical | |
26 | report that accompanies this package. | |
27 | ||
28 | Some of the additional features of rsync are: | |
29 | ||
30 | itemize( | |
31 | it() support for copying links, devices, owners, groups and permissions | |
32 | it() exclude and exclude-from options similar to GNU tar | |
33 | it() a CVS exclude mode for ignoring the same files that CVS would ignore | |
34 | it() can use any transparent remote shell, including rsh or ssh | |
35 | it() does not require root privileges | |
36 | it() pipelining of file transfers to minimize latency costs | |
37 | it() support for anonymous or authenticated rsync servers (ideal for | |
38 | mirroring) | |
39 | ) | |
40 | ||
41 | manpagesection(GENERAL) | |
42 | ||
43 | There are five different ways of using rsync. They are: | |
44 | ||
45 | itemize( | |
46 | it() for copying local files. This is invoked when neither | |
47 | source nor destination path contains a : separator | |
48 | ||
49 | it() for copying from the local machine to a remote machine using | |
50 | a remote shell program as the transport (such as rsh or | |
51 | ssh). This is invoked when the destination path contains a | |
52 | single : separator. | |
53 | ||
54 | it() for copying from a remote machine to the local machine | |
55 | using a remote shell program. This is invoked when the local path | |
56 | contains a : separator. | |
57 | ||
58 | it() for copying from a remote rsync server to the local | |
59 | machine. This is invoked when the source path contains a :: | |
60 | separator. | |
61 | ||
62 | it() for copying from the local machine to a remote rsync | |
63 | server. This is invoked when the destination path contains a :: | |
64 | separator. | |
65 | ) | |
66 | ||
67 | Note that in all cases at least one of the source and destination | |
68 | paths must be local. | |
69 | ||
70 | manpagesection(SETUP) | |
71 | ||
72 | See the file README for installation instructions. | |
73 | ||
74 | Once installed you can use rsync to any machine that you can use rsh | |
75 | to. rsync uses rsh for its communications, unless both the source and | |
76 | destination are local. | |
77 | ||
78 | You can also specify a alternative to rsh, by either using the -e | |
79 | command line option, or by setting the RSYNC_RSH environment variable. | |
80 | ||
81 | One common substitute is to use ssh, which offers a high degree of | |
82 | security. | |
83 | ||
84 | manpagesection(USAGE) | |
85 | ||
86 | You use rsync in the same way you use rcp. You must specify a source | |
87 | and a destination, one of which may be remote. | |
88 | ||
89 | Perhaps the best way to explain the syntax is some examples: | |
90 | ||
91 | quote(rsync *.c foo:src/) | |
92 | ||
93 | this would transfer all files matching the pattern *.c from the | |
94 | current directory to the directory src on the machine foo. If any of | |
95 | the files already exist on the remote system then the rsync | |
96 | remote-update protocol is used to update the file by sending only the | |
97 | differences. See the tech report for details. | |
98 | ||
99 | quote(rsync -avz foo:src/bar /data/tmp) | |
100 | ||
101 | recursively transfer all files from the directory src/bar on the | |
102 | machine foo into the /data/tmp/bar directory on the local machine. The | |
103 | files are transferred in "archive" mode, which ensures that symbolic | |
104 | links, devices, attributes, permissions, ownerships etc are preserved | |
105 | in the transfer. Additionally compression will be used to reduce the | |
106 | size of data portions of the transfer. | |
107 | ||
108 | quote(rsync -avz foo:src/bar/ /data/tmp) | |
109 | ||
110 | With a trailing slash on the source this behavior changes to transfer | |
111 | all files from the directory src/bar on the machine foo into the | |
112 | /data/tmp/. With a trailing / on a source name it means "copy the | |
113 | contents of this directory". Without a trailing slash it means "copy | |
114 | the directory". This difference becomes particularly important when | |
115 | using the --delete option. | |
116 | ||
117 | You can also use rsync in local-only mode, where both the source and | |
118 | destination don't have a ':' in the name. In this case it behaves like | |
119 | an improved copy command. | |
120 | ||
121 | ||
122 | manpagesection(CONNECTING TO AN RSYNC SERVER) | |
123 | ||
124 | It is also possible to use rsync without using rsh or ssh as the | |
125 | transport. In this case you will connect to a remote rsync server | |
126 | running on TCP port 873. | |
127 | ||
128 | Using rsync in this was is the same as using it with rsh or ssh except | |
129 | that: | |
130 | ||
131 | itemize( | |
132 | it() you use a double colon :: instead of a single colon to | |
133 | separate the hostname from the path. | |
134 | ||
135 | it() the remote server may print a message of the day when you | |
136 | connect | |
137 | ||
138 | it() if you specify no path name on the remote server then the | |
139 | list of accessible paths on the server will be shown. | |
140 | ) | |
141 | ||
4c3d16be AT |
142 | Some paths on the remote server may require authentication. If so then |
143 | you will receive a password prompt when you connect. You can avoid the | |
144 | password prompt by setting the environment variable RSYNC_PASSWORD to | |
145 | the password you want to use. This may be useful when scripting rsync. | |
146 | ||
41059f75 AT |
147 | manpagesection(RUNNING AN RSYNC SERVER) |
148 | ||
149 | An rsync server is configured using a config file which by default is | |
150 | called /etc/rsyncd.conf. Please see the rsyncd.conf(5) man page for more | |
151 | information. | |
152 | ||
153 | manpagesection(EXAMPLES) | |
154 | ||
155 | Here are some examples of how I use rsync. | |
156 | ||
157 | To backup my wife's home directory, which consists of large MS word | |
158 | files and mail folders I use a cron job that runs | |
159 | ||
160 | quote(rsync -Cavz . arvidsjaur:backup) | |
161 | ||
162 | each night over a PPP link to a duplicate directory on my machine | |
163 | "arvidsjaur". | |
164 | ||
165 | To synchronize my samba source trees I use the following Makefile | |
166 | targets: | |
167 | ||
168 | quote( get:nl() | |
169 | rsync -avuzb --exclude '*~' samba:samba/ . | |
170 | ||
171 | put:nl() | |
172 | rsync -Cavuzb . samba:samba/ | |
173 | ||
174 | sync: get put) | |
175 | ||
176 | this allows me to sync with a CVS directory at the other end of the | |
177 | link. I then do cvs operations on the remote machine, which saves a | |
178 | lot of time as the remote cvs protocol isn't very efficient. | |
179 | ||
180 | I mirror a directory between my "old" and "new" ftp sites with the | |
181 | command | |
182 | ||
183 | quote(rsync -az -e ssh --delete ~ftp/pub/samba/ nimbus:"~ftp/pub/tridge/samba") | |
184 | ||
185 | this is launched from cron every few hours. | |
186 | ||
187 | manpageoptions() | |
188 | ||
189 | rsync uses the GNU long options package. Many of the command line | |
190 | options have two variants, one short and one long. These are shown | |
191 | below separated by commas. Some options only have a long variant. | |
192 | ||
193 | startdit() | |
194 | dit(bf(-h, --help)) Print a short help page describing the options | |
195 | available in rsync | |
196 | ||
197 | dit(bf(--version)) print the rsync version number and exit | |
198 | ||
199 | dit(bf(-v, --verbose)) This option increases the amount of information you | |
200 | are given during the transfer. By default rsync works silently. A | |
201 | single -v will give you information about what files are being | |
202 | transferred and a brief summary at the end. Two -v flags will give you | |
203 | information on what files are being skipped and slightly more | |
204 | information at the end. More than two -v flags should only be used if | |
205 | you are debugging rsync | |
206 | ||
207 | dit(bf(-I, --ignore-times)) Normally rsync will skip any files that are | |
208 | already the same length and have the same time-stamp. This option turns | |
209 | off this behavior. | |
210 | ||
211 | dit(bf(-c, --checksum)) This forces the sender to checksum all files using | |
212 | a 128-bit MD4 checksum before transfer. The checksum is then | |
213 | explicitly checked on the receiver and any files of the same name | |
214 | which already exist and have the same checksum and size on the | |
215 | receiver are skipped. This option can be quite slow. | |
216 | ||
217 | dit(bf(-a, --archive)) This is equivalent to -rlptDog. It is a quick way | |
218 | of saying I want recursion and want to preserve everything. | |
219 | ||
220 | dit(bf(-r, --recursive)) This tells rsync to copy directories recursively | |
221 | ||
222 | dit(bf(-R, --relative)) Use relative paths. This means that the full path | |
223 | names specified on the command line are sent to the server rather than | |
224 | just the last parts of the filenames. This is particularly useful when | |
225 | you want to sent several different directories at the same time. For | |
226 | example if you used the command | |
227 | ||
228 | verb(rsync foo/bar/foo.c remote:/tmp/) | |
229 | ||
230 | then this would create a file called foo.c in /tmp/ on the remote | |
231 | machine. If instead you used | |
232 | ||
233 | verb(rsync -R foo/bar/foo.c remote:/tmp/) | |
234 | ||
235 | then a file called /tmp/foo/bar/foo.c would be created on the remote | |
236 | machine. The full path name is preserved. | |
237 | ||
238 | dit(bf(-b, --backup)) With this option preexisting destination files are | |
239 | renamed with a ~ extension as each file is transferred. You can | |
240 | control the backup suffix using the --suffix option. | |
241 | ||
242 | dit(bf(-u, --update)) This forces rsync to skip any files for which the | |
243 | destination file already exists and has a date later than the source | |
244 | file. | |
245 | ||
246 | dit(bf(-l, --links)) This tells rsync to recreate symbolic links on the | |
247 | remote system to be the same as the local system. Without this | |
248 | option all symbolic links are skipped. | |
249 | ||
250 | dit(bf(-L, --copy-links)) This tells rsync to treat symbolic links just | |
251 | like ordinary files. | |
252 | ||
253 | dit(bf(-H, --hard-links)) This tells rsync to recreate hard links on | |
254 | the remote system to be the same as the local system. Without this | |
255 | option hard links are treated like regular files. | |
256 | ||
257 | Note that rsync can only detect hard links if both parts of the link | |
258 | are in the list of files being sent. | |
259 | ||
260 | This option can be quite slow, so only use it if you need it. | |
261 | ||
262 | dit(bf(-W, --whole-file)) With this option the incremental rsync algorithm | |
263 | is not used and the whole file is sent as-is instead. This may be | |
264 | useful when using rsync with a local machine. | |
265 | ||
266 | dit(bf(-p, --perms)) This option causes rsync to update the remote | |
267 | permissions to be the same as the local permissions. | |
268 | ||
269 | dit(bf(-o, --owner)) This option causes rsync to update the remote owner | |
270 | of the file to be the same as the local owner. This is only available | |
271 | to the super-user. | |
272 | ||
273 | dit(bf(-g, --group)) This option causes rsync to update the remote group | |
274 | of the file to be the same as the local group. | |
275 | ||
276 | dit(bf(-D, --devices)) This option causes rsync to transfer character and | |
277 | block device information to the remote system to recreate these | |
278 | devices. This option is only available to the super-user. | |
279 | ||
280 | dit(bf(-t, --times)) This tells rsync to transfer modification times along | |
281 | with the files and update them on the remote system | |
282 | ||
283 | dit(bf(-n, --dry-run)) This tells rsync to not do any file transfers, | |
284 | instead it will just report the actions it would have taken. | |
285 | ||
286 | dit(bf(-S, --sparse)) Try to handle sparse files efficiently so they take | |
287 | up less space on the destination. | |
288 | ||
289 | dit(bf(-x, --one-file-system)) This tells rsync not to cross filesystem | |
290 | boundaries when recursing. This is useful for transferring the | |
291 | contents of only one filesystem. | |
292 | ||
293 | dit(bf(--delete)) This tells rsync to delete any files on the receiving | |
294 | side that aren't on the sending side. This option can be dangerous if | |
295 | used incorrectly! | |
296 | ||
297 | It is a very good idea to run first using the dry run option (-n) to | |
298 | see what files would be deleted to make sure important files aren't | |
299 | listed. | |
300 | ||
301 | rsync 1.6.4 changed the behavior of --delete to make it less | |
302 | dangerous. rsync now only scans directories on the receiving side | |
303 | that are explicitly transferred from the sending side. Only files in | |
304 | these directories are deleted. | |
305 | ||
306 | Still, it is probably easy to get burnt with this option. The moral | |
307 | of the story is to use the -n option until you get used to the | |
308 | behavior of --delete. | |
309 | ||
310 | NOTE: It also may delete files on the destination if the sending side | |
311 | can't open them or stat them. This is a bug that hopefully will be | |
312 | fixed in a future release. | |
313 | ||
314 | dit(bf(--force)) This options tells rsync to delete directories even if | |
315 | they are not empty. This applies to both the --delete option and to | |
316 | cases where rsync tries to copy a normal file but the destination | |
317 | contains a directory of the same name. Normally rsync will refuse to | |
318 | do a recursive directory deletion in such cases, by using --force | |
319 | the recursive deletion will be done. | |
320 | ||
321 | Use this option with caution! | |
322 | ||
323 | dit(bf(-B , --block_size BLOCKSIZE)) This controls the block size used in | |
324 | the rsync algorithm. See the technical report for details. | |
325 | ||
326 | dit(bf(-e, --rsh COMMAND)) This option allows you to choose an alternative | |
327 | remote shell program to use for communication between the local and | |
328 | remote copies of rsync. By default rsync will use rsh, but you may | |
329 | like to instead use ssh because of its high security. | |
330 | ||
331 | You can also choose the remote shell program using the RSYNC_RSH | |
332 | environment variable. | |
333 | ||
334 | dit(bf(--rsync-path PATH)) Use this to specify the path to the copy of | |
335 | rsync on the remote machine. Useful when its not in your path. | |
336 | ||
337 | dit(bf(--exclude FILE)) This option allows you to selectively exclude | |
338 | certain files from the list of files to be transferred. This is most | |
339 | useful in combination with a recursive transfer. | |
340 | ||
341 | The option FILE can either be a file name or a shell wildcard | |
342 | expression. If it is a directory name then rsync will not recurse into | |
343 | directories of that name. | |
344 | ||
345 | You may use as many --exclude options on the command line as you like | |
346 | to build up the list of files to exclude. | |
347 | ||
348 | If the filename is a single ! then the exclude list is reset. | |
349 | ||
350 | dit(bf(--exclude-from FILE)) This option is similar to the --exclude | |
351 | option, but instead it adds all filenames listed in the file FILE to | |
352 | the exclude list. | |
353 | ||
354 | dit(bf(-C, --cvs-exclude)) This is a useful shorthand for excluding a | |
355 | broad range of files that you often don't want to transfer between | |
356 | systems. It uses the same algorithm that CVS uses to determine if | |
357 | a file should be ignored. | |
358 | ||
359 | The exclude list is initialized to: | |
360 | ||
361 | quote(RCS SCCS CVS CVS.adm RCSLOG cvslog.* tags TAGS .make.state | |
362 | .nse_depinfo *~ #* .#* ,* *.old *.bak *.BAK *.orig *.rej .del-* | |
363 | *.a *.o *.obj *.so *.Z *.elc *.ln core) | |
364 | ||
365 | then files listed in a $HOME/.cvsignore are added to the list and any | |
366 | files listed in the CVSIGNORE environment variable (space delimited). | |
367 | ||
368 | Finally in each directory any files listed in the .cvsignore file in | |
369 | that directory are added to the list. | |
370 | ||
371 | dit(bf(--suffix SUFFIX)) This option allows you to override the default | |
372 | backup suffix used with the -b option. The default is a ~. | |
373 | ||
374 | dit(bf(--csum-length LENGTH)) By default the primary checksum used in | |
375 | rsync is a very strong 16 byte MD4 checksum. In most cases you will | |
376 | find that a truncated version of this checksum is quite efficient, and | |
377 | this will decrease the size of the checksum data sent over the link, | |
378 | making things faster. | |
379 | ||
380 | You can choose the number of bytes in the truncated checksum using the | |
381 | --csum-length option. Any value less than or equal to 16 is valid. | |
382 | ||
383 | Note that if you use this option then you run the risk of ending up | |
384 | with an incorrect target file. The risk with a value of 16 is | |
385 | microscopic and can be safely ignored (the universe will probably end | |
386 | before it fails) but with smaller values the risk is higher. | |
387 | ||
388 | dit(bf(-T, --temp-dir DIR)) This options instructs rsync to use DIR as a | |
389 | scratch directory when creating a temporary copies of the files | |
390 | transferred on the receiving side. The default behavior is to create | |
391 | the temporary files in the receiving directory. | |
392 | ||
393 | dit(bf(-z, --compress)) With this option, rsync compresses any data from | |
394 | the source file(s) which it sends to the destination machine. This | |
395 | option is useful on slow links. The compression method used is the | |
396 | same method that gzip uses. | |
397 | ||
398 | Note this this option typically achieves better compression ratios | |
399 | that can be achieved by using a compressing remote shell, or a | |
400 | compressing transport, as it takes advantage of the implicit | |
401 | information sent for matching data blocks. | |
402 | ||
403 | dit(bf(--numeric-ids)) With this option rsync will transfer numeric group | |
404 | and user ids rather than using user and group names and mapping them | |
405 | at both ends. | |
406 | ||
407 | By default rsync will use the user name and group name to determine | |
408 | what ownership to give files. The special uid 0 and the special group | |
409 | 0 and never mapped via user/group names even if the --numeric-ids | |
410 | option is not specified. | |
411 | ||
412 | If a user or group name does not exist on the destination system then | |
413 | the numeric id from the source system is used instead. | |
414 | ||
415 | dit(bf(--timeout)) This option allows you to set a maximum IO timeout in | |
416 | seconds. If no data is transferred for the specified time then rsync | |
417 | will exit. The default is 0, which means no timeout. | |
418 | ||
419 | dit(bf(--daemon)) This tells rsync that it is to run as a rsync | |
420 | daemon. If standard input is a socket then rsync will assume that it | |
421 | is being run via inetd, otherwise it will detach from the current | |
5315b793 | 422 | terminal and become a background daemon. The daemon will read the |
41059f75 AT |
423 | config file (/etc/rsyncd.conf) on each connect made by a client and |
424 | respond to requests accordingly. See the rsyncd.conf(5) man page for more | |
425 | details. | |
426 | ||
427 | dit(bf(--config FILE)) This specifies an alternate config file than | |
5315b793 | 428 | the default /etc/rsyncd.conf. This is only relevant when --daemon is |
41059f75 AT |
429 | specified. |
430 | ||
431 | dit(bf(--port PORT)) This specifies an alternate TCP port number to use | |
432 | rather than the default port 873. | |
433 | ||
434 | enddit() | |
435 | ||
436 | manpagefiles() | |
437 | ||
438 | /etc/rsyncd.conf | |
439 | ||
440 | manpageseealso() | |
441 | ||
442 | rsyncd.conf(5) | |
443 | ||
444 | manpagediagnostics() | |
445 | ||
446 | manpagebugs() | |
447 | ||
448 | times are transferred as unix time_t values | |
449 | ||
450 | file permissions, devices etc are transferred as native numerical | |
451 | values | |
452 | ||
a87b3b2a | 453 | see also the comments on the --delete option |
41059f75 AT |
454 | |
455 | Please report bugs! The rsync bug tracking system is online at | |
456 | url(http://samba.anu.edu.au/rsync/)(http://samba.anu.edu.au/rsync/) | |
457 | ||
458 | manpagesection(VERSION) | |
459 | This man page is current for version 2.0 of rsync | |
460 | ||
461 | manpagesection(CREDITS) | |
462 | ||
463 | rsync is distributed under the GNU public license. See the file | |
464 | COPYING for details. | |
465 | ||
466 | The primary ftp site for rsync is | |
467 | url(ftp://samba.anu.edu.au/pub/rsync)(ftp://samba.anu.edu.au/pub/rsync). | |
468 | ||
469 | A WEB site is available at | |
470 | url(http://samba.anu.edu.au/rsync/)(http://samba.anu.edu.au/rsync/) | |
471 | ||
472 | We would be delighted to hear from you if you like this program. | |
473 | ||
474 | This program uses the zlib compression library written by Jean-loup | |
475 | Gailly and Mark Adler. | |
476 | ||
477 | manpagesection(THANKS) | |
478 | ||
479 | Thanks to Richard Brent, Brendan Mackay, Bill Waite, Stephen Rothwell | |
480 | and David Bell for helpful suggestions and testing of rsync. I've | |
481 | probably missed some people, my apologies if I have. | |
482 | ||
483 | ||
484 | manpageauthor() | |
485 | ||
486 | rsync was written by Andrew Tridgell and Paul Mackerras. They may be | |
487 | contacted via email at tridge@samba.anu.edu.au and | |
488 | Paul.Mackerras@cs.anu.edu.au | |
489 |