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