Commit | Line | Data |
---|---|---|
9e3c856a | 1 | mailto(rsync-bugs@samba.org) |
618c8a73 | 2 | manpage(rsync)(1)(30 Sep 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 | |
675ef1aa WD |
24 | greatly speed up file transfers when the destination file is being |
25 | updated. | |
41059f75 AT |
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 | |
41059f75 | 52 | it() for copying from the local machine to a remote machine using |
43cd760f WD |
53 | a remote shell program as the transport (such as ssh or |
54 | rsh). This is invoked when the destination path contains a | |
41059f75 | 55 | single : separator. |
41059f75 | 56 | it() for copying from a remote machine to the local machine |
6c7c2ef3 | 57 | using a remote shell program. This is invoked when the source |
41059f75 | 58 | contains a : separator. |
41059f75 AT |
59 | it() for copying from a remote rsync server to the local |
60 | machine. This is invoked when the source path contains a :: | |
bb18e755 | 61 | separator or an rsync:// URL. |
41059f75 AT |
62 | it() for copying from the local machine to a remote rsync |
63 | server. This is invoked when the destination path contains a :: | |
bb18e755 | 64 | separator or an rsync:// URL. |
bef49340 WD |
65 | it() for copying from a remote machine using a remote shell |
66 | program as the transport, using rsync server on the remote | |
67 | machine. This is invoked when the source path contains a :: | |
faa82484 | 68 | separator and the bf(--rsh=COMMAND) (aka "bf(-e COMMAND)") option is |
bef49340 | 69 | also provided. |
bef49340 WD |
70 | it() for copying from the local machine to a remote machine |
71 | using a remote shell program as the transport, using rsync | |
72 | server on the remote machine. This is invoked when the | |
73 | destination path contains a :: separator and the | |
faa82484 | 74 | bf(--rsh=COMMAND) option is also provided. |
039faa86 AT |
75 | it() for listing files on a remote machine. This is done the |
76 | same way as rsync transfers except that you leave off the | |
faa82484 | 77 | local destination. |
41059f75 AT |
78 | ) |
79 | ||
14d43f1f DD |
80 | Note that in all cases (other than listing) at least one of the source |
81 | and destination paths must be local. | |
41059f75 AT |
82 | |
83 | manpagesection(SETUP) | |
84 | ||
85 | See the file README for installation instructions. | |
86 | ||
1bbf83c0 WD |
87 | Once installed, you can use rsync to any machine that you can access via |
88 | a remote shell (as well as some that you can access using the rsync | |
43cd760f | 89 | daemon-mode protocol). For remote transfers, a modern rsync uses ssh |
1bbf83c0 | 90 | for its communications, but it may have been configured to use a |
43cd760f | 91 | different remote shell by default, such as rsh or remsh. |
41059f75 | 92 | |
faa82484 | 93 | You can also specify any remote shell you like, either by using the bf(-e) |
41059f75 AT |
94 | command line option, or by setting the RSYNC_RSH environment variable. |
95 | ||
96 | One common substitute is to use ssh, which offers a high degree of | |
97 | security. | |
98 | ||
8e987130 | 99 | Note that rsync must be installed on both the source and destination |
faa82484 | 100 | machines. |
8e987130 | 101 | |
41059f75 AT |
102 | manpagesection(USAGE) |
103 | ||
104 | You use rsync in the same way you use rcp. You must specify a source | |
105 | and a destination, one of which may be remote. | |
106 | ||
4d888108 | 107 | Perhaps the best way to explain the syntax is with some examples: |
41059f75 | 108 | |
faa82484 | 109 | quote(tt(rsync -t *.c foo:src/)) |
41059f75 | 110 | |
8a97fc2e | 111 | This would transfer all files matching the pattern *.c from the |
41059f75 AT |
112 | current directory to the directory src on the machine foo. If any of |
113 | the files already exist on the remote system then the rsync | |
114 | remote-update protocol is used to update the file by sending only the | |
115 | differences. See the tech report for details. | |
116 | ||
faa82484 | 117 | quote(tt(rsync -avz foo:src/bar /data/tmp)) |
41059f75 | 118 | |
8a97fc2e | 119 | This would recursively transfer all files from the directory src/bar on the |
41059f75 AT |
120 | machine foo into the /data/tmp/bar directory on the local machine. The |
121 | files are transferred in "archive" mode, which ensures that symbolic | |
b5accaba | 122 | links, devices, attributes, permissions, ownerships, etc. are preserved |
14d43f1f | 123 | in the transfer. Additionally, compression will be used to reduce the |
41059f75 AT |
124 | size of data portions of the transfer. |
125 | ||
faa82484 | 126 | quote(tt(rsync -avz foo:src/bar/ /data/tmp)) |
41059f75 | 127 | |
8a97fc2e WD |
128 | A trailing slash on the source changes this behavior to avoid creating an |
129 | additional directory level at the destination. You can think of a trailing | |
130 | / on a source as meaning "copy the contents of this directory" as opposed | |
131 | to "copy the directory by name", but in both cases the attributes of the | |
132 | containing directory are transferred to the containing directory on the | |
133 | destination. In other words, each of the following commands copies the | |
134 | files in the same way, including their setting of the attributes of | |
135 | /dest/foo: | |
136 | ||
faa82484 WD |
137 | quote( |
138 | tt(rsync -av /src/foo /dest)nl() | |
139 | tt(rsync -av /src/foo/ /dest/foo)nl() | |
140 | ) | |
41059f75 AT |
141 | |
142 | You can also use rsync in local-only mode, where both the source and | |
143 | destination don't have a ':' in the name. In this case it behaves like | |
144 | an improved copy command. | |
145 | ||
faa82484 | 146 | quote(tt(rsync somehost.mydomain.com::)) |
14d43f1f | 147 | |
8a97fc2e | 148 | This would list all the anonymous rsync modules available on the host |
14d43f1f DD |
149 | somehost.mydomain.com. (See the following section for more details.) |
150 | ||
675ef1aa WD |
151 | manpagesection(ADVANCED USAGE) |
152 | ||
153 | The syntax for requesting multiple files from a remote host involves using | |
154 | quoted spaces in the SRC. Some examples: | |
155 | ||
faa82484 | 156 | quote(tt(rsync host::'modname/dir1/file1 modname/dir2/file2' /dest)) |
675ef1aa WD |
157 | |
158 | This would copy file1 and file2 into /dest from an rsync daemon. Each | |
159 | additional arg must include the same "modname/" prefix as the first one, | |
160 | and must be preceded by a single space. All other spaces are assumed | |
161 | to be a part of the filenames. | |
162 | ||
faa82484 | 163 | quote(tt(rsync -av host:'dir1/file1 dir2/file2' /dest)) |
675ef1aa WD |
164 | |
165 | This would copy file1 and file2 into /dest using a remote shell. This | |
166 | word-splitting is done by the remote shell, so if it doesn't work it means | |
167 | that the remote shell isn't configured to split its args based on | |
168 | whitespace (a very rare setting, but not unknown). If you need to transfer | |
169 | a filename that contains whitespace, you'll need to either escape the | |
170 | whitespace in a way that the remote shell will understand, or use wildcards | |
171 | in place of the spaces. Two examples of this are: | |
172 | ||
faa82484 WD |
173 | quote( |
174 | tt(rsync -av host:'file\ name\ with\ spaces' /dest)nl() | |
175 | tt(rsync -av host:file?name?with?spaces /dest)nl() | |
176 | ) | |
675ef1aa WD |
177 | |
178 | This latter example assumes that your shell passes through unmatched | |
179 | wildcards. If it complains about "no match", put the name in quotes. | |
180 | ||
41059f75 AT |
181 | manpagesection(CONNECTING TO AN RSYNC SERVER) |
182 | ||
1bbf83c0 | 183 | It is also possible to use rsync without a remote shell as the |
41059f75 | 184 | transport. In this case you will connect to a remote rsync server |
faa82484 | 185 | running on TCP port 873. |
41059f75 | 186 | |
eb06fa95 | 187 | You may establish the connection via a web proxy by setting the |
4c3b4b25 | 188 | environment variable RSYNC_PROXY to a hostname:port pair pointing to |
4d888108 WD |
189 | your web proxy. Note that your web proxy's configuration must support |
190 | proxy connections to port 873. | |
4c3b4b25 | 191 | |
1bbf83c0 | 192 | Using rsync in this way is the same as using it with a remote shell except |
41059f75 AT |
193 | that: |
194 | ||
195 | itemize( | |
196 | it() you use a double colon :: instead of a single colon to | |
bb18e755 | 197 | separate the hostname from the path or an rsync:// URL. |
41059f75 | 198 | it() the remote server may print a message of the day when you |
14d43f1f | 199 | connect. |
41059f75 AT |
200 | it() if you specify no path name on the remote server then the |
201 | list of accessible paths on the server will be shown. | |
f7632fc6 | 202 | it() if you specify no local destination then a listing of the |
14d43f1f | 203 | specified files on the remote server is provided. |
41059f75 AT |
204 | ) |
205 | ||
4c3d16be AT |
206 | Some paths on the remote server may require authentication. If so then |
207 | you will receive a password prompt when you connect. You can avoid the | |
208 | password prompt by setting the environment variable RSYNC_PASSWORD to | |
faa82484 | 209 | the password you want to use or using the bf(--password-file) option. This |
65575e96 | 210 | may be useful when scripting rsync. |
4c3d16be | 211 | |
3bc67f0c | 212 | WARNING: On some systems environment variables are visible to all |
faa82484 | 213 | users. On those systems using bf(--password-file) is recommended. |
3bc67f0c | 214 | |
bef49340 WD |
215 | manpagesection(CONNECTING TO AN RSYNC SERVER OVER A REMOTE SHELL PROGRAM) |
216 | ||
217 | It is sometimes useful to be able to set up file transfers using rsync | |
43cd760f WD |
218 | server capabilities on the remote machine, while still using ssh or |
219 | rsh for transport. This is especially useful when you want to connect | |
bef49340 WD |
220 | to a remote machine via ssh (for encryption or to get through a |
221 | firewall), but you still want to have access to the rsync server | |
222 | features (see RUNNING AN RSYNC SERVER OVER A REMOTE SHELL PROGRAM, | |
faa82484 | 223 | below). |
bef49340 WD |
224 | |
225 | From the user's perspective, using rsync in this way is the same as | |
226 | using it to connect to an rsync server, except that you must | |
227 | explicitly set the remote shell program on the command line with | |
faa82484 | 228 | bf(--rsh=COMMAND). (Setting RSYNC_RSH in the environment will not turn on |
bef49340 WD |
229 | this functionality.) |
230 | ||
231 | In order to distinguish between the remote-shell user and the rsync | |
232 | server user, you can use '-l user' on your remote-shell command: | |
233 | ||
faa82484 WD |
234 | verb( rsync -av --rsh="ssh -l ssh-user" \ |
235 | rsync-user@host::module[/path] local-path) | |
bef49340 WD |
236 | |
237 | The "ssh-user" will be used at the ssh level; the "rsync-user" will be | |
238 | used to check against the rsyncd.conf on the remote host. | |
239 | ||
41059f75 AT |
240 | manpagesection(RUNNING AN RSYNC SERVER) |
241 | ||
faa82484 | 242 | An rsync server is configured using a configuration file. Please see the |
30e8c8e1 DD |
243 | rsyncd.conf(5) man page for more information. By default the configuration |
244 | file is called /etc/rsyncd.conf, unless rsync is running over a remote | |
245 | shell program and is not running as root; in that case, the default name | |
faa82484 | 246 | is rsyncd.conf in the current directory on the remote computer |
30e8c8e1 | 247 | (typically $HOME). |
41059f75 | 248 | |
bef49340 WD |
249 | manpagesection(RUNNING AN RSYNC SERVER OVER A REMOTE SHELL PROGRAM) |
250 | ||
251 | See the rsyncd.conf(5) man page for full information on the rsync | |
faa82484 | 252 | server configuration file. |
bef49340 WD |
253 | |
254 | Several configuration options will not be available unless the remote | |
255 | user is root (e.g. chroot, setuid/setgid, etc.). There is no need to | |
256 | configure inetd or the services map to include the rsync server port | |
257 | if you run an rsync server only via a remote shell program. | |
258 | ||
e6f9e388 WD |
259 | To run an rsync server out of a single-use ssh key, see this section |
260 | in the rsyncd.conf(5) man page. | |
bef49340 | 261 | |
41059f75 AT |
262 | manpagesection(EXAMPLES) |
263 | ||
264 | Here are some examples of how I use rsync. | |
265 | ||
14d43f1f DD |
266 | To backup my wife's home directory, which consists of large MS Word |
267 | files and mail folders, I use a cron job that runs | |
41059f75 | 268 | |
faa82484 | 269 | quote(tt(rsync -Cavz . arvidsjaur:backup)) |
41059f75 | 270 | |
f39281ae | 271 | each night over a PPP connection to a duplicate directory on my machine |
41059f75 AT |
272 | "arvidsjaur". |
273 | ||
274 | To synchronize my samba source trees I use the following Makefile | |
275 | targets: | |
276 | ||
faa82484 WD |
277 | verb( get: |
278 | rsync -avuzb --exclude '*~' samba:samba/ . | |
279 | put: | |
280 | rsync -Cavuzb . samba:samba/ | |
281 | sync: get put) | |
41059f75 AT |
282 | |
283 | this allows me to sync with a CVS directory at the other end of the | |
ae283632 WD |
284 | connection. I then do CVS operations on the remote machine, which saves a |
285 | lot of time as the remote CVS protocol isn't very efficient. | |
41059f75 AT |
286 | |
287 | I mirror a directory between my "old" and "new" ftp sites with the | |
faa82484 | 288 | command: |
41059f75 | 289 | |
faa82484 | 290 | tt(rsync -az -e ssh --delete ~ftp/pub/samba nimbus:"~ftp/pub/tridge") |
41059f75 | 291 | |
faa82484 | 292 | This is launched from cron every few hours. |
41059f75 | 293 | |
c95da96a AT |
294 | manpagesection(OPTIONS SUMMARY) |
295 | ||
14d43f1f | 296 | Here is a short summary of the options available in rsync. Please refer |
faa82484 | 297 | to the detailed description below for a complete description. verb( |
c95da96a | 298 | -v, --verbose increase verbosity |
44d98d61 | 299 | -q, --quiet suppress non-error messages |
c95da96a | 300 | -c, --checksum always checksum |
44d98d61 WD |
301 | -c, --checksum skip based on checksum, not mod-time & size |
302 | -a, --archive archive mode; same as -rlptgoD (no -H) | |
c95da96a AT |
303 | -r, --recursive recurse into directories |
304 | -R, --relative use relative path names | |
f177b7cc WD |
305 | --no-relative turn off --relative |
306 | --no-implied-dirs don't send implied dirs with -R | |
915dd207 | 307 | -b, --backup make backups (see --suffix & --backup-dir) |
44d98d61 | 308 | --backup-dir=DIR make backups into hierarchy based in DIR |
915dd207 | 309 | --suffix=SUFFIX backup suffix (default ~ w/o --backup-dir) |
44d98d61 WD |
310 | -u, --update skip files that are newer on the receiver |
311 | --inplace update destination files in-place | |
09ed3099 | 312 | -d, --dirs transfer directories without recursing |
eb06fa95 | 313 | -l, --links copy symlinks as symlinks |
44d98d61 WD |
314 | -L, --copy-links transform symlink into referent file/dir |
315 | --copy-unsafe-links only "unsafe" symlinks are transformed | |
316 | --safe-links ignore symlinks that point outside the tree | |
c95da96a | 317 | -H, --hard-links preserve hard links |
09ed3099 | 318 | -K, --keep-dirlinks treat symlinked dir on receiver as dir |
c95da96a AT |
319 | -p, --perms preserve permissions |
320 | -o, --owner preserve owner (root only) | |
321 | -g, --group preserve group | |
322 | -D, --devices preserve devices (root only) | |
323 | -t, --times preserve times | |
54e66f1d | 324 | -O, --omit-dir-times omit directories when preserving times |
c95da96a AT |
325 | -S, --sparse handle sparse files efficiently |
326 | -n, --dry-run show what would have been transferred | |
44d98d61 WD |
327 | -W, --whole-file copy files whole |
328 | --no-whole-file always use incremental rsync algorithm | |
c95da96a | 329 | -x, --one-file-system don't cross filesystem boundaries |
3ed8eb3f | 330 | -B, --block-size=SIZE force a fixed checksum block-size |
44d98d61 | 331 | -e, --rsh=COMMAND specify the remote shell to use |
d9fcc198 | 332 | --rsync-path=PATH specify path to rsync on the remote machine |
1347d512 | 333 | --existing only update files that already exist |
915dd207 | 334 | --ignore-existing ignore files that already exist on receiver |
ae76a740 | 335 | --del an alias for --delete-during |
915dd207 | 336 | --delete delete files that don't exist on sender |
598c409e | 337 | --delete-before receiver deletes before transfer (default) |
ae76a740 WD |
338 | --delete-during receiver deletes during xfer, not before |
339 | --delete-after receiver deletes after transfer, not before | |
866925bf | 340 | --delete-excluded also delete excluded files on receiver |
b5accaba | 341 | --ignore-errors delete even if there are I/O errors |
866925bf | 342 | --force force deletion of dirs even if not empty |
0b73ca12 | 343 | --max-delete=NUM don't delete more than NUM files |
3610c458 | 344 | --max-size=SIZE don't transfer any file larger than SIZE |
c95da96a | 345 | --partial keep partially transferred files |
44cad59f | 346 | --partial-dir=DIR put a partially transferred file into DIR |
44d98d61 | 347 | --delay-updates put all updated files into place at end |
c95da96a | 348 | --numeric-ids don't map uid/gid values by user/group name |
b5accaba | 349 | --timeout=TIME set I/O timeout in seconds |
44d98d61 WD |
350 | -I, --ignore-times don't skip files that match size and time |
351 | --size-only skip files that match in size | |
352 | --modify-window=NUM compare mod-times with reduced accuracy | |
c95da96a | 353 | -T --temp-dir=DIR create temporary files in directory DIR |
915dd207 | 354 | --compare-dest=DIR also compare received files relative to DIR |
b127c1dc WD |
355 | --copy-dest=DIR ... and include copies of unchanged files |
356 | --link-dest=DIR hardlink to files in DIR when unchanged | |
c95da96a | 357 | -z, --compress compress file data |
44d98d61 | 358 | -C, --cvs-exclude auto-ignore files in the same way CVS does |
16e5de84 WD |
359 | -f, --filter=RULE add a file-filtering RULE |
360 | -F same as --filter=': /.rsync-filter' | |
361 | repeated: --filter='- .rsync-filter' | |
2acf81eb | 362 | --exclude=PATTERN exclude files matching PATTERN |
44d98d61 | 363 | --exclude-from=FILE read exclude patterns from FILE |
2acf81eb | 364 | --include=PATTERN don't exclude files matching PATTERN |
44d98d61 WD |
365 | --include-from=FILE read include patterns from FILE |
366 | --files-from=FILE read list of source-file names from FILE | |
367 | -0 --from0 all *from file lists are delimited by nulls | |
c95da96a | 368 | --version print version number |
c259892c | 369 | --port=PORT specify double-colon alternate port number |
b5accaba | 370 | --blocking-io use blocking I/O for the remote shell |
44d98d61 WD |
371 | --no-blocking-io turn off blocking I/O when it is default |
372 | --stats give some file-transfer stats | |
eb86d661 | 373 | --progress show progress during transfer |
44d98d61 WD |
374 | -P same as --partial --progress |
375 | --log-format=FORMAT log file-transfers using specified format | |
376 | --password-file=FILE read password from FILE | |
09ed3099 | 377 | --list-only list the files instead of copying them |
44d98d61 | 378 | --bwlimit=KBPS limit I/O bandwidth; KBytes per second |
faa82484 | 379 | --write-batch=FILE write a batched update to FILE |
44d98d61 WD |
380 | --read-batch=FILE read a batched update from FILE |
381 | --checksum-seed=NUM set block/file checksum seed (advanced) | |
e40a46de WD |
382 | -4 --ipv4 prefer IPv4 |
383 | -6 --ipv6 prefer IPv6 | |
faa82484 | 384 | -h, --help show this help screen) |
6902ed17 | 385 | |
faa82484 WD |
386 | Rsync can also be run as a daemon, in which case the following options are |
387 | accepted: verb( | |
bdf278f7 WD |
388 | --daemon run as an rsync daemon |
389 | --address=ADDRESS bind to the specified address | |
44d98d61 | 390 | --bwlimit=KBPS limit I/O bandwidth; KBytes per second |
bdf278f7 WD |
391 | --config=FILE specify alternate rsyncd.conf file |
392 | --no-detach do not detach from the parent | |
c259892c | 393 | --port=PORT listen on alternate port number |
24b0922b | 394 | -v, --verbose increase verbosity |
bdf278f7 WD |
395 | -4 --ipv4 prefer IPv4 |
396 | -6 --ipv6 prefer IPv6 | |
faa82484 | 397 | -h, --help show this help screen) |
c95da96a | 398 | |
41059f75 AT |
399 | manpageoptions() |
400 | ||
401 | rsync uses the GNU long options package. Many of the command line | |
402 | options have two variants, one short and one long. These are shown | |
14d43f1f | 403 | below, separated by commas. Some options only have a long variant. |
b5679335 DD |
404 | The '=' for options that take a parameter is optional; whitespace |
405 | can be used instead. | |
41059f75 AT |
406 | |
407 | startdit() | |
408 | dit(bf(-h, --help)) Print a short help page describing the options | |
bdf278f7 | 409 | available in rsync. |
41059f75 | 410 | |
bdf278f7 | 411 | dit(bf(--version)) print the rsync version number and exit. |
41059f75 AT |
412 | |
413 | dit(bf(-v, --verbose)) This option increases the amount of information you | |
14d43f1f | 414 | are given during the transfer. By default, rsync works silently. A |
faa82484 WD |
415 | single bf(-v) will give you information about what files are being |
416 | transferred and a brief summary at the end. Two bf(-v) flags will give you | |
41059f75 | 417 | information on what files are being skipped and slightly more |
faa82484 | 418 | information at the end. More than two bf(-v) flags should only be used if |
14d43f1f | 419 | you are debugging rsync. |
41059f75 | 420 | |
b86f0cef DD |
421 | dit(bf(-q, --quiet)) This option decreases the amount of information you |
422 | are given during the transfer, notably suppressing information messages | |
423 | from the remote server. This flag is useful when invoking rsync from | |
424 | cron. | |
425 | ||
41059f75 | 426 | dit(bf(-I, --ignore-times)) Normally rsync will skip any files that are |
915dd207 WD |
427 | already the same size and have the same modification time-stamp. |
428 | This option turns off this "quick check" behavior. | |
41059f75 | 429 | |
a03a9f4e | 430 | dit(bf(--size-only)) Normally rsync will not transfer any files that are |
915dd207 | 431 | already the same size and have the same modification time-stamp. With the |
faa82484 | 432 | bf(--size-only) option, files will not be transferred if they have the same size, |
f83f0548 AT |
433 | regardless of timestamp. This is useful when starting to use rsync |
434 | after using another mirroring system which may not preserve timestamps | |
435 | exactly. | |
436 | ||
5b56cc19 AT |
437 | dit(bf(--modify-window)) When comparing two timestamps rsync treats |
438 | the timestamps as being equal if they are within the value of | |
439 | modify_window. This is normally zero, but you may find it useful to | |
440 | set this to a larger value in some situations. In particular, when | |
38843171 | 441 | transferring to Windows FAT filesystems which cannot represent times |
faa82484 | 442 | with a 1 second resolution bf(--modify-window=1) is useful. |
5b56cc19 | 443 | |
41059f75 AT |
444 | dit(bf(-c, --checksum)) This forces the sender to checksum all files using |
445 | a 128-bit MD4 checksum before transfer. The checksum is then | |
446 | explicitly checked on the receiver and any files of the same name | |
447 | which already exist and have the same checksum and size on the | |
a03a9f4e | 448 | receiver are not transferred. This option can be quite slow. |
41059f75 | 449 | |
faa82484 | 450 | dit(bf(-a, --archive)) This is equivalent to bf(-rlptgoD). It is a quick |
e7bf3e5e | 451 | way of saying you want recursion and want to preserve almost |
faa82484 WD |
452 | everything. The only exception to this is if bf(--files-from) was |
453 | specified, in which case bf(-d) is implied instead of bf(-r). | |
e7bf3e5e | 454 | |
faa82484 | 455 | Note that bf(-a) bf(does not preserve hardlinks), because |
e7bf3e5e MP |
456 | finding multiply-linked files is expensive. You must separately |
457 | specify bf(-H). | |
41059f75 | 458 | |
24986abd | 459 | dit(bf(-r, --recursive)) This tells rsync to copy directories |
faa82484 | 460 | recursively. See also bf(--dirs) (bf(-d)). |
41059f75 AT |
461 | |
462 | dit(bf(-R, --relative)) Use relative paths. This means that the full path | |
463 | names specified on the command line are sent to the server rather than | |
464 | just the last parts of the filenames. This is particularly useful when | |
14d43f1f DD |
465 | you want to send several different directories at the same time. For |
466 | example, if you used the command | |
41059f75 | 467 | |
faa82484 | 468 | quote(tt( rsync /foo/bar/foo.c remote:/tmp/)) |
41059f75 AT |
469 | |
470 | then this would create a file called foo.c in /tmp/ on the remote | |
471 | machine. If instead you used | |
472 | ||
faa82484 | 473 | quote(tt( rsync -R /foo/bar/foo.c remote:/tmp/)) |
41059f75 AT |
474 | |
475 | then a file called /tmp/foo/bar/foo.c would be created on the remote | |
9bef934c WD |
476 | machine -- the full path name is preserved. To limit the amount of |
477 | path information that is sent, do something like this: | |
478 | ||
faa82484 WD |
479 | quote( |
480 | tt( cd /foo)nl() | |
481 | tt( rsync -R bar/foo.c remote:/tmp/)nl() | |
482 | ) | |
9bef934c WD |
483 | |
484 | That would create /tmp/bar/foo.c on the remote machine. | |
f177b7cc | 485 | |
faa82484 WD |
486 | dit(bf(--no-relative)) Turn off the bf(--relative) option. This is only |
487 | needed if you want to use bf(--files-from) without its implied bf(--relative) | |
f177b7cc WD |
488 | file processing. |
489 | ||
faa82484 | 490 | dit(bf(--no-implied-dirs)) When combined with the bf(--relative) option, the |
f177b7cc WD |
491 | implied directories in each path are not explicitly duplicated as part |
492 | of the transfer. This makes the transfer more optimal and also allows | |
493 | the two sides to have non-matching symlinks in the implied part of the | |
faa82484 | 494 | path. For instance, if you transfer the file "/path/foo/file" with bf(-R), |
f177b7cc WD |
495 | the default is for rsync to ensure that "/path" and "/path/foo" on the |
496 | destination exactly match the directories/symlinks of the source. Using | |
faa82484 | 497 | the bf(--no-implied-dirs) option would omit both of these implied dirs, |
f177b7cc WD |
498 | which means that if "/path" was a real directory on one machine and a |
499 | symlink of the other machine, rsync would not try to change this. | |
41059f75 | 500 | |
b19fd07c WD |
501 | dit(bf(-b, --backup)) With this option, preexisting destination files are |
502 | renamed as each file is transferred or deleted. You can control where the | |
503 | backup file goes and what (if any) suffix gets appended using the | |
faa82484 | 504 | bf(--backup-dir) and bf(--suffix) options. |
41059f75 | 505 | |
faa82484 | 506 | dit(bf(--backup-dir=DIR)) In combination with the bf(--backup) option, this |
66203a98 | 507 | tells rsync to store all backups in the specified directory. This is |
759ac870 | 508 | very useful for incremental backups. You can additionally |
faa82484 | 509 | specify a backup suffix using the bf(--suffix) option |
759ac870 DD |
510 | (otherwise the files backed up in the specified directory |
511 | will keep their original filenames). | |
0b79c324 WD |
512 | If DIR is a relative path, it is relative to the destination directory |
513 | (which changes in a recursive transfer). | |
66203a98 | 514 | |
b5679335 | 515 | dit(bf(--suffix=SUFFIX)) This option allows you to override the default |
faa82484 WD |
516 | backup suffix used with the bf(--backup) (bf(-b)) option. The default suffix is a ~ |
517 | if no -bf(-backup-dir) was specified, otherwise it is an empty string. | |
9ef53907 | 518 | |
4539c0d7 WD |
519 | dit(bf(-u, --update)) This forces rsync to skip any files which exist on |
520 | the destination and have a modified time that is newer than the source | |
521 | file. (If an existing destination file has a modify time equal to the | |
522 | source file's, it will be updated if the sizes are different.) | |
41059f75 | 523 | |
faa82484 | 524 | In the current implementation of bf(--update), a difference of file format |
4539c0d7 | 525 | between the sender and receiver is always |
adddd075 WD |
526 | considered to be important enough for an update, no matter what date |
527 | is on the objects. In other words, if the source has a directory or a | |
528 | symlink where the destination has a file, the transfer would occur | |
529 | regardless of the timestamps. This might change in the future (feel | |
530 | free to comment on this on the mailing list if you have an opinion). | |
531 | ||
a3221d2a WD |
532 | dit(bf(--inplace)) This causes rsync not to create a new copy of the file |
533 | and then move it into place. Instead rsync will overwrite the existing | |
eb162f3b WD |
534 | file, meaning that the rsync algorithm can't accomplish the full amount of |
535 | network reduction it might be able to otherwise (since it does not yet try | |
536 | to sort data matches). One exception to this is if you combine the option | |
faa82484 | 537 | with bf(--backup), since rsync is smart enough to use the backup file as the |
eb162f3b | 538 | basis file for the transfer. |
a3221d2a | 539 | |
183150b7 WD |
540 | This option is useful for transfer of large files with block-based changes |
541 | or appended data, and also on systems that are disk bound, not network | |
542 | bound. | |
543 | ||
faa82484 WD |
544 | The option implies bf(--partial) (since an interrupted transfer does not delete |
545 | the file), but conflicts with bf(--partial-dir) and bf(--delay-updates). | |
546 | Prior to rsync 2.6.4 bf(--inplace) was also incompatible with bf(--compare-dest), | |
547 | bf(--copy-dest), and bf(--link-dest). | |
a3221d2a | 548 | |
399371e7 | 549 | WARNING: The file's data will be in an inconsistent state during the |
98f51bfb | 550 | transfer (and possibly afterward if the transfer gets interrupted), so you |
399371e7 | 551 | should not use this option to update files that are in use. Also note that |
eb162f3b | 552 | rsync will be unable to update a file in-place that is not writable by the |
75b243a5 | 553 | receiving user. |
a3221d2a | 554 | |
09ed3099 | 555 | dit(bf(-d, --dirs)) Tell the sending side to include any directories that |
faa82484 | 556 | are encountered. Unlike bf(--recursive), a directory's contents are not copied |
09ed3099 WD |
557 | unless the directory was specified on the command-line as either "." or a |
558 | name with a trailing slash (e.g. "foo/"). Without this option or the | |
faa82484 | 559 | bf(--recursive) option, rsync will skip all directories it encounters (and |
09ed3099 WD |
560 | output a message to that effect for each one). |
561 | ||
eb06fa95 MP |
562 | dit(bf(-l, --links)) When symlinks are encountered, recreate the |
563 | symlink on the destination. | |
41059f75 | 564 | |
eb06fa95 | 565 | dit(bf(-L, --copy-links)) When symlinks are encountered, the file that |
ef855d19 WD |
566 | they point to (the referent) is copied, rather than the symlink. In older |
567 | versions of rsync, this option also had the side-effect of telling the | |
568 | receiving side to follow symlinks, such as symlinks to directories. In a | |
faa82484 | 569 | modern rsync such as this one, you'll need to specify bf(--keep-dirlinks) (bf(-K)) |
ef855d19 | 570 | to get this extra behavior. The only exception is when sending files to |
faa82484 WD |
571 | an rsync that is too old to understand bf(-K) -- in that case, the bf(-L) option |
572 | will still have the side-effect of bf(-K) on that older receiving rsync. | |
b5313607 | 573 | |
eb06fa95 | 574 | dit(bf(--copy-unsafe-links)) This tells rsync to copy the referent of |
7af4227a | 575 | symbolic links that point outside the copied tree. Absolute symlinks |
eb06fa95 | 576 | are also treated like ordinary files, and so are any symlinks in the |
faa82484 | 577 | source path itself when bf(--relative) is used. |
41059f75 | 578 | |
d310a212 | 579 | dit(bf(--safe-links)) This tells rsync to ignore any symbolic links |
7af4227a | 580 | which point outside the copied tree. All absolute symlinks are |
faa82484 WD |
581 | also ignored. Using this option in conjunction with bf(--relative) may |
582 | give unexpected results. | |
d310a212 | 583 | |
41059f75 AT |
584 | dit(bf(-H, --hard-links)) This tells rsync to recreate hard links on |
585 | the remote system to be the same as the local system. Without this | |
586 | option hard links are treated like regular files. | |
587 | ||
588 | Note that rsync can only detect hard links if both parts of the link | |
589 | are in the list of files being sent. | |
590 | ||
591 | This option can be quite slow, so only use it if you need it. | |
592 | ||
09ed3099 WD |
593 | dit(bf(-K, --keep-dirlinks)) On the receiving side, if a symlink is |
594 | pointing to a directory, it will be treated as matching a directory | |
595 | from the sender. | |
596 | ||
41059f75 | 597 | dit(bf(-W, --whole-file)) With this option the incremental rsync algorithm |
a1a440c2 DD |
598 | is not used and the whole file is sent as-is instead. The transfer may be |
599 | faster if this option is used when the bandwidth between the source and | |
6eb770bb | 600 | destination machines is higher than the bandwidth to disk (especially when the |
4d888108 | 601 | "disk" is actually a networked filesystem). This is the default when both |
6eb770bb | 602 | the source and destination are specified as local paths. |
41059f75 | 603 | |
faa82484 | 604 | dit(bf(--no-whole-file)) Turn off bf(--whole-file), for use when it is the |
93689aa5 DD |
605 | default. |
606 | ||
8dc74608 WD |
607 | dit(bf(-p, --perms)) This option causes rsync to set the destination |
608 | permissions to be the same as the source permissions. | |
609 | ||
610 | Without this option, each new file gets its permissions set based on the | |
611 | source file's permissions and the umask at the receiving end, while all | |
612 | other files (including updated files) retain their existing permissions | |
613 | (which is the same behavior as other file-copy utilities, such as cp). | |
41059f75 | 614 | |
eb06fa95 MP |
615 | dit(bf(-o, --owner)) This option causes rsync to set the owner of the |
616 | destination file to be the same as the source file. On most systems, | |
a2b0471f WD |
617 | only the super-user can set file ownership. By default, the preservation |
618 | is done by name, but may fall back to using the ID number in some | |
faa82484 | 619 | circumstances. See the bf(--numeric-ids) option for a full discussion. |
41059f75 | 620 | |
eb06fa95 MP |
621 | dit(bf(-g, --group)) This option causes rsync to set the group of the |
622 | destination file to be the same as the source file. If the receiving | |
623 | program is not running as the super-user, only groups that the | |
a2b0471f WD |
624 | receiver is a member of will be preserved. By default, the preservation |
625 | is done by name, but may fall back to using the ID number in some | |
faa82484 | 626 | circumstances. See the bf(--numeric-ids) option for a full discussion. |
41059f75 AT |
627 | |
628 | dit(bf(-D, --devices)) This option causes rsync to transfer character and | |
629 | block device information to the remote system to recreate these | |
630 | devices. This option is only available to the super-user. | |
631 | ||
632 | dit(bf(-t, --times)) This tells rsync to transfer modification times along | |
baf3e504 DD |
633 | with the files and update them on the remote system. Note that if this |
634 | option is not used, the optimization that excludes files that have not been | |
faa82484 WD |
635 | modified cannot be effective; in other words, a missing bf(-t) or bf(-a) will |
636 | cause the next transfer to behave as if it used bf(-I), causing all files to be | |
d0bc3520 | 637 | updated (though the rsync algorithm will make the update fairly efficient |
faa82484 | 638 | if the files haven't actually changed, you're much better off using bf(-t)). |
41059f75 | 639 | |
54e66f1d | 640 | dit(bf(-O, --omit-dir-times)) This tells rsync to omit directories when |
faa82484 WD |
641 | it is preserving modification times (see bf(--times)). If NFS is sharing |
642 | the directories on the receiving side, it is a good idea to use bf(-O). | |
54e66f1d | 643 | |
41059f75 AT |
644 | dit(bf(-n, --dry-run)) This tells rsync to not do any file transfers, |
645 | instead it will just report the actions it would have taken. | |
646 | ||
647 | dit(bf(-S, --sparse)) Try to handle sparse files efficiently so they take | |
648 | up less space on the destination. | |
649 | ||
d310a212 AT |
650 | NOTE: Don't use this option when the destination is a Solaris "tmpfs" |
651 | filesystem. It doesn't seem to handle seeks over null regions | |
652 | correctly and ends up corrupting the files. | |
653 | ||
41059f75 AT |
654 | dit(bf(-x, --one-file-system)) This tells rsync not to cross filesystem |
655 | boundaries when recursing. This is useful for transferring the | |
656 | contents of only one filesystem. | |
657 | ||
faa82484 | 658 | dit(bf(--existing)) This tells rsync not to create any new files -- |
1347d512 AT |
659 | only update files that already exist on the destination. |
660 | ||
3d6feada | 661 | dit(bf(--ignore-existing)) |
faa82484 WD |
662 | This tells rsync not to update files that already exist on |
663 | the destination. | |
3d6feada | 664 | |
0b73ca12 AT |
665 | dit(bf(--max-delete=NUM)) This tells rsync not to delete more than NUM |
666 | files or directories. This is useful when mirroring very large trees | |
667 | to prevent disasters. | |
668 | ||
3610c458 WD |
669 | dit(bf(--max-size=SIZE)) This tells rsync to avoid transferring any |
670 | file that is larger than the specified SIZE. The SIZE value can be | |
671 | suffixed with a letter to indicate a size multiplier (K, M, or G) and | |
faa82484 | 672 | may be a fractional value (e.g. "bf(--max-size=1.5m)"). |
3610c458 | 673 | |
2c0fa6c5 | 674 | dit(bf(--delete)) This tells rsync to delete extraneous files from the |
e8b155a3 WD |
675 | receiving side (ones that aren't on the sending side), but only for the |
676 | directories that are being synchronized. You must have asked rsync to | |
677 | send the whole directory (e.g. "dir" or "dir/") without using a wildcard | |
678 | for the directory's contents (e.g. "dir/*") since the wildcard is expanded | |
ae76a740 | 679 | by the shell and rsync thus gets a request to transfer individual files, not |
e8b155a3 | 680 | the files' parent directory. Files that are excluded from transfer are |
faa82484 | 681 | excluded from being deleted unless you use bf(--delete-excluded). |
41059f75 | 682 | |
866925bf | 683 | This option has no effect unless directory recursion is enabled. |
24986abd | 684 | |
b33b791e | 685 | This option can be dangerous if used incorrectly! It is a very good idea |
faa82484 | 686 | to run first using the bf(--dry-run) option (bf(-n)) to see what files would be |
b33b791e | 687 | deleted to make sure important files aren't listed. |
41059f75 | 688 | |
e8b155a3 | 689 | If the sending side detects any I/O errors, then the deletion of any |
3e578a19 AT |
690 | files at the destination will be automatically disabled. This is to |
691 | prevent temporary filesystem failures (such as NFS errors) on the | |
692 | sending side causing a massive deletion of files on the | |
faa82484 | 693 | destination. You can override this with the bf(--ignore-errors) option. |
41059f75 | 694 | |
faa82484 WD |
695 | The bf(--delete) option may be combined with one of the --delete-WHEN options |
696 | without conflict, as well as bf(--delete-excluded). However, if none of the | |
2c0fa6c5 | 697 | --delete-WHEN options are specified, rsync will currently choose the |
faa82484 WD |
698 | bf(--delete-before) algorithm. A future version may change this to choose the |
699 | bf(--delete-during) algorithm. See also bf(--delete-after). | |
2c0fa6c5 WD |
700 | |
701 | dit(bf(--delete-before)) Request that the file-deletions on the receiving | |
faa82484 WD |
702 | side be done before the transfer starts. This is the default if bf(--delete) |
703 | or bf(--delete-excluded) is specified without one of the --delete-WHEN options. | |
704 | See bf(--delete) (which is implied) for more details on file-deletion. | |
2c0fa6c5 WD |
705 | |
706 | Deleting before the transfer is helpful if the filesystem is tight for space | |
aaca3daa | 707 | and removing extraneous files would help to make the transfer possible. |
ae76a740 | 708 | However, it does introduce a delay before the start of the transfer, |
faa82484 | 709 | and this delay might cause the transfer to timeout (if bf(--timeout) was |
ae76a740 WD |
710 | specified). |
711 | ||
2c0fa6c5 WD |
712 | dit(bf(--delete-during, --del)) Request that the file-deletions on the |
713 | receiving side be done incrementally as the transfer happens. This is | |
ae283632 | 714 | a faster method than choosing the before- or after-transfer algorithm, |
ae76a740 | 715 | but it is only supported beginning with rsync version 2.6.4. |
faa82484 | 716 | See bf(--delete) (which is implied) for more details on file-deletion. |
aaca3daa | 717 | |
2c0fa6c5 | 718 | dit(bf(--delete-after)) Request that the file-deletions on the receiving |
ae76a740 WD |
719 | side be done after the transfer has completed. This is useful if you |
720 | are sending new per-directory merge files as a part of the transfer and | |
721 | you want their exclusions to take effect for the delete phase of the | |
722 | current transfer. | |
faa82484 | 723 | See bf(--delete) (which is implied) for more details on file-deletion. |
e8b155a3 | 724 | |
866925bf WD |
725 | dit(bf(--delete-excluded)) In addition to deleting the files on the |
726 | receiving side that are not on the sending side, this tells rsync to also | |
faa82484 WD |
727 | delete any files on the receiving side that are excluded (see bf(--exclude)). |
728 | See bf(--delete) (which is implied) for more details on file-deletion. | |
866925bf | 729 | |
faa82484 | 730 | dit(bf(--ignore-errors)) Tells bf(--delete) to go ahead and delete files |
b5accaba | 731 | even when there are I/O errors. |
2c5548d2 | 732 | |
b695d088 DD |
733 | dit(bf(--force)) This options tells rsync to delete directories even if |
734 | they are not empty when they are to be replaced by non-directories. This | |
faa82484 WD |
735 | is only relevant without bf(--delete) because deletions are now done depth-first. |
736 | Requires the bf(--recursive) option (which is implied by bf(-a)) to have any effect. | |
41059f75 | 737 | |
3ed8eb3f WD |
738 | dit(bf(-B, --block-size=BLOCKSIZE)) This forces the block size used in |
739 | the rsync algorithm to a fixed value. It is normally selected based on | |
740 | the size of each file being updated. See the technical report for details. | |
41059f75 | 741 | |
b5679335 | 742 | dit(bf(-e, --rsh=COMMAND)) This option allows you to choose an alternative |
41059f75 | 743 | remote shell program to use for communication between the local and |
43cd760f WD |
744 | remote copies of rsync. Typically, rsync is configured to use ssh by |
745 | default, but you may prefer to use rsh on a local network. | |
41059f75 | 746 | |
bef49340 | 747 | If this option is used with bf([user@]host::module/path), then the |
4d888108 | 748 | remote shell em(COMMAND) will be used to run an rsync server on the |
bef49340 WD |
749 | remote host, and all data will be transmitted through that remote |
750 | shell connection, rather than through a direct socket connection to a | |
2d4ca358 DD |
751 | running rsync server on the remote host. See the section "CONNECTING |
752 | TO AN RSYNC SERVER OVER A REMOTE SHELL PROGRAM" above. | |
bef49340 | 753 | |
ea7f8108 WD |
754 | Command-line arguments are permitted in COMMAND provided that COMMAND is |
755 | presented to rsync as a single argument. For example: | |
98393ae2 | 756 | |
faa82484 | 757 | quote(tt( -e "ssh -p 2234")) |
98393ae2 WD |
758 | |
759 | (Note that ssh users can alternately customize site-specific connect | |
760 | options in their .ssh/config file.) | |
761 | ||
41059f75 | 762 | You can also choose the remote shell program using the RSYNC_RSH |
faa82484 | 763 | environment variable, which accepts the same range of values as bf(-e). |
41059f75 | 764 | |
faa82484 | 765 | See also the bf(--blocking-io) option which is affected by this option. |
735a816e | 766 | |
b5679335 | 767 | dit(bf(--rsync-path=PATH)) Use this to specify the path to the copy of |
d73ee7b7 AT |
768 | rsync on the remote machine. Useful when it's not in your path. Note |
769 | that this is the full path to the binary, not just the directory that | |
770 | the binary is in. | |
41059f75 | 771 | |
f177b7cc WD |
772 | dit(bf(-C, --cvs-exclude)) This is a useful shorthand for excluding a |
773 | broad range of files that you often don't want to transfer between | |
774 | systems. It uses the same algorithm that CVS uses to determine if | |
775 | a file should be ignored. | |
776 | ||
777 | The exclude list is initialized to: | |
778 | ||
faa82484 | 779 | quote(quote(tt(RCS SCCS CVS CVS.adm RCSLOG cvslog.* tags TAGS .make.state |
2a383be0 | 780 | .nse_depinfo *~ #* .#* ,* _$* *$ *.old *.bak *.BAK *.orig *.rej |
faa82484 | 781 | .del-* *.a *.olb *.o *.obj *.so *.exe *.Z *.elc *.ln core .svn/))) |
f177b7cc WD |
782 | |
783 | then files listed in a $HOME/.cvsignore are added to the list and any | |
2a383be0 WD |
784 | files listed in the CVSIGNORE environment variable (all cvsignore names |
785 | are delimited by whitespace). | |
786 | ||
f177b7cc | 787 | Finally, any file is ignored if it is in the same directory as a |
2a383be0 | 788 | .cvsignore file and matches one of the patterns listed therein. |
2a383be0 | 789 | See the bf(cvs(1)) manual for more information. |
f177b7cc | 790 | |
16e5de84 WD |
791 | dit(bf(-f, --filter=RULE)) This option allows you to add rules to selectively |
792 | exclude certain files from the list of files to be transferred. This is | |
793 | most useful in combination with a recursive transfer. | |
41059f75 | 794 | |
faa82484 | 795 | You may use as many bf(--filter) options on the command line as you like |
41059f75 AT |
796 | to build up the list of files to exclude. |
797 | ||
16e5de84 WD |
798 | See the FILTER RULES section for detailed information on this option. |
799 | ||
faa82484 | 800 | dit(bf(-F)) The bf(-F) option is a shorthand for adding two bf(--filter) rules to |
16e5de84 WD |
801 | your command. The first time it is used is a shorthand for this rule: |
802 | ||
faa82484 | 803 | quote(tt( --filter=': /.rsync-filter')) |
16e5de84 WD |
804 | |
805 | This tells rsync to look for per-directory .rsync-filter files that have | |
806 | been sprinkled through the hierarchy and use their rules to filter the | |
faa82484 | 807 | files in the transfer. If bf(-F) is repeated, it is a shorthand for this |
16e5de84 WD |
808 | rule: |
809 | ||
faa82484 | 810 | quote(tt( --filter='- .rsync-filter')) |
16e5de84 WD |
811 | |
812 | This filters out the .rsync-filter files themselves from the transfer. | |
813 | ||
814 | See the FILTER RULES section for detailed information on how these options | |
815 | work. | |
816 | ||
817 | dit(bf(--exclude=PATTERN)) This option is a simplified form of the | |
faa82484 | 818 | bf(--filter) option that defaults to an exclude rule and does not allow |
16e5de84 WD |
819 | the full rule-parsing syntax of normal filter rules. |
820 | ||
821 | See the FILTER RULES section for detailed information on this option. | |
41059f75 | 822 | |
faa82484 | 823 | dit(bf(--exclude-from=FILE)) This option is similar to the bf(--exclude) |
c48b22c8 AT |
824 | option, but instead it adds all exclude patterns listed in the file |
825 | FILE to the exclude list. Blank lines in FILE and lines starting with | |
826 | ';' or '#' are ignored. | |
f8a94f0d DD |
827 | If em(FILE) is bf(-) the list will be read from standard input. |
828 | ||
16e5de84 | 829 | dit(bf(--include=PATTERN)) This option is a simplified form of the |
faa82484 | 830 | bf(--filter) option that defaults to an include rule and does not allow |
16e5de84 | 831 | the full rule-parsing syntax of normal filter rules. |
43bd68e5 | 832 | |
16e5de84 | 833 | See the FILTER RULES section for detailed information on this option. |
43bd68e5 | 834 | |
b5679335 | 835 | dit(bf(--include-from=FILE)) This specifies a list of include patterns |
43bd68e5 | 836 | from a file. |
c769702f | 837 | If em(FILE) is "-" the list will be read from standard input. |
f8a94f0d | 838 | |
f177b7cc WD |
839 | dit(bf(--files-from=FILE)) Using this option allows you to specify the |
840 | exact list of files to transfer (as read from the specified FILE or "-" | |
c769702f | 841 | for standard input). It also tweaks the default behavior of rsync to make |
faa82484 WD |
842 | transferring just the specified files and directories easier: |
843 | ||
844 | quote(itemize( | |
845 | it() The bf(--relative) (bf(-R)) option is implied, which preserves the path | |
846 | information that is specified for each item in the file (use | |
847 | bf(--no-relative) if you want to turn that off). | |
848 | it() The bf(--dirs) (bf(-d)) option is implied, which will create directories | |
849 | specified in the list on the destination rather than noisily skipping | |
850 | them. | |
851 | it() The bf(--archive) (bf(-a)) option's behavior does not imply bf(--recursive) | |
852 | (bf(-r)), so specify it explicitly, if you want it. | |
853 | )) | |
f177b7cc WD |
854 | |
855 | The file names that are read from the FILE are all relative to the | |
856 | source dir -- any leading slashes are removed and no ".." references are | |
857 | allowed to go higher than the source dir. For example, take this | |
858 | command: | |
859 | ||
faa82484 | 860 | quote(tt( rsync -a --files-from=/tmp/foo /usr remote:/backup)) |
f177b7cc WD |
861 | |
862 | If /tmp/foo contains the string "bin" (or even "/bin"), the /usr/bin | |
863 | directory will be created as /backup/bin on the remote host (but the | |
faa82484 | 864 | contents of the /usr/bin dir would not be sent unless you specified bf(-r) |
f177b7cc | 865 | or the names were explicitly listed in /tmp/foo). Also keep in mind |
faa82484 | 866 | that the effect of the (enabled by default) bf(--relative) option is to |
f177b7cc WD |
867 | duplicate only the path info that is read from the file -- it does not |
868 | force the duplication of the source-spec path (/usr in this case). | |
869 | ||
faa82484 | 870 | In addition, the bf(--files-from) file can be read from the remote host |
f177b7cc WD |
871 | instead of the local host if you specify a "host:" in front of the file |
872 | (the host must match one end of the transfer). As a short-cut, you can | |
873 | specify just a prefix of ":" to mean "use the remote end of the | |
874 | transfer". For example: | |
875 | ||
faa82484 | 876 | quote(tt( rsync -a --files-from=:/path/file-list src:/ /tmp/copy)) |
f177b7cc WD |
877 | |
878 | This would copy all the files specified in the /path/file-list file that | |
879 | was located on the remote "src" host. | |
880 | ||
881 | dit(bf(-0, --from0)) This tells rsync that the filenames it reads from a | |
882 | file are terminated by a null ('\0') character, not a NL, CR, or CR+LF. | |
faa82484 WD |
883 | This affects bf(--exclude-from), bf(--include-from), bf(--files-from), and any |
884 | merged files specified in a bf(--filter) rule. | |
885 | It does not affect bf(--cvs-exclude) (since all names read from a .cvsignore | |
f01b6368 | 886 | file are split on whitespace). |
41059f75 | 887 | |
b5679335 | 888 | dit(bf(-T, --temp-dir=DIR)) This option instructs rsync to use DIR as a |
375a4556 | 889 | scratch directory when creating temporary copies of the files |
41059f75 AT |
890 | transferred on the receiving side. The default behavior is to create |
891 | the temporary files in the receiving directory. | |
892 | ||
b127c1dc | 893 | dit(bf(--compare-dest=DIR)) This option instructs rsync to use em(DIR) on |
e49f61f5 WD |
894 | the destination machine as an additional hierarchy to compare destination |
895 | files against doing transfers (if the files are missing in the destination | |
896 | directory). If a file is found in em(DIR) that is identical to the | |
897 | sender's file, the file will NOT be transferred to the destination | |
898 | directory. This is useful for creating a sparse backup of just files that | |
899 | have changed from an earlier backup. | |
900 | ||
faa82484 | 901 | Beginning in version 2.6.4, multiple bf(--compare-dest) directories may be |
e49f61f5 WD |
902 | provided and rsync will search the list in the order specified until it |
903 | finds an existing file. That first discovery is used as the basis file, | |
904 | and also determines if the transfer needs to happen. | |
905 | ||
906 | If em(DIR) is a relative path, it is relative to the destination directory. | |
faa82484 | 907 | See also bf(--copy-dest) and bf(--link-dest). |
b127c1dc WD |
908 | |
909 | dit(bf(--copy-dest=DIR)) This option behaves like bf(--compare-dest), but | |
910 | rsync will also copy unchanged files found in em(DIR) to the destination | |
911 | directory (using the data in the em(DIR) for an efficient copy). This is | |
912 | useful for doing transfers to a new destination while leaving existing | |
913 | files intact, and then doing a flash-cutover when all files have been | |
e49f61f5 WD |
914 | successfully transferred. |
915 | ||
916 | If em(DIR) is a relative path, it is relative to the destination directory. | |
faa82484 | 917 | See also bf(--compare-dest) and bf(--link-dest). |
b127c1dc WD |
918 | |
919 | dit(bf(--link-dest=DIR)) This option behaves like bf(--copy-dest), but | |
e49f61f5 WD |
920 | unchanged files are hard linked from em(DIR) to the destination directory. |
921 | The files must be identical in all preserved attributes (e.g. permissions, | |
922 | possibly ownership) in order for the files to be linked together. | |
8429aa9e WD |
923 | An example: |
924 | ||
faa82484 | 925 | quote(tt( rsync -av --link-dest=$PWD/prior_dir host:src_dir/ new_dir/)) |
59c95e42 | 926 | |
faa82484 | 927 | Beginning with version 2.6.4, if more than one bf(--link-dest) option is |
e49f61f5 WD |
928 | specified, rsync will try to find an exact match to link with (searching |
929 | the list in the order specified), and if not found, a basis file from one | |
930 | of the em(DIR)s will be selected to try to speed up the transfer. | |
931 | ||
932 | If em(DIR) is a relative path, it is relative to the destination directory. | |
faa82484 | 933 | See also bf(--compare-dest) and bf(--copy-dest). |
b127c1dc | 934 | |
e0204f56 | 935 | Note that rsync versions prior to 2.6.1 had a bug that could prevent |
faa82484 WD |
936 | bf(--link-dest) from working properly for a non-root user when bf(-o) was specified |
937 | (or implied by bf(-a)). You can work-around this bug by avoiding the bf(-o) option | |
eb162f3b | 938 | when sending to an old rsync. |
e0204f56 | 939 | |
41059f75 | 940 | dit(bf(-z, --compress)) With this option, rsync compresses any data from |
089e73f8 | 941 | the files that it sends to the destination machine. This |
f39281ae | 942 | option is useful on slow connections. The compression method used is the |
41059f75 AT |
943 | same method that gzip uses. |
944 | ||
945 | Note this this option typically achieves better compression ratios | |
946 | that can be achieved by using a compressing remote shell, or a | |
947 | compressing transport, as it takes advantage of the implicit | |
948 | information sent for matching data blocks. | |
949 | ||
950 | dit(bf(--numeric-ids)) With this option rsync will transfer numeric group | |
4d888108 | 951 | and user IDs rather than using user and group names and mapping them |
41059f75 AT |
952 | at both ends. |
953 | ||
4d888108 | 954 | By default rsync will use the username and groupname to determine |
41059f75 | 955 | what ownership to give files. The special uid 0 and the special group |
faa82484 | 956 | 0 are never mapped via user/group names even if the bf(--numeric-ids) |
41059f75 AT |
957 | option is not specified. |
958 | ||
ec40899b WD |
959 | If a user or group has no name on the source system or it has no match |
960 | on the destination system, then the numeric ID | |
961 | from the source system is used instead. See also the comments on the | |
a2b0471f WD |
962 | "use chroot" setting in the rsyncd.conf manpage for information on how |
963 | the chroot setting affects rsync's ability to look up the names of the | |
964 | users and groups and what you can do about it. | |
41059f75 | 965 | |
b5accaba | 966 | dit(bf(--timeout=TIMEOUT)) This option allows you to set a maximum I/O |
de2fd20e AT |
967 | timeout in seconds. If no data is transferred for the specified time |
968 | then rsync will exit. The default is 0, which means no timeout. | |
41059f75 | 969 | |
c259892c WD |
970 | dit(bf(--port=PORT)) This specifies an alternate TCP port number to use |
971 | rather than the default of 873. This is only needed if you are using the | |
972 | double-colon (::) syntax to connect with an rsync daemon (since the URL | |
973 | syntax has a way to specify the port as a part of the URL). See also this | |
faa82484 | 974 | option in the bf(--daemon) mode section. |
c259892c | 975 | |
b5accaba | 976 | dit(bf(--blocking-io)) This tells rsync to use blocking I/O when launching |
314a74d7 WD |
977 | a remote shell transport. If the remote shell is either rsh or remsh, |
978 | rsync defaults to using | |
b5accaba WD |
979 | blocking I/O, otherwise it defaults to using non-blocking I/O. (Note that |
980 | ssh prefers non-blocking I/O.) | |
64c704f0 | 981 | |
faa82484 | 982 | dit(bf(--no-blocking-io)) Turn off bf(--blocking-io), for use when it is the |
93689aa5 DD |
983 | default. |
984 | ||
3a64ad1f | 985 | dit(bf(--log-format=FORMAT)) This allows you to specify exactly what the |
14d43f1f | 986 | rsync client logs to stdout on a per-file basis. The log format is |
3a64ad1f DD |
987 | specified using the same format conventions as the log format option in |
988 | rsyncd.conf. | |
b6062654 | 989 | |
b72f24c7 AT |
990 | dit(bf(--stats)) This tells rsync to print a verbose set of statistics |
991 | on the file transfer, allowing you to tell how effective the rsync | |
e19452a9 | 992 | algorithm is for your data. |
b72f24c7 | 993 | |
d9fcc198 AT |
994 | dit(bf(--partial)) By default, rsync will delete any partially |
995 | transferred file if the transfer is interrupted. In some circumstances | |
996 | it is more desirable to keep partially transferred files. Using the | |
faa82484 | 997 | bf(--partial) option tells rsync to keep the partial file which should |
d9fcc198 AT |
998 | make a subsequent transfer of the rest of the file much faster. |
999 | ||
faa82484 | 1000 | dit(bf(--partial-dir=DIR)) Turns on bf(--partial) mode, but tells rsync to |
b127c1dc | 1001 | put a partially transferred file into em(DIR) instead of writing out the |
44cad59f WD |
1002 | file to the destination dir. Rsync will also use a file found in this |
1003 | dir as data to speed up the transfer (i.e. when you redo the send after | |
1004 | rsync creates a partial file) and delete such a file after it has served | |
faa82484 | 1005 | its purpose. Note that if bf(--whole-file) is specified (or implied) that an |
b90a6d9f WD |
1006 | existing partial-dir file will not be used to speedup the transfer (since |
1007 | rsync is sending files without using the incremental rsync algorithm). | |
44cad59f WD |
1008 | |
1009 | Rsync will create the dir if it is missing (just the last dir -- not the | |
1010 | whole path). This makes it easy to use a relative path (such as | |
faa82484 | 1011 | "bf(--partial-dir=.rsync-partial)") to have rsync create the partial-directory |
b127c1dc | 1012 | in the destination file's directory (rsync will also try to remove the em(DIR) |
44cad59f WD |
1013 | if a partial file was found to exist at the start of the transfer and the |
1014 | DIR was specified as a relative path). | |
1015 | ||
a33857da | 1016 | If the partial-dir value is not an absolute path, rsync will also add an |
faa82484 | 1017 | bf(--exclude) of this value at the end of all your existing excludes. This |
a33857da WD |
1018 | will prevent partial-dir files from being transferred and also prevent the |
1019 | untimely deletion of partial-dir items on the receiving side. An example: | |
faa82484 | 1020 | the above bf(--partial-dir) option would add an "bf(--exclude=.rsync-partial/)" |
16e5de84 WD |
1021 | rule at the end of any other filter rules. Note that if you are |
1022 | supplying your own filter rules, you may need to manually insert a | |
a33857da WD |
1023 | rule for this directory exclusion somewhere higher up in the list so that |
1024 | it has a high enough priority to be effective (e.g., if your rules specify | |
faa82484 | 1025 | a trailing bf(--exclude='*') rule, the auto-added rule will be ineffective). |
44cad59f | 1026 | |
faa82484 | 1027 | IMPORTANT: the bf(--partial-dir) should not be writable by other users or it |
b4d1e854 WD |
1028 | is a security risk. E.g. AVOID "/tmp". |
1029 | ||
1030 | You can also set the partial-dir value the RSYNC_PARTIAL_DIR environment | |
faa82484 WD |
1031 | variable. Setting this in the environment does not force bf(--partial) to be |
1032 | enabled, but rather it effects where partial files go when bf(--partial) is | |
1033 | specified. For instance, instead of using bf(--partial-dir=.rsync-tmp) | |
1034 | along with bf(--progress), you could set RSYNC_PARTIAL_DIR=.rsync-tmp in your | |
1035 | environment and then just use the bf(-P) option to turn on the use of the | |
1036 | .rsync-tmp dir for partial transfers. The only time that the bf(--partial) | |
1037 | option does not look for this environment value is (1) when bf(--inplace) was | |
1038 | specified (since bf(--inplace) conflicts with bf(--partial-dir)), or (2) when | |
1039 | bf(--delay-updates) was specified (see below). | |
01b835c2 WD |
1040 | |
1041 | dit(bf(--delay-updates)) This option puts the temporary file from each | |
1042 | updated file into the file's partial-dir (see above) until the end of the | |
1043 | transfer, at which time all the files are renamed into place in rapid | |
1044 | succession. This attempts to make the updating of the files a little more | |
faa82484 | 1045 | atomic. If you don't specify the bf(--partial-dir) option, this option will |
01b835c2 | 1046 | cause it to default to ".~tmp~" (RSYNC_PARTIAL_DIR is not consulted for |
faa82484 | 1047 | this value). Conflicts with bf(--inplace). |
01b835c2 WD |
1048 | |
1049 | This option uses more memory on the receiving side (one bit per file | |
1050 | transferred) and also requires enough free disk space on the receiving | |
1051 | side to hold an additional copy of all the updated files. Note also that | |
faa82484 | 1052 | you should not use an absolute path to bf(--partial-dir) unless there is no |
01b835c2 WD |
1053 | chance of any of the files in the transfer having the same name (since all |
1054 | the updated files will be put into a single directory if the path is | |
1055 | absolute). | |
1056 | ||
1057 | See also the "atomic-rsync" perl script in the "support" subdir for an | |
faa82484 | 1058 | update algorithm that is even more atomic (it uses bf(--link-dest) and a |
01b835c2 | 1059 | parallel hierarchy of files). |
44cad59f | 1060 | |
eb86d661 AT |
1061 | dit(bf(--progress)) This option tells rsync to print information |
1062 | showing the progress of the transfer. This gives a bored user | |
1063 | something to watch. | |
faa82484 | 1064 | Implies bf(--verbose) without incrementing verbosity. |
7b10f91d | 1065 | |
68f9910d WD |
1066 | When the file is transferring, the data looks like this: |
1067 | ||
faa82484 | 1068 | verb( 782448 63% 110.64kB/s 0:00:04) |
68f9910d WD |
1069 | |
1070 | This tells you the current file size, the percentage of the transfer that | |
1071 | is complete, the current calculated file-completion rate (including both | |
1072 | data over the wire and data being matched locally), and the estimated time | |
1073 | remaining in this transfer. | |
1074 | ||
c2c14fa2 | 1075 | After a file is complete, the data looks like this: |
68f9910d | 1076 | |
faa82484 | 1077 | verb( 1238099 100% 146.38kB/s 0:00:08 (5, 57.1% of 396)) |
68f9910d WD |
1078 | |
1079 | This tells you the final file size, that it's 100% complete, the final | |
1080 | transfer rate for the file, the amount of elapsed time it took to transfer | |
1081 | the file, and the addition of a total-transfer summary in parentheses. | |
1082 | These additional numbers tell you how many files have been updated, and | |
1083 | what percent of the total number of files has been scanned. | |
1084 | ||
faa82484 | 1085 | dit(bf(-P)) The bf(-P) option is equivalent to bf(--partial) bf(--progress). Its |
183150b7 WD |
1086 | purpose is to make it much easier to specify these two options for a long |
1087 | transfer that may be interrupted. | |
d9fcc198 | 1088 | |
65575e96 AT |
1089 | dit(bf(--password-file)) This option allows you to provide a password |
1090 | in a file for accessing a remote rsync server. Note that this option | |
bb18e755 | 1091 | is only useful when accessing an rsync server using the built in |
65575e96 | 1092 | transport, not when using a remote shell as the transport. The file |
fc7952e7 AT |
1093 | must not be world readable. It should contain just the password as a |
1094 | single line. | |
65575e96 | 1095 | |
09ed3099 WD |
1096 | dit(bf(--list-only)) This option will cause the source files to be listed |
1097 | instead of transferred. This option is inferred if there is no destination | |
1098 | specified, so you don't usually need to use it explicitly. However, it can | |
faa82484 | 1099 | come in handy for a power user that wants to avoid the "bf(-r --exclude='/*/*')" |
09ed3099 WD |
1100 | options that rsync might use as a compatibility kluge when generating a |
1101 | non-recursive listing. | |
1102 | ||
ef5d23eb DD |
1103 | dit(bf(--bwlimit=KBPS)) This option allows you to specify a maximum |
1104 | transfer rate in kilobytes per second. This option is most effective when | |
1105 | using rsync with large files (several megabytes and up). Due to the nature | |
1106 | of rsync transfers, blocks of data are sent, then if rsync determines the | |
1107 | transfer was too fast, it will wait before sending the next data block. The | |
4d888108 | 1108 | result is an average transfer rate equaling the specified limit. A value |
ef5d23eb DD |
1109 | of zero specifies no limit. |
1110 | ||
b9f592fb | 1111 | dit(bf(--write-batch=FILE)) Record a file that can later be applied to |
faa82484 | 1112 | another identical destination with bf(--read-batch). See the "BATCH MODE" |
b9f592fb | 1113 | section for details. |
6902ed17 | 1114 | |
b9f592fb | 1115 | dit(bf(--read-batch=FILE)) Apply all of the changes stored in FILE, a |
faa82484 | 1116 | file previously generated by bf(--write-batch). |
399371e7 | 1117 | If em(FILE) is "-" the batch data will be read from standard input. |
c769702f | 1118 | See the "BATCH MODE" section for details. |
6902ed17 | 1119 | |
e40a46de WD |
1120 | dit(bf(-4, --ipv4) or bf(-6, --ipv6)) Tells rsync to prefer IPv4/IPv6 |
1121 | when creating sockets. This only affects sockets that rsync has direct | |
1122 | control over, such as the outgoing socket when directly contacting an | |
faa82484 | 1123 | rsync daemon. See also these options in the bf(--daemon) mode section. |
e40a46de | 1124 | |
c8d895de WD |
1125 | dit(bf(--checksum-seed=NUM)) Set the MD4 checksum seed to the integer |
1126 | NUM. This 4 byte checksum seed is included in each block and file | |
1127 | MD4 checksum calculation. By default the checksum seed is generated | |
b9f592fb | 1128 | by the server and defaults to the current time(). This option |
c8d895de WD |
1129 | is used to set a specific checksum seed, which is useful for |
1130 | applications that want repeatable block and file checksums, or | |
1131 | in the case where the user wants a more random checksum seed. | |
1132 | Note that setting NUM to 0 causes rsync to use the default of time() | |
b9f592fb | 1133 | for checksum seed. |
41059f75 AT |
1134 | enddit() |
1135 | ||
faa82484 WD |
1136 | manpagesection(DAEMON OPTIONS) |
1137 | ||
bdf278f7 WD |
1138 | The options allowed when starting an rsync daemon are as follows: |
1139 | ||
1140 | startdit() | |
bdf278f7 WD |
1141 | dit(bf(--daemon)) This tells rsync that it is to run as a daemon. The |
1142 | daemon may be accessed using the bf(host::module) or | |
1143 | bf(rsync://host/module/) syntax. | |
1144 | ||
1145 | If standard input is a socket then rsync will assume that it is being | |
1146 | run via inetd, otherwise it will detach from the current terminal and | |
1147 | become a background daemon. The daemon will read the config file | |
1148 | (rsyncd.conf) on each connect made by a client and respond to | |
1149 | requests accordingly. See the rsyncd.conf(5) man page for more | |
1150 | details. | |
1151 | ||
1152 | dit(bf(--address)) By default rsync will bind to the wildcard address | |
faa82484 WD |
1153 | when run as a daemon with the bf(--daemon) option or when connecting to a |
1154 | rsync server. The bf(--address) option allows you to specify a specific IP | |
bdf278f7 | 1155 | address (or hostname) to bind to. This makes virtual hosting possible |
faa82484 | 1156 | in conjunction with the bf(--config) option. See also the "address" global |
01f8a115 | 1157 | option in the rsyncd.conf manpage. |
bdf278f7 | 1158 | |
1f69bec4 WD |
1159 | dit(bf(--bwlimit=KBPS)) This option allows you to specify a maximum |
1160 | transfer rate in kilobytes per second for the data the daemon sends. | |
faa82484 | 1161 | The client can still specify a smaller bf(--bwlimit) value, but their |
1f69bec4 WD |
1162 | requested value will be rounded down if they try to exceed it. See the |
1163 | client version of this option (above) for some extra details. | |
1164 | ||
bdf278f7 | 1165 | dit(bf(--config=FILE)) This specifies an alternate config file than |
faa82484 | 1166 | the default. This is only relevant when bf(--daemon) is specified. |
bdf278f7 WD |
1167 | The default is /etc/rsyncd.conf unless the daemon is running over |
1168 | a remote shell program and the remote user is not root; in that case | |
1169 | the default is rsyncd.conf in the current directory (typically $HOME). | |
1170 | ||
1171 | dit(bf(--no-detach)) When running as a daemon, this option instructs | |
1172 | rsync to not detach itself and become a background process. This | |
1173 | option is required when running as a service on Cygwin, and may also | |
1174 | be useful when rsync is supervised by a program such as | |
1175 | bf(daemontools) or AIX's bf(System Resource Controller). | |
1176 | bf(--no-detach) is also recommended when rsync is run under a | |
1177 | debugger. This option has no effect if rsync is run from inetd or | |
1178 | sshd. | |
1179 | ||
c259892c WD |
1180 | dit(bf(--port=PORT)) This specifies an alternate TCP port number for the |
1181 | daemon to listen on rather than the default of 873. See also the "port" | |
1182 | global option in the rsyncd.conf manpage. | |
bdf278f7 | 1183 | |
24b0922b WD |
1184 | dit(bf(-v, --verbose)) This option increases the amount of information the |
1185 | daemon logs during its startup phase. After the client connects, the | |
1186 | daemon's verbosity level will be controlled by the options that the client | |
1187 | used and the "max verbosity" setting in the module's config section. | |
1188 | ||
bdf278f7 WD |
1189 | dit(bf(-4, --ipv4) or bf(-6, --ipv6)) Tells rsync to prefer IPv4/IPv6 |
1190 | when creating the incoming sockets that the rsync daemon will use to | |
1191 | listen for connections. One of these options may be required in older | |
1192 | versions of Linux to work around an IPv6 bug in the kernel (if you see | |
1193 | an "address already in use" error when nothing else is using the port, | |
faa82484 | 1194 | try specifying bf(--ipv6) or bf(--ipv4) when starting the daemon). |
bdf278f7 | 1195 | |
faa82484 | 1196 | dit(bf(-h, --help)) When specified after bf(--daemon), print a short help |
bdf278f7 | 1197 | page describing the options available for starting an rsync daemon. |
bdf278f7 WD |
1198 | enddit() |
1199 | ||
16e5de84 | 1200 | manpagesection(FILTER RULES) |
43bd68e5 | 1201 | |
16e5de84 WD |
1202 | The filter rules allow for flexible selection of which files to transfer |
1203 | (include) and which files to skip (exclude). The rules either directly | |
1204 | specify include/exclude patterns or they specify a way to acquire more | |
1205 | include/exclude patterns (e.g. to read them from a file). | |
43bd68e5 | 1206 | |
16e5de84 WD |
1207 | As the list of files/directories to transfer is built, rsync checks each |
1208 | name to be transferred against the list of include/exclude patterns in | |
1209 | turn, and the first matching pattern is acted on: if it is an exclude | |
1210 | pattern, then that file is skipped; if it is an include pattern then that | |
1211 | filename is not skipped; if no matching pattern is found, then the | |
43bd68e5 AT |
1212 | filename is not skipped. |
1213 | ||
16e5de84 WD |
1214 | Rsync builds an ordered list of filter rules as specified on the |
1215 | command-line. Filter rules have the following syntax: | |
1216 | ||
faa82484 WD |
1217 | quote( |
1218 | tt(x [RULE])nl() | |
1219 | tt(xMODIFIERS [RULE])nl() | |
16e5de84 WD |
1220 | ) |
1221 | ||
1222 | The 'x' is a single-letter that specifies the kind of rule to create. It | |
dc1488ae WD |
1223 | can have trailing modifiers, and is separated from the RULE by either a |
1224 | single space or an underscore (_). Here are the available rule prefixes: | |
16e5de84 | 1225 | |
faa82484 WD |
1226 | quote( |
1227 | bf(-) specifies an exclude pattern. nl() | |
1228 | bf(+) specifies an include pattern. nl() | |
1229 | bf(.) specifies a merge-file to read for more rules. nl() | |
1230 | bf(:) specifies a per-directory merge-file. nl() | |
1231 | bf(!) clears the current include/exclude list (takes no RULE) nl() | |
16e5de84 WD |
1232 | ) |
1233 | ||
faa82484 | 1234 | Note that the bf(--include)/bf(--exclude) command-line options do not allow the |
16e5de84 WD |
1235 | full range of rule parsing as described above -- they only allow the |
1236 | specification of include/exclude patterns and the "!" token (not to | |
1237 | mention the comment lines when reading rules from a file). If a pattern | |
1238 | does not begin with "- " (dash, space) or "+ " (plus, space), then the | |
1239 | rule will be interpreted as if "+ " (for an include option) or "- " (for | |
faa82484 | 1240 | an exclude option) were prefixed to the string. A bf(--filter) option, on |
16e5de84 WD |
1241 | the other hand, must always contain one of the prefixes above. |
1242 | ||
faa82484 | 1243 | Note also that the bf(--filter), bf(--include), and bf(--exclude) options take one |
16e5de84 | 1244 | rule/pattern each. To add multiple ones, you can repeat the options on |
faa82484 WD |
1245 | the command-line, use the merge-file syntax of the bf(--filter) option, or |
1246 | the bf(--include-from)/bf(--exclude-from) options. | |
16e5de84 WD |
1247 | |
1248 | When rules are being read from a file, empty lines are ignored, as are | |
1249 | comment lines that start with a "#". | |
1250 | ||
1251 | manpagesection(INCLUDE/EXCLUDE PATTERN RULES) | |
1252 | ||
ae283632 | 1253 | You can include and exclude files by specifying patterns using the "+" and |
16e5de84 WD |
1254 | "-" filter rules (as introduced in the FILTER RULES section above). These |
1255 | rules specify a pattern that is matched against the names of the files | |
1256 | that are going to be transferred. These patterns can take several forms: | |
1257 | ||
1258 | itemize( | |
16e5de84 WD |
1259 | it() if the pattern starts with a / then it is anchored to a |
1260 | particular spot in the hierarchy of files, otherwise it is matched | |
1261 | against the end of the pathname. This is similar to a leading ^ in | |
1262 | regular expressions. | |
1263 | Thus "/foo" would match a file called "foo" at either the "root of the | |
1264 | transfer" (for a global rule) or in the merge-file's directory (for a | |
1265 | per-directory rule). | |
1266 | An unqualified "foo" would match any file or directory named "foo" | |
1267 | anywhere in the tree because the algorithm is applied recursively from | |
1268 | the | |
1269 | top down; it behaves as if each path component gets a turn at being the | |
1270 | end of the file name. Even the unanchored "sub/foo" would match at | |
1271 | any point in the hierarchy where a "foo" was found within a directory | |
1272 | named "sub". See the section on ANCHORING INCLUDE/EXCLUDE PATTERNS for | |
1273 | a full discussion of how to specify a pattern that matches at the root | |
1274 | of the transfer. | |
16e5de84 WD |
1275 | it() if the pattern ends with a / then it will only match a |
1276 | directory, not a file, link, or device. | |
16e5de84 WD |
1277 | it() if the pattern contains a wildcard character from the set |
1278 | *?[ then expression matching is applied using the shell filename | |
1279 | matching rules. Otherwise a simple string match is used. | |
16e5de84 WD |
1280 | it() the double asterisk pattern "**" will match slashes while a |
1281 | single asterisk pattern "*" will stop at slashes. | |
16e5de84 WD |
1282 | it() if the pattern contains a / (not counting a trailing /) or a "**" |
1283 | then it is matched against the full pathname, including any leading | |
1284 | directories. If the pattern doesn't contain a / or a "**", then it is | |
1285 | matched only against the final component of the filename. | |
1286 | (Remember that the algorithm is applied recursively so "full filename" | |
ae283632 | 1287 | can actually be any portion of a path from the starting directory on |
16e5de84 | 1288 | down.) |
16e5de84 WD |
1289 | ) |
1290 | ||
faa82484 WD |
1291 | Note that, when using the bf(--recursive) (bf(-r)) option (which is implied by |
1292 | bf(-a)), every subcomponent of every path is visited from the top down, so | |
16e5de84 WD |
1293 | include/exclude patterns get applied recursively to each subcomponent's |
1294 | full name (e.g. to include "/foo/bar/baz" the subcomponents "/foo" and | |
1295 | "/foo/bar" must not be excluded). | |
1296 | The exclude patterns actually short-circuit the directory traversal stage | |
1297 | when rsync finds the files to send. If a pattern excludes a particular | |
1298 | parent directory, it can render a deeper include pattern ineffectual | |
1299 | because rsync did not descend through that excluded section of the | |
1300 | hierarchy. This is particularly important when using a trailing '*' rule. | |
1301 | For instance, this won't work: | |
1302 | ||
faa82484 WD |
1303 | quote( |
1304 | tt(+ /some/path/this-file-will-not-be-found)nl() | |
1305 | tt(+ /file-is-included)nl() | |
1306 | tt(- *)nl() | |
16e5de84 WD |
1307 | ) |
1308 | ||
1309 | This fails because the parent directory "some" is excluded by the '*' | |
1310 | rule, so rsync never visits any of the files in the "some" or "some/path" | |
1311 | directories. One solution is to ask for all directories in the hierarchy | |
1312 | to be included by using a single rule: "+_*/" (put it somewhere before the | |
1313 | "-_*" rule). Another solution is to add specific include rules for all | |
1314 | the parent dirs that need to be visited. For instance, this set of rules | |
1315 | works fine: | |
1316 | ||
faa82484 WD |
1317 | quote( |
1318 | tt(+ /some/)nl() | |
1319 | tt(+ /some/path/)nl() | |
1320 | tt(+ /some/path/this-file-is-found)nl() | |
1321 | tt(+ /file-also-included)nl() | |
1322 | tt(- *)nl() | |
16e5de84 WD |
1323 | ) |
1324 | ||
1325 | Here are some examples of exclude/include matching: | |
1326 | ||
1327 | itemize( | |
1328 | it() "- *.o" would exclude all filenames matching *.o | |
1329 | it() "- /foo" would exclude a file called foo in the transfer-root directory | |
1330 | it() "- foo/" would exclude any directory called foo | |
1331 | it() "- /foo/*/bar" would exclude any file called bar two | |
1332 | levels below a directory called foo in the transfer-root directory | |
1333 | it() "- /foo/**/bar" would exclude any file called bar two | |
1334 | or more levels below a directory called foo in the transfer-root directory | |
faa82484 | 1335 | it() The combination of "+ */", "+ *.c", and "- *" would include all |
16e5de84 WD |
1336 | directories and C source files but nothing else. |
1337 | it() The combination of "+ foo/", "+ foo/bar.c", and "- *" would include | |
1338 | only the foo directory and foo/bar.c (the foo directory must be | |
1339 | explicitly included or it would be excluded by the "*") | |
1340 | ) | |
1341 | ||
1342 | manpagesection(MERGE-FILE FILTER RULES) | |
1343 | ||
1344 | You can merge whole files into your filter rules by specifying either a | |
1345 | "." or a ":" filter rule (as introduced in the FILTER RULES section | |
1346 | above). | |
1347 | ||
1348 | There are two kinds of merged files -- single-instance ('.') and | |
1349 | per-directory (':'). A single-instance merge file is read one time, and | |
1350 | its rules are incorporated into the filter list in the place of the "." | |
1351 | rule. For per-directory merge files, rsync will scan every directory that | |
1352 | it traverses for the named file, merging its contents when the file exists | |
1353 | into the current list of inherited rules. These per-directory rule files | |
1354 | must be created on the sending side because it is the sending side that is | |
1355 | being scanned for the available files to transfer. These rule files may | |
1356 | also need to be transferred to the receiving side if you want them to | |
1357 | affect what files don't get deleted (see PER-DIRECTORY RULES AND DELETE | |
1358 | below). | |
1359 | ||
1360 | Some examples: | |
1361 | ||
faa82484 WD |
1362 | quote( |
1363 | tt(. /etc/rsync/default.rules)nl() | |
1364 | tt(: .per-dir-filter)nl() | |
1365 | tt(:n- .non-inherited-per-dir-excludes)nl() | |
16e5de84 WD |
1366 | ) |
1367 | ||
dc1488ae | 1368 | The following modifiers are accepted after a "." or ":": |
16e5de84 WD |
1369 | |
1370 | itemize( | |
62bf783f | 1371 | it() A bf(-) specifies that the file should consist of only exclude |
16e5de84 WD |
1372 | patterns, with no other rule-parsing except for the list-clearing |
1373 | token ("!"). | |
62bf783f | 1374 | it() A bf(+) specifies that the file should consist of only include |
16e5de84 WD |
1375 | patterns, with no other rule-parsing except for the list-clearing |
1376 | token ("!"). | |
62bf783f | 1377 | it() A bf(C) is a shorthand for the modifiers bf(nw-), which makes the |
16e5de84 WD |
1378 | parsing compatible with the way CVS parses their exclude files. If no |
1379 | filename is specified, ".cvsignore" is assumed. | |
62bf783f | 1380 | it() A bf(e) will exclude the merge-file from the transfer; e.g. |
16e5de84 | 1381 | ":e_.rules" is like ":_.rules" and "-_.rules". |
62bf783f WD |
1382 | it() An bf(n) specifies that the rules are not inherited by subdirectories. |
1383 | it() A bf(w) specifies that the rules are word-split on whitespace instead | |
16e5de84 WD |
1384 | of the normal line-splitting. This also turns off comments. Note: the |
1385 | space that separates the prefix from the rule is treated specially, so | |
62bf783f | 1386 | "- foo + bar" is parsed as two rules (assuming that bf(-) or bf(+) was not |
16e5de84 WD |
1387 | specified to turn off the parsing of prefixes). |
1388 | ) | |
1389 | ||
dc1488ae WD |
1390 | The following modifier is accepted after a "+" or "-": |
1391 | ||
1392 | itemize( | |
1393 | it() A "/" specifies that the include/exclude should be treated as an | |
1394 | absolute path, relative to the root of the filesystem. For example, | |
faa82484 | 1395 | "-/_/etc/passwd" would exclude the passwd file any time the transfer |
dc1488ae WD |
1396 | was sending files from the "/etc" directory. |
1397 | ) | |
1398 | ||
16e5de84 WD |
1399 | Per-directory rules are inherited in all subdirectories of the directory |
1400 | where the merge-file was found unless the 'n' modifier was used. Each | |
1401 | subdirectory's rules are prefixed to the inherited per-directory rules | |
1402 | from its parents, which gives the newest rules a higher priority than the | |
1403 | inherited rules. The entire set of per-dir rules is grouped together in | |
1404 | the spot where the merge-file was specified, so it is possible to override | |
1405 | per-dir rules via a rule that got specified earlier in the list of global | |
1406 | rules. When the list-clearing rule ("!") is read from a per-directory | |
1407 | file, it only clears the inherited rules for the current merge file. | |
1408 | ||
1409 | Another way to prevent a single per-dir rule from being inherited is to | |
1410 | anchor it with a leading slash. Anchored rules in a per-directory | |
1411 | merge-file are relative to the merge-file's directory, so a pattern "/foo" | |
1412 | would only match the file "foo" in the directory where the per-dir filter | |
1413 | file was found. | |
1414 | ||
faa82484 | 1415 | Here's an example filter file which you'd specify via bf(--filter=". file":) |
16e5de84 | 1416 | |
faa82484 WD |
1417 | quote( |
1418 | tt(. /home/user/.global-filter)nl() | |
1419 | tt(- *.gz)nl() | |
1420 | tt(: .rules)nl() | |
1421 | tt(+ *.[ch])nl() | |
1422 | tt(- *.o)nl() | |
16e5de84 WD |
1423 | ) |
1424 | ||
1425 | This will merge the contents of the /home/user/.global-filter file at the | |
1426 | start of the list and also turns the ".rules" filename into a per-directory | |
1427 | filter file. All rules read-in prior to the start of the directory scan | |
1428 | follow the global anchoring rules (i.e. a leading slash matches at the root | |
1429 | of the transfer). | |
1430 | ||
1431 | If a per-directory merge-file is specified with a path that is a parent | |
1432 | directory of the first transfer directory, rsync will scan all the parent | |
1433 | dirs from that starting point to the transfer directory for the indicated | |
faa82484 | 1434 | per-directory file. For instance, here is a common filter (see bf(-F)): |
16e5de84 | 1435 | |
faa82484 | 1436 | quote(tt(--filter=': /.rsync-filter')) |
16e5de84 WD |
1437 | |
1438 | That rule tells rsync to scan for the file .rsync-filter in all | |
1439 | directories from the root down through the parent directory of the | |
1440 | transfer prior to the start of the normal directory scan of the file in | |
1441 | the directories that are sent as a part of the transfer. (Note: for an | |
1442 | rsync daemon, the root is always the same as the module's "path".) | |
1443 | ||
1444 | Some examples of this pre-scanning for per-directory files: | |
1445 | ||
faa82484 WD |
1446 | quote( |
1447 | tt(rsync -avF /src/path/ /dest/dir)nl() | |
1448 | tt(rsync -av --filter=': ../../.rsync-filter' /src/path/ /dest/dir)nl() | |
1449 | tt(rsync -av --filter=': .rsync-filter' /src/path/ /dest/dir)nl() | |
16e5de84 WD |
1450 | ) |
1451 | ||
1452 | The first two commands above will look for ".rsync-filter" in "/" and | |
1453 | "/src" before the normal scan begins looking for the file in "/src/path" | |
1454 | and its subdirectories. The last command avoids the parent-dir scan | |
1455 | and only looks for the ".rsync-filter" files in each directory that is | |
1456 | a part of the transfer. | |
1457 | ||
1458 | If you want to include the contents of a ".cvsignore" in your patterns, | |
1459 | you should use the rule ":C" -- this is a short-hand for the rule | |
62bf783f | 1460 | ":nw-_.cvsignore", and ensures that the .cvsignore file's contents are |
16e5de84 | 1461 | interpreted according to the same parsing rules that CVS uses. You can |
faa82484 | 1462 | use this to affect where the bf(--cvs-exclude) (bf(-C)) option's inclusion of the |
16e5de84 WD |
1463 | per-directory .cvsignore file gets placed into your rules by putting a |
1464 | ":C" wherever you like in your filter rules. Without this, rsync would | |
ae283632 | 1465 | add the per-dir rule for the .cvsignore file at the end of all your other |
16e5de84 WD |
1466 | rules (giving it a lower priority than your command-line rules). For |
1467 | example: | |
1468 | ||
faa82484 WD |
1469 | quote( |
1470 | tt(cat <<EOT | rsync -avC --filter='. -' a/ b)nl() | |
1471 | tt(+ foo.o)nl() | |
1472 | tt(:C)nl() | |
1473 | tt(- *.old)nl() | |
1474 | tt(EOT)nl() | |
1475 | tt(rsync -avC --include=foo.o -f :C --exclude='*.old' a/ b)nl() | |
16e5de84 WD |
1476 | ) |
1477 | ||
1478 | Both of the above rsync commands are identical. Each one will merge all | |
1479 | the per-directory .cvsignore rules in the middle of the list rather than | |
1480 | at the end. This allows their dir-specific rules to supersede the rules | |
1481 | that follow the :C instead of being subservient to all your rules. (The | |
1482 | global rules taken from the $HOME/.cvsignore file and from $CVSIGNORE are | |
1483 | not repositioned from their spot at the end of your rules, however -- feel | |
1484 | free to manually include $HOME/.cvsignore elsewhere in your rules.) | |
1485 | ||
1486 | manpagesection(LIST-CLEARING FILTER RULE) | |
1487 | ||
1488 | You can clear the current include/exclude list by using the "!" filter | |
1489 | rule (as introduced in the FILTER RULES section above). The "current" | |
1490 | list is either the global list of rules (if the rule is encountered while | |
1491 | parsing the filter options) or a set of per-directory rules (which are | |
1492 | inherited in their own sub-list, so a subdirectory can use this to clear | |
1493 | out the parent's rules). | |
1494 | ||
1495 | manpagesection(ANCHORING INCLUDE/EXCLUDE PATTERNS) | |
1496 | ||
1497 | As mentioned earlier, global include/exclude patterns are anchored at the | |
1498 | "root of the transfer" (as opposed to per-directory patterns, which are | |
1499 | anchored at the merge-file's directory). If you think of the transfer as | |
1500 | a subtree of names that are being sent from sender to receiver, the | |
1501 | transfer-root is where the tree starts to be duplicated in the destination | |
1502 | directory. This root governs where patterns that start with a / match. | |
a4b6f305 WD |
1503 | |
1504 | Because the matching is relative to the transfer-root, changing the | |
faa82484 | 1505 | trailing slash on a source path or changing your use of the bf(--relative) |
a4b6f305 WD |
1506 | option affects the path you need to use in your matching (in addition to |
1507 | changing how much of the file tree is duplicated on the destination | |
16e5de84 | 1508 | host). The following examples demonstrate this. |
a4b6f305 | 1509 | |
b5ebe6d9 WD |
1510 | Let's say that we want to match two source files, one with an absolute |
1511 | path of "/home/me/foo/bar", and one with a path of "/home/you/bar/baz". | |
1512 | Here is how the various command choices differ for a 2-source transfer: | |
a4b6f305 | 1513 | |
faa82484 WD |
1514 | quote( |
1515 | Example cmd: rsync -a /home/me /home/you /dest nl() | |
1516 | +/- pattern: /me/foo/bar nl() | |
1517 | +/- pattern: /you/bar/baz nl() | |
1518 | Target file: /dest/me/foo/bar nl() | |
1519 | Target file: /dest/you/bar/baz nl() | |
1520 | ) | |
1521 | ||
1522 | quote( | |
1523 | Example cmd: rsync -a /home/me/ /home/you/ /dest nl() | |
1524 | +/- pattern: /foo/bar (note missing "me") nl() | |
1525 | +/- pattern: /bar/baz (note missing "you") nl() | |
1526 | Target file: /dest/foo/bar nl() | |
1527 | Target file: /dest/bar/baz nl() | |
1528 | ) | |
1529 | ||
1530 | quote( | |
1531 | Example cmd: rsync -a --relative /home/me/ /home/you /dest nl() | |
1532 | +/- pattern: /home/me/foo/bar (note full path) nl() | |
1533 | +/- pattern: /home/you/bar/baz (ditto) nl() | |
1534 | Target file: /dest/home/me/foo/bar nl() | |
1535 | Target file: /dest/home/you/bar/baz nl() | |
1536 | ) | |
1537 | ||
1538 | quote( | |
1539 | Example cmd: cd /home; rsync -a --relative me/foo you/ /dest nl() | |
1540 | +/- pattern: /me/foo/bar (starts at specified path) nl() | |
1541 | +/- pattern: /you/bar/baz (ditto) nl() | |
1542 | Target file: /dest/me/foo/bar nl() | |
1543 | Target file: /dest/you/bar/baz nl() | |
a4b6f305 WD |
1544 | ) |
1545 | ||
16e5de84 | 1546 | The easiest way to see what name you should filter is to just |
faa82484 WD |
1547 | look at the output when using bf(--verbose) and put a / in front of the name |
1548 | (use the bf(--dry-run) option if you're not yet ready to copy any files). | |
d1cce1dd | 1549 | |
16e5de84 | 1550 | manpagesection(PER-DIRECTORY RULES AND DELETE) |
43bd68e5 | 1551 | |
16e5de84 WD |
1552 | Without a delete option, per-directory rules are only relevant on the |
1553 | sending side, so you can feel free to exclude the merge files themselves | |
1554 | without affecting the transfer. To make this easy, the 'e' modifier adds | |
1555 | this exclude for you, as seen in these two equivalent commands: | |
27b9a19b | 1556 | |
faa82484 WD |
1557 | quote( |
1558 | tt(rsync -av --filter=': .excl' --exclude=.excl host:src/dir /dest)nl() | |
1559 | tt(rsync -av --filter=':e .excl' host:src/dir /dest)nl() | |
43bd68e5 AT |
1560 | ) |
1561 | ||
16e5de84 WD |
1562 | However, if you want to do a delete on the receiving side AND you want some |
1563 | files to be excluded from being deleted, you'll need to be sure that the | |
1564 | receiving side knows what files to exclude. The easiest way is to include | |
faa82484 | 1565 | the per-directory merge files in the transfer and use bf(--delete-after), |
16e5de84 WD |
1566 | because this ensures that the receiving side gets all the same exclude |
1567 | rules as the sending side before it tries to delete anything: | |
43bd68e5 | 1568 | |
faa82484 | 1569 | quote(tt(rsync -avF --delete-after host:src/dir /dest)) |
20af605e | 1570 | |
16e5de84 WD |
1571 | However, if the merge files are not a part of the transfer, you'll need to |
1572 | either specify some global exclude rules (i.e. specified on the command | |
1573 | line), or you'll need to maintain your own per-directory merge files on | |
1574 | the receiving side. An example of the first is this (assume that the | |
1575 | remote .rules files exclude themselves): | |
20af605e | 1576 | |
faa82484 WD |
1577 | verb(rsync -av --filter=': .rules' --filter='. /my/extra.rules' |
1578 | --delete host:src/dir /dest) | |
20af605e | 1579 | |
16e5de84 WD |
1580 | In the above example the extra.rules file can affect both sides of the |
1581 | transfer, but (on the sending side) the rules are subservient to the rules | |
1582 | merged from the .rules files because they were specified after the | |
1583 | per-directory merge rule. | |
43bd68e5 | 1584 | |
16e5de84 WD |
1585 | In one final example, the remote side is excluding the .rsync-filter |
1586 | files from the transfer, but we want to use our own .rsync-filter files | |
1587 | to control what gets deleted on the receiving side. To do this we must | |
1588 | specifically exclude the per-directory merge files (so that they don't get | |
1589 | deleted) and then put rules into the local files to control what else | |
1590 | should not get deleted. Like one of these commands: | |
1591 | ||
faa82484 WD |
1592 | verb( rsync -av --filter=':e /.rsync-filter' --delete \ |
1593 | host:src/dir /dest | |
1594 | rsync -avFF --delete host:src/dir /dest) | |
43bd68e5 | 1595 | |
6902ed17 MP |
1596 | manpagesection(BATCH MODE) |
1597 | ||
088aac85 DD |
1598 | Batch mode can be used to apply the same set of updates to many |
1599 | identical systems. Suppose one has a tree which is replicated on a | |
1600 | number of hosts. Now suppose some changes have been made to this | |
1601 | source tree and those changes need to be propagated to the other | |
1602 | hosts. In order to do this using batch mode, rsync is run with the | |
1603 | write-batch option to apply the changes made to the source tree to one | |
1604 | of the destination trees. The write-batch option causes the rsync | |
b9f592fb WD |
1605 | client to store in a "batch file" all the information needed to repeat |
1606 | this operation against other, identical destination trees. | |
1607 | ||
1608 | To apply the recorded changes to another destination tree, run rsync | |
1609 | with the read-batch option, specifying the name of the same batch | |
1610 | file, and the destination tree. Rsync updates the destination tree | |
1611 | using the information stored in the batch file. | |
1612 | ||
1613 | For convenience, one additional file is creating when the write-batch | |
1614 | option is used. This file's name is created by appending | |
73e01568 | 1615 | ".sh" to the batch filename. The .sh file contains |
b9f592fb WD |
1616 | a command-line suitable for updating a destination tree using that |
1617 | batch file. It can be executed using a Bourne(-like) shell, optionally | |
1618 | passing in an alternate destination tree pathname which is then used | |
1619 | instead of the original path. This is useful when the destination tree | |
1620 | path differs from the original destination tree path. | |
1621 | ||
1622 | Generating the batch file once saves having to perform the file | |
1623 | status, checksum, and data block generation more than once when | |
088aac85 | 1624 | updating multiple destination trees. Multicast transport protocols can |
b9f592fb WD |
1625 | be used to transfer the batch update files in parallel to many hosts |
1626 | at once, instead of sending the same data to every host individually. | |
088aac85 | 1627 | |
4602eafa | 1628 | Examples: |
088aac85 | 1629 | |
faa82484 WD |
1630 | quote( |
1631 | tt($ rsync --write-batch=foo -a host:/source/dir/ /adest/dir/)nl() | |
1632 | tt($ scp foo* remote:)nl() | |
1633 | tt($ ssh remote ./foo.sh /bdest/dir/)nl() | |
4602eafa WD |
1634 | ) |
1635 | ||
faa82484 WD |
1636 | quote( |
1637 | tt($ rsync --write-batch=foo -a /source/dir/ /adest/dir/)nl() | |
1638 | tt($ ssh remote rsync --read-batch=- -a /bdest/dir/ <foo)nl() | |
4602eafa WD |
1639 | ) |
1640 | ||
98f51bfb WD |
1641 | In these examples, rsync is used to update /adest/dir/ from /source/dir/ |
1642 | and the information to repeat this operation is stored in "foo" and | |
1643 | "foo.sh". The host "remote" is then updated with the batched data going | |
1644 | into the directory /bdest/dir. The differences between the two examples | |
1645 | reveals some of the flexibility you have in how you deal with batches: | |
1646 | ||
1647 | itemize( | |
98f51bfb WD |
1648 | it() The first example shows that the initial copy doesn't have to be |
1649 | local -- you can push or pull data to/from a remote host using either the | |
1650 | remote-shell syntax or rsync daemon syntax, as desired. | |
98f51bfb WD |
1651 | it() The first example uses the created "foo.sh" file to get the right |
1652 | rsync options when running the read-batch command on the remote host. | |
98f51bfb WD |
1653 | it() The second example reads the batch data via standard input so that |
1654 | the batch file doesn't need to be copied to the remote machine first. | |
1655 | This example avoids the foo.sh script because it needed to use a modified | |
faa82484 | 1656 | bf(--read-batch) option, but you could edit the script file if you wished to |
98f51bfb | 1657 | make use of it (just be sure that no other option is trying to use |
faa82484 | 1658 | standard input, such as the "bf(--exclude-from=-)" option). |
98f51bfb | 1659 | ) |
088aac85 DD |
1660 | |
1661 | Caveats: | |
1662 | ||
98f51bfb | 1663 | The read-batch option expects the destination tree that it is updating |
088aac85 DD |
1664 | to be identical to the destination tree that was used to create the |
1665 | batch update fileset. When a difference between the destination trees | |
7432ccf4 WD |
1666 | is encountered the update might be discarded with no error (if the file |
1667 | appears to be up-to-date already) or the file-update may be attempted | |
1668 | and then, if the file fails to verify, the update discarded with an | |
1669 | error. This means that it should be safe to re-run a read-batch operation | |
59d73bf3 | 1670 | if the command got interrupted. If you wish to force the batched-update to |
faa82484 | 1671 | always be attempted regardless of the file's size and date, use the bf(-I) |
59d73bf3 WD |
1672 | option (when reading the batch). |
1673 | If an error occurs, the destination tree will probably be in a | |
7432ccf4 | 1674 | partially updated state. In that case, rsync can |
088aac85 DD |
1675 | be used in its regular (non-batch) mode of operation to fix up the |
1676 | destination tree. | |
1677 | ||
b9f592fb | 1678 | The rsync version used on all destinations must be at least as new as the |
59d73bf3 WD |
1679 | one used to generate the batch file. Rsync will die with an error if the |
1680 | protocol version in the batch file is too new for the batch-reading rsync | |
1681 | to handle. | |
088aac85 | 1682 | |
faa82484 | 1683 | The bf(--dry-run) (bf(-n)) option does not work in batch mode and yields a runtime |
088aac85 DD |
1684 | error. |
1685 | ||
7432ccf4 WD |
1686 | When reading a batch file, rsync will force the value of certain options |
1687 | to match the data in the batch file if you didn't set them to the same | |
1688 | as the batch-writing command. Other options can (and should) be changed. | |
1689 | For instance | |
faa82484 WD |
1690 | bf(--write-batch) changes to bf(--read-batch), bf(--files-from) is dropped, and the |
1691 | bf(--filter)/bf(--include)/bf(--exclude) options are not needed unless one of the | |
1692 | bf(--delete) options is specified without bf(--delete-excluded). | |
b9f592fb | 1693 | |
faa82484 | 1694 | The code that creates the BATCH.sh file transforms any filter/include/exclude |
98f51bfb WD |
1695 | options into a single list that is appended as a "here" document to the |
1696 | shell script file. An advanced user can use this to modify the exclude | |
faa82484 | 1697 | list if a change in what gets deleted by bf(--delete) is desired. A normal |
98f51bfb | 1698 | user can ignore this detail and just use the shell script as an easy way |
faa82484 | 1699 | to run the appropriate bf(--read-batch) command for the batched data. |
98f51bfb | 1700 | |
59d73bf3 WD |
1701 | The original batch mode in rsync was based on "rsync+", but the latest |
1702 | version uses a new implementation. | |
6902ed17 | 1703 | |
eb06fa95 MP |
1704 | manpagesection(SYMBOLIC LINKS) |
1705 | ||
f28bd833 | 1706 | Three basic behaviors are possible when rsync encounters a symbolic |
eb06fa95 MP |
1707 | link in the source directory. |
1708 | ||
1709 | By default, symbolic links are not transferred at all. A message | |
1710 | "skipping non-regular" file is emitted for any symlinks that exist. | |
1711 | ||
1712 | If bf(--links) is specified, then symlinks are recreated with the same | |
1713 | target on the destination. Note that bf(--archive) implies | |
1714 | bf(--links). | |
1715 | ||
1716 | If bf(--copy-links) is specified, then symlinks are "collapsed" by | |
1717 | copying their referent, rather than the symlink. | |
1718 | ||
1719 | rsync also distinguishes "safe" and "unsafe" symbolic links. An | |
1720 | example where this might be used is a web site mirror that wishes | |
1721 | ensure the rsync module they copy does not include symbolic links to | |
1722 | bf(/etc/passwd) in the public section of the site. Using | |
1723 | bf(--copy-unsafe-links) will cause any links to be copied as the file | |
1724 | they point to on the destination. Using bf(--safe-links) will cause | |
4d888108 | 1725 | unsafe links to be omitted altogether. |
eb06fa95 | 1726 | |
7bd0cf5b MP |
1727 | Symbolic links are considered unsafe if they are absolute symlinks |
1728 | (start with bf(/)), empty, or if they contain enough bf("..") | |
1729 | components to ascend from the directory being copied. | |
1730 | ||
faa82484 | 1731 | manpagediagnostics() |
d310a212 | 1732 | |
14d43f1f | 1733 | rsync occasionally produces error messages that may seem a little |
d310a212 | 1734 | cryptic. The one that seems to cause the most confusion is "protocol |
faa82484 | 1735 | version mismatch -- is your shell clean?". |
d310a212 AT |
1736 | |
1737 | This message is usually caused by your startup scripts or remote shell | |
1738 | facility producing unwanted garbage on the stream that rsync is using | |
14d43f1f | 1739 | for its transport. The way to diagnose this problem is to run your |
d310a212 AT |
1740 | remote shell like this: |
1741 | ||
faa82484 WD |
1742 | quote(tt(ssh remotehost /bin/true > out.dat)) |
1743 | ||
d310a212 | 1744 | then look at out.dat. If everything is working correctly then out.dat |
2cfeab21 | 1745 | should be a zero length file. If you are getting the above error from |
d310a212 AT |
1746 | rsync then you will probably find that out.dat contains some text or |
1747 | data. Look at the contents and try to work out what is producing | |
14d43f1f | 1748 | it. The most common cause is incorrectly configured shell startup |
d310a212 AT |
1749 | scripts (such as .cshrc or .profile) that contain output statements |
1750 | for non-interactive logins. | |
1751 | ||
16e5de84 | 1752 | If you are having trouble debugging filter patterns, then |
faa82484 | 1753 | try specifying the bf(-vv) option. At this level of verbosity rsync will |
e6c64e79 MP |
1754 | show why each individual file is included or excluded. |
1755 | ||
55b64e4b MP |
1756 | manpagesection(EXIT VALUES) |
1757 | ||
1758 | startdit() | |
a73de5f3 | 1759 | dit(bf(0)) Success |
faa82484 WD |
1760 | dit(bf(1)) Syntax or usage error |
1761 | dit(bf(2)) Protocol incompatibility | |
a73de5f3 WD |
1762 | dit(bf(3)) Errors selecting input/output files, dirs |
1763 | dit(bf(4)) Requested action not supported: an attempt | |
8212336a | 1764 | was made to manipulate 64-bit files on a platform that cannot support |
f28bd833 | 1765 | them; or an option was specified that is supported by the client and |
8212336a | 1766 | not by the server. |
a73de5f3 | 1767 | dit(bf(5)) Error starting client-server protocol |
faa82484 WD |
1768 | dit(bf(10)) Error in socket I/O |
1769 | dit(bf(11)) Error in file I/O | |
1770 | dit(bf(12)) Error in rsync protocol data stream | |
1771 | dit(bf(13)) Errors with program diagnostics | |
1772 | dit(bf(14)) Error in IPC code | |
1773 | dit(bf(20)) Received SIGUSR1 or SIGINT | |
1774 | dit(bf(21)) Some error returned by waitpid() | |
1775 | dit(bf(22)) Error allocating core memory buffers | |
3c1e2ad9 WD |
1776 | dit(bf(23)) Partial transfer due to error |
1777 | dit(bf(24)) Partial transfer due to vanished source files | |
faa82484 | 1778 | dit(bf(30)) Timeout in data send/receive |
55b64e4b MP |
1779 | enddit() |
1780 | ||
de2fd20e AT |
1781 | manpagesection(ENVIRONMENT VARIABLES) |
1782 | ||
1783 | startdit() | |
de2fd20e | 1784 | dit(bf(CVSIGNORE)) The CVSIGNORE environment variable supplements any |
faa82484 | 1785 | ignore patterns in .cvsignore files. See the bf(--cvs-exclude) option for |
de2fd20e | 1786 | more details. |
de2fd20e | 1787 | dit(bf(RSYNC_RSH)) The RSYNC_RSH environment variable allows you to |
ea7f8108 | 1788 | override the default shell used as the transport for rsync. Command line |
faa82484 | 1789 | options are permitted after the command name, just as in the bf(-e) option. |
4c3b4b25 AT |
1790 | dit(bf(RSYNC_PROXY)) The RSYNC_PROXY environment variable allows you to |
1791 | redirect your rsync client to use a web proxy when connecting to a | |
1792 | rsync daemon. You should set RSYNC_PROXY to a hostname:port pair. | |
de2fd20e | 1793 | dit(bf(RSYNC_PASSWORD)) Setting RSYNC_PASSWORD to the required |
bb18e755 | 1794 | password allows you to run authenticated rsync connections to an rsync |
de2fd20e AT |
1795 | daemon without user intervention. Note that this does not supply a |
1796 | password to a shell transport such as ssh. | |
de2fd20e | 1797 | dit(bf(USER) or bf(LOGNAME)) The USER or LOGNAME environment variables |
bb18e755 | 1798 | are used to determine the default username sent to an rsync server. |
4b2f6a7c | 1799 | If neither is set, the username defaults to "nobody". |
14d43f1f | 1800 | dit(bf(HOME)) The HOME environment variable is used to find the user's |
de2fd20e | 1801 | default .cvsignore file. |
de2fd20e AT |
1802 | enddit() |
1803 | ||
41059f75 AT |
1804 | manpagefiles() |
1805 | ||
30e8c8e1 | 1806 | /etc/rsyncd.conf or rsyncd.conf |
41059f75 AT |
1807 | |
1808 | manpageseealso() | |
1809 | ||
1810 | rsyncd.conf(5) | |
1811 | ||
41059f75 AT |
1812 | manpagebugs() |
1813 | ||
1814 | times are transferred as unix time_t values | |
1815 | ||
f28bd833 | 1816 | When transferring to FAT filesystems rsync may re-sync |
38843171 | 1817 | unmodified files. |
faa82484 | 1818 | See the comments on the bf(--modify-window) option. |
38843171 | 1819 | |
b5accaba | 1820 | file permissions, devices, etc. are transferred as native numerical |
41059f75 AT |
1821 | values |
1822 | ||
faa82484 | 1823 | see also the comments on the bf(--delete) option |
41059f75 | 1824 | |
38843171 DD |
1825 | Please report bugs! See the website at |
1826 | url(http://rsync.samba.org/)(http://rsync.samba.org/) | |
41059f75 AT |
1827 | |
1828 | manpagesection(CREDITS) | |
1829 | ||
1830 | rsync is distributed under the GNU public license. See the file | |
1831 | COPYING for details. | |
1832 | ||
41059f75 | 1833 | A WEB site is available at |
3cd5eb3b MP |
1834 | url(http://rsync.samba.org/)(http://rsync.samba.org/). The site |
1835 | includes an FAQ-O-Matic which may cover questions unanswered by this | |
1836 | manual page. | |
9e3c856a AT |
1837 | |
1838 | The primary ftp site for rsync is | |
1839 | url(ftp://rsync.samba.org/pub/rsync)(ftp://rsync.samba.org/pub/rsync). | |
41059f75 AT |
1840 | |
1841 | We would be delighted to hear from you if you like this program. | |
1842 | ||
9e3c856a AT |
1843 | This program uses the excellent zlib compression library written by |
1844 | Jean-loup Gailly and Mark Adler. | |
41059f75 AT |
1845 | |
1846 | manpagesection(THANKS) | |
1847 | ||
1848 | Thanks to Richard Brent, Brendan Mackay, Bill Waite, Stephen Rothwell | |
7ff701e8 MP |
1849 | and David Bell for helpful suggestions, patches and testing of rsync. |
1850 | I've probably missed some people, my apologies if I have. | |
1851 | ||
ce5f2732 | 1852 | Especial thanks also to: David Dykstra, Jos Backus, Sebastian Krahmer, |
98f51bfb | 1853 | Martin Pool, Wayne Davison, J.W. Schultz. |
41059f75 AT |
1854 | |
1855 | manpageauthor() | |
1856 | ||
ce5f2732 MP |
1857 | rsync was originally written by Andrew Tridgell and Paul Mackerras. |
1858 | Many people have later contributed to it. | |
3cd5eb3b | 1859 | |
a5d74a18 | 1860 | Mailing lists for support and development are available at |
faa82484 | 1861 | url(http://lists.samba.org)(lists.samba.org) |