Commit | Line | Data |
---|---|---|
9e3c856a | 1 | mailto(rsync-bugs@samba.org) |
deec5744 | 2 | manpage(rsync)(1)(26 Jan 2003)()() |
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( | |
35 | it() support for copying links, devices, owners, groups and permissions | |
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 | |
38 | it() can use any transparent remote shell, including rsh or ssh | |
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 | |
54 | a remote shell program as the transport (such as rsh or | |
55 | ssh). This is invoked when the destination path contains a | |
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 :: | |
946347b8 | 64 | separator or a 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 :: | |
8d69d571 | 68 | separator or a 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 | |
80 | --rsh=COMMMAND option is also provided. | |
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 | |
96 | daemon-mode protocol). For remote transfers, rsync typically uses rsh | |
97 | for its communications, but it may have been configured to use a | |
98 | different remote shell by default, such as ssh. | |
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 | ||
114 | Perhaps the best way to explain the syntax is some examples: | |
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 | |
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 |
eb06fa95 MP |
165 | your web proxy. Note that your web proxy's configuration must allow |
166 | proxying 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 | |
8d69d571 | 173 | separate the hostname from the path or a 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 | |
197 | server capabilities on the remote machine, while still using rsh or | |
198 | ssh for transport. This is especially useful when you want to connect | |
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 | ||
30e8c8e1 DD |
220 | An rsync server is configured using a config file. Please see the |
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 | ||
237 | To run an rsync server out of a single-use ssh key, use the | |
238 | "command=em(COMMAND)" syntax in the remote user's | |
239 | authorized_keys entry, where command would be | |
240 | ||
241 | quote(rsync --server --daemon .) | |
242 | ||
243 | NOTE: rsync's argument parsing expects the trailing ".", so make sure | |
244 | that it's there. If you want to use a rsyncd.conf(5)-style | |
30e8c8e1 | 245 | configuration file other than the default, you can added a |
1b887755 | 246 | --config option to the em(command): |
bef49340 | 247 | |
1b887755 | 248 | quote(rsync --server --daemon --config=em(file) .) |
bef49340 | 249 | |
41059f75 AT |
250 | manpagesection(EXAMPLES) |
251 | ||
252 | Here are some examples of how I use rsync. | |
253 | ||
14d43f1f DD |
254 | To backup my wife's home directory, which consists of large MS Word |
255 | files and mail folders, I use a cron job that runs | |
41059f75 AT |
256 | |
257 | quote(rsync -Cavz . arvidsjaur:backup) | |
258 | ||
f39281ae | 259 | each night over a PPP connection to a duplicate directory on my machine |
41059f75 AT |
260 | "arvidsjaur". |
261 | ||
262 | To synchronize my samba source trees I use the following Makefile | |
263 | targets: | |
264 | ||
265 | quote( get:nl() | |
266 | rsync -avuzb --exclude '*~' samba:samba/ . | |
267 | ||
268 | put:nl() | |
269 | rsync -Cavuzb . samba:samba/ | |
270 | ||
271 | sync: get put) | |
272 | ||
273 | this allows me to sync with a CVS directory at the other end of the | |
f39281ae | 274 | connection. I then do cvs operations on the remote machine, which saves a |
41059f75 AT |
275 | lot of time as the remote cvs protocol isn't very efficient. |
276 | ||
277 | I mirror a directory between my "old" and "new" ftp sites with the | |
278 | command | |
279 | ||
280 | quote(rsync -az -e ssh --delete ~ftp/pub/samba/ nimbus:"~ftp/pub/tridge/samba") | |
281 | ||
282 | this is launched from cron every few hours. | |
283 | ||
c95da96a AT |
284 | manpagesection(OPTIONS SUMMARY) |
285 | ||
14d43f1f | 286 | Here is a short summary of the options available in rsync. Please refer |
c95da96a AT |
287 | to the detailed description below for a complete description. |
288 | ||
289 | verb( | |
290 | -v, --verbose increase verbosity | |
b86f0cef | 291 | -q, --quiet decrease verbosity |
c95da96a | 292 | -c, --checksum always checksum |
06891710 | 293 | -a, --archive archive mode, equivalent to -rlptgoD |
c95da96a AT |
294 | -r, --recursive recurse into directories |
295 | -R, --relative use relative path names | |
f177b7cc WD |
296 | --no-relative turn off --relative |
297 | --no-implied-dirs don't send implied dirs with -R | |
b19fd07c | 298 | -b, --backup make backups (see --suffix) |
5b56cc19 | 299 | --backup-dir make backups into this directory |
b19fd07c | 300 | --suffix=SUFFIX define backup suffix (default ~ w/o --backup-dir) |
c95da96a | 301 | -u, --update update only (don't overwrite newer files) |
eb06fa95 MP |
302 | -l, --links copy symlinks as symlinks |
303 | -L, --copy-links copy the referent of symlinks | |
b5313607 | 304 | --copy-unsafe-links copy links outside the source tree |
d853783f | 305 | --safe-links ignore links outside the destination tree |
c95da96a AT |
306 | -H, --hard-links preserve hard links |
307 | -p, --perms preserve permissions | |
308 | -o, --owner preserve owner (root only) | |
309 | -g, --group preserve group | |
310 | -D, --devices preserve devices (root only) | |
311 | -t, --times preserve times | |
312 | -S, --sparse handle sparse files efficiently | |
313 | -n, --dry-run show what would have been transferred | |
314 | -W, --whole-file copy whole files, no incremental checks | |
93689aa5 | 315 | --no-whole-file turn off --whole-file |
c95da96a | 316 | -x, --one-file-system don't cross filesystem boundaries |
9ef53907 | 317 | -B, --block-size=SIZE checksum blocking size (default 700) |
1bbf83c0 | 318 | -e, --rsh=COMMAND specify the remote shell to use |
d9fcc198 | 319 | --rsync-path=PATH specify path to rsync on the remote machine |
1347d512 | 320 | --existing only update files that already exist |
3d6feada | 321 | --ignore-existing ignore files that already exist on the receiving side |
c95da96a | 322 | --delete delete files that don't exist on the sending side |
b33b791e | 323 | --delete-excluded also delete excluded files on the receiving side |
1347d512 | 324 | --delete-after delete after transferring, not before |
ef55c686 | 325 | --ignore-errors delete even if there are IO errors |
0b73ca12 | 326 | --max-delete=NUM don't delete more than NUM files |
c95da96a AT |
327 | --partial keep partially transferred files |
328 | --force force deletion of directories even if not empty | |
329 | --numeric-ids don't map uid/gid values by user/group name | |
330 | --timeout=TIME set IO timeout in seconds | |
331 | -I, --ignore-times don't exclude files that match length and time | |
f83f0548 | 332 | --size-only only use file size when determining if a file should be transferred |
5b56cc19 | 333 | --modify-window=NUM Timestamp window (seconds) for file match (default=0) |
c95da96a | 334 | -T --temp-dir=DIR create temporary files in directory DIR |
375a4556 | 335 | --compare-dest=DIR also compare destination files relative to DIR |
59c95e42 | 336 | --link-dest=DIR create hardlinks to DIR for unchanged files |
d9fcc198 | 337 | -P equivalent to --partial --progress |
c95da96a | 338 | -z, --compress compress file data |
f177b7cc | 339 | -C, --cvs-exclude auto ignore files in the same way CVS does |
2acf81eb | 340 | --exclude=PATTERN exclude files matching PATTERN |
9ef53907 | 341 | --exclude-from=FILE exclude patterns listed in FILE |
2acf81eb | 342 | --include=PATTERN don't exclude files matching PATTERN |
9ef53907 | 343 | --include-from=FILE don't exclude patterns listed in FILE |
f177b7cc WD |
344 | --files-from=FILE read FILE for list of source-file names |
345 | -0 --from0 file names we read are separated by nulls, not newlines | |
c95da96a AT |
346 | --version print version number |
347 | --daemon run as a rsync daemon | |
bbd6f4ba | 348 | --no-detach do not detach from the parent |
2a951cd2 | 349 | --address=ADDRESS bind to the specified address |
c95da96a AT |
350 | --config=FILE specify alternate rsyncd.conf file |
351 | --port=PORT specify alternate rsyncd port number | |
64c704f0 | 352 | --blocking-io use blocking IO for the remote shell |
93689aa5 | 353 | --no-blocking-io turn off --blocking-io |
c95da96a | 354 | --stats give some file transfer stats |
eb86d661 | 355 | --progress show progress during transfer |
b6062654 | 356 | --log-format=FORMAT log file transfers using specified format |
9ef53907 | 357 | --password-file=FILE get password from FILE |
ef5d23eb | 358 | --bwlimit=KBPS limit I/O bandwidth, KBytes per second |
088aac85 DD |
359 | --read-batch=PREFIX read batch fileset starting with PREFIX |
360 | --write-batch=PREFIX write batch fileset starting with PREFIX | |
c95da96a | 361 | -h, --help show this help screen |
6902ed17 MP |
362 | |
363 | ||
c95da96a AT |
364 | ) |
365 | ||
41059f75 AT |
366 | manpageoptions() |
367 | ||
368 | rsync uses the GNU long options package. Many of the command line | |
369 | options have two variants, one short and one long. These are shown | |
14d43f1f | 370 | below, separated by commas. Some options only have a long variant. |
b5679335 DD |
371 | The '=' for options that take a parameter is optional; whitespace |
372 | can be used instead. | |
41059f75 AT |
373 | |
374 | startdit() | |
375 | dit(bf(-h, --help)) Print a short help page describing the options | |
376 | available in rsync | |
377 | ||
378 | dit(bf(--version)) print the rsync version number and exit | |
379 | ||
380 | dit(bf(-v, --verbose)) This option increases the amount of information you | |
14d43f1f | 381 | are given during the transfer. By default, rsync works silently. A |
41059f75 AT |
382 | single -v will give you information about what files are being |
383 | transferred and a brief summary at the end. Two -v flags will give you | |
384 | information on what files are being skipped and slightly more | |
385 | information at the end. More than two -v flags should only be used if | |
14d43f1f | 386 | you are debugging rsync. |
41059f75 | 387 | |
b86f0cef DD |
388 | dit(bf(-q, --quiet)) This option decreases the amount of information you |
389 | are given during the transfer, notably suppressing information messages | |
390 | from the remote server. This flag is useful when invoking rsync from | |
391 | cron. | |
392 | ||
41059f75 AT |
393 | dit(bf(-I, --ignore-times)) Normally rsync will skip any files that are |
394 | already the same length and have the same time-stamp. This option turns | |
395 | off this behavior. | |
396 | ||
a7d068ab | 397 | dit(bf(--size-only)) Normally rsync will skip any files that are |
f83f0548 AT |
398 | already the same length and have the same time-stamp. With the |
399 | --size-only option files will be skipped if they have the same size, | |
400 | regardless of timestamp. This is useful when starting to use rsync | |
401 | after using another mirroring system which may not preserve timestamps | |
402 | exactly. | |
403 | ||
5b56cc19 AT |
404 | dit(bf(--modify-window)) When comparing two timestamps rsync treats |
405 | the timestamps as being equal if they are within the value of | |
406 | modify_window. This is normally zero, but you may find it useful to | |
407 | set this to a larger value in some situations. In particular, when | |
38843171 DD |
408 | transferring to Windows FAT filesystems which cannot represent times |
409 | with a 1 second resolution --modify-window=1 is useful. | |
5b56cc19 | 410 | |
41059f75 AT |
411 | dit(bf(-c, --checksum)) This forces the sender to checksum all files using |
412 | a 128-bit MD4 checksum before transfer. The checksum is then | |
413 | explicitly checked on the receiver and any files of the same name | |
414 | which already exist and have the same checksum and size on the | |
415 | receiver are skipped. This option can be quite slow. | |
416 | ||
e7bf3e5e MP |
417 | dit(bf(-a, --archive)) This is equivalent to -rlptgoD. It is a quick |
418 | way of saying you want recursion and want to preserve almost | |
419 | everything. | |
420 | ||
421 | Note however that bf(-a) bf(does not preserve hardlinks), because | |
422 | finding multiply-linked files is expensive. You must separately | |
423 | specify bf(-H). | |
41059f75 | 424 | |
24986abd AT |
425 | dit(bf(-r, --recursive)) This tells rsync to copy directories |
426 | recursively. If you don't specify this then rsync won't copy | |
427 | directories at all. | |
41059f75 AT |
428 | |
429 | dit(bf(-R, --relative)) Use relative paths. This means that the full path | |
430 | names specified on the command line are sent to the server rather than | |
431 | just the last parts of the filenames. This is particularly useful when | |
14d43f1f DD |
432 | you want to send several different directories at the same time. For |
433 | example, if you used the command | |
41059f75 AT |
434 | |
435 | verb(rsync foo/bar/foo.c remote:/tmp/) | |
436 | ||
437 | then this would create a file called foo.c in /tmp/ on the remote | |
438 | machine. If instead you used | |
439 | ||
440 | verb(rsync -R foo/bar/foo.c remote:/tmp/) | |
441 | ||
442 | then a file called /tmp/foo/bar/foo.c would be created on the remote | |
f177b7cc WD |
443 | machine -- the full path name is preserved. |
444 | ||
445 | dit(bf(--no-relative)) Turn off the --relative option. This is only | |
446 | needed if you want to use --files-from without its implied --relative | |
447 | file processing. | |
448 | ||
449 | dit(bf(--no-implied-dirs)) When combined with the --relative option, the | |
450 | implied directories in each path are not explicitly duplicated as part | |
451 | of the transfer. This makes the transfer more optimal and also allows | |
452 | the two sides to have non-matching symlinks in the implied part of the | |
453 | path. For instance, if you transfer the file "/path/foo/file" with -R, | |
454 | the default is for rsync to ensure that "/path" and "/path/foo" on the | |
455 | destination exactly match the directories/symlinks of the source. Using | |
456 | the --no-implied-dirs option would omit both of these implied dirs, | |
457 | which means that if "/path" was a real directory on one machine and a | |
458 | symlink of the other machine, rsync would not try to change this. | |
41059f75 | 459 | |
b19fd07c WD |
460 | dit(bf(-b, --backup)) With this option, preexisting destination files are |
461 | renamed as each file is transferred or deleted. You can control where the | |
462 | backup file goes and what (if any) suffix gets appended using the | |
463 | --backup-dir and --suffix options. | |
41059f75 | 464 | |
66203a98 AT |
465 | dit(bf(--backup-dir=DIR)) In combination with the --backup option, this |
466 | tells rsync to store all backups in the specified directory. This is | |
759ac870 DD |
467 | very useful for incremental backups. You can additionally |
468 | specify a backup suffix using the --suffix option | |
469 | (otherwise the files backed up in the specified directory | |
470 | will keep their original filenames). | |
66203a98 | 471 | |
b5679335 | 472 | dit(bf(--suffix=SUFFIX)) This option allows you to override the default |
b19fd07c WD |
473 | backup suffix used with the --backup (-b) option. The default suffix is a ~ |
474 | if no --backup-dir was specified, otherwise it is an empty string. | |
9ef53907 | 475 | |
41059f75 AT |
476 | dit(bf(-u, --update)) This forces rsync to skip any files for which the |
477 | destination file already exists and has a date later than the source | |
478 | file. | |
479 | ||
eb06fa95 MP |
480 | dit(bf(-l, --links)) When symlinks are encountered, recreate the |
481 | symlink on the destination. | |
41059f75 | 482 | |
eb06fa95 MP |
483 | dit(bf(-L, --copy-links)) When symlinks are encountered, the file that |
484 | they point to is copied, rather than the symlink. | |
b5313607 | 485 | |
eb06fa95 MP |
486 | dit(bf(--copy-unsafe-links)) This tells rsync to copy the referent of |
487 | symbolic links that point outside the source tree. Absolute symlinks | |
488 | are also treated like ordinary files, and so are any symlinks in the | |
489 | source path itself when --relative is used. | |
41059f75 | 490 | |
d310a212 AT |
491 | dit(bf(--safe-links)) This tells rsync to ignore any symbolic links |
492 | which point outside the destination tree. All absolute symlinks are | |
493 | also ignored. Using this option in conjunction with --relative may | |
14d43f1f | 494 | give unexpected results. |
d310a212 | 495 | |
41059f75 AT |
496 | dit(bf(-H, --hard-links)) This tells rsync to recreate hard links on |
497 | the remote system to be the same as the local system. Without this | |
498 | option hard links are treated like regular files. | |
499 | ||
500 | Note that rsync can only detect hard links if both parts of the link | |
501 | are in the list of files being sent. | |
502 | ||
503 | This option can be quite slow, so only use it if you need it. | |
504 | ||
505 | dit(bf(-W, --whole-file)) With this option the incremental rsync algorithm | |
a1a440c2 DD |
506 | is not used and the whole file is sent as-is instead. The transfer may be |
507 | faster if this option is used when the bandwidth between the source and | |
508 | target machines is higher than the bandwidth to disk (especially when the | |
509 | "disk" is actually a networked file system). This is the default when both | |
510 | the source and target are on the local machine. | |
41059f75 | 511 | |
93689aa5 DD |
512 | dit(bf(--no-whole-file)) Turn off --whole-file, for use when it is the |
513 | default. | |
514 | ||
8dc74608 WD |
515 | dit(bf(-p, --perms)) This option causes rsync to set the destination |
516 | permissions to be the same as the source permissions. | |
517 | ||
518 | Without this option, each new file gets its permissions set based on the | |
519 | source file's permissions and the umask at the receiving end, while all | |
520 | other files (including updated files) retain their existing permissions | |
521 | (which is the same behavior as other file-copy utilities, such as cp). | |
41059f75 | 522 | |
eb06fa95 MP |
523 | dit(bf(-o, --owner)) This option causes rsync to set the owner of the |
524 | destination file to be the same as the source file. On most systems, | |
fca9a9b0 DD |
525 | only the super-user can set file ownership. Note that if the remote system |
526 | is a daemon using chroot, the --numeric-ids option is implied because the | |
527 | remote system cannot get access to the usernames from /etc/passwd. | |
41059f75 | 528 | |
eb06fa95 MP |
529 | dit(bf(-g, --group)) This option causes rsync to set the group of the |
530 | destination file to be the same as the source file. If the receiving | |
531 | program is not running as the super-user, only groups that the | |
532 | receiver is a member of will be preserved (by group name, not group id | |
533 | number). | |
41059f75 AT |
534 | |
535 | dit(bf(-D, --devices)) This option causes rsync to transfer character and | |
536 | block device information to the remote system to recreate these | |
537 | devices. This option is only available to the super-user. | |
538 | ||
539 | dit(bf(-t, --times)) This tells rsync to transfer modification times along | |
baf3e504 DD |
540 | with the files and update them on the remote system. Note that if this |
541 | option is not used, the optimization that excludes files that have not been | |
542 | modified cannot be effective; in other words, a missing -t or -a will | |
543 | cause the next transfer to behave as if it used -I, and all files will have | |
544 | their checksums compared and show up in log messages even if they haven't | |
545 | changed. | |
41059f75 AT |
546 | |
547 | dit(bf(-n, --dry-run)) This tells rsync to not do any file transfers, | |
548 | instead it will just report the actions it would have taken. | |
549 | ||
550 | dit(bf(-S, --sparse)) Try to handle sparse files efficiently so they take | |
551 | up less space on the destination. | |
552 | ||
d310a212 AT |
553 | NOTE: Don't use this option when the destination is a Solaris "tmpfs" |
554 | filesystem. It doesn't seem to handle seeks over null regions | |
555 | correctly and ends up corrupting the files. | |
556 | ||
41059f75 AT |
557 | dit(bf(-x, --one-file-system)) This tells rsync not to cross filesystem |
558 | boundaries when recursing. This is useful for transferring the | |
559 | contents of only one filesystem. | |
560 | ||
1347d512 AT |
561 | dit(bf(--existing)) This tells rsync not to create any new files - |
562 | only update files that already exist on the destination. | |
563 | ||
3d6feada MP |
564 | dit(bf(--ignore-existing)) |
565 | This tells rsync not to update files that already exist on | |
566 | the destination. | |
567 | ||
0b73ca12 AT |
568 | dit(bf(--max-delete=NUM)) This tells rsync not to delete more than NUM |
569 | files or directories. This is useful when mirroring very large trees | |
570 | to prevent disasters. | |
571 | ||
41059f75 | 572 | dit(bf(--delete)) This tells rsync to delete any files on the receiving |
b33b791e DD |
573 | side that aren't on the sending side. Files that are excluded from |
574 | transfer are excluded from being deleted unless you use --delete-excluded. | |
41059f75 | 575 | |
24986abd AT |
576 | This option has no effect if directory recursion is not selected. |
577 | ||
b33b791e DD |
578 | This option can be dangerous if used incorrectly! It is a very good idea |
579 | to run first using the dry run option (-n) to see what files would be | |
580 | deleted to make sure important files aren't listed. | |
41059f75 | 581 | |
3e578a19 AT |
582 | If the sending side detects any IO errors then the deletion of any |
583 | files at the destination will be automatically disabled. This is to | |
584 | prevent temporary filesystem failures (such as NFS errors) on the | |
585 | sending side causing a massive deletion of files on the | |
2c5548d2 | 586 | destination. You can override this with the --ignore-errors option. |
41059f75 | 587 | |
b33b791e DD |
588 | dit(bf(--delete-excluded)) In addition to deleting the files on the |
589 | receiving side that are not on the sending side, this tells rsync to also | |
590 | delete any files on the receiving side that are excluded (see --exclude). | |
786c3687 | 591 | Implies --delete. |
b33b791e | 592 | |
57df171b AT |
593 | dit(bf(--delete-after)) By default rsync does file deletions before |
594 | transferring files to try to ensure that there is sufficient space on | |
595 | the receiving filesystem. If you want to delete after transferring | |
786c3687 | 596 | then use the --delete-after switch. Implies --delete. |
57df171b | 597 | |
2c5548d2 DD |
598 | dit(bf(--ignore-errors)) Tells --delete to go ahead and delete files |
599 | even when there are IO errors. | |
600 | ||
b695d088 DD |
601 | dit(bf(--force)) This options tells rsync to delete directories even if |
602 | they are not empty when they are to be replaced by non-directories. This | |
603 | is only relevant without --delete because deletions are now done depth-first. | |
604 | Requires the --recursive option (which is implied by -a) to have any effect. | |
41059f75 | 605 | |
ad911a7a | 606 | dit(bf(-B , --block-size=BLOCKSIZE)) This controls the block size used in |
41059f75 AT |
607 | the rsync algorithm. See the technical report for details. |
608 | ||
b5679335 | 609 | dit(bf(-e, --rsh=COMMAND)) This option allows you to choose an alternative |
41059f75 | 610 | remote shell program to use for communication between the local and |
1bbf83c0 WD |
611 | remote copies of rsync. Typically, rsync is configured to use rsh by |
612 | default, but you may prefer to use ssh because of its high security. | |
41059f75 | 613 | |
bef49340 WD |
614 | If this option is used with bf([user@]host::module/path), then the |
615 | remote shell em(COMMMAND) will be used to run an rsync server on the | |
616 | remote host, and all data will be transmitted through that remote | |
617 | shell connection, rather than through a direct socket connection to a | |
2d4ca358 DD |
618 | running rsync server on the remote host. See the section "CONNECTING |
619 | TO AN RSYNC SERVER OVER A REMOTE SHELL PROGRAM" above. | |
bef49340 | 620 | |
ea7f8108 WD |
621 | Command-line arguments are permitted in COMMAND provided that COMMAND is |
622 | presented to rsync as a single argument. For example: | |
98393ae2 | 623 | |
ea7f8108 | 624 | quote(-e "ssh -p 2234") |
98393ae2 WD |
625 | |
626 | (Note that ssh users can alternately customize site-specific connect | |
627 | options in their .ssh/config file.) | |
628 | ||
41059f75 | 629 | You can also choose the remote shell program using the RSYNC_RSH |
ea7f8108 | 630 | environment variable, which accepts the same range of values as -e. |
41059f75 | 631 | |
735a816e DD |
632 | See also the --blocking-io option which is affected by this option. |
633 | ||
b5679335 | 634 | dit(bf(--rsync-path=PATH)) Use this to specify the path to the copy of |
d73ee7b7 AT |
635 | rsync on the remote machine. Useful when it's not in your path. Note |
636 | that this is the full path to the binary, not just the directory that | |
637 | the binary is in. | |
41059f75 | 638 | |
f177b7cc WD |
639 | dit(bf(-C, --cvs-exclude)) This is a useful shorthand for excluding a |
640 | broad range of files that you often don't want to transfer between | |
641 | systems. It uses the same algorithm that CVS uses to determine if | |
642 | a file should be ignored. | |
643 | ||
644 | The exclude list is initialized to: | |
645 | ||
646 | quote(RCS/ SCCS/ CVS/ .svn/ CVS.adm RCSLOG cvslog.* tags TAGS .make.state | |
647 | .nse_depinfo *~ #* .#* ,* *.old *.bak *.BAK *.orig *.rej .del-* | |
648 | *.a *.o *.obj *.so *.Z *.elc *.ln core) | |
649 | ||
650 | then files listed in a $HOME/.cvsignore are added to the list and any | |
651 | files listed in the CVSIGNORE environment variable (space delimited). | |
652 | ||
653 | Finally, any file is ignored if it is in the same directory as a | |
654 | .cvsignore file and matches one of the patterns listed therein. See | |
655 | the bf(cvs(1)) manual for more information. | |
656 | ||
b5679335 | 657 | dit(bf(--exclude=PATTERN)) This option allows you to selectively exclude |
41059f75 AT |
658 | certain files from the list of files to be transferred. This is most |
659 | useful in combination with a recursive transfer. | |
660 | ||
41059f75 AT |
661 | You may use as many --exclude options on the command line as you like |
662 | to build up the list of files to exclude. | |
663 | ||
d1cce1dd | 664 | See the EXCLUDE PATTERNS section for information on the syntax of |
43bd68e5 | 665 | this option. |
41059f75 | 666 | |
b5679335 | 667 | dit(bf(--exclude-from=FILE)) This option is similar to the --exclude |
c48b22c8 AT |
668 | option, but instead it adds all exclude patterns listed in the file |
669 | FILE to the exclude list. Blank lines in FILE and lines starting with | |
670 | ';' or '#' are ignored. | |
f8a94f0d DD |
671 | If em(FILE) is bf(-) the list will be read from standard input. |
672 | ||
b5679335 | 673 | dit(bf(--include=PATTERN)) This option tells rsync to not exclude the |
43bd68e5 AT |
674 | specified pattern of filenames. This is useful as it allows you to |
675 | build up quite complex exclude/include rules. | |
676 | ||
d1cce1dd | 677 | See the EXCLUDE PATTERNS section for information on the syntax of |
43bd68e5 AT |
678 | this option. |
679 | ||
b5679335 | 680 | dit(bf(--include-from=FILE)) This specifies a list of include patterns |
43bd68e5 | 681 | from a file. |
f8a94f0d DD |
682 | If em(FILE) is bf(-) the list will be read from standard input. |
683 | ||
f177b7cc WD |
684 | dit(bf(--files-from=FILE)) Using this option allows you to specify the |
685 | exact list of files to transfer (as read from the specified FILE or "-" | |
686 | for stdin). It also tweaks the default behavior of rsync to make | |
687 | transferring just the specified files and directories easier. For | |
688 | instance, the --relative option is enabled by default when this option | |
689 | is used (use --no-relative if you want to turn that off), all | |
690 | directories specified in the list are created on the destination (rather | |
691 | than being noisily skipped without -r), and the -a (--archive) option's | |
692 | behavior does not imply -r (--recursive) -- specify it explicitly, if | |
693 | you want it. | |
694 | ||
695 | The file names that are read from the FILE are all relative to the | |
696 | source dir -- any leading slashes are removed and no ".." references are | |
697 | allowed to go higher than the source dir. For example, take this | |
698 | command: | |
699 | ||
700 | quote(rsync -a --files-from=/tmp/foo /usr remote:/backup) | |
701 | ||
702 | If /tmp/foo contains the string "bin" (or even "/bin"), the /usr/bin | |
703 | directory will be created as /backup/bin on the remote host (but the | |
704 | contents of the /usr/bin dir would not be sent unless you specified -r | |
705 | or the names were explicitly listed in /tmp/foo). Also keep in mind | |
706 | that the effect of the (enabled by default) --relative option is to | |
707 | duplicate only the path info that is read from the file -- it does not | |
708 | force the duplication of the source-spec path (/usr in this case). | |
709 | ||
710 | In addition, the --files-from file can be read from the remote host | |
711 | instead of the local host if you specify a "host:" in front of the file | |
712 | (the host must match one end of the transfer). As a short-cut, you can | |
713 | specify just a prefix of ":" to mean "use the remote end of the | |
714 | transfer". For example: | |
715 | ||
716 | quote(rsync -a --files-from=:/path/file-list src:/ /tmp/copy) | |
717 | ||
718 | This would copy all the files specified in the /path/file-list file that | |
719 | was located on the remote "src" host. | |
720 | ||
721 | dit(bf(-0, --from0)) This tells rsync that the filenames it reads from a | |
722 | file are terminated by a null ('\0') character, not a NL, CR, or CR+LF. | |
723 | This affects --exclude-from, --include-from, and --files-from. | |
41059f75 | 724 | |
b5679335 | 725 | dit(bf(-T, --temp-dir=DIR)) This option instructs rsync to use DIR as a |
375a4556 | 726 | scratch directory when creating temporary copies of the files |
41059f75 AT |
727 | transferred on the receiving side. The default behavior is to create |
728 | the temporary files in the receiving directory. | |
729 | ||
3473b5b4 DD |
730 | dit(bf(--compare-dest=DIR)) This option instructs rsync to use DIR on |
731 | the destination machine as an additional directory to compare destination | |
d53d7795 DD |
732 | files against when doing transfers if the files are missing in the |
733 | destination directory. This is useful for doing transfers to a new | |
734 | destination while leaving existing files intact, and then doing a | |
3473b5b4 DD |
735 | flash-cutover when all files have been successfully transferred (for |
736 | example by moving directories around and removing the old directory, | |
d53d7795 DD |
737 | although this skips files that haven't changed; see also --link-dest). |
738 | This option increases the usefulness of --partial because partially | |
739 | transferred files will remain in the new temporary destination until they | |
740 | have a chance to be completed. If DIR is a relative path, it is relative | |
741 | to the destination directory. | |
375a4556 | 742 | |
59c95e42 DD |
743 | dit(bf(--link-dest=DIR)) This option behaves like bf(--compare-dest) but |
744 | also will create hard links from em(DIR) to the destination directory for | |
745 | unchanged files. Files with changed ownership or permissions will not be | |
746 | linked. | |
d31c09c8 S |
747 | Like bf(--compare-dest) if DIR is a relative path, it is relative |
748 | to the destination directory. | |
59c95e42 | 749 | |
41059f75 | 750 | dit(bf(-z, --compress)) With this option, rsync compresses any data from |
089e73f8 | 751 | the files that it sends to the destination machine. This |
f39281ae | 752 | option is useful on slow connections. The compression method used is the |
41059f75 AT |
753 | same method that gzip uses. |
754 | ||
755 | Note this this option typically achieves better compression ratios | |
756 | that can be achieved by using a compressing remote shell, or a | |
757 | compressing transport, as it takes advantage of the implicit | |
758 | information sent for matching data blocks. | |
759 | ||
760 | dit(bf(--numeric-ids)) With this option rsync will transfer numeric group | |
761 | and user ids rather than using user and group names and mapping them | |
762 | at both ends. | |
763 | ||
764 | By default rsync will use the user name and group name to determine | |
765 | what ownership to give files. The special uid 0 and the special group | |
14d43f1f | 766 | 0 are never mapped via user/group names even if the --numeric-ids |
41059f75 AT |
767 | option is not specified. |
768 | ||
eb06fa95 MP |
769 | If the source system is a daemon using chroot, or if a user or group |
770 | name does not exist on the destination system, then the numeric id | |
771 | from the source system is used instead. | |
41059f75 | 772 | |
de2fd20e AT |
773 | dit(bf(--timeout=TIMEOUT)) This option allows you to set a maximum IO |
774 | timeout in seconds. If no data is transferred for the specified time | |
775 | then rsync will exit. The default is 0, which means no timeout. | |
41059f75 | 776 | |
eb06fa95 MP |
777 | dit(bf(--daemon)) This tells rsync that it is to run as a daemon. The |
778 | daemon may be accessed using the bf(host::module) or | |
779 | bf(rsync://host/module/) syntax. | |
780 | ||
781 | If standard input is a socket then rsync will assume that it is being | |
782 | run via inetd, otherwise it will detach from the current terminal and | |
783 | become a background daemon. The daemon will read the config file | |
30e8c8e1 | 784 | (rsyncd.conf) on each connect made by a client and respond to |
eb06fa95 MP |
785 | requests accordingly. See the rsyncd.conf(5) man page for more |
786 | details. | |
41059f75 | 787 | |
bbd6f4ba MP |
788 | dit(bf(--no-detach)) When running as a daemon, this option instructs |
789 | rsync to not detach itself and become a background process. This | |
790 | option is required when running as a service on Cygwin, and may also | |
791 | be useful when rsync is supervised by a program such as | |
792 | bf(daemontools) or AIX's bf(System Resource Controller). | |
793 | bf(--no-detach) is also recommended when rsync is run under a | |
794 | debugger. This option has no effect if rsync is run from inetd or | |
795 | sshd. | |
796 | ||
5c9730a4 | 797 | dit(bf(--address)) By default rsync will bind to the wildcard address |
e30f0657 AT |
798 | when run as a daemon with the --daemon option or when connecting to a |
799 | rsync server. The --address option allows you to specify a specific IP | |
800 | address (or hostname) to bind to. This makes virtual hosting possible | |
801 | in conjunction with the --config option. | |
5c9730a4 | 802 | |
b5679335 | 803 | dit(bf(--config=FILE)) This specifies an alternate config file than |
30e8c8e1 DD |
804 | the default. This is only relevant when --daemon is specified. |
805 | The default is /etc/rsyncd.conf unless the daemon is running over | |
806 | a remote shell program and the remote user is not root; in that case | |
807 | the default is rsyncd.conf in the current directory (typically $HOME). | |
41059f75 | 808 | |
b5679335 | 809 | dit(bf(--port=PORT)) This specifies an alternate TCP port number to use |
14d43f1f | 810 | rather than the default port 873. |
41059f75 | 811 | |
735a816e DD |
812 | dit(bf(--blocking-io)) This tells rsync to use blocking IO when launching |
813 | a remote shell transport. If -e or --rsh are not specified or are set to | |
814 | the default "rsh", this defaults to blocking IO, otherwise it defaults to | |
815 | non-blocking IO. You may find the --blocking-io option is needed for some | |
1bbf83c0 WD |
816 | remote shells that can't handle non-blocking IO. (Note that ssh prefers |
817 | non-blocking IO.) | |
64c704f0 | 818 | |
93689aa5 DD |
819 | dit(bf(--no-blocking-io)) Turn off --blocking-io, for use when it is the |
820 | default. | |
821 | ||
3a64ad1f | 822 | dit(bf(--log-format=FORMAT)) This allows you to specify exactly what the |
14d43f1f | 823 | rsync client logs to stdout on a per-file basis. The log format is |
3a64ad1f DD |
824 | specified using the same format conventions as the log format option in |
825 | rsyncd.conf. | |
b6062654 | 826 | |
b72f24c7 AT |
827 | dit(bf(--stats)) This tells rsync to print a verbose set of statistics |
828 | on the file transfer, allowing you to tell how effective the rsync | |
e19452a9 | 829 | algorithm is for your data. |
b72f24c7 | 830 | |
d9fcc198 AT |
831 | dit(bf(--partial)) By default, rsync will delete any partially |
832 | transferred file if the transfer is interrupted. In some circumstances | |
833 | it is more desirable to keep partially transferred files. Using the | |
834 | --partial option tells rsync to keep the partial file which should | |
835 | make a subsequent transfer of the rest of the file much faster. | |
836 | ||
eb86d661 AT |
837 | dit(bf(--progress)) This option tells rsync to print information |
838 | showing the progress of the transfer. This gives a bored user | |
839 | something to watch. | |
e2559dbe | 840 | Implies --verbose without incrementing verbosity. |
7b10f91d | 841 | |
d9fcc198 AT |
842 | dit(bf(-P)) The -P option is equivalent to --partial --progress. I |
843 | found myself typing that combination quite often so I created an | |
844 | option to make it easier. | |
845 | ||
65575e96 AT |
846 | dit(bf(--password-file)) This option allows you to provide a password |
847 | in a file for accessing a remote rsync server. Note that this option | |
848 | is only useful when accessing a rsync server using the built in | |
849 | transport, not when using a remote shell as the transport. The file | |
fc7952e7 AT |
850 | must not be world readable. It should contain just the password as a |
851 | single line. | |
65575e96 | 852 | |
ef5d23eb DD |
853 | dit(bf(--bwlimit=KBPS)) This option allows you to specify a maximum |
854 | transfer rate in kilobytes per second. This option is most effective when | |
855 | using rsync with large files (several megabytes and up). Due to the nature | |
856 | of rsync transfers, blocks of data are sent, then if rsync determines the | |
857 | transfer was too fast, it will wait before sending the next data block. The | |
858 | result is an average transfer rate equalling the specified limit. A value | |
859 | of zero specifies no limit. | |
860 | ||
088aac85 DD |
861 | dit(bf(--write-batch=PREFIX)) Generate a set of files that can be |
862 | transferred as a batch update. Each filename in the set starts with | |
863 | PREFIX. See the "BATCH MODE" section for details. | |
6902ed17 | 864 | |
088aac85 DD |
865 | dit(bf(--read-batch=PREFIX)) Apply a previously generated change batch, |
866 | using the fileset whose filenames start with PREFIX. See the "BATCH | |
867 | MODE" section for details. | |
6902ed17 | 868 | |
41059f75 AT |
869 | enddit() |
870 | ||
43bd68e5 AT |
871 | manpagesection(EXCLUDE PATTERNS) |
872 | ||
873 | The exclude and include patterns specified to rsync allow for flexible | |
14d43f1f | 874 | selection of which files to transfer and which files to skip. |
43bd68e5 | 875 | |
eb06fa95 | 876 | rsync builds an ordered list of include/exclude options as specified on |
98606687 | 877 | the command line. Rsync checks each file and directory |
43bd68e5 | 878 | name against each exclude/include pattern in turn. The first matching |
23489269 | 879 | pattern is acted on. If it is an exclude pattern, then that file is |
43bd68e5 AT |
880 | skipped. If it is an include pattern then that filename is not |
881 | skipped. If no matching include/exclude pattern is found then the | |
882 | filename is not skipped. | |
883 | ||
98606687 S |
884 | The filenames matched against the exclude/include patterns |
885 | are relative to the destination directory, or "top | |
886 | directory", so patterns should not include the path elements | |
887 | of the source or destination directories. The only way in | |
888 | which a pattern will match the absolute path of a file or | |
889 | directory is if the source path is the root directory. | |
d1cce1dd | 890 | |
27b9a19b DD |
891 | Note that when used with -r (which is implied by -a), every subcomponent of |
892 | every path is visited from top down, so include/exclude patterns get | |
893 | applied recursively to each subcomponent. | |
894 | ||
895 | Note also that the --include and --exclude options take one pattern | |
2fb139c1 AT |
896 | each. To add multiple patterns use the --include-from and |
897 | --exclude-from options or multiple --include and --exclude options. | |
898 | ||
14d43f1f | 899 | The patterns can take several forms. The rules are: |
43bd68e5 AT |
900 | |
901 | itemize( | |
d1cce1dd | 902 | |
43bd68e5 AT |
903 | it() if the pattern starts with a / then it is matched against the |
904 | start of the filename, otherwise it is matched against the end of | |
d1cce1dd S |
905 | the filename. |
906 | This is the equivalent of a leading ^ in regular expressions. | |
98606687 | 907 | Thus "/foo" would match a file called "foo" at the top of the |
b7dc46c0 | 908 | transferred tree. |
d1cce1dd | 909 | On the other hand, "foo" would match any file called "foo" |
27b9a19b DD |
910 | anywhere in the tree because the algorithm is applied recursively from |
911 | top down; it behaves as if each path component gets a turn at being the | |
912 | end of the file name. | |
d1cce1dd | 913 | The leading / does not make the pattern an absolute pathname. |
43bd68e5 AT |
914 | |
915 | it() if the pattern ends with a / then it will only match a | |
916 | directory, not a file, link or device. | |
917 | ||
918 | it() if the pattern contains a wildcard character from the set | |
a8b9d4ed DD |
919 | *?[ then expression matching is applied using the shell filename |
920 | matching rules. Otherwise a simple string match is used. | |
43bd68e5 | 921 | |
8a7846f9 WD |
922 | it() the double asterisk pattern "**" will match slashes while a |
923 | single asterisk pattern "*" will stop at slashes. | |
27b9a19b | 924 | |
38499c1a WD |
925 | it() if the pattern contains a / (not counting a trailing /) or a "**" |
926 | then it is matched against the full filename, including any leading | |
927 | directory. If the pattern doesn't contain a / or a "**", then it is | |
928 | matched only against the final component of the filename. Again, | |
929 | remember that the algorithm is applied recursively so "full filename" can | |
8a7846f9 | 930 | actually be any portion of a path below the starting directory. |
43bd68e5 AT |
931 | |
932 | it() if the pattern starts with "+ " (a plus followed by a space) | |
5a554d5b | 933 | then it is always considered an include pattern, even if specified as |
43bd68e5 AT |
934 | part of an exclude option. The "+ " part is discarded before matching. |
935 | ||
936 | it() if the pattern starts with "- " (a minus followed by a space) | |
5a554d5b | 937 | then it is always considered an exclude pattern, even if specified as |
43bd68e5 | 938 | part of an include option. The "- " part is discarded before matching. |
de2fd20e AT |
939 | |
940 | it() if the pattern is a single exclamation mark ! then the current | |
eb06fa95 | 941 | include/exclude list is reset, removing all previously defined patterns. |
43bd68e5 AT |
942 | ) |
943 | ||
b7dc46c0 WD |
944 | The +/- rules are most useful in a list that was read from a file, allowing |
945 | you to have a single exclude list that contains both include and exclude | |
946 | options. | |
27b9a19b DD |
947 | |
948 | If you end an exclude list with --exclude '*', note that since the | |
949 | algorithm is applied recursively that unless you explicitly include | |
950 | parent directories of files you want to include then the algorithm | |
951 | will stop at the parent directories and never see the files below | |
952 | them. To include all directories, use --include '*/' before the | |
953 | --exclude '*'. | |
43bd68e5 | 954 | |
328fcf11 | 955 | Here are some exclude/include examples: |
43bd68e5 AT |
956 | |
957 | itemize( | |
958 | it() --exclude "*.o" would exclude all filenames matching *.o | |
98606687 | 959 | it() --exclude "/foo" would exclude a file called foo in the top directory |
43bd68e5 | 960 | it() --exclude "foo/" would exclude any directory called foo |
a8b9d4ed | 961 | it() --exclude "/foo/*/bar" would exclude any file called bar two |
98606687 | 962 | levels below a directory called foo in the top directory |
a8b9d4ed | 963 | it() --exclude "/foo/**/bar" would exclude any file called bar two |
98606687 | 964 | or more levels below a directory called foo in the top directory |
43bd68e5 | 965 | it() --include "*/" --include "*.c" --exclude "*" would include all |
5d5811f7 DD |
966 | directories and C source files |
967 | it() --include "foo/" --include "foo/bar.c" --exclude "*" would include | |
968 | only foo/bar.c (the foo/ directory must be explicitly included or | |
969 | it would be excluded by the "*") | |
43bd68e5 AT |
970 | ) |
971 | ||
6902ed17 MP |
972 | manpagesection(BATCH MODE) |
973 | ||
2e3c1417 | 974 | bf(Note:) Batch mode should be considered experimental in this version |
088aac85 DD |
975 | of rsync. The interface or behaviour may change before it stabilizes. |
976 | ||
977 | Batch mode can be used to apply the same set of updates to many | |
978 | identical systems. Suppose one has a tree which is replicated on a | |
979 | number of hosts. Now suppose some changes have been made to this | |
980 | source tree and those changes need to be propagated to the other | |
981 | hosts. In order to do this using batch mode, rsync is run with the | |
982 | write-batch option to apply the changes made to the source tree to one | |
983 | of the destination trees. The write-batch option causes the rsync | |
984 | client to store the information needed to repeat this operation against | |
985 | other destination trees in a batch update fileset (see below). The | |
986 | filename of each file in the fileset starts with a prefix specified by | |
987 | the user as an argument to the write-batch option. This fileset is | |
988 | then copied to each remote host, where rsync is run with the read-batch | |
989 | option, again specifying the same prefix, and the destination tree. | |
990 | Rsync updates the destination tree using the information stored in the | |
991 | batch update fileset. | |
992 | ||
993 | The fileset consists of 4 files: | |
2e3c1417 | 994 | |
088aac85 DD |
995 | itemize( |
996 | it() bf(<prefix>.rsync_argvs) command-line arguments | |
997 | it() bf(<prefix>.rsync_flist) rsync internal file metadata | |
998 | it() bf(<prefix>.rsync_csums) rsync checksums | |
999 | it() bf(<prefix>.rsync_delta) data blocks for file update & change | |
6902ed17 MP |
1000 | ) |
1001 | ||
088aac85 DD |
1002 | The .rsync_argvs file contains a command-line suitable for updating a |
1003 | destination tree using that batch update fileset. It can be executed | |
1004 | using a Bourne(-like) shell, optionally passing in an alternate | |
1005 | destination tree pathname which is then used instead of the original | |
1006 | path. This is useful when the destination tree path differs from the | |
1007 | original destination tree path. | |
6902ed17 | 1008 | |
088aac85 DD |
1009 | Generating the batch update fileset once saves having to perform the |
1010 | file status, checksum and data block generation more than once when | |
1011 | updating multiple destination trees. Multicast transport protocols can | |
1012 | be used to transfer the batch update files in parallel to many hosts at | |
1013 | once, instead of sending the same data to every host individually. | |
1014 | ||
1015 | Example: | |
1016 | ||
1017 | verb( | |
8a78bb96 | 1018 | $ rsync --write-batch=pfx -a /source/dir/ /adest/dir/ |
088aac85 | 1019 | $ rcp pfx.rsync_* remote: |
8a78bb96 | 1020 | $ rsh remote rsync --read-batch=pfx -a /bdest/dir/ |
088aac85 DD |
1021 | # or alternatively |
1022 | $ rsh remote ./pfx.rsync_argvs /bdest/dir/ | |
6902ed17 MP |
1023 | ) |
1024 | ||
088aac85 DD |
1025 | In this example, rsync is used to update /adest/dir/ with /source/dir/ |
1026 | and the information to repeat this operation is stored in the files | |
1027 | pfx.rsync_*. These files are then copied to the machine named "remote". | |
1028 | Rsync is then invoked on "remote" to update /bdest/dir/ the same way as | |
1029 | /adest/dir/. The last line shows the rsync_argvs file being used to | |
1030 | invoke rsync. | |
1031 | ||
1032 | Caveats: | |
1033 | ||
1034 | The read-batch option expects the destination tree it is meant to update | |
1035 | to be identical to the destination tree that was used to create the | |
1036 | batch update fileset. When a difference between the destination trees | |
1037 | is encountered the update will fail at that point, leaving the | |
1038 | destination tree in a partially updated state. In that case, rsync can | |
1039 | be used in its regular (non-batch) mode of operation to fix up the | |
1040 | destination tree. | |
1041 | ||
1042 | The rsync version used on all destinations should be identical to the | |
1043 | one used on the original destination. | |
1044 | ||
1045 | The -z/--compress option does not work in batch mode and yields a usage | |
1046 | error. A separate compression tool can be used instead to reduce the | |
1047 | size of the batch update files for transport to the destination. | |
1048 | ||
1049 | The -n/--dryrun option does not work in batch mode and yields a runtime | |
1050 | error. | |
1051 | ||
6902ed17 MP |
1052 | See bf(http://www.ils.unc.edu/i2dsi/unc_rsync+.html) for papers and technical |
1053 | reports. | |
1054 | ||
eb06fa95 MP |
1055 | manpagesection(SYMBOLIC LINKS) |
1056 | ||
1057 | Three basic behaviours are possible when rsync encounters a symbolic | |
1058 | link in the source directory. | |
1059 | ||
1060 | By default, symbolic links are not transferred at all. A message | |
1061 | "skipping non-regular" file is emitted for any symlinks that exist. | |
1062 | ||
1063 | If bf(--links) is specified, then symlinks are recreated with the same | |
1064 | target on the destination. Note that bf(--archive) implies | |
1065 | bf(--links). | |
1066 | ||
1067 | If bf(--copy-links) is specified, then symlinks are "collapsed" by | |
1068 | copying their referent, rather than the symlink. | |
1069 | ||
1070 | rsync also distinguishes "safe" and "unsafe" symbolic links. An | |
1071 | example where this might be used is a web site mirror that wishes | |
1072 | ensure the rsync module they copy does not include symbolic links to | |
1073 | bf(/etc/passwd) in the public section of the site. Using | |
1074 | bf(--copy-unsafe-links) will cause any links to be copied as the file | |
1075 | they point to on the destination. Using bf(--safe-links) will cause | |
1076 | unsafe links to be ommitted altogether. | |
1077 | ||
7bd0cf5b MP |
1078 | Symbolic links are considered unsafe if they are absolute symlinks |
1079 | (start with bf(/)), empty, or if they contain enough bf("..") | |
1080 | components to ascend from the directory being copied. | |
1081 | ||
d310a212 AT |
1082 | manpagesection(DIAGNOSTICS) |
1083 | ||
14d43f1f | 1084 | rsync occasionally produces error messages that may seem a little |
d310a212 AT |
1085 | cryptic. The one that seems to cause the most confusion is "protocol |
1086 | version mismatch - is your shell clean?". | |
1087 | ||
1088 | This message is usually caused by your startup scripts or remote shell | |
1089 | facility producing unwanted garbage on the stream that rsync is using | |
14d43f1f | 1090 | for its transport. The way to diagnose this problem is to run your |
d310a212 AT |
1091 | remote shell like this: |
1092 | ||
1093 | verb( | |
1094 | rsh remotehost /bin/true > out.dat | |
1095 | ) | |
1096 | ||
1097 | then look at out.dat. If everything is working correctly then out.dat | |
2cfeab21 | 1098 | should be a zero length file. If you are getting the above error from |
d310a212 AT |
1099 | rsync then you will probably find that out.dat contains some text or |
1100 | data. Look at the contents and try to work out what is producing | |
14d43f1f | 1101 | it. The most common cause is incorrectly configured shell startup |
d310a212 AT |
1102 | scripts (such as .cshrc or .profile) that contain output statements |
1103 | for non-interactive logins. | |
1104 | ||
e6c64e79 MP |
1105 | If you are having trouble debugging include and exclude patterns, then |
1106 | try specifying the -vv option. At this level of verbosity rsync will | |
1107 | show why each individual file is included or excluded. | |
1108 | ||
55b64e4b MP |
1109 | manpagesection(EXIT VALUES) |
1110 | ||
1111 | startdit() | |
a73de5f3 WD |
1112 | dit(bf(0)) Success |
1113 | dit(bf(1)) Syntax or usage error | |
1114 | dit(bf(2)) Protocol incompatibility | |
1115 | dit(bf(3)) Errors selecting input/output files, dirs | |
1116 | dit(bf(4)) Requested action not supported: an attempt | |
8212336a MP |
1117 | was made to manipulate 64-bit files on a platform that cannot support |
1118 | them; or an option was speciifed that is supported by the client and | |
1119 | not by the server. | |
a73de5f3 WD |
1120 | dit(bf(5)) Error starting client-server protocol |
1121 | dit(bf(10)) Error in socket IO | |
1122 | dit(bf(11)) Error in file IO | |
1123 | dit(bf(12)) Error in rsync protocol data stream | |
1124 | dit(bf(13)) Errors with program diagnostics | |
1125 | dit(bf(14)) Error in IPC code | |
1126 | dit(bf(20)) Received SIGUSR1 or SIGINT | |
1127 | dit(bf(21)) Some error returned by waitpid() | |
1128 | dit(bf(22)) Error allocating core memory buffers | |
1129 | dit(bf(23)) Partial transfer | |
1130 | dit(bf(30)) Timeout in data send/receive | |
55b64e4b MP |
1131 | enddit() |
1132 | ||
de2fd20e AT |
1133 | manpagesection(ENVIRONMENT VARIABLES) |
1134 | ||
1135 | startdit() | |
1136 | ||
1137 | dit(bf(CVSIGNORE)) The CVSIGNORE environment variable supplements any | |
1138 | ignore patterns in .cvsignore files. See the --cvs-exclude option for | |
1139 | more details. | |
1140 | ||
1141 | dit(bf(RSYNC_RSH)) The RSYNC_RSH environment variable allows you to | |
ea7f8108 WD |
1142 | override the default shell used as the transport for rsync. Command line |
1143 | options are permitted after the command name, just as in the -e option. | |
de2fd20e | 1144 | |
4c3b4b25 AT |
1145 | dit(bf(RSYNC_PROXY)) The RSYNC_PROXY environment variable allows you to |
1146 | redirect your rsync client to use a web proxy when connecting to a | |
1147 | rsync daemon. You should set RSYNC_PROXY to a hostname:port pair. | |
1148 | ||
de2fd20e AT |
1149 | dit(bf(RSYNC_PASSWORD)) Setting RSYNC_PASSWORD to the required |
1150 | password allows you to run authenticated rsync connections to a rsync | |
1151 | daemon without user intervention. Note that this does not supply a | |
1152 | password to a shell transport such as ssh. | |
1153 | ||
1154 | dit(bf(USER) or bf(LOGNAME)) The USER or LOGNAME environment variables | |
1155 | are used to determine the default username sent to a rsync server. | |
1156 | ||
14d43f1f | 1157 | dit(bf(HOME)) The HOME environment variable is used to find the user's |
de2fd20e AT |
1158 | default .cvsignore file. |
1159 | ||
1160 | enddit() | |
1161 | ||
41059f75 AT |
1162 | manpagefiles() |
1163 | ||
30e8c8e1 | 1164 | /etc/rsyncd.conf or rsyncd.conf |
41059f75 AT |
1165 | |
1166 | manpageseealso() | |
1167 | ||
1168 | rsyncd.conf(5) | |
1169 | ||
1170 | manpagediagnostics() | |
1171 | ||
1172 | manpagebugs() | |
1173 | ||
1174 | times are transferred as unix time_t values | |
1175 | ||
38843171 DD |
1176 | When transferring to FAT filesystmes rsync may resync |
1177 | unmodified files. | |
1178 | See the comments on the --modify-window option. | |
1179 | ||
41059f75 AT |
1180 | file permissions, devices etc are transferred as native numerical |
1181 | values | |
1182 | ||
a87b3b2a | 1183 | see also the comments on the --delete option |
41059f75 | 1184 | |
38843171 DD |
1185 | Please report bugs! See the website at |
1186 | url(http://rsync.samba.org/)(http://rsync.samba.org/) | |
41059f75 AT |
1187 | |
1188 | manpagesection(CREDITS) | |
1189 | ||
1190 | rsync is distributed under the GNU public license. See the file | |
1191 | COPYING for details. | |
1192 | ||
41059f75 | 1193 | A WEB site is available at |
3cd5eb3b MP |
1194 | url(http://rsync.samba.org/)(http://rsync.samba.org/). The site |
1195 | includes an FAQ-O-Matic which may cover questions unanswered by this | |
1196 | manual page. | |
9e3c856a AT |
1197 | |
1198 | The primary ftp site for rsync is | |
1199 | url(ftp://rsync.samba.org/pub/rsync)(ftp://rsync.samba.org/pub/rsync). | |
41059f75 AT |
1200 | |
1201 | We would be delighted to hear from you if you like this program. | |
1202 | ||
9e3c856a AT |
1203 | This program uses the excellent zlib compression library written by |
1204 | Jean-loup Gailly and Mark Adler. | |
41059f75 AT |
1205 | |
1206 | manpagesection(THANKS) | |
1207 | ||
1208 | Thanks to Richard Brent, Brendan Mackay, Bill Waite, Stephen Rothwell | |
7ff701e8 MP |
1209 | and David Bell for helpful suggestions, patches and testing of rsync. |
1210 | I've probably missed some people, my apologies if I have. | |
1211 | ||
1212 | Especial thanks also to: David Dykstra, Jos Backus, Sebastian Krahmer. | |
41059f75 AT |
1213 | |
1214 | ||
1215 | manpageauthor() | |
1216 | ||
7ff701e8 MP |
1217 | rsync was written by Andrew Tridgell <tridge@samba.org> and Paul |
1218 | Mackerras. | |
3cd5eb3b | 1219 | |
7ff701e8 | 1220 | rsync is now maintained by Martin Pool <mbp@samba.org>. |
3cd5eb3b | 1221 | |
a5d74a18 | 1222 | Mailing lists for support and development are available at |
7ff701e8 MP |
1223 | url(http://lists.samba.org)(lists.samba.org) |
1224 | ||
1225 | If you suspect you have found a security vulnerability in rsync, | |
1226 | please send it directly to Martin Pool and Andrew Tridgell. For other | |
1227 | enquiries, please use the mailing list. |