Commit | Line | Data |
---|---|---|
9e3c856a | 1 | mailto(rsync-bugs@samba.org) |
c8d771a0 | 2 | manpage(rsync)(1)(30 Apr 2004)()() |
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 | |
8d69d571 WD |
18 | rsync [OPTION]... SRC [SRC]... rsync://[USER@]HOST[:PORT]/DEST |
19 | ||
41059f75 AT |
20 | manpagedescription() |
21 | ||
22 | rsync is a program that behaves in much the same way that rcp does, | |
23 | but has many more options and uses the rsync remote-update protocol to | |
eb06fa95 | 24 | greatly speed up file transfers when the destination file already |
41059f75 AT |
25 | exists. |
26 | ||
27 | The rsync remote-update protocol allows rsync to transfer just the | |
f39281ae | 28 | differences between two sets of files across the network connection, using |
41059f75 AT |
29 | an efficient checksum-search algorithm described in the technical |
30 | report that accompanies this package. | |
31 | ||
32 | Some of the additional features of rsync are: | |
33 | ||
34 | itemize( | |
b9f592fb | 35 | it() support for copying links, devices, owners, groups, and permissions |
41059f75 AT |
36 | it() exclude and exclude-from options similar to GNU tar |
37 | it() a CVS exclude mode for ignoring the same files that CVS would ignore | |
43cd760f | 38 | it() can use any transparent remote shell, including ssh or rsh |
41059f75 AT |
39 | it() does not require root privileges |
40 | it() pipelining of file transfers to minimize latency costs | |
41 | it() support for anonymous or authenticated rsync servers (ideal for | |
42 | mirroring) | |
43 | ) | |
44 | ||
45 | manpagesection(GENERAL) | |
46 | ||
bef49340 | 47 | There are eight different ways of using rsync. They are: |
41059f75 AT |
48 | |
49 | itemize( | |
50 | it() for copying local files. This is invoked when neither | |
51 | source nor destination path contains a : separator | |
52 | ||
53 | it() for copying from the local machine to a remote machine using | |
43cd760f WD |
54 | a remote shell program as the transport (such as ssh or |
55 | rsh). This is invoked when the destination path contains a | |
41059f75 AT |
56 | single : separator. |
57 | ||
58 | it() for copying from a remote machine to the local machine | |
6c7c2ef3 | 59 | using a remote shell program. This is invoked when the source |
41059f75 AT |
60 | contains a : separator. |
61 | ||
62 | it() for copying from a remote rsync server to the local | |
63 | machine. This is invoked when the source path contains a :: | |
bb18e755 | 64 | separator or an rsync:// URL. |
41059f75 AT |
65 | |
66 | it() for copying from the local machine to a remote rsync | |
67 | server. This is invoked when the destination path contains a :: | |
bb18e755 | 68 | separator or an rsync:// URL. |
039faa86 | 69 | |
bef49340 WD |
70 | it() for copying from a remote machine using a remote shell |
71 | program as the transport, using rsync server on the remote | |
72 | machine. This is invoked when the source path contains a :: | |
73 | separator and the --rsh=COMMAND (aka "-e COMMAND") option is | |
74 | also provided. | |
75 | ||
76 | it() for copying from the local machine to a remote machine | |
77 | using a remote shell program as the transport, using rsync | |
78 | server on the remote machine. This is invoked when the | |
79 | destination path contains a :: separator and the | |
4d888108 | 80 | --rsh=COMMAND option is also provided. |
bef49340 | 81 | |
039faa86 AT |
82 | it() for listing files on a remote machine. This is done the |
83 | same way as rsync transfers except that you leave off the | |
84 | local destination. | |
41059f75 AT |
85 | ) |
86 | ||
14d43f1f DD |
87 | Note that in all cases (other than listing) at least one of the source |
88 | and destination paths must be local. | |
41059f75 AT |
89 | |
90 | manpagesection(SETUP) | |
91 | ||
92 | See the file README for installation instructions. | |
93 | ||
1bbf83c0 WD |
94 | Once installed, you can use rsync to any machine that you can access via |
95 | a remote shell (as well as some that you can access using the rsync | |
43cd760f | 96 | daemon-mode protocol). For remote transfers, a modern rsync uses ssh |
1bbf83c0 | 97 | for its communications, but it may have been configured to use a |
43cd760f | 98 | different remote shell by default, such as rsh or remsh. |
41059f75 | 99 | |
1bbf83c0 | 100 | You can also specify any remote shell you like, either by using the -e |
41059f75 AT |
101 | command line option, or by setting the RSYNC_RSH environment variable. |
102 | ||
103 | One common substitute is to use ssh, which offers a high degree of | |
104 | security. | |
105 | ||
8e987130 AT |
106 | Note that rsync must be installed on both the source and destination |
107 | machines. | |
108 | ||
41059f75 AT |
109 | manpagesection(USAGE) |
110 | ||
111 | You use rsync in the same way you use rcp. You must specify a source | |
112 | and a destination, one of which may be remote. | |
113 | ||
4d888108 | 114 | Perhaps the best way to explain the syntax is with some examples: |
41059f75 AT |
115 | |
116 | quote(rsync *.c foo:src/) | |
117 | ||
8a97fc2e | 118 | This would transfer all files matching the pattern *.c from the |
41059f75 AT |
119 | current directory to the directory src on the machine foo. If any of |
120 | the files already exist on the remote system then the rsync | |
121 | remote-update protocol is used to update the file by sending only the | |
122 | differences. See the tech report for details. | |
123 | ||
124 | quote(rsync -avz foo:src/bar /data/tmp) | |
125 | ||
8a97fc2e | 126 | This would recursively transfer all files from the directory src/bar on the |
41059f75 AT |
127 | machine foo into the /data/tmp/bar directory on the local machine. The |
128 | files are transferred in "archive" mode, which ensures that symbolic | |
b5accaba | 129 | links, devices, attributes, permissions, ownerships, etc. are preserved |
14d43f1f | 130 | in the transfer. Additionally, compression will be used to reduce the |
41059f75 AT |
131 | size of data portions of the transfer. |
132 | ||
133 | quote(rsync -avz foo:src/bar/ /data/tmp) | |
134 | ||
8a97fc2e WD |
135 | A trailing slash on the source changes this behavior to avoid creating an |
136 | additional directory level at the destination. You can think of a trailing | |
137 | / on a source as meaning "copy the contents of this directory" as opposed | |
138 | to "copy the directory by name", but in both cases the attributes of the | |
139 | containing directory are transferred to the containing directory on the | |
140 | destination. In other words, each of the following commands copies the | |
141 | files in the same way, including their setting of the attributes of | |
142 | /dest/foo: | |
143 | ||
144 | quote(rsync -avz /src/foo /dest) | |
145 | quote(rsync -avz /src/foo/ /dest/foo) | |
41059f75 AT |
146 | |
147 | You can also use rsync in local-only mode, where both the source and | |
148 | destination don't have a ':' in the name. In this case it behaves like | |
149 | an improved copy command. | |
150 | ||
14d43f1f DD |
151 | quote(rsync somehost.mydomain.com::) |
152 | ||
8a97fc2e | 153 | This would list all the anonymous rsync modules available on the host |
14d43f1f DD |
154 | somehost.mydomain.com. (See the following section for more details.) |
155 | ||
41059f75 AT |
156 | |
157 | manpagesection(CONNECTING TO AN RSYNC SERVER) | |
158 | ||
1bbf83c0 | 159 | It is also possible to use rsync without a remote shell as the |
41059f75 AT |
160 | transport. In this case you will connect to a remote rsync server |
161 | running on TCP port 873. | |
162 | ||
eb06fa95 | 163 | You may establish the connection via a web proxy by setting the |
4c3b4b25 | 164 | environment variable RSYNC_PROXY to a hostname:port pair pointing to |
4d888108 WD |
165 | your web proxy. Note that your web proxy's configuration must support |
166 | proxy connections to port 873. | |
4c3b4b25 | 167 | |
1bbf83c0 | 168 | Using rsync in this way is the same as using it with a remote shell except |
41059f75 AT |
169 | that: |
170 | ||
171 | itemize( | |
172 | it() you use a double colon :: instead of a single colon to | |
bb18e755 | 173 | separate the hostname from the path or an rsync:// URL. |
41059f75 AT |
174 | |
175 | it() the remote server may print a message of the day when you | |
14d43f1f | 176 | connect. |
41059f75 AT |
177 | |
178 | it() if you specify no path name on the remote server then the | |
179 | list of accessible paths on the server will be shown. | |
14d43f1f | 180 | |
f7632fc6 | 181 | it() if you specify no local destination then a listing of the |
14d43f1f | 182 | specified files on the remote server is provided. |
41059f75 AT |
183 | ) |
184 | ||
4c3d16be AT |
185 | Some paths on the remote server may require authentication. If so then |
186 | you will receive a password prompt when you connect. You can avoid the | |
187 | password prompt by setting the environment variable RSYNC_PASSWORD to | |
65575e96 AT |
188 | the password you want to use or using the --password-file option. This |
189 | may be useful when scripting rsync. | |
4c3d16be | 190 | |
3bc67f0c | 191 | WARNING: On some systems environment variables are visible to all |
65575e96 | 192 | users. On those systems using --password-file is recommended. |
3bc67f0c | 193 | |
bef49340 WD |
194 | manpagesection(CONNECTING TO AN RSYNC SERVER OVER A REMOTE SHELL PROGRAM) |
195 | ||
196 | It is sometimes useful to be able to set up file transfers using rsync | |
43cd760f WD |
197 | server capabilities on the remote machine, while still using ssh or |
198 | rsh for transport. This is especially useful when you want to connect | |
bef49340 WD |
199 | to a remote machine via ssh (for encryption or to get through a |
200 | firewall), but you still want to have access to the rsync server | |
201 | features (see RUNNING AN RSYNC SERVER OVER A REMOTE SHELL PROGRAM, | |
202 | below). | |
203 | ||
204 | From the user's perspective, using rsync in this way is the same as | |
205 | using it to connect to an rsync server, except that you must | |
206 | explicitly set the remote shell program on the command line with | |
207 | --rsh=COMMAND. (Setting RSYNC_RSH in the environment will not turn on | |
208 | this functionality.) | |
209 | ||
210 | In order to distinguish between the remote-shell user and the rsync | |
211 | server user, you can use '-l user' on your remote-shell command: | |
212 | ||
213 | quote(rsync -av --rsh="ssh -l ssh-user" rsync-user@host::module[/path] local-path) | |
214 | ||
215 | The "ssh-user" will be used at the ssh level; the "rsync-user" will be | |
216 | used to check against the rsyncd.conf on the remote host. | |
217 | ||
41059f75 AT |
218 | manpagesection(RUNNING AN RSYNC SERVER) |
219 | ||
4d888108 | 220 | An rsync server is configured using a configuration file. Please see the |
30e8c8e1 DD |
221 | rsyncd.conf(5) man page for more information. By default the configuration |
222 | file is called /etc/rsyncd.conf, unless rsync is running over a remote | |
223 | shell program and is not running as root; in that case, the default name | |
224 | is rsyncd.conf in the current directory on the remote computer | |
225 | (typically $HOME). | |
41059f75 | 226 | |
bef49340 WD |
227 | manpagesection(RUNNING AN RSYNC SERVER OVER A REMOTE SHELL PROGRAM) |
228 | ||
229 | See the rsyncd.conf(5) man page for full information on the rsync | |
230 | server configuration file. | |
231 | ||
232 | Several configuration options will not be available unless the remote | |
233 | user is root (e.g. chroot, setuid/setgid, etc.). There is no need to | |
234 | configure inetd or the services map to include the rsync server port | |
235 | if you run an rsync server only via a remote shell program. | |
236 | ||
e6f9e388 WD |
237 | To run an rsync server out of a single-use ssh key, see this section |
238 | in the rsyncd.conf(5) man page. | |
bef49340 | 239 | |
41059f75 AT |
240 | manpagesection(EXAMPLES) |
241 | ||
242 | Here are some examples of how I use rsync. | |
243 | ||
14d43f1f DD |
244 | To backup my wife's home directory, which consists of large MS Word |
245 | files and mail folders, I use a cron job that runs | |
41059f75 AT |
246 | |
247 | quote(rsync -Cavz . arvidsjaur:backup) | |
248 | ||
f39281ae | 249 | each night over a PPP connection to a duplicate directory on my machine |
41059f75 AT |
250 | "arvidsjaur". |
251 | ||
252 | To synchronize my samba source trees I use the following Makefile | |
253 | targets: | |
254 | ||
255 | quote( get:nl() | |
256 | rsync -avuzb --exclude '*~' samba:samba/ . | |
257 | ||
258 | put:nl() | |
259 | rsync -Cavuzb . samba:samba/ | |
260 | ||
261 | sync: get put) | |
262 | ||
263 | this allows me to sync with a CVS directory at the other end of the | |
f39281ae | 264 | connection. I then do cvs operations on the remote machine, which saves a |
41059f75 AT |
265 | lot of time as the remote cvs protocol isn't very efficient. |
266 | ||
267 | I mirror a directory between my "old" and "new" ftp sites with the | |
268 | command | |
269 | ||
270 | quote(rsync -az -e ssh --delete ~ftp/pub/samba/ nimbus:"~ftp/pub/tridge/samba") | |
271 | ||
272 | this is launched from cron every few hours. | |
273 | ||
c95da96a AT |
274 | manpagesection(OPTIONS SUMMARY) |
275 | ||
14d43f1f | 276 | Here is a short summary of the options available in rsync. Please refer |
c95da96a AT |
277 | to the detailed description below for a complete description. |
278 | ||
279 | verb( | |
280 | -v, --verbose increase verbosity | |
b86f0cef | 281 | -q, --quiet decrease verbosity |
c95da96a | 282 | -c, --checksum always checksum |
06891710 | 283 | -a, --archive archive mode, equivalent to -rlptgoD |
c95da96a AT |
284 | -r, --recursive recurse into directories |
285 | -R, --relative use relative path names | |
f177b7cc WD |
286 | --no-relative turn off --relative |
287 | --no-implied-dirs don't send implied dirs with -R | |
915dd207 | 288 | -b, --backup make backups (see --suffix & --backup-dir) |
5b56cc19 | 289 | --backup-dir make backups into this directory |
915dd207 | 290 | --suffix=SUFFIX backup suffix (default ~ w/o --backup-dir) |
c95da96a | 291 | -u, --update update only (don't overwrite newer files) |
75b243a5 | 292 | --inplace update the destination files inplace |
716e73d4 | 293 | -K, --keep-dirlinks treat symlinked dir on receiver as dir |
eb06fa95 | 294 | -l, --links copy symlinks as symlinks |
7af4227a WD |
295 | -L, --copy-links copy the referent of all symlinks |
296 | --copy-unsafe-links copy the referent of "unsafe" symlinks | |
297 | --safe-links ignore "unsafe" symlinks | |
c95da96a AT |
298 | -H, --hard-links preserve hard links |
299 | -p, --perms preserve permissions | |
300 | -o, --owner preserve owner (root only) | |
301 | -g, --group preserve group | |
302 | -D, --devices preserve devices (root only) | |
303 | -t, --times preserve times | |
304 | -S, --sparse handle sparse files efficiently | |
305 | -n, --dry-run show what would have been transferred | |
306 | -W, --whole-file copy whole files, no incremental checks | |
93689aa5 | 307 | --no-whole-file turn off --whole-file |
c95da96a | 308 | -x, --one-file-system don't cross filesystem boundaries |
9ef53907 | 309 | -B, --block-size=SIZE checksum blocking size (default 700) |
915dd207 | 310 | -e, --rsh=COMMAND specify the remote shell |
d9fcc198 | 311 | --rsync-path=PATH specify path to rsync on the remote machine |
1347d512 | 312 | --existing only update files that already exist |
915dd207 WD |
313 | --ignore-existing ignore files that already exist on receiver |
314 | --delete delete files that don't exist on sender | |
315 | --delete-excluded also delete excluded files on receiver | |
d48c8065 | 316 | --delete-after receiver deletes after transfer, not before |
b5accaba | 317 | --ignore-errors delete even if there are I/O errors |
0b73ca12 | 318 | --max-delete=NUM don't delete more than NUM files |
c95da96a | 319 | --partial keep partially transferred files |
44cad59f | 320 | --partial-dir=DIR put a partially transferred file into DIR |
915dd207 | 321 | --force force deletion of dirs even if not empty |
c95da96a | 322 | --numeric-ids don't map uid/gid values by user/group name |
b5accaba | 323 | --timeout=TIME set I/O timeout in seconds |
915dd207 WD |
324 | -I, --ignore-times turn off mod time & file size quick check |
325 | --size-only ignore mod time for quick check (use size) | |
f6aeaa74 | 326 | --modify-window=NUM compare mod times with reduced accuracy |
c95da96a | 327 | -T --temp-dir=DIR create temporary files in directory DIR |
915dd207 | 328 | --compare-dest=DIR also compare received files relative to DIR |
59c95e42 | 329 | --link-dest=DIR create hardlinks to DIR for unchanged files |
d9fcc198 | 330 | -P equivalent to --partial --progress |
c95da96a | 331 | -z, --compress compress file data |
f177b7cc | 332 | -C, --cvs-exclude auto ignore files in the same way CVS does |
2acf81eb | 333 | --exclude=PATTERN exclude files matching PATTERN |
9ef53907 | 334 | --exclude-from=FILE exclude patterns listed in FILE |
2acf81eb | 335 | --include=PATTERN don't exclude files matching PATTERN |
9ef53907 | 336 | --include-from=FILE don't exclude patterns listed in FILE |
f177b7cc | 337 | --files-from=FILE read FILE for list of source-file names |
915dd207 | 338 | -0 --from0 all file lists are delimited by nulls |
c95da96a | 339 | --version print version number |
bb18e755 | 340 | --daemon run as an rsync daemon |
bbd6f4ba | 341 | --no-detach do not detach from the parent |
2a951cd2 | 342 | --address=ADDRESS bind to the specified address |
c95da96a AT |
343 | --config=FILE specify alternate rsyncd.conf file |
344 | --port=PORT specify alternate rsyncd port number | |
b5accaba | 345 | --blocking-io use blocking I/O for the remote shell |
93689aa5 | 346 | --no-blocking-io turn off --blocking-io |
c95da96a | 347 | --stats give some file transfer stats |
eb86d661 | 348 | --progress show progress during transfer |
b6062654 | 349 | --log-format=FORMAT log file transfers using specified format |
9ef53907 | 350 | --password-file=FILE get password from FILE |
ef5d23eb | 351 | --bwlimit=KBPS limit I/O bandwidth, KBytes per second |
b9f592fb WD |
352 | --write-batch=FILE write a batch to FILE |
353 | --read-batch=FILE read a batch from FILE | |
c8d895de | 354 | --checksum-seed=NUM set block/file checksum seed |
e40a46de WD |
355 | -4 --ipv4 prefer IPv4 |
356 | -6 --ipv6 prefer IPv6 | |
c95da96a | 357 | -h, --help show this help screen |
6902ed17 MP |
358 | |
359 | ||
c95da96a AT |
360 | ) |
361 | ||
41059f75 AT |
362 | manpageoptions() |
363 | ||
364 | rsync uses the GNU long options package. Many of the command line | |
365 | options have two variants, one short and one long. These are shown | |
14d43f1f | 366 | below, separated by commas. Some options only have a long variant. |
b5679335 DD |
367 | The '=' for options that take a parameter is optional; whitespace |
368 | can be used instead. | |
41059f75 AT |
369 | |
370 | startdit() | |
371 | dit(bf(-h, --help)) Print a short help page describing the options | |
372 | available in rsync | |
373 | ||
374 | dit(bf(--version)) print the rsync version number and exit | |
375 | ||
376 | dit(bf(-v, --verbose)) This option increases the amount of information you | |
14d43f1f | 377 | are given during the transfer. By default, rsync works silently. A |
41059f75 AT |
378 | single -v will give you information about what files are being |
379 | transferred and a brief summary at the end. Two -v flags will give you | |
380 | information on what files are being skipped and slightly more | |
381 | information at the end. More than two -v flags should only be used if | |
14d43f1f | 382 | you are debugging rsync. |
41059f75 | 383 | |
b86f0cef DD |
384 | dit(bf(-q, --quiet)) This option decreases the amount of information you |
385 | are given during the transfer, notably suppressing information messages | |
386 | from the remote server. This flag is useful when invoking rsync from | |
387 | cron. | |
388 | ||
41059f75 | 389 | dit(bf(-I, --ignore-times)) Normally rsync will skip any files that are |
915dd207 WD |
390 | already the same size and have the same modification time-stamp. |
391 | This option turns off this "quick check" behavior. | |
41059f75 | 392 | |
a03a9f4e | 393 | dit(bf(--size-only)) Normally rsync will not transfer any files that are |
915dd207 | 394 | already the same size and have the same modification time-stamp. With the |
a03a9f4e | 395 | --size-only option, files will not be transferred if they have the same size, |
f83f0548 AT |
396 | regardless of timestamp. This is useful when starting to use rsync |
397 | after using another mirroring system which may not preserve timestamps | |
398 | exactly. | |
399 | ||
5b56cc19 AT |
400 | dit(bf(--modify-window)) When comparing two timestamps rsync treats |
401 | the timestamps as being equal if they are within the value of | |
402 | modify_window. This is normally zero, but you may find it useful to | |
403 | set this to a larger value in some situations. In particular, when | |
38843171 DD |
404 | transferring to Windows FAT filesystems which cannot represent times |
405 | with a 1 second resolution --modify-window=1 is useful. | |
5b56cc19 | 406 | |
41059f75 AT |
407 | dit(bf(-c, --checksum)) This forces the sender to checksum all files using |
408 | a 128-bit MD4 checksum before transfer. The checksum is then | |
409 | explicitly checked on the receiver and any files of the same name | |
410 | which already exist and have the same checksum and size on the | |
a03a9f4e | 411 | receiver are not transferred. This option can be quite slow. |
41059f75 | 412 | |
e7bf3e5e MP |
413 | dit(bf(-a, --archive)) This is equivalent to -rlptgoD. It is a quick |
414 | way of saying you want recursion and want to preserve almost | |
415 | everything. | |
416 | ||
417 | Note however that bf(-a) bf(does not preserve hardlinks), because | |
418 | finding multiply-linked files is expensive. You must separately | |
419 | specify bf(-H). | |
41059f75 | 420 | |
24986abd AT |
421 | dit(bf(-r, --recursive)) This tells rsync to copy directories |
422 | recursively. If you don't specify this then rsync won't copy | |
423 | directories at all. | |
41059f75 AT |
424 | |
425 | dit(bf(-R, --relative)) Use relative paths. This means that the full path | |
426 | names specified on the command line are sent to the server rather than | |
427 | just the last parts of the filenames. This is particularly useful when | |
14d43f1f DD |
428 | you want to send several different directories at the same time. For |
429 | example, if you used the command | |
41059f75 AT |
430 | |
431 | verb(rsync foo/bar/foo.c remote:/tmp/) | |
432 | ||
433 | then this would create a file called foo.c in /tmp/ on the remote | |
434 | machine. If instead you used | |
435 | ||
436 | verb(rsync -R foo/bar/foo.c remote:/tmp/) | |
437 | ||
438 | then a file called /tmp/foo/bar/foo.c would be created on the remote | |
f177b7cc WD |
439 | machine -- the full path name is preserved. |
440 | ||
441 | dit(bf(--no-relative)) Turn off the --relative option. This is only | |
442 | needed if you want to use --files-from without its implied --relative | |
443 | file processing. | |
444 | ||
445 | dit(bf(--no-implied-dirs)) When combined with the --relative option, the | |
446 | implied directories in each path are not explicitly duplicated as part | |
447 | of the transfer. This makes the transfer more optimal and also allows | |
448 | the two sides to have non-matching symlinks in the implied part of the | |
449 | path. For instance, if you transfer the file "/path/foo/file" with -R, | |
450 | the default is for rsync to ensure that "/path" and "/path/foo" on the | |
451 | destination exactly match the directories/symlinks of the source. Using | |
452 | the --no-implied-dirs option would omit both of these implied dirs, | |
453 | which means that if "/path" was a real directory on one machine and a | |
454 | symlink of the other machine, rsync would not try to change this. | |
41059f75 | 455 | |
b19fd07c WD |
456 | dit(bf(-b, --backup)) With this option, preexisting destination files are |
457 | renamed as each file is transferred or deleted. You can control where the | |
458 | backup file goes and what (if any) suffix gets appended using the | |
459 | --backup-dir and --suffix options. | |
41059f75 | 460 | |
66203a98 AT |
461 | dit(bf(--backup-dir=DIR)) In combination with the --backup option, this |
462 | tells rsync to store all backups in the specified directory. This is | |
759ac870 DD |
463 | very useful for incremental backups. You can additionally |
464 | specify a backup suffix using the --suffix option | |
465 | (otherwise the files backed up in the specified directory | |
466 | will keep their original filenames). | |
0b79c324 WD |
467 | If DIR is a relative path, it is relative to the destination directory |
468 | (which changes in a recursive transfer). | |
66203a98 | 469 | |
b5679335 | 470 | dit(bf(--suffix=SUFFIX)) This option allows you to override the default |
b19fd07c WD |
471 | backup suffix used with the --backup (-b) option. The default suffix is a ~ |
472 | if no --backup-dir was specified, otherwise it is an empty string. | |
9ef53907 | 473 | |
41059f75 AT |
474 | dit(bf(-u, --update)) This forces rsync to skip any files for which the |
475 | destination file already exists and has a date later than the source | |
476 | file. | |
477 | ||
adddd075 WD |
478 | In the currently implementation, a difference of file format is always |
479 | considered to be important enough for an update, no matter what date | |
480 | is on the objects. In other words, if the source has a directory or a | |
481 | symlink where the destination has a file, the transfer would occur | |
482 | regardless of the timestamps. This might change in the future (feel | |
483 | free to comment on this on the mailing list if you have an opinion). | |
484 | ||
716e73d4 WD |
485 | dit(bf(-K, --keep-dirlinks)) On the receiving side, if a symlink is |
486 | pointing to a directory, it will be treated as matching a directory | |
487 | from the sender. | |
488 | ||
a3221d2a WD |
489 | dit(bf(--inplace)) This causes rsync not to create a new copy of the file |
490 | and then move it into place. Instead rsync will overwrite the existing | |
98f51bfb | 491 | file, meaning that the rsync algorithm can't extract the full amount of |
a3221d2a WD |
492 | network reduction it might otherwise. |
493 | ||
75b243a5 WD |
494 | This option is useful for transfer of large files with block-based change |
495 | or appended data, and also on systems that are disk bound not network bound. | |
a3221d2a | 496 | |
399371e7 | 497 | WARNING: The file's data will be in an inconsistent state during the |
98f51bfb | 498 | transfer (and possibly afterward if the transfer gets interrupted), so you |
399371e7 | 499 | should not use this option to update files that are in use. Also note that |
75b243a5 WD |
500 | rsync will be unable to update a file inplace that is not writable by the |
501 | receiving user. | |
a3221d2a | 502 | |
eb06fa95 MP |
503 | dit(bf(-l, --links)) When symlinks are encountered, recreate the |
504 | symlink on the destination. | |
41059f75 | 505 | |
eb06fa95 | 506 | dit(bf(-L, --copy-links)) When symlinks are encountered, the file that |
ef855d19 WD |
507 | they point to (the referent) is copied, rather than the symlink. In older |
508 | versions of rsync, this option also had the side-effect of telling the | |
509 | receiving side to follow symlinks, such as symlinks to directories. In a | |
510 | modern rsync such as this one, you'll need to specify --keep-dirlinks (-K) | |
511 | to get this extra behavior. The only exception is when sending files to | |
512 | an rsync that is too old to understand -K -- in that case, the -L option | |
513 | will still have the side-effect of -K on that older receiving rsync. | |
b5313607 | 514 | |
eb06fa95 | 515 | dit(bf(--copy-unsafe-links)) This tells rsync to copy the referent of |
7af4227a | 516 | symbolic links that point outside the copied tree. Absolute symlinks |
eb06fa95 MP |
517 | are also treated like ordinary files, and so are any symlinks in the |
518 | source path itself when --relative is used. | |
41059f75 | 519 | |
d310a212 | 520 | dit(bf(--safe-links)) This tells rsync to ignore any symbolic links |
7af4227a | 521 | which point outside the copied tree. All absolute symlinks are |
d310a212 | 522 | also ignored. Using this option in conjunction with --relative may |
14d43f1f | 523 | give unexpected results. |
d310a212 | 524 | |
41059f75 AT |
525 | dit(bf(-H, --hard-links)) This tells rsync to recreate hard links on |
526 | the remote system to be the same as the local system. Without this | |
527 | option hard links are treated like regular files. | |
528 | ||
529 | Note that rsync can only detect hard links if both parts of the link | |
530 | are in the list of files being sent. | |
531 | ||
532 | This option can be quite slow, so only use it if you need it. | |
533 | ||
534 | dit(bf(-W, --whole-file)) With this option the incremental rsync algorithm | |
a1a440c2 DD |
535 | is not used and the whole file is sent as-is instead. The transfer may be |
536 | faster if this option is used when the bandwidth between the source and | |
6eb770bb | 537 | destination machines is higher than the bandwidth to disk (especially when the |
4d888108 | 538 | "disk" is actually a networked filesystem). This is the default when both |
6eb770bb | 539 | the source and destination are specified as local paths. |
41059f75 | 540 | |
93689aa5 DD |
541 | dit(bf(--no-whole-file)) Turn off --whole-file, for use when it is the |
542 | default. | |
543 | ||
8dc74608 WD |
544 | dit(bf(-p, --perms)) This option causes rsync to set the destination |
545 | permissions to be the same as the source permissions. | |
546 | ||
547 | Without this option, each new file gets its permissions set based on the | |
548 | source file's permissions and the umask at the receiving end, while all | |
549 | other files (including updated files) retain their existing permissions | |
550 | (which is the same behavior as other file-copy utilities, such as cp). | |
41059f75 | 551 | |
eb06fa95 MP |
552 | dit(bf(-o, --owner)) This option causes rsync to set the owner of the |
553 | destination file to be the same as the source file. On most systems, | |
a2b0471f WD |
554 | only the super-user can set file ownership. By default, the preservation |
555 | is done by name, but may fall back to using the ID number in some | |
556 | circumstances. See the --numeric-ids option for a full discussion. | |
41059f75 | 557 | |
eb06fa95 MP |
558 | dit(bf(-g, --group)) This option causes rsync to set the group of the |
559 | destination file to be the same as the source file. If the receiving | |
560 | program is not running as the super-user, only groups that the | |
a2b0471f WD |
561 | receiver is a member of will be preserved. By default, the preservation |
562 | is done by name, but may fall back to using the ID number in some | |
563 | circumstances. See the --numeric-ids option for a full discussion. | |
41059f75 AT |
564 | |
565 | dit(bf(-D, --devices)) This option causes rsync to transfer character and | |
566 | block device information to the remote system to recreate these | |
567 | devices. This option is only available to the super-user. | |
568 | ||
569 | dit(bf(-t, --times)) This tells rsync to transfer modification times along | |
baf3e504 DD |
570 | with the files and update them on the remote system. Note that if this |
571 | option is not used, the optimization that excludes files that have not been | |
572 | modified cannot be effective; in other words, a missing -t or -a will | |
573 | cause the next transfer to behave as if it used -I, and all files will have | |
574 | their checksums compared and show up in log messages even if they haven't | |
575 | changed. | |
41059f75 AT |
576 | |
577 | dit(bf(-n, --dry-run)) This tells rsync to not do any file transfers, | |
578 | instead it will just report the actions it would have taken. | |
579 | ||
580 | dit(bf(-S, --sparse)) Try to handle sparse files efficiently so they take | |
581 | up less space on the destination. | |
582 | ||
d310a212 AT |
583 | NOTE: Don't use this option when the destination is a Solaris "tmpfs" |
584 | filesystem. It doesn't seem to handle seeks over null regions | |
585 | correctly and ends up corrupting the files. | |
586 | ||
41059f75 AT |
587 | dit(bf(-x, --one-file-system)) This tells rsync not to cross filesystem |
588 | boundaries when recursing. This is useful for transferring the | |
589 | contents of only one filesystem. | |
590 | ||
1347d512 AT |
591 | dit(bf(--existing)) This tells rsync not to create any new files - |
592 | only update files that already exist on the destination. | |
593 | ||
3d6feada MP |
594 | dit(bf(--ignore-existing)) |
595 | This tells rsync not to update files that already exist on | |
596 | the destination. | |
597 | ||
0b73ca12 AT |
598 | dit(bf(--max-delete=NUM)) This tells rsync not to delete more than NUM |
599 | files or directories. This is useful when mirroring very large trees | |
600 | to prevent disasters. | |
601 | ||
41059f75 | 602 | dit(bf(--delete)) This tells rsync to delete any files on the receiving |
b33b791e DD |
603 | side that aren't on the sending side. Files that are excluded from |
604 | transfer are excluded from being deleted unless you use --delete-excluded. | |
41059f75 | 605 | |
24986abd AT |
606 | This option has no effect if directory recursion is not selected. |
607 | ||
b33b791e DD |
608 | This option can be dangerous if used incorrectly! It is a very good idea |
609 | to run first using the dry run option (-n) to see what files would be | |
610 | deleted to make sure important files aren't listed. | |
41059f75 | 611 | |
b5accaba | 612 | If the sending side detects any I/O errors then the deletion of any |
3e578a19 AT |
613 | files at the destination will be automatically disabled. This is to |
614 | prevent temporary filesystem failures (such as NFS errors) on the | |
615 | sending side causing a massive deletion of files on the | |
2c5548d2 | 616 | destination. You can override this with the --ignore-errors option. |
41059f75 | 617 | |
b33b791e DD |
618 | dit(bf(--delete-excluded)) In addition to deleting the files on the |
619 | receiving side that are not on the sending side, this tells rsync to also | |
620 | delete any files on the receiving side that are excluded (see --exclude). | |
786c3687 | 621 | Implies --delete. |
b33b791e | 622 | |
d48c8065 WD |
623 | dit(bf(--delete-after)) By default rsync does file deletions on the |
624 | receiving side before transferring files to try to ensure that there is | |
625 | sufficient space on the receiving filesystem. If you want to delete | |
626 | after transferring, use the --delete-after switch. Implies --delete. | |
57df171b | 627 | |
2c5548d2 | 628 | dit(bf(--ignore-errors)) Tells --delete to go ahead and delete files |
b5accaba | 629 | even when there are I/O errors. |
2c5548d2 | 630 | |
b695d088 DD |
631 | dit(bf(--force)) This options tells rsync to delete directories even if |
632 | they are not empty when they are to be replaced by non-directories. This | |
633 | is only relevant without --delete because deletions are now done depth-first. | |
634 | Requires the --recursive option (which is implied by -a) to have any effect. | |
41059f75 | 635 | |
e40a46de | 636 | dit(bf(-B, --block-size=BLOCKSIZE)) This controls the block size used in |
41059f75 AT |
637 | the rsync algorithm. See the technical report for details. |
638 | ||
b5679335 | 639 | dit(bf(-e, --rsh=COMMAND)) This option allows you to choose an alternative |
41059f75 | 640 | remote shell program to use for communication between the local and |
43cd760f WD |
641 | remote copies of rsync. Typically, rsync is configured to use ssh by |
642 | default, but you may prefer to use rsh on a local network. | |
41059f75 | 643 | |
bef49340 | 644 | If this option is used with bf([user@]host::module/path), then the |
4d888108 | 645 | remote shell em(COMMAND) will be used to run an rsync server on the |
bef49340 WD |
646 | remote host, and all data will be transmitted through that remote |
647 | shell connection, rather than through a direct socket connection to a | |
2d4ca358 DD |
648 | running rsync server on the remote host. See the section "CONNECTING |
649 | TO AN RSYNC SERVER OVER A REMOTE SHELL PROGRAM" above. | |
bef49340 | 650 | |
ea7f8108 WD |
651 | Command-line arguments are permitted in COMMAND provided that COMMAND is |
652 | presented to rsync as a single argument. For example: | |
98393ae2 | 653 | |
ea7f8108 | 654 | quote(-e "ssh -p 2234") |
98393ae2 WD |
655 | |
656 | (Note that ssh users can alternately customize site-specific connect | |
657 | options in their .ssh/config file.) | |
658 | ||
41059f75 | 659 | You can also choose the remote shell program using the RSYNC_RSH |
ea7f8108 | 660 | environment variable, which accepts the same range of values as -e. |
41059f75 | 661 | |
735a816e DD |
662 | See also the --blocking-io option which is affected by this option. |
663 | ||
b5679335 | 664 | dit(bf(--rsync-path=PATH)) Use this to specify the path to the copy of |
d73ee7b7 AT |
665 | rsync on the remote machine. Useful when it's not in your path. Note |
666 | that this is the full path to the binary, not just the directory that | |
667 | the binary is in. | |
41059f75 | 668 | |
f177b7cc WD |
669 | dit(bf(-C, --cvs-exclude)) This is a useful shorthand for excluding a |
670 | broad range of files that you often don't want to transfer between | |
671 | systems. It uses the same algorithm that CVS uses to determine if | |
672 | a file should be ignored. | |
673 | ||
674 | The exclude list is initialized to: | |
675 | ||
2a383be0 WD |
676 | quote(RCS SCCS CVS CVS.adm RCSLOG cvslog.* tags TAGS .make.state |
677 | .nse_depinfo *~ #* .#* ,* _$* *$ *.old *.bak *.BAK *.orig *.rej | |
678 | .del-* *.a *.olb *.o *.obj *.so *.exe *.Z *.elc *.ln core .svn/) | |
f177b7cc WD |
679 | |
680 | then files listed in a $HOME/.cvsignore are added to the list and any | |
2a383be0 WD |
681 | files listed in the CVSIGNORE environment variable (all cvsignore names |
682 | are delimited by whitespace). | |
683 | ||
f177b7cc | 684 | Finally, any file is ignored if it is in the same directory as a |
2a383be0 | 685 | .cvsignore file and matches one of the patterns listed therein. |
2a383be0 | 686 | See the bf(cvs(1)) manual for more information. |
f177b7cc | 687 | |
b5679335 | 688 | dit(bf(--exclude=PATTERN)) This option allows you to selectively exclude |
41059f75 AT |
689 | certain files from the list of files to be transferred. This is most |
690 | useful in combination with a recursive transfer. | |
691 | ||
41059f75 AT |
692 | You may use as many --exclude options on the command line as you like |
693 | to build up the list of files to exclude. | |
694 | ||
6156e72f | 695 | See the EXCLUDE PATTERNS section for detailed information on this option. |
41059f75 | 696 | |
b5679335 | 697 | dit(bf(--exclude-from=FILE)) This option is similar to the --exclude |
c48b22c8 AT |
698 | option, but instead it adds all exclude patterns listed in the file |
699 | FILE to the exclude list. Blank lines in FILE and lines starting with | |
700 | ';' or '#' are ignored. | |
f8a94f0d DD |
701 | If em(FILE) is bf(-) the list will be read from standard input. |
702 | ||
b5679335 | 703 | dit(bf(--include=PATTERN)) This option tells rsync to not exclude the |
43bd68e5 AT |
704 | specified pattern of filenames. This is useful as it allows you to |
705 | build up quite complex exclude/include rules. | |
706 | ||
6156e72f | 707 | See the EXCLUDE PATTERNS section for detailed information on this option. |
43bd68e5 | 708 | |
b5679335 | 709 | dit(bf(--include-from=FILE)) This specifies a list of include patterns |
43bd68e5 | 710 | from a file. |
c769702f | 711 | If em(FILE) is "-" the list will be read from standard input. |
f8a94f0d | 712 | |
f177b7cc WD |
713 | dit(bf(--files-from=FILE)) Using this option allows you to specify the |
714 | exact list of files to transfer (as read from the specified FILE or "-" | |
c769702f | 715 | for standard input). It also tweaks the default behavior of rsync to make |
f177b7cc WD |
716 | transferring just the specified files and directories easier. For |
717 | instance, the --relative option is enabled by default when this option | |
718 | is used (use --no-relative if you want to turn that off), all | |
719 | directories specified in the list are created on the destination (rather | |
720 | than being noisily skipped without -r), and the -a (--archive) option's | |
721 | behavior does not imply -r (--recursive) -- specify it explicitly, if | |
722 | you want it. | |
723 | ||
724 | The file names that are read from the FILE are all relative to the | |
725 | source dir -- any leading slashes are removed and no ".." references are | |
726 | allowed to go higher than the source dir. For example, take this | |
727 | command: | |
728 | ||
729 | quote(rsync -a --files-from=/tmp/foo /usr remote:/backup) | |
730 | ||
731 | If /tmp/foo contains the string "bin" (or even "/bin"), the /usr/bin | |
732 | directory will be created as /backup/bin on the remote host (but the | |
733 | contents of the /usr/bin dir would not be sent unless you specified -r | |
734 | or the names were explicitly listed in /tmp/foo). Also keep in mind | |
735 | that the effect of the (enabled by default) --relative option is to | |
736 | duplicate only the path info that is read from the file -- it does not | |
737 | force the duplication of the source-spec path (/usr in this case). | |
738 | ||
739 | In addition, the --files-from file can be read from the remote host | |
740 | instead of the local host if you specify a "host:" in front of the file | |
741 | (the host must match one end of the transfer). As a short-cut, you can | |
742 | specify just a prefix of ":" to mean "use the remote end of the | |
743 | transfer". For example: | |
744 | ||
745 | quote(rsync -a --files-from=:/path/file-list src:/ /tmp/copy) | |
746 | ||
747 | This would copy all the files specified in the /path/file-list file that | |
748 | was located on the remote "src" host. | |
749 | ||
750 | dit(bf(-0, --from0)) This tells rsync that the filenames it reads from a | |
751 | file are terminated by a null ('\0') character, not a NL, CR, or CR+LF. | |
752 | This affects --exclude-from, --include-from, and --files-from. | |
f01b6368 WD |
753 | It does not affect --cvs-exclude (since all names read from a .cvsignore |
754 | file are split on whitespace). | |
41059f75 | 755 | |
b5679335 | 756 | dit(bf(-T, --temp-dir=DIR)) This option instructs rsync to use DIR as a |
375a4556 | 757 | scratch directory when creating temporary copies of the files |
41059f75 AT |
758 | transferred on the receiving side. The default behavior is to create |
759 | the temporary files in the receiving directory. | |
760 | ||
3473b5b4 DD |
761 | dit(bf(--compare-dest=DIR)) This option instructs rsync to use DIR on |
762 | the destination machine as an additional directory to compare destination | |
d53d7795 DD |
763 | files against when doing transfers if the files are missing in the |
764 | destination directory. This is useful for doing transfers to a new | |
765 | destination while leaving existing files intact, and then doing a | |
3473b5b4 DD |
766 | flash-cutover when all files have been successfully transferred (for |
767 | example by moving directories around and removing the old directory, | |
d53d7795 DD |
768 | although this skips files that haven't changed; see also --link-dest). |
769 | This option increases the usefulness of --partial because partially | |
770 | transferred files will remain in the new temporary destination until they | |
771 | have a chance to be completed. If DIR is a relative path, it is relative | |
0b79c324 | 772 | to the destination directory (which changes in a recursive transfer). |
375a4556 | 773 | |
59c95e42 DD |
774 | dit(bf(--link-dest=DIR)) This option behaves like bf(--compare-dest) but |
775 | also will create hard links from em(DIR) to the destination directory for | |
776 | unchanged files. Files with changed ownership or permissions will not be | |
777 | linked. | |
d31c09c8 | 778 | Like bf(--compare-dest) if DIR is a relative path, it is relative |
0b79c324 | 779 | to the destination directory (which changes in a recursive transfer). |
8429aa9e WD |
780 | An example: |
781 | ||
782 | verb( | |
783 | rsync -av --link-dest=$PWD/prior_dir host:src_dir/ new_dir/ | |
784 | ) | |
59c95e42 | 785 | |
41059f75 | 786 | dit(bf(-z, --compress)) With this option, rsync compresses any data from |
089e73f8 | 787 | the files that it sends to the destination machine. This |
f39281ae | 788 | option is useful on slow connections. The compression method used is the |
41059f75 AT |
789 | same method that gzip uses. |
790 | ||
791 | Note this this option typically achieves better compression ratios | |
792 | that can be achieved by using a compressing remote shell, or a | |
793 | compressing transport, as it takes advantage of the implicit | |
794 | information sent for matching data blocks. | |
795 | ||
796 | dit(bf(--numeric-ids)) With this option rsync will transfer numeric group | |
4d888108 | 797 | and user IDs rather than using user and group names and mapping them |
41059f75 AT |
798 | at both ends. |
799 | ||
4d888108 | 800 | By default rsync will use the username and groupname to determine |
41059f75 | 801 | what ownership to give files. The special uid 0 and the special group |
14d43f1f | 802 | 0 are never mapped via user/group names even if the --numeric-ids |
41059f75 AT |
803 | option is not specified. |
804 | ||
ec40899b WD |
805 | If a user or group has no name on the source system or it has no match |
806 | on the destination system, then the numeric ID | |
807 | from the source system is used instead. See also the comments on the | |
a2b0471f WD |
808 | "use chroot" setting in the rsyncd.conf manpage for information on how |
809 | the chroot setting affects rsync's ability to look up the names of the | |
810 | users and groups and what you can do about it. | |
41059f75 | 811 | |
b5accaba | 812 | dit(bf(--timeout=TIMEOUT)) This option allows you to set a maximum I/O |
de2fd20e AT |
813 | timeout in seconds. If no data is transferred for the specified time |
814 | then rsync will exit. The default is 0, which means no timeout. | |
41059f75 | 815 | |
eb06fa95 MP |
816 | dit(bf(--daemon)) This tells rsync that it is to run as a daemon. The |
817 | daemon may be accessed using the bf(host::module) or | |
818 | bf(rsync://host/module/) syntax. | |
819 | ||
820 | If standard input is a socket then rsync will assume that it is being | |
821 | run via inetd, otherwise it will detach from the current terminal and | |
822 | become a background daemon. The daemon will read the config file | |
30e8c8e1 | 823 | (rsyncd.conf) on each connect made by a client and respond to |
eb06fa95 MP |
824 | requests accordingly. See the rsyncd.conf(5) man page for more |
825 | details. | |
41059f75 | 826 | |
bbd6f4ba MP |
827 | dit(bf(--no-detach)) When running as a daemon, this option instructs |
828 | rsync to not detach itself and become a background process. This | |
829 | option is required when running as a service on Cygwin, and may also | |
830 | be useful when rsync is supervised by a program such as | |
831 | bf(daemontools) or AIX's bf(System Resource Controller). | |
832 | bf(--no-detach) is also recommended when rsync is run under a | |
833 | debugger. This option has no effect if rsync is run from inetd or | |
834 | sshd. | |
835 | ||
5c9730a4 | 836 | dit(bf(--address)) By default rsync will bind to the wildcard address |
e30f0657 AT |
837 | when run as a daemon with the --daemon option or when connecting to a |
838 | rsync server. The --address option allows you to specify a specific IP | |
839 | address (or hostname) to bind to. This makes virtual hosting possible | |
840 | in conjunction with the --config option. | |
5c9730a4 | 841 | |
b5679335 | 842 | dit(bf(--config=FILE)) This specifies an alternate config file than |
30e8c8e1 DD |
843 | the default. This is only relevant when --daemon is specified. |
844 | The default is /etc/rsyncd.conf unless the daemon is running over | |
845 | a remote shell program and the remote user is not root; in that case | |
846 | the default is rsyncd.conf in the current directory (typically $HOME). | |
41059f75 | 847 | |
b5679335 | 848 | dit(bf(--port=PORT)) This specifies an alternate TCP port number to use |
14d43f1f | 849 | rather than the default port 873. |
41059f75 | 850 | |
b5accaba | 851 | dit(bf(--blocking-io)) This tells rsync to use blocking I/O when launching |
314a74d7 WD |
852 | a remote shell transport. If the remote shell is either rsh or remsh, |
853 | rsync defaults to using | |
b5accaba WD |
854 | blocking I/O, otherwise it defaults to using non-blocking I/O. (Note that |
855 | ssh prefers non-blocking I/O.) | |
64c704f0 | 856 | |
93689aa5 DD |
857 | dit(bf(--no-blocking-io)) Turn off --blocking-io, for use when it is the |
858 | default. | |
859 | ||
3a64ad1f | 860 | dit(bf(--log-format=FORMAT)) This allows you to specify exactly what the |
14d43f1f | 861 | rsync client logs to stdout on a per-file basis. The log format is |
3a64ad1f DD |
862 | specified using the same format conventions as the log format option in |
863 | rsyncd.conf. | |
b6062654 | 864 | |
b72f24c7 AT |
865 | dit(bf(--stats)) This tells rsync to print a verbose set of statistics |
866 | on the file transfer, allowing you to tell how effective the rsync | |
e19452a9 | 867 | algorithm is for your data. |
b72f24c7 | 868 | |
d9fcc198 AT |
869 | dit(bf(--partial)) By default, rsync will delete any partially |
870 | transferred file if the transfer is interrupted. In some circumstances | |
871 | it is more desirable to keep partially transferred files. Using the | |
872 | --partial option tells rsync to keep the partial file which should | |
873 | make a subsequent transfer of the rest of the file much faster. | |
874 | ||
44cad59f WD |
875 | dit(bf(--partial-dir=DIR)) Turns on --partial mode, but tells rsync to |
876 | put a partially transferred file into DIR instead of writing out the | |
877 | file to the destination dir. Rsync will also use a file found in this | |
878 | dir as data to speed up the transfer (i.e. when you redo the send after | |
879 | rsync creates a partial file) and delete such a file after it has served | |
880 | its purpose. | |
881 | ||
882 | Rsync will create the dir if it is missing (just the last dir -- not the | |
883 | whole path). This makes it easy to use a relative path (such as | |
884 | "--partial-dir=.rsync-partial") to have rsync create the partial-directory | |
885 | in the destination file's directory (rsync will also try to remove the DIR | |
886 | if a partial file was found to exist at the start of the transfer and the | |
887 | DIR was specified as a relative path). | |
888 | ||
889 | If you are deleting files on the destination and your partial-dir is | |
890 | inside the destination hierarchy, make sure you specify an exclude to | |
891 | prevent the partial file from being deleted (it could get deleted at the | |
892 | end of the transfer when using --delete-after, or at the beginning of the | |
893 | transfer when using --delete). E.g. "--exclude=.rsync-partial/". | |
894 | ||
895 | IMPORTANT: the --partial-dir should not be writable by other users to | |
896 | avoid a security risk. E.g. AVOID "/tmp". | |
897 | ||
eb86d661 AT |
898 | dit(bf(--progress)) This option tells rsync to print information |
899 | showing the progress of the transfer. This gives a bored user | |
900 | something to watch. | |
e2559dbe | 901 | Implies --verbose without incrementing verbosity. |
7b10f91d | 902 | |
68f9910d WD |
903 | When the file is transferring, the data looks like this: |
904 | ||
905 | verb( | |
906 | 782448 63% 110.64kB/s 0:00:04 | |
907 | ) | |
908 | ||
909 | This tells you the current file size, the percentage of the transfer that | |
910 | is complete, the current calculated file-completion rate (including both | |
911 | data over the wire and data being matched locally), and the estimated time | |
912 | remaining in this transfer. | |
913 | ||
914 | After the a file is complete, it the data looks like this: | |
915 | ||
916 | verb( | |
917 | 1238099 100% 146.38kB/s 0:00:08 (5, 57.1% of 396) | |
918 | ) | |
919 | ||
920 | This tells you the final file size, that it's 100% complete, the final | |
921 | transfer rate for the file, the amount of elapsed time it took to transfer | |
922 | the file, and the addition of a total-transfer summary in parentheses. | |
923 | These additional numbers tell you how many files have been updated, and | |
924 | what percent of the total number of files has been scanned. | |
925 | ||
d9fcc198 AT |
926 | dit(bf(-P)) The -P option is equivalent to --partial --progress. I |
927 | found myself typing that combination quite often so I created an | |
928 | option to make it easier. | |
929 | ||
65575e96 AT |
930 | dit(bf(--password-file)) This option allows you to provide a password |
931 | in a file for accessing a remote rsync server. Note that this option | |
bb18e755 | 932 | is only useful when accessing an rsync server using the built in |
65575e96 | 933 | transport, not when using a remote shell as the transport. The file |
fc7952e7 AT |
934 | must not be world readable. It should contain just the password as a |
935 | single line. | |
65575e96 | 936 | |
ef5d23eb DD |
937 | dit(bf(--bwlimit=KBPS)) This option allows you to specify a maximum |
938 | transfer rate in kilobytes per second. This option is most effective when | |
939 | using rsync with large files (several megabytes and up). Due to the nature | |
940 | of rsync transfers, blocks of data are sent, then if rsync determines the | |
941 | transfer was too fast, it will wait before sending the next data block. The | |
4d888108 | 942 | result is an average transfer rate equaling the specified limit. A value |
ef5d23eb DD |
943 | of zero specifies no limit. |
944 | ||
b9f592fb | 945 | dit(bf(--write-batch=FILE)) Record a file that can later be applied to |
98f51bfb | 946 | another identical destination with --read-batch. See the "BATCH MODE" |
b9f592fb | 947 | section for details. |
6902ed17 | 948 | |
b9f592fb | 949 | dit(bf(--read-batch=FILE)) Apply all of the changes stored in FILE, a |
c769702f | 950 | file previously generated by --write-batch. |
399371e7 | 951 | If em(FILE) is "-" the batch data will be read from standard input. |
c769702f | 952 | See the "BATCH MODE" section for details. |
6902ed17 | 953 | |
e40a46de WD |
954 | dit(bf(-4, --ipv4) or bf(-6, --ipv6)) Tells rsync to prefer IPv4/IPv6 |
955 | when creating sockets. This only affects sockets that rsync has direct | |
956 | control over, such as the outgoing socket when directly contacting an | |
957 | rsync daemon, or the incoming sockets that an rsync daemon uses to | |
958 | listen for connections. One of these options may be required in older | |
959 | versions of Linux to work around an IPv6 bug in the kernel (if you see | |
960 | an "address already in use" error when nothing else is using the port, | |
961 | try specifying --ipv6 or --ipv4 when starting the daemon). | |
962 | ||
c8d895de WD |
963 | dit(bf(--checksum-seed=NUM)) Set the MD4 checksum seed to the integer |
964 | NUM. This 4 byte checksum seed is included in each block and file | |
965 | MD4 checksum calculation. By default the checksum seed is generated | |
b9f592fb | 966 | by the server and defaults to the current time(). This option |
c8d895de WD |
967 | is used to set a specific checksum seed, which is useful for |
968 | applications that want repeatable block and file checksums, or | |
969 | in the case where the user wants a more random checksum seed. | |
970 | Note that setting NUM to 0 causes rsync to use the default of time() | |
b9f592fb | 971 | for checksum seed. |
c8d895de | 972 | |
41059f75 AT |
973 | enddit() |
974 | ||
43bd68e5 AT |
975 | manpagesection(EXCLUDE PATTERNS) |
976 | ||
977 | The exclude and include patterns specified to rsync allow for flexible | |
14d43f1f | 978 | selection of which files to transfer and which files to skip. |
43bd68e5 | 979 | |
be92ac6c | 980 | Rsync builds an ordered list of include/exclude options as specified on |
98606687 | 981 | the command line. Rsync checks each file and directory |
43bd68e5 | 982 | name against each exclude/include pattern in turn. The first matching |
23489269 | 983 | pattern is acted on. If it is an exclude pattern, then that file is |
43bd68e5 AT |
984 | skipped. If it is an include pattern then that filename is not |
985 | skipped. If no matching include/exclude pattern is found then the | |
986 | filename is not skipped. | |
987 | ||
a4b6f305 WD |
988 | The filenames matched against the exclude/include patterns are relative |
989 | to the "root of the transfer". If you think of the transfer as a | |
990 | subtree of names that are being sent from sender to receiver, the root | |
991 | is where the tree starts to be duplicated in the destination directory. | |
992 | This root governs where patterns that start with a / match (see below). | |
993 | ||
994 | Because the matching is relative to the transfer-root, changing the | |
20af605e | 995 | trailing slash on a source path or changing your use of the --relative |
a4b6f305 WD |
996 | option affects the path you need to use in your matching (in addition to |
997 | changing how much of the file tree is duplicated on the destination | |
998 | system). The following examples demonstrate this. | |
999 | ||
b5ebe6d9 WD |
1000 | Let's say that we want to match two source files, one with an absolute |
1001 | path of "/home/me/foo/bar", and one with a path of "/home/you/bar/baz". | |
1002 | Here is how the various command choices differ for a 2-source transfer: | |
a4b6f305 WD |
1003 | |
1004 | verb( | |
b5ebe6d9 | 1005 | Example cmd: rsync -a /home/me /home/you /dest |
a4b6f305 | 1006 | +/- pattern: /me/foo/bar |
b5ebe6d9 | 1007 | +/- pattern: /you/bar/baz |
a4b6f305 | 1008 | Target file: /dest/me/foo/bar |
b5ebe6d9 | 1009 | Target file: /dest/you/bar/baz |
a4b6f305 | 1010 | |
b5ebe6d9 | 1011 | Example cmd: rsync -a /home/me/ /home/you/ /dest |
b5ebe6d9 WD |
1012 | +/- pattern: /foo/bar (note missing "me") |
1013 | +/- pattern: /bar/baz (note missing "you") | |
a4b6f305 | 1014 | Target file: /dest/foo/bar |
b5ebe6d9 | 1015 | Target file: /dest/bar/baz |
a4b6f305 | 1016 | |
b5ebe6d9 | 1017 | Example cmd: rsync -a --relative /home/me/ /home/you /dest |
b5ebe6d9 WD |
1018 | +/- pattern: /home/me/foo/bar (note full path) |
1019 | +/- pattern: /home/you/bar/baz (ditto) | |
a4b6f305 | 1020 | Target file: /dest/home/me/foo/bar |
b5ebe6d9 | 1021 | Target file: /dest/home/you/bar/baz |
be92ac6c | 1022 | |
b5ebe6d9 | 1023 | Example cmd: cd /home; rsync -a --relative me/foo you/ /dest |
b5ebe6d9 WD |
1024 | +/- pattern: /me/foo/bar (starts at specified path) |
1025 | +/- pattern: /you/bar/baz (ditto) | |
be92ac6c | 1026 | Target file: /dest/me/foo/bar |
b5ebe6d9 | 1027 | Target file: /dest/you/bar/baz |
a4b6f305 WD |
1028 | ) |
1029 | ||
1030 | The easiest way to see what name you should include/exclude is to just | |
1031 | look at the output when using --verbose and put a / in front of the name | |
1032 | (use the --dry-run option if you're not yet ready to copy any files). | |
d1cce1dd | 1033 | |
be92ac6c WD |
1034 | Note that, when using the --recursive (-r) option (which is implied by -a), |
1035 | every subcomponent of | |
a4b6f305 | 1036 | every path is visited from the top down, so include/exclude patterns get |
27b9a19b | 1037 | applied recursively to each subcomponent. |
20af605e WD |
1038 | The exclude patterns actually short-circuit the directory traversal stage |
1039 | when rsync finds the files to send. If a pattern excludes a particular | |
1040 | parent directory, it can render a deeper include pattern ineffectual | |
1041 | because rsync did not descend through that excluded section of the | |
1042 | hierarchy. | |
27b9a19b DD |
1043 | |
1044 | Note also that the --include and --exclude options take one pattern | |
2fb139c1 AT |
1045 | each. To add multiple patterns use the --include-from and |
1046 | --exclude-from options or multiple --include and --exclude options. | |
1047 | ||
14d43f1f | 1048 | The patterns can take several forms. The rules are: |
43bd68e5 AT |
1049 | |
1050 | itemize( | |
d1cce1dd | 1051 | |
43bd68e5 AT |
1052 | it() if the pattern starts with a / then it is matched against the |
1053 | start of the filename, otherwise it is matched against the end of | |
d1cce1dd S |
1054 | the filename. |
1055 | This is the equivalent of a leading ^ in regular expressions. | |
a4b6f305 WD |
1056 | Thus "/foo" would match a file called "foo" at the transfer-root |
1057 | (see above for how this is different from the filesystem-root). | |
d1cce1dd | 1058 | On the other hand, "foo" would match any file called "foo" |
27b9a19b DD |
1059 | anywhere in the tree because the algorithm is applied recursively from |
1060 | top down; it behaves as if each path component gets a turn at being the | |
1061 | end of the file name. | |
43bd68e5 AT |
1062 | |
1063 | it() if the pattern ends with a / then it will only match a | |
a4b6f305 | 1064 | directory, not a file, link, or device. |
43bd68e5 AT |
1065 | |
1066 | it() if the pattern contains a wildcard character from the set | |
a8b9d4ed DD |
1067 | *?[ then expression matching is applied using the shell filename |
1068 | matching rules. Otherwise a simple string match is used. | |
43bd68e5 | 1069 | |
8a7846f9 WD |
1070 | it() the double asterisk pattern "**" will match slashes while a |
1071 | single asterisk pattern "*" will stop at slashes. | |
27b9a19b | 1072 | |
38499c1a WD |
1073 | it() if the pattern contains a / (not counting a trailing /) or a "**" |
1074 | then it is matched against the full filename, including any leading | |
1075 | directory. If the pattern doesn't contain a / or a "**", then it is | |
1076 | matched only against the final component of the filename. Again, | |
1077 | remember that the algorithm is applied recursively so "full filename" can | |
8a7846f9 | 1078 | actually be any portion of a path below the starting directory. |
43bd68e5 AT |
1079 | |
1080 | it() if the pattern starts with "+ " (a plus followed by a space) | |
5a554d5b | 1081 | then it is always considered an include pattern, even if specified as |
a03a9f4e | 1082 | part of an exclude option. The prefix is discarded before matching. |
43bd68e5 AT |
1083 | |
1084 | it() if the pattern starts with "- " (a minus followed by a space) | |
5a554d5b | 1085 | then it is always considered an exclude pattern, even if specified as |
a03a9f4e | 1086 | part of an include option. The prefix is discarded before matching. |
de2fd20e AT |
1087 | |
1088 | it() if the pattern is a single exclamation mark ! then the current | |
eb06fa95 | 1089 | include/exclude list is reset, removing all previously defined patterns. |
43bd68e5 AT |
1090 | ) |
1091 | ||
b7dc46c0 WD |
1092 | The +/- rules are most useful in a list that was read from a file, allowing |
1093 | you to have a single exclude list that contains both include and exclude | |
20af605e | 1094 | options in the proper order. |
27b9a19b | 1095 | |
20af605e WD |
1096 | Remember that the matching occurs at every step in the traversal of the |
1097 | directory hierarchy, so you must be sure that all the parent directories of | |
1098 | the files you want to include are not excluded. This is particularly | |
1099 | important when using a trailing '*' rule. For instance, this won't work: | |
43bd68e5 | 1100 | |
20af605e WD |
1101 | verb( |
1102 | + /some/path/this-file-will-not-be-found | |
1103 | + /file-is-included | |
1104 | - * | |
1105 | ) | |
1106 | ||
1107 | This fails because the parent directory "some" is excluded by the '*' rule, | |
1108 | so rsync never visits any of the files in the "some" or "some/path" | |
1109 | directories. One solution is to ask for all directories in the hierarchy | |
1110 | to be included by using a single rule: --include='*/' (put it somewhere | |
f28bd833 | 1111 | before the --exclude='*' rule). Another solution is to add specific |
20af605e WD |
1112 | include rules for all the parent dirs that need to be visited. For |
1113 | instance, this set of rules works fine: | |
1114 | ||
1115 | verb( | |
1116 | + /some/ | |
1117 | + /some/path/ | |
1118 | + /some/path/this-file-is-found | |
1119 | + /file-also-included | |
1120 | - * | |
1121 | ) | |
1122 | ||
1123 | Here are some examples of exclude/include matching: | |
43bd68e5 AT |
1124 | |
1125 | itemize( | |
1126 | it() --exclude "*.o" would exclude all filenames matching *.o | |
a4b6f305 | 1127 | it() --exclude "/foo" would exclude a file called foo in the transfer-root directory |
43bd68e5 | 1128 | it() --exclude "foo/" would exclude any directory called foo |
a8b9d4ed | 1129 | it() --exclude "/foo/*/bar" would exclude any file called bar two |
a4b6f305 | 1130 | levels below a directory called foo in the transfer-root directory |
a8b9d4ed | 1131 | it() --exclude "/foo/**/bar" would exclude any file called bar two |
a4b6f305 | 1132 | or more levels below a directory called foo in the transfer-root directory |
43bd68e5 | 1133 | it() --include "*/" --include "*.c" --exclude "*" would include all |
5d5811f7 DD |
1134 | directories and C source files |
1135 | it() --include "foo/" --include "foo/bar.c" --exclude "*" would include | |
1136 | only foo/bar.c (the foo/ directory must be explicitly included or | |
1137 | it would be excluded by the "*") | |
43bd68e5 AT |
1138 | ) |
1139 | ||
6902ed17 MP |
1140 | manpagesection(BATCH MODE) |
1141 | ||
2e3c1417 | 1142 | bf(Note:) Batch mode should be considered experimental in this version |
7432ccf4 WD |
1143 | of rsync. The interface and behavior have now stabilized, though, so |
1144 | feel free to try this out. | |
088aac85 DD |
1145 | |
1146 | Batch mode can be used to apply the same set of updates to many | |
1147 | identical systems. Suppose one has a tree which is replicated on a | |
1148 | number of hosts. Now suppose some changes have been made to this | |
1149 | source tree and those changes need to be propagated to the other | |
1150 | hosts. In order to do this using batch mode, rsync is run with the | |
1151 | write-batch option to apply the changes made to the source tree to one | |
1152 | of the destination trees. The write-batch option causes the rsync | |
b9f592fb WD |
1153 | client to store in a "batch file" all the information needed to repeat |
1154 | this operation against other, identical destination trees. | |
1155 | ||
1156 | To apply the recorded changes to another destination tree, run rsync | |
1157 | with the read-batch option, specifying the name of the same batch | |
1158 | file, and the destination tree. Rsync updates the destination tree | |
1159 | using the information stored in the batch file. | |
1160 | ||
1161 | For convenience, one additional file is creating when the write-batch | |
1162 | option is used. This file's name is created by appending | |
73e01568 | 1163 | ".sh" to the batch filename. The .sh file contains |
b9f592fb WD |
1164 | a command-line suitable for updating a destination tree using that |
1165 | batch file. It can be executed using a Bourne(-like) shell, optionally | |
1166 | passing in an alternate destination tree pathname which is then used | |
1167 | instead of the original path. This is useful when the destination tree | |
1168 | path differs from the original destination tree path. | |
1169 | ||
1170 | Generating the batch file once saves having to perform the file | |
1171 | status, checksum, and data block generation more than once when | |
088aac85 | 1172 | updating multiple destination trees. Multicast transport protocols can |
b9f592fb WD |
1173 | be used to transfer the batch update files in parallel to many hosts |
1174 | at once, instead of sending the same data to every host individually. | |
088aac85 | 1175 | |
4602eafa | 1176 | Examples: |
088aac85 DD |
1177 | |
1178 | verb( | |
98f51bfb WD |
1179 | $ rsync --write-batch=foo -a host:/source/dir/ /adest/dir/ |
1180 | $ scp foo* remote: | |
1181 | $ ssh remote ./foo.sh /bdest/dir/ | |
4602eafa WD |
1182 | ) |
1183 | ||
1184 | verb( | |
98f51bfb WD |
1185 | $ rsync --write-batch=foo -a /source/dir/ /adest/dir/ |
1186 | $ ssh remote rsync --read-batch=- -a /bdest/dir/ <foo | |
4602eafa WD |
1187 | ) |
1188 | ||
98f51bfb WD |
1189 | In these examples, rsync is used to update /adest/dir/ from /source/dir/ |
1190 | and the information to repeat this operation is stored in "foo" and | |
1191 | "foo.sh". The host "remote" is then updated with the batched data going | |
1192 | into the directory /bdest/dir. The differences between the two examples | |
1193 | reveals some of the flexibility you have in how you deal with batches: | |
1194 | ||
1195 | itemize( | |
1196 | ||
1197 | it() The first example shows that the initial copy doesn't have to be | |
1198 | local -- you can push or pull data to/from a remote host using either the | |
1199 | remote-shell syntax or rsync daemon syntax, as desired. | |
6902ed17 | 1200 | |
98f51bfb WD |
1201 | it() The first example uses the created "foo.sh" file to get the right |
1202 | rsync options when running the read-batch command on the remote host. | |
1203 | ||
1204 | it() The second example reads the batch data via standard input so that | |
1205 | the batch file doesn't need to be copied to the remote machine first. | |
1206 | This example avoids the foo.sh script because it needed to use a modified | |
1207 | --read-batch option, but you could edit the script file if you wished to | |
1208 | make use of it (just be sure that no other option is trying to use | |
1209 | standard input, such as the "--exclude-from=-" option). | |
1210 | ||
1211 | ) | |
088aac85 DD |
1212 | |
1213 | Caveats: | |
1214 | ||
98f51bfb | 1215 | The read-batch option expects the destination tree that it is updating |
088aac85 DD |
1216 | to be identical to the destination tree that was used to create the |
1217 | batch update fileset. When a difference between the destination trees | |
7432ccf4 WD |
1218 | is encountered the update might be discarded with no error (if the file |
1219 | appears to be up-to-date already) or the file-update may be attempted | |
1220 | and then, if the file fails to verify, the update discarded with an | |
1221 | error. This means that it should be safe to re-run a read-batch operation | |
1222 | if the command got updated. If you wish to force the batched-update to | |
1223 | always be attempted regardless of the file's size and date, use the -I | |
1224 | option. If an error occurs, the destination tree will probably be in a | |
1225 | partially updated state. In that case, rsync can | |
088aac85 DD |
1226 | be used in its regular (non-batch) mode of operation to fix up the |
1227 | destination tree. | |
1228 | ||
b9f592fb WD |
1229 | The rsync version used on all destinations must be at least as new as the |
1230 | one used to generate the batch file. | |
088aac85 | 1231 | |
98f51bfb | 1232 | The --dry-run (-n) option does not work in batch mode and yields a runtime |
088aac85 DD |
1233 | error. |
1234 | ||
7432ccf4 WD |
1235 | When reading a batch file, rsync will force the value of certain options |
1236 | to match the data in the batch file if you didn't set them to the same | |
1237 | as the batch-writing command. Other options can (and should) be changed. | |
1238 | For instance | |
b9f592fb WD |
1239 | --write-batch changes to --read-batch, --files-from is dropped, and the |
1240 | --include/--exclude options are not needed unless --delete is specified | |
7432ccf4 | 1241 | without --delete-excluded. |
b9f592fb | 1242 | |
98f51bfb WD |
1243 | The code that creates the BATCH.sh file transforms any include/exclude |
1244 | options into a single list that is appended as a "here" document to the | |
1245 | shell script file. An advanced user can use this to modify the exclude | |
1246 | list if a change in what gets deleted by --delete is desired. A normal | |
1247 | user can ignore this detail and just use the shell script as an easy way | |
1248 | to run the appropriate --read-batch command for the batched data. | |
1249 | ||
6902ed17 MP |
1250 | See bf(http://www.ils.unc.edu/i2dsi/unc_rsync+.html) for papers and technical |
1251 | reports. | |
1252 | ||
eb06fa95 MP |
1253 | manpagesection(SYMBOLIC LINKS) |
1254 | ||
f28bd833 | 1255 | Three basic behaviors are possible when rsync encounters a symbolic |
eb06fa95 MP |
1256 | link in the source directory. |
1257 | ||
1258 | By default, symbolic links are not transferred at all. A message | |
1259 | "skipping non-regular" file is emitted for any symlinks that exist. | |
1260 | ||
1261 | If bf(--links) is specified, then symlinks are recreated with the same | |
1262 | target on the destination. Note that bf(--archive) implies | |
1263 | bf(--links). | |
1264 | ||
1265 | If bf(--copy-links) is specified, then symlinks are "collapsed" by | |
1266 | copying their referent, rather than the symlink. | |
1267 | ||
1268 | rsync also distinguishes "safe" and "unsafe" symbolic links. An | |
1269 | example where this might be used is a web site mirror that wishes | |
1270 | ensure the rsync module they copy does not include symbolic links to | |
1271 | bf(/etc/passwd) in the public section of the site. Using | |
1272 | bf(--copy-unsafe-links) will cause any links to be copied as the file | |
1273 | they point to on the destination. Using bf(--safe-links) will cause | |
4d888108 | 1274 | unsafe links to be omitted altogether. |
eb06fa95 | 1275 | |
7bd0cf5b MP |
1276 | Symbolic links are considered unsafe if they are absolute symlinks |
1277 | (start with bf(/)), empty, or if they contain enough bf("..") | |
1278 | components to ascend from the directory being copied. | |
1279 | ||
d310a212 AT |
1280 | manpagesection(DIAGNOSTICS) |
1281 | ||
14d43f1f | 1282 | rsync occasionally produces error messages that may seem a little |
d310a212 AT |
1283 | cryptic. The one that seems to cause the most confusion is "protocol |
1284 | version mismatch - is your shell clean?". | |
1285 | ||
1286 | This message is usually caused by your startup scripts or remote shell | |
1287 | facility producing unwanted garbage on the stream that rsync is using | |
14d43f1f | 1288 | for its transport. The way to diagnose this problem is to run your |
d310a212 AT |
1289 | remote shell like this: |
1290 | ||
1291 | verb( | |
43cd760f | 1292 | ssh remotehost /bin/true > out.dat |
d310a212 AT |
1293 | ) |
1294 | ||
1295 | then look at out.dat. If everything is working correctly then out.dat | |
2cfeab21 | 1296 | should be a zero length file. If you are getting the above error from |
d310a212 AT |
1297 | rsync then you will probably find that out.dat contains some text or |
1298 | data. Look at the contents and try to work out what is producing | |
14d43f1f | 1299 | it. The most common cause is incorrectly configured shell startup |
d310a212 AT |
1300 | scripts (such as .cshrc or .profile) that contain output statements |
1301 | for non-interactive logins. | |
1302 | ||
e6c64e79 MP |
1303 | If you are having trouble debugging include and exclude patterns, then |
1304 | try specifying the -vv option. At this level of verbosity rsync will | |
1305 | show why each individual file is included or excluded. | |
1306 | ||
55b64e4b MP |
1307 | manpagesection(EXIT VALUES) |
1308 | ||
1309 | startdit() | |
a73de5f3 WD |
1310 | dit(bf(0)) Success |
1311 | dit(bf(1)) Syntax or usage error | |
1312 | dit(bf(2)) Protocol incompatibility | |
1313 | dit(bf(3)) Errors selecting input/output files, dirs | |
1314 | dit(bf(4)) Requested action not supported: an attempt | |
8212336a | 1315 | was made to manipulate 64-bit files on a platform that cannot support |
f28bd833 | 1316 | them; or an option was specified that is supported by the client and |
8212336a | 1317 | not by the server. |
a73de5f3 | 1318 | dit(bf(5)) Error starting client-server protocol |
b5accaba WD |
1319 | dit(bf(10)) Error in socket I/O |
1320 | dit(bf(11)) Error in file I/O | |
a73de5f3 WD |
1321 | dit(bf(12)) Error in rsync protocol data stream |
1322 | dit(bf(13)) Errors with program diagnostics | |
1323 | dit(bf(14)) Error in IPC code | |
1324 | dit(bf(20)) Received SIGUSR1 or SIGINT | |
1325 | dit(bf(21)) Some error returned by waitpid() | |
1326 | dit(bf(22)) Error allocating core memory buffers | |
3c1e2ad9 WD |
1327 | dit(bf(23)) Partial transfer due to error |
1328 | dit(bf(24)) Partial transfer due to vanished source files | |
a73de5f3 | 1329 | dit(bf(30)) Timeout in data send/receive |
55b64e4b MP |
1330 | enddit() |
1331 | ||
de2fd20e AT |
1332 | manpagesection(ENVIRONMENT VARIABLES) |
1333 | ||
1334 | startdit() | |
1335 | ||
1336 | dit(bf(CVSIGNORE)) The CVSIGNORE environment variable supplements any | |
1337 | ignore patterns in .cvsignore files. See the --cvs-exclude option for | |
1338 | more details. | |
1339 | ||
1340 | dit(bf(RSYNC_RSH)) The RSYNC_RSH environment variable allows you to | |
ea7f8108 WD |
1341 | override the default shell used as the transport for rsync. Command line |
1342 | options are permitted after the command name, just as in the -e option. | |
de2fd20e | 1343 | |
4c3b4b25 AT |
1344 | dit(bf(RSYNC_PROXY)) The RSYNC_PROXY environment variable allows you to |
1345 | redirect your rsync client to use a web proxy when connecting to a | |
1346 | rsync daemon. You should set RSYNC_PROXY to a hostname:port pair. | |
1347 | ||
de2fd20e | 1348 | dit(bf(RSYNC_PASSWORD)) Setting RSYNC_PASSWORD to the required |
bb18e755 | 1349 | password allows you to run authenticated rsync connections to an rsync |
de2fd20e AT |
1350 | daemon without user intervention. Note that this does not supply a |
1351 | password to a shell transport such as ssh. | |
1352 | ||
1353 | dit(bf(USER) or bf(LOGNAME)) The USER or LOGNAME environment variables | |
bb18e755 | 1354 | are used to determine the default username sent to an rsync server. |
4b2f6a7c | 1355 | If neither is set, the username defaults to "nobody". |
de2fd20e | 1356 | |
14d43f1f | 1357 | dit(bf(HOME)) The HOME environment variable is used to find the user's |
de2fd20e AT |
1358 | default .cvsignore file. |
1359 | ||
1360 | enddit() | |
1361 | ||
41059f75 AT |
1362 | manpagefiles() |
1363 | ||
30e8c8e1 | 1364 | /etc/rsyncd.conf or rsyncd.conf |
41059f75 AT |
1365 | |
1366 | manpageseealso() | |
1367 | ||
1368 | rsyncd.conf(5) | |
1369 | ||
1370 | manpagediagnostics() | |
1371 | ||
1372 | manpagebugs() | |
1373 | ||
1374 | times are transferred as unix time_t values | |
1375 | ||
f28bd833 | 1376 | When transferring to FAT filesystems rsync may re-sync |
38843171 DD |
1377 | unmodified files. |
1378 | See the comments on the --modify-window option. | |
1379 | ||
b5accaba | 1380 | file permissions, devices, etc. are transferred as native numerical |
41059f75 AT |
1381 | values |
1382 | ||
a87b3b2a | 1383 | see also the comments on the --delete option |
41059f75 | 1384 | |
38843171 DD |
1385 | Please report bugs! See the website at |
1386 | url(http://rsync.samba.org/)(http://rsync.samba.org/) | |
41059f75 AT |
1387 | |
1388 | manpagesection(CREDITS) | |
1389 | ||
1390 | rsync is distributed under the GNU public license. See the file | |
1391 | COPYING for details. | |
1392 | ||
41059f75 | 1393 | A WEB site is available at |
3cd5eb3b MP |
1394 | url(http://rsync.samba.org/)(http://rsync.samba.org/). The site |
1395 | includes an FAQ-O-Matic which may cover questions unanswered by this | |
1396 | manual page. | |
9e3c856a AT |
1397 | |
1398 | The primary ftp site for rsync is | |
1399 | url(ftp://rsync.samba.org/pub/rsync)(ftp://rsync.samba.org/pub/rsync). | |
41059f75 AT |
1400 | |
1401 | We would be delighted to hear from you if you like this program. | |
1402 | ||
9e3c856a AT |
1403 | This program uses the excellent zlib compression library written by |
1404 | Jean-loup Gailly and Mark Adler. | |
41059f75 AT |
1405 | |
1406 | manpagesection(THANKS) | |
1407 | ||
1408 | Thanks to Richard Brent, Brendan Mackay, Bill Waite, Stephen Rothwell | |
7ff701e8 MP |
1409 | and David Bell for helpful suggestions, patches and testing of rsync. |
1410 | I've probably missed some people, my apologies if I have. | |
1411 | ||
ce5f2732 | 1412 | Especial thanks also to: David Dykstra, Jos Backus, Sebastian Krahmer, |
98f51bfb | 1413 | Martin Pool, Wayne Davison, J.W. Schultz. |
41059f75 AT |
1414 | |
1415 | manpageauthor() | |
1416 | ||
ce5f2732 MP |
1417 | rsync was originally written by Andrew Tridgell and Paul Mackerras. |
1418 | Many people have later contributed to it. | |
3cd5eb3b | 1419 | |
a5d74a18 | 1420 | Mailing lists for support and development are available at |
7ff701e8 | 1421 | url(http://lists.samba.org)(lists.samba.org) |