Commit | Line | Data |
---|---|---|
9e3c856a | 1 | mailto(rsync-bugs@samba.org) |
db8f3f73 | 2 | manpage(rsync)(1)(29 Jun 2008)()() |
ddf8c2b0 | 3 | manpagename(rsync)(a fast, versatile, remote (and local) file-copying tool) |
41059f75 AT |
4 | manpagesynopsis() |
5 | ||
ddf8c2b0 | 6 | verb(Local: rsync [OPTION...] SRC... [DEST] |
868676dc | 7 | |
8f61dfdb | 8 | Access via remote shell: |
ddf8c2b0 WD |
9 | Pull: rsync [OPTION...] [USER@]HOST:SRC... [DEST] |
10 | Push: rsync [OPTION...] SRC... [USER@]HOST:DEST | |
41059f75 | 11 | |
8f61dfdb | 12 | Access via rsync daemon: |
ddf8c2b0 WD |
13 | Pull: rsync [OPTION...] [USER@]HOST::SRC... [DEST] |
14 | rsync [OPTION...] rsync://[USER@]HOST[:PORT]/SRC... [DEST] | |
15 | Push: rsync [OPTION...] SRC... [USER@]HOST::DEST | |
16 | rsync [OPTION...] SRC... rsync://[USER@]HOST[:PORT]/DEST) | |
41059f75 | 17 | |
a6fa5bde WD |
18 | Usages with just one SRC arg and no DEST arg will list the source files |
19 | instead of copying. | |
039faa86 | 20 | |
41059f75 AT |
21 | manpagedescription() |
22 | ||
a6fa5bde WD |
23 | Rsync is a fast and extraordinarily versatile file copying tool. It can |
24 | copy locally, to/from another host over any remote shell, or to/from a | |
25 | remote rsync daemon. It offers a large number of options that control | |
26 | every aspect of its behavior and permit very flexible specification of the | |
27 | set of files to be copied. It is famous for its delta-transfer algorithm, | |
28 | which reduces the amount of data sent over the network by sending only the | |
29 | differences between the source files and the existing files in the | |
30 | destination. Rsync is widely used for backups and mirroring and as an | |
31 | improved copy command for everyday use. | |
32 | ||
33 | Rsync finds files that need to be transferred using a "quick check" | |
34 | algorithm (by default) that looks for files that have changed in size or | |
35 | in last-modified time. Any changes in the other preserved attributes (as | |
36 | requested by options) are made on the destination file directly when the | |
37 | quick check indicates that the file's data does not need to be updated. | |
1874f7e2 | 38 | |
41059f75 AT |
39 | Some of the additional features of rsync are: |
40 | ||
b8a6dae0 | 41 | itemization( |
b9f592fb | 42 | it() support for copying links, devices, owners, groups, and permissions |
41059f75 AT |
43 | it() exclude and exclude-from options similar to GNU tar |
44 | it() a CVS exclude mode for ignoring the same files that CVS would ignore | |
43cd760f | 45 | it() can use any transparent remote shell, including ssh or rsh |
d38772e0 | 46 | it() does not require super-user privileges |
41059f75 | 47 | it() pipelining of file transfers to minimize latency costs |
5a727522 | 48 | it() support for anonymous or authenticated rsync daemons (ideal for |
41059f75 AT |
49 | mirroring) |
50 | ) | |
51 | ||
52 | manpagesection(GENERAL) | |
53 | ||
15997547 WD |
54 | Rsync copies files either to or from a remote host, or locally on the |
55 | current host (it does not support copying files between two remote hosts). | |
56 | ||
57 | There are two different ways for rsync to contact a remote system: using a | |
58 | remote-shell program as the transport (such as ssh or rsh) or contacting an | |
59 | rsync daemon directly via TCP. The remote-shell transport is used whenever | |
60 | the source or destination path contains a single colon (:) separator after | |
61 | a host specification. Contacting an rsync daemon directly happens when the | |
62 | source or destination path contains a double colon (::) separator after a | |
ba3542cf | 63 | host specification, OR when an rsync:// URL is specified (see also the |
754a080f | 64 | "USING RSYNC-DAEMON FEATURES VIA A REMOTE-SHELL CONNECTION" section for |
ba3542cf | 65 | an exception to this latter rule). |
15997547 | 66 | |
c897f711 WD |
67 | As a special case, if a single source arg is specified without a |
68 | destination, the files are listed in an output format similar to "ls -l". | |
15997547 WD |
69 | |
70 | As expected, if neither the source or destination path specify a remote | |
71 | host, the copy occurs locally (see also the bf(--list-only) option). | |
72 | ||
1049378d WD |
73 | Rsync refers to the local side as the "client" and the remote side as the |
74 | "server". Don't confuse "server" with an rsync daemon -- a daemon is always a | |
75 | server, but a server can be either a daemon or a remote-shell spawned process. | |
76 | ||
41059f75 AT |
77 | manpagesection(SETUP) |
78 | ||
79 | See the file README for installation instructions. | |
80 | ||
1bbf83c0 WD |
81 | Once installed, you can use rsync to any machine that you can access via |
82 | a remote shell (as well as some that you can access using the rsync | |
43cd760f | 83 | daemon-mode protocol). For remote transfers, a modern rsync uses ssh |
1bbf83c0 | 84 | for its communications, but it may have been configured to use a |
43cd760f | 85 | different remote shell by default, such as rsh or remsh. |
41059f75 | 86 | |
faa82484 | 87 | You can also specify any remote shell you like, either by using the bf(-e) |
41059f75 AT |
88 | command line option, or by setting the RSYNC_RSH environment variable. |
89 | ||
8e987130 | 90 | Note that rsync must be installed on both the source and destination |
faa82484 | 91 | machines. |
8e987130 | 92 | |
41059f75 AT |
93 | manpagesection(USAGE) |
94 | ||
95 | You use rsync in the same way you use rcp. You must specify a source | |
96 | and a destination, one of which may be remote. | |
97 | ||
4d888108 | 98 | Perhaps the best way to explain the syntax is with some examples: |
41059f75 | 99 | |
faa82484 | 100 | quote(tt(rsync -t *.c foo:src/)) |
41059f75 | 101 | |
8a97fc2e | 102 | This would transfer all files matching the pattern *.c from the |
41059f75 AT |
103 | current directory to the directory src on the machine foo. If any of |
104 | the files already exist on the remote system then the rsync | |
105 | remote-update protocol is used to update the file by sending only the | |
106 | differences. See the tech report for details. | |
107 | ||
faa82484 | 108 | quote(tt(rsync -avz foo:src/bar /data/tmp)) |
41059f75 | 109 | |
8a97fc2e | 110 | This would recursively transfer all files from the directory src/bar on the |
41059f75 AT |
111 | machine foo into the /data/tmp/bar directory on the local machine. The |
112 | files are transferred in "archive" mode, which ensures that symbolic | |
b5accaba | 113 | links, devices, attributes, permissions, ownerships, etc. are preserved |
14d43f1f | 114 | in the transfer. Additionally, compression will be used to reduce the |
41059f75 AT |
115 | size of data portions of the transfer. |
116 | ||
faa82484 | 117 | quote(tt(rsync -avz foo:src/bar/ /data/tmp)) |
41059f75 | 118 | |
8a97fc2e WD |
119 | A trailing slash on the source changes this behavior to avoid creating an |
120 | additional directory level at the destination. You can think of a trailing | |
121 | / on a source as meaning "copy the contents of this directory" as opposed | |
122 | to "copy the directory by name", but in both cases the attributes of the | |
123 | containing directory are transferred to the containing directory on the | |
124 | destination. In other words, each of the following commands copies the | |
125 | files in the same way, including their setting of the attributes of | |
126 | /dest/foo: | |
127 | ||
faa82484 WD |
128 | quote( |
129 | tt(rsync -av /src/foo /dest)nl() | |
130 | tt(rsync -av /src/foo/ /dest/foo)nl() | |
131 | ) | |
41059f75 | 132 | |
c4833b02 WD |
133 | Note also that host and module references don't require a trailing slash to |
134 | copy the contents of the default directory. For example, both of these | |
135 | copy the remote directory's contents into "/dest": | |
136 | ||
137 | quote( | |
138 | tt(rsync -av host: /dest)nl() | |
139 | tt(rsync -av host::module /dest)nl() | |
140 | ) | |
141 | ||
41059f75 AT |
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 | ||
bb9bdba4 WD |
146 | Finally, you can list all the (listable) modules available from a |
147 | particular rsync daemon by leaving off the module name: | |
148 | ||
faa82484 | 149 | quote(tt(rsync somehost.mydomain.com::)) |
14d43f1f | 150 | |
bb9bdba4 | 151 | See the following section for more details. |
14d43f1f | 152 | |
675ef1aa WD |
153 | manpagesection(ADVANCED USAGE) |
154 | ||
f92e15ef WD |
155 | The syntax for requesting multiple files from a remote host is done by |
156 | specifying additional remote-host args in the same style as the first, | |
157 | or with the hostname omitted. For instance, all these work: | |
675ef1aa | 158 | |
f92e15ef WD |
159 | quote(tt(rsync -av host:file1 :file2 host:file{3,4} /dest/)nl() |
160 | tt(rsync -av host::modname/file{1,2} host::modname/file3 /dest/)nl() | |
161 | tt(rsync -av host::modname/file1 ::modname/file{3,4})) | |
675ef1aa | 162 | |
f92e15ef WD |
163 | Older versions of rsync required using quoted spaces in the SRC, like these |
164 | examples: | |
675ef1aa | 165 | |
f92e15ef WD |
166 | quote(tt(rsync -av host:'dir1/file1 dir2/file2' /dest)nl() |
167 | tt(rsync host::'modname/dir1/file1 modname/dir2/file2' /dest)) | |
675ef1aa | 168 | |
f92e15ef WD |
169 | This word-splitting still works (by default) in the latest rsync, but is |
170 | not as easy to use as the first method. | |
675ef1aa | 171 | |
f92e15ef WD |
172 | If you need to transfer a filename that contains whitespace, you can either |
173 | specify the bf(--protect-args) (bf(-s)) option, or you'll need to escape | |
174 | the whitespace in a way that the remote shell will understand. For | |
175 | instance: | |
675ef1aa | 176 | |
f92e15ef | 177 | quote(tt(rsync -av host:'file\ name\ with\ spaces' /dest)) |
675ef1aa | 178 | |
5a727522 | 179 | manpagesection(CONNECTING TO AN RSYNC DAEMON) |
41059f75 | 180 | |
754a080f WD |
181 | It is also possible to use rsync without a remote shell as the transport. |
182 | In this case you will directly connect to a remote rsync daemon, typically | |
183 | using TCP port 873. (This obviously requires the daemon to be running on | |
184 | the remote system, so refer to the STARTING AN RSYNC DAEMON TO ACCEPT | |
185 | CONNECTIONS section below for information on that.) | |
4c3b4b25 | 186 | |
1bbf83c0 | 187 | Using rsync in this way is the same as using it with a remote shell except |
41059f75 AT |
188 | that: |
189 | ||
b8a6dae0 | 190 | itemization( |
62f27e3c WD |
191 | it() you either use a double colon :: instead of a single colon to |
192 | separate the hostname from the path, or you use an rsync:// URL. | |
2c64b258 | 193 | it() the first word of the "path" is actually a module name. |
5a727522 | 194 | it() the remote daemon may print a message of the day when you |
14d43f1f | 195 | connect. |
5a727522 WD |
196 | it() if you specify no path name on the remote daemon then the |
197 | list of accessible paths on the daemon will be shown. | |
f7632fc6 | 198 | it() if you specify no local destination then a listing of the |
5a727522 | 199 | specified files on the remote daemon is provided. |
2c64b258 | 200 | it() you must not specify the bf(--rsh) (bf(-e)) option. |
41059f75 AT |
201 | ) |
202 | ||
754a080f WD |
203 | An example that copies all the files in a remote module named "src": |
204 | ||
205 | verb( rsync -av host::src /dest) | |
206 | ||
207 | Some modules on the remote daemon may require authentication. If so, | |
4c3d16be AT |
208 | you will receive a password prompt when you connect. You can avoid the |
209 | password prompt by setting the environment variable RSYNC_PASSWORD to | |
faa82484 | 210 | the password you want to use or using the bf(--password-file) option. This |
65575e96 | 211 | may be useful when scripting rsync. |
4c3d16be | 212 | |
3bc67f0c | 213 | WARNING: On some systems environment variables are visible to all |
faa82484 | 214 | users. On those systems using bf(--password-file) is recommended. |
3bc67f0c | 215 | |
754a080f WD |
216 | You may establish the connection via a web proxy by setting the |
217 | environment variable RSYNC_PROXY to a hostname:port pair pointing to | |
218 | your web proxy. Note that your web proxy's configuration must support | |
219 | proxy connections to port 873. | |
bef49340 | 220 | |
b553a3dd WD |
221 | You may also establish a daemon connection using a program as a proxy by |
222 | setting the environment variable RSYNC_CONNECT_PROG to the commands you | |
223 | wish to run in place of making a direct socket connection. The string may | |
224 | contain the escape "%H" to represent the hostname specified in the rsync | |
225 | command (so use "%%" if you need a single "%" in your string). For | |
226 | example: | |
227 | ||
228 | verb( export RSYNC_CONNECT_PROG='ssh proxyhost nc %H 873' | |
229 | rsync -av targethost1::module/src/ /dest/ | |
230 | rsync -av rsync:://targethost2/module/src/ /dest/ ) | |
231 | ||
84e1a34e | 232 | The command specified above uses ssh to run nc (netcat) on a proxyhost, |
b553a3dd WD |
233 | which forwards all data to port 873 (the rsync daemon) on the targethost |
234 | (%H). | |
235 | ||
754a080f WD |
236 | manpagesection(USING RSYNC-DAEMON FEATURES VIA A REMOTE-SHELL CONNECTION) |
237 | ||
238 | It is sometimes useful to use various features of an rsync daemon (such as | |
239 | named modules) without actually allowing any new socket connections into a | |
240 | system (other than what is already required to allow remote-shell access). | |
241 | Rsync supports connecting to a host using a remote shell and then spawning | |
242 | a single-use "daemon" server that expects to read its config file in the | |
243 | home dir of the remote user. This can be useful if you want to encrypt a | |
244 | daemon-style transfer's data, but since the daemon is started up fresh by | |
245 | the remote user, you may not be able to use features such as chroot or | |
246 | change the uid used by the daemon. (For another way to encrypt a daemon | |
247 | transfer, consider using ssh to tunnel a local port to a remote machine and | |
248 | configure a normal rsync daemon on that remote host to only allow | |
249 | connections from "localhost".) | |
250 | ||
251 | From the user's perspective, a daemon transfer via a remote-shell | |
252 | connection uses nearly the same command-line syntax as a normal | |
253 | rsync-daemon transfer, with the only exception being that you must | |
254 | explicitly set the remote shell program on the command-line with the | |
255 | bf(--rsh=COMMAND) option. (Setting the RSYNC_RSH in the environment | |
256 | will not turn on this functionality.) For example: | |
257 | ||
258 | verb( rsync -av --rsh=ssh host::module /dest) | |
259 | ||
260 | If you need to specify a different remote-shell user, keep in mind that the | |
261 | user@ prefix in front of the host is specifying the rsync-user value (for a | |
262 | module that requires user-based authentication). This means that you must | |
f2ebbebe WD |
263 | give the '-l user' option to ssh when specifying the remote-shell, as in |
264 | this example that uses the short version of the bf(--rsh) option: | |
754a080f WD |
265 | |
266 | verb( rsync -av -e "ssh -l ssh-user" rsync-user@host::module /dest) | |
bef49340 WD |
267 | |
268 | The "ssh-user" will be used at the ssh level; the "rsync-user" will be | |
754a080f | 269 | used to log-in to the "module". |
bef49340 | 270 | |
754a080f | 271 | manpagesection(STARTING AN RSYNC DAEMON TO ACCEPT CONNECTIONS) |
bef49340 | 272 | |
754a080f WD |
273 | In order to connect to an rsync daemon, the remote system needs to have a |
274 | daemon already running (or it needs to have configured something like inetd | |
275 | to spawn an rsync daemon for incoming connections on a particular port). | |
276 | For full information on how to start a daemon that will handling incoming | |
49f4cfdf | 277 | socket connections, see the bf(rsyncd.conf)(5) man page -- that is the config |
754a080f WD |
278 | file for the daemon, and it contains the full details for how to run the |
279 | daemon (including stand-alone and inetd configurations). | |
bef49340 | 280 | |
754a080f WD |
281 | If you're using one of the remote-shell transports for the transfer, there is |
282 | no need to manually start an rsync daemon. | |
bef49340 | 283 | |
41059f75 AT |
284 | manpagesection(EXAMPLES) |
285 | ||
286 | Here are some examples of how I use rsync. | |
287 | ||
14d43f1f DD |
288 | To backup my wife's home directory, which consists of large MS Word |
289 | files and mail folders, I use a cron job that runs | |
41059f75 | 290 | |
faa82484 | 291 | quote(tt(rsync -Cavz . arvidsjaur:backup)) |
41059f75 | 292 | |
f39281ae | 293 | each night over a PPP connection to a duplicate directory on my machine |
41059f75 AT |
294 | "arvidsjaur". |
295 | ||
296 | To synchronize my samba source trees I use the following Makefile | |
297 | targets: | |
298 | ||
faa82484 WD |
299 | verb( get: |
300 | rsync -avuzb --exclude '*~' samba:samba/ . | |
301 | put: | |
302 | rsync -Cavuzb . samba:samba/ | |
303 | sync: get put) | |
41059f75 AT |
304 | |
305 | this allows me to sync with a CVS directory at the other end of the | |
ae283632 WD |
306 | connection. I then do CVS operations on the remote machine, which saves a |
307 | lot of time as the remote CVS protocol isn't very efficient. | |
41059f75 AT |
308 | |
309 | I mirror a directory between my "old" and "new" ftp sites with the | |
faa82484 | 310 | command: |
41059f75 | 311 | |
faa82484 | 312 | tt(rsync -az -e ssh --delete ~ftp/pub/samba nimbus:"~ftp/pub/tridge") |
41059f75 | 313 | |
faa82484 | 314 | This is launched from cron every few hours. |
41059f75 | 315 | |
c95da96a AT |
316 | manpagesection(OPTIONS SUMMARY) |
317 | ||
14d43f1f | 318 | Here is a short summary of the options available in rsync. Please refer |
faa82484 | 319 | to the detailed description below for a complete description. verb( |
c95da96a | 320 | -v, --verbose increase verbosity |
951e826b WD |
321 | --info=FLAGS fine-grained informational verbosity |
322 | --debug=FLAGS fine-grained debug verbosity | |
44d98d61 | 323 | -q, --quiet suppress non-error messages |
1de02c27 | 324 | --no-motd suppress daemon-mode MOTD (see caveat) |
44d98d61 | 325 | -c, --checksum skip based on checksum, not mod-time & size |
16edf865 | 326 | -a, --archive archive mode; equals -rlptgoD (no -H,-A,-X) |
f40aa6fb | 327 | --no-OPTION turn off an implied OPTION (e.g. --no-D) |
c95da96a AT |
328 | -r, --recursive recurse into directories |
329 | -R, --relative use relative path names | |
f40aa6fb | 330 | --no-implied-dirs don't send implied dirs with --relative |
915dd207 | 331 | -b, --backup make backups (see --suffix & --backup-dir) |
44d98d61 | 332 | --backup-dir=DIR make backups into hierarchy based in DIR |
915dd207 | 333 | --suffix=SUFFIX backup suffix (default ~ w/o --backup-dir) |
44d98d61 WD |
334 | -u, --update skip files that are newer on the receiver |
335 | --inplace update destination files in-place | |
94f20a9f | 336 | --append append data onto shorter files |
84e1a34e | 337 | --append-verify --append w/old data in file checksum |
09ed3099 | 338 | -d, --dirs transfer directories without recursing |
eb06fa95 | 339 | -l, --links copy symlinks as symlinks |
44d98d61 WD |
340 | -L, --copy-links transform symlink into referent file/dir |
341 | --copy-unsafe-links only "unsafe" symlinks are transformed | |
342 | --safe-links ignore symlinks that point outside the tree | |
41adbcec | 343 | --munge-links munge symlinks to make them safer |
f2ebbebe | 344 | -k, --copy-dirlinks transform symlink to dir into referent dir |
09ed3099 | 345 | -K, --keep-dirlinks treat symlinked dir on receiver as dir |
f2ebbebe | 346 | -H, --hard-links preserve hard links |
c95da96a | 347 | -p, --perms preserve permissions |
2d5279ac | 348 | -E, --executability preserve executability |
dfe1ed5e | 349 | --chmod=CHMOD affect file and/or directory permissions |
1c3344a1 | 350 | -A, --acls preserve ACLs (implies -p) |
eb7e7b24 | 351 | -X, --xattrs preserve extended attributes |
d38772e0 | 352 | -o, --owner preserve owner (super-user only) |
c95da96a | 353 | -g, --group preserve group |
d38772e0 | 354 | --devices preserve device files (super-user only) |
4e7d07c8 WD |
355 | --specials preserve special files |
356 | -D same as --devices --specials | |
42b06481 WD |
357 | -t, --times preserve modification times |
358 | -O, --omit-dir-times omit directories from --times | |
2624e005 | 359 | -J, --omit-link-times omit symlinks from --times |
d38772e0 | 360 | --super receiver attempts super-user activities |
9439c0cb | 361 | --fake-super store/recover privileged attrs using xattrs |
c95da96a | 362 | -S, --sparse handle sparse files efficiently |
28b519c9 | 363 | --preallocate allocate dest files before writing |
d100e733 | 364 | -n, --dry-run perform a trial run with no changes made |
f7a2ac07 | 365 | -W, --whole-file copy files whole (w/o delta-xfer algorithm) |
c95da96a | 366 | -x, --one-file-system don't cross filesystem boundaries |
3ed8eb3f | 367 | -B, --block-size=SIZE force a fixed checksum block-size |
44d98d61 | 368 | -e, --rsh=COMMAND specify the remote shell to use |
68e169ab | 369 | --rsync-path=PROGRAM specify the rsync to run on remote machine |
8517e9c1 WD |
370 | --existing skip creating new files on receiver |
371 | --ignore-existing skip updating files that exist on receiver | |
47c11975 | 372 | --remove-source-files sender removes synchronized files (non-dir) |
ae76a740 | 373 | --del an alias for --delete-during |
8517e9c1 | 374 | --delete delete extraneous files from dest dirs |
416cef36 WD |
375 | --delete-before receiver deletes before xfer, not during |
376 | --delete-during receiver deletes during transfer (default) | |
fd0a130c | 377 | --delete-delay find deletions during, delete after |
ae76a740 | 378 | --delete-after receiver deletes after transfer, not before |
8517e9c1 | 379 | --delete-excluded also delete excluded files from dest dirs |
42d8ec61 WD |
380 | --ignore-missing-args ignore missing source args without error |
381 | --delete-missing-args delete missing source args from destination | |
b5accaba | 382 | --ignore-errors delete even if there are I/O errors |
866925bf | 383 | --force force deletion of dirs even if not empty |
0b73ca12 | 384 | --max-delete=NUM don't delete more than NUM files |
3610c458 | 385 | --max-size=SIZE don't transfer any file larger than SIZE |
59dd6786 | 386 | --min-size=SIZE don't transfer any file smaller than SIZE |
c95da96a | 387 | --partial keep partially transferred files |
44cad59f | 388 | --partial-dir=DIR put a partially transferred file into DIR |
44d98d61 | 389 | --delay-updates put all updated files into place at end |
a272ff8c | 390 | -m, --prune-empty-dirs prune empty directory chains from file-list |
c95da96a | 391 | --numeric-ids don't map uid/gid values by user/group name |
2df20057 WD |
392 | --usermap=STRING custom username mapping |
393 | --groupmap=STRING custom groupname mapping | |
394 | --chown=USER:GROUP simple username/groupname mapping | |
ba22c9e2 WD |
395 | --timeout=SECONDS set I/O timeout in seconds |
396 | --contimeout=SECONDS set daemon connection timeout in seconds | |
44d98d61 WD |
397 | -I, --ignore-times don't skip files that match size and time |
398 | --size-only skip files that match in size | |
399 | --modify-window=NUM compare mod-times with reduced accuracy | |
abce74bb | 400 | -T, --temp-dir=DIR create temporary files in directory DIR |
5b483755 | 401 | -y, --fuzzy find similar file for basis if no dest file |
915dd207 | 402 | --compare-dest=DIR also compare received files relative to DIR |
2f03ce67 | 403 | --copy-dest=DIR ... and include copies of unchanged files |
b127c1dc | 404 | --link-dest=DIR hardlink to files in DIR when unchanged |
32a5edf4 | 405 | -z, --compress compress file data during the transfer |
bad01106 | 406 | --compress-level=NUM explicitly set compression level |
2b967218 | 407 | --skip-compress=LIST skip compressing files with suffix in LIST |
44d98d61 | 408 | -C, --cvs-exclude auto-ignore files in the same way CVS does |
16e5de84 | 409 | -f, --filter=RULE add a file-filtering RULE |
8a6f3fea | 410 | -F same as --filter='dir-merge /.rsync-filter' |
16e5de84 | 411 | repeated: --filter='- .rsync-filter' |
2acf81eb | 412 | --exclude=PATTERN exclude files matching PATTERN |
44d98d61 | 413 | --exclude-from=FILE read exclude patterns from FILE |
2acf81eb | 414 | --include=PATTERN don't exclude files matching PATTERN |
44d98d61 WD |
415 | --include-from=FILE read include patterns from FILE |
416 | --files-from=FILE read list of source-file names from FILE | |
fa92818a | 417 | -0, --from0 all *from/filter files are delimited by 0s |
82f37486 | 418 | -s, --protect-args no space-splitting; wildcard chars only |
3ae5367f | 419 | --address=ADDRESS bind address for outgoing socket to daemon |
c259892c | 420 | --port=PORT specify double-colon alternate port number |
04f48837 | 421 | --sockopts=OPTIONS specify custom TCP options |
b5accaba | 422 | --blocking-io use blocking I/O for the remote shell |
44d98d61 | 423 | --stats give some file-transfer stats |
a6a27602 | 424 | -8, --8-bit-output leave high-bit chars unescaped in output |
955c3145 | 425 | -h, --human-readable output numbers in a human-readable format |
eb86d661 | 426 | --progress show progress during transfer |
44d98d61 | 427 | -P same as --partial --progress |
b78296cb | 428 | -i, --itemize-changes output a change-summary for all updates |
7a2eca41 | 429 | -M, --remote-option=OPTION send OPTION to the remote side only |
c000002f WD |
430 | --out-format=FORMAT output updates using the specified FORMAT |
431 | --log-file=FILE log what we're doing to the specified FILE | |
432 | --log-file-format=FMT log updates using the specified FMT | |
09a54c39 | 433 | --password-file=FILE read daemon-access password from FILE |
09ed3099 | 434 | --list-only list the files instead of copying them |
ce795fcd | 435 | --bwlimit=RATE limit socket I/O bandwidth |
faa82484 | 436 | --write-batch=FILE write a batched update to FILE |
326bb56e | 437 | --only-write-batch=FILE like --write-batch but w/o updating dest |
44d98d61 | 438 | --read-batch=FILE read a batched update from FILE |
0b941479 | 439 | --protocol=NUM force an older protocol version to be used |
84e1a34e | 440 | --iconv=CONVERT_SPEC request charset conversion of filenames |
44d98d61 | 441 | --checksum-seed=NUM set block/file checksum seed (advanced) |
abce74bb WD |
442 | -4, --ipv4 prefer IPv4 |
443 | -6, --ipv6 prefer IPv6 | |
81c453b1 | 444 | --version print version number |
b8a6dae0 | 445 | (-h) --help show this help (see below for -h comment)) |
6902ed17 | 446 | |
faa82484 WD |
447 | Rsync can also be run as a daemon, in which case the following options are |
448 | accepted: verb( | |
bdf278f7 WD |
449 | --daemon run as an rsync daemon |
450 | --address=ADDRESS bind to the specified address | |
ce795fcd | 451 | --bwlimit=RATE limit socket I/O bandwidth |
bdf278f7 | 452 | --config=FILE specify alternate rsyncd.conf file |
2206abf8 | 453 | -M, --dparam=OVERRIDE override global daemon config parameter |
bdf278f7 | 454 | --no-detach do not detach from the parent |
c259892c | 455 | --port=PORT listen on alternate port number |
a2ed5801 | 456 | --log-file=FILE override the "log file" setting |
4b90820d | 457 | --log-file-format=FMT override the "log format" setting |
04f48837 | 458 | --sockopts=OPTIONS specify custom TCP options |
24b0922b | 459 | -v, --verbose increase verbosity |
abce74bb WD |
460 | -4, --ipv4 prefer IPv4 |
461 | -6, --ipv6 prefer IPv6 | |
b8a6dae0 | 462 | -h, --help show this help (if used after --daemon)) |
c95da96a | 463 | |
41059f75 AT |
464 | manpageoptions() |
465 | ||
466 | rsync uses the GNU long options package. Many of the command line | |
467 | options have two variants, one short and one long. These are shown | |
14d43f1f | 468 | below, separated by commas. Some options only have a long variant. |
b5679335 DD |
469 | The '=' for options that take a parameter is optional; whitespace |
470 | can be used instead. | |
41059f75 AT |
471 | |
472 | startdit() | |
955c3145 WD |
473 | dit(bf(--help)) Print a short help page describing the options |
474 | available in rsync and exit. For backward-compatibility with older | |
467688dc WD |
475 | versions of rsync, the help will also be output if you use the bf(-h) |
476 | option without any other args. | |
41059f75 | 477 | |
bdf278f7 | 478 | dit(bf(--version)) print the rsync version number and exit. |
41059f75 AT |
479 | |
480 | dit(bf(-v, --verbose)) This option increases the amount of information you | |
14d43f1f | 481 | are given during the transfer. By default, rsync works silently. A |
faa82484 | 482 | single bf(-v) will give you information about what files are being |
951e826b | 483 | transferred and a brief summary at the end. Two bf(-v) options will give you |
41059f75 | 484 | information on what files are being skipped and slightly more |
951e826b | 485 | information at the end. More than two bf(-v) options should only be used if |
14d43f1f | 486 | you are debugging rsync. |
41059f75 | 487 | |
951e826b WD |
488 | In a modern rsync, the bf(-v) option is equivalent to the setting of groups |
489 | of bf(--info) and bf(--debug) options. You can choose to use these newer | |
490 | options in addition to, or in place of using bf(--verbose), as any | |
491 | fine-grained settings override the implied settings of bf(-v). Both | |
492 | bf(--info) and bf(--debug) have a way to ask for help that tells you | |
493 | exactly what flags are set for each increase in verbosity. | |
494 | ||
495 | dit(bf(--info=FLAGS)) | |
496 | This option lets you have fine-grained control over the | |
497 | information | |
498 | output you want to see. An individual flag name may be followed by a level | |
499 | number, with 0 meaning to silence that output, 1 being the default output | |
500 | level, and higher numbers increasing the output of that flag (for those | |
501 | that support higher levels). Use | |
502 | bf(--info=help) | |
503 | to see all the available flag names, what they output, and what flag names | |
504 | are added for each increase in the verbose level. Some examples: | |
505 | ||
506 | verb( rsync -a --info=progress2 src/ dest/ | |
507 | rsync -avv --info=stats2,misc1,flist0 src/ dest/ ) | |
508 | ||
509 | Note that bf(--info=name)'s output is affected by the bf(--out-format) and | |
510 | bf(--itemize-changes) (bf(-i)) options. See those options for more | |
511 | information on what is output and when. | |
512 | ||
513 | This option was added to 3.1.0, so an older rsync on the server side might | |
514 | reject your attempts at fine-grained control (if one or more flags needed | |
515 | to be send to the server and the server was too old to understand them). | |
516 | ||
517 | dit(bf(--debug=FLAGS)) | |
518 | This option lets you have fine-grained control over the | |
519 | debug | |
520 | output you want to see. An individual flag name may be followed by a level | |
521 | number, with 0 meaning to silence that output, 1 being the default output | |
522 | level, and higher numbers increasing the output of that flag (for those | |
523 | that support higher levels). Use | |
524 | bf(--debug=help) | |
525 | to see all the available flag names, what they output, and what flag names | |
526 | are added for each increase in the verbose level. Some examples: | |
527 | ||
528 | verb( rsync -avvv --debug=none src/ dest/ | |
529 | rsync -avA --del --debug=del2,acl src/ dest/ ) | |
530 | ||
531 | This option was added to 3.1.0, so an older rsync on the server side might | |
532 | reject your attempts at fine-grained control (if one or more flags needed | |
533 | to be send to the server and the server was too old to understand them). | |
4f90eb43 | 534 | |
b86f0cef DD |
535 | dit(bf(-q, --quiet)) This option decreases the amount of information you |
536 | are given during the transfer, notably suppressing information messages | |
951e826b | 537 | from the remote server. This option name is useful when invoking rsync from |
b86f0cef DD |
538 | cron. |
539 | ||
1de02c27 WD |
540 | dit(bf(--no-motd)) This option affects the information that is output |
541 | by the client at the start of a daemon transfer. This suppresses the | |
542 | message-of-the-day (MOTD) text, but it also affects the list of modules | |
543 | that the daemon sends in response to the "rsync host::" request (due to | |
544 | a limitation in the rsync protocol), so omit this option if you want to | |
c5b6e57a | 545 | request the list of modules from the daemon. |
1de02c27 | 546 | |
41059f75 | 547 | dit(bf(-I, --ignore-times)) Normally rsync will skip any files that are |
1874f7e2 | 548 | already the same size and have the same modification timestamp. |
d04e95e9 WD |
549 | This option turns off this "quick check" behavior, causing all files to |
550 | be updated. | |
41059f75 | 551 | |
1874f7e2 WD |
552 | dit(bf(--size-only)) This modifies rsync's "quick check" algorithm for |
553 | finding files that need to be transferred, changing it from the default of | |
554 | transferring files with either a changed size or a changed last-modified | |
d15f2ff0 | 555 | time to just looking for files that have changed in size. This is useful |
1874f7e2 WD |
556 | when starting to use rsync after using another mirroring system which may |
557 | not preserve timestamps exactly. | |
f83f0548 | 558 | |
4f1f94d1 WD |
559 | dit(bf(--modify-window)) When comparing two timestamps, rsync treats the |
560 | timestamps as being equal if they differ by no more than the modify-window | |
561 | value. This is normally 0 (for an exact match), but you may find it useful | |
562 | to set this to a larger value in some situations. In particular, when | |
563 | transferring to or from an MS Windows FAT filesystem (which represents | |
564 | times with a 2-second resolution), bf(--modify-window=1) is useful | |
565 | (allowing times to differ by up to 1 second). | |
5b56cc19 | 566 | |
c64ff141 WD |
567 | dit(bf(-c, --checksum)) This changes the way rsync checks if the files have |
568 | been changed and are in need of a transfer. Without this option, rsync | |
569 | uses a "quick check" that (by default) checks if each file's size and time | |
570 | of last modification match between the sender and receiver. This option | |
e129500c | 571 | changes this to compare a 128-bit checksum for each file that has a |
c64ff141 WD |
572 | matching size. Generating the checksums means that both sides will expend |
573 | a lot of disk I/O reading all the data in the files in the transfer (and | |
574 | this is prior to any reading that will be done to transfer changed files), | |
575 | so this can slow things down significantly. | |
576 | ||
577 | The sending side generates its checksums while it is doing the file-system | |
578 | scan that builds the list of the available files. The receiver generates | |
579 | its checksums when it is scanning for changed files, and will checksum any | |
580 | file that has the same size as the corresponding sender's file: files with | |
581 | either a changed size or a changed checksum are selected for transfer. | |
582 | ||
583 | Note that rsync always verifies that each em(transferred) file was | |
584 | correctly reconstructed on the receiving side by checking a whole-file | |
f96bac84 | 585 | checksum that is generated as the file is transferred, but that |
c64ff141 | 586 | automatic after-the-transfer verification has nothing to do with this |
2a24b4bd | 587 | option's before-the-transfer "Does this file need to be updated?" check. |
41059f75 | 588 | |
e129500c WD |
589 | For protocol 30 and beyond (first supported in 3.0.0), the checksum used is |
590 | MD5. For older protocols, the checksum used is MD4. | |
591 | ||
faa82484 | 592 | dit(bf(-a, --archive)) This is equivalent to bf(-rlptgoD). It is a quick |
e7bf3e5e | 593 | way of saying you want recursion and want to preserve almost |
f40aa6fb WD |
594 | everything (with -H being a notable omission). |
595 | The only exception to the above equivalence is when bf(--files-from) is | |
5dd97ab9 | 596 | specified, in which case bf(-r) is not implied. |
e7bf3e5e | 597 | |
faa82484 | 598 | Note that bf(-a) bf(does not preserve hardlinks), because |
e7bf3e5e MP |
599 | finding multiply-linked files is expensive. You must separately |
600 | specify bf(-H). | |
41059f75 | 601 | |
f40aa6fb WD |
602 | dit(--no-OPTION) You may turn off one or more implied options by prefixing |
603 | the option name with "no-". Not all options may be prefixed with a "no-": | |
604 | only options that are implied by other options (e.g. bf(--no-D), | |
605 | bf(--no-perms)) or have different defaults in various circumstances | |
606 | (e.g. bf(--no-whole-file), bf(--no-blocking-io), bf(--no-dirs)). You may | |
607 | specify either the short or the long option name after the "no-" prefix | |
608 | (e.g. bf(--no-R) is the same as bf(--no-relative)). | |
609 | ||
610 | For example: if you want to use bf(-a) (bf(--archive)) but don't want | |
611 | bf(-o) (bf(--owner)), instead of converting bf(-a) into bf(-rlptgD), you | |
612 | could specify bf(-a --no-o) (or bf(-a --no-owner)). | |
613 | ||
614 | The order of the options is important: if you specify bf(--no-r -a), the | |
615 | bf(-r) option would end up being turned on, the opposite of bf(-a --no-r). | |
616 | Note also that the side-effects of the bf(--files-from) option are NOT | |
a9af5d8e | 617 | positional, as it affects the default state of several options and slightly |
f40aa6fb WD |
618 | changes the meaning of bf(-a) (see the bf(--files-from) option for more |
619 | details). | |
620 | ||
24986abd | 621 | dit(bf(-r, --recursive)) This tells rsync to copy directories |
faa82484 | 622 | recursively. See also bf(--dirs) (bf(-d)). |
41059f75 | 623 | |
d9f46544 WD |
624 | Beginning with rsync 3.0.0, the recursive algorithm used is now an |
625 | incremental scan that uses much less memory than before and begins the | |
626 | transfer after the scanning of the first few directories have been | |
627 | completed. This incremental scan only affects our recursion algorithm, and | |
ba2d43d7 WD |
628 | does not change a non-recursive transfer. It is also only possible when |
629 | both ends of the transfer are at least version 3.0.0. | |
d9f46544 WD |
630 | |
631 | Some options require rsync to know the full file list, so these options | |
1e05b590 | 632 | disable the incremental recursion mode. These include: bf(--delete-before), |
ba2d43d7 | 633 | bf(--delete-after), bf(--prune-empty-dirs), and bf(--delay-updates). |
d9f46544 | 634 | Because of this, the default delete mode when you specify bf(--delete) is now |
1e05b590 WD |
635 | bf(--delete-during) when both ends of the connection are at least 3.0.0 |
636 | (use bf(--del) or bf(--delete-during) to request this improved deletion mode | |
d9f46544 WD |
637 | explicitly). See also the bf(--delete-delay) option that is a better choice |
638 | than using bf(--delete-after). | |
639 | ||
ba2d43d7 | 640 | Incremental recursion can be disabled using the bf(--no-inc-recursive) |
27999aba | 641 | option or its shorter bf(--no-i-r) alias. |
ba2d43d7 | 642 | |
41059f75 AT |
643 | dit(bf(-R, --relative)) Use relative paths. This means that the full path |
644 | names specified on the command line are sent to the server rather than | |
645 | just the last parts of the filenames. This is particularly useful when | |
14d43f1f | 646 | you want to send several different directories at the same time. For |
1dc42d12 | 647 | example, if you used this command: |
41059f75 | 648 | |
1dc42d12 | 649 | quote(tt( rsync -av /foo/bar/baz.c remote:/tmp/)) |
41059f75 | 650 | |
58718881 | 651 | ... this would create a file named baz.c in /tmp/ on the remote |
41059f75 AT |
652 | machine. If instead you used |
653 | ||
1dc42d12 | 654 | quote(tt( rsync -avR /foo/bar/baz.c remote:/tmp/)) |
41059f75 | 655 | |
58718881 | 656 | then a file named /tmp/foo/bar/baz.c would be created on the remote |
0758b2db WD |
657 | machine, preserving its full path. These extra path elements are called |
658 | "implied directories" (i.e. the "foo" and the "foo/bar" directories in the | |
659 | above example). | |
660 | ||
661 | Beginning with rsync 3.0.0, rsync always sends these implied directories as | |
662 | real directories in the file list, even if a path element is really a | |
663 | symlink on the sending side. This prevents some really unexpected | |
664 | behaviors when copying the full path of a file that you didn't realize had | |
665 | a symlink in its path. If you want to duplicate a server-side symlink, | |
666 | include both the symlink via its path, and referent directory via its real | |
667 | path. If you're dealing with an older rsync on the sending side, you may | |
668 | need to use the bf(--no-implied-dirs) option. | |
669 | ||
670 | It is also possible to limit the amount of path information that is sent as | |
671 | implied directories for each path you specify. With a modern rsync on the | |
672 | sending side (beginning with 2.6.7), you can insert a dot and a slash into | |
673 | the source path, like this: | |
1dc42d12 WD |
674 | |
675 | quote(tt( rsync -avR /foo/./bar/baz.c remote:/tmp/)) | |
676 | ||
677 | That would create /tmp/bar/baz.c on the remote machine. (Note that the | |
f2ebbebe | 678 | dot must be followed by a slash, so "/foo/." would not be abbreviated.) |
6f098b0f | 679 | For older rsync versions, you would need to use a chdir to limit the |
1dc42d12 WD |
680 | source path. For example, when pushing files: |
681 | ||
53cf0b8b | 682 | quote(tt( (cd /foo; rsync -avR bar/baz.c remote:/tmp/) )) |
1dc42d12 | 683 | |
53cf0b8b WD |
684 | (Note that the parens put the two commands into a sub-shell, so that the |
685 | "cd" command doesn't remain in effect for future commands.) | |
0758b2db WD |
686 | If you're pulling files from an older rsync, use this idiom (but only |
687 | for a non-daemon transfer): | |
9bef934c | 688 | |
faa82484 | 689 | quote( |
1dc42d12 WD |
690 | tt( rsync -avR --rsync-path="cd /foo; rsync" \ )nl() |
691 | tt( remote:bar/baz.c /tmp/) | |
faa82484 | 692 | ) |
9bef934c | 693 | |
f2ebbebe WD |
694 | dit(bf(--no-implied-dirs)) This option affects the default behavior of the |
695 | bf(--relative) option. When it is specified, the attributes of the implied | |
696 | directories from the source names are not included in the transfer. This | |
697 | means that the corresponding path elements on the destination system are | |
698 | left unchanged if they exist, and any missing implied directories are | |
699 | created with default attributes. This even allows these implied path | |
700 | elements to have big differences, such as being a symlink to a directory on | |
0758b2db | 701 | the receiving side. |
f2ebbebe WD |
702 | |
703 | For instance, if a command-line arg or a files-from entry told rsync to | |
704 | transfer the file "path/foo/file", the directories "path" and "path/foo" | |
705 | are implied when bf(--relative) is used. If "path/foo" is a symlink to | |
706 | "bar" on the destination system, the receiving rsync would ordinarily | |
707 | delete "path/foo", recreate it as a directory, and receive the file into | |
708 | the new directory. With bf(--no-implied-dirs), the receiving rsync updates | |
709 | "path/foo/file" using the existing path elements, which means that the file | |
710 | ends up being created in "path/bar". Another way to accomplish this link | |
711 | preservation is to use the bf(--keep-dirlinks) option (which will also | |
712 | affect symlinks to directories in the rest of the transfer). | |
713 | ||
0758b2db WD |
714 | When pulling files from an rsync older than 3.0.0, you may need to use this |
715 | option if the sending side has a symlink in the path you request and you | |
716 | wish the implied directories to be transferred as normal directories. | |
41059f75 | 717 | |
b19fd07c WD |
718 | dit(bf(-b, --backup)) With this option, preexisting destination files are |
719 | renamed as each file is transferred or deleted. You can control where the | |
720 | backup file goes and what (if any) suffix gets appended using the | |
faa82484 | 721 | bf(--backup-dir) and bf(--suffix) options. |
4c72f27d WD |
722 | |
723 | Note that if you don't specify bf(--backup-dir), (1) the | |
724 | bf(--omit-dir-times) option will be implied, and (2) if bf(--delete) is | |
2d5279ac | 725 | also in effect (without bf(--delete-excluded)), rsync will add a "protect" |
4c72f27d | 726 | filter-rule for the backup suffix to the end of all your existing excludes |
89cb4721 | 727 | (e.g. bf(-f "P *~")). This will prevent previously backed-up files from being |
4c72f27d WD |
728 | deleted. Note that if you are supplying your own filter rules, you may |
729 | need to manually insert your own exclude/protect rule somewhere higher up | |
730 | in the list so that it has a high enough priority to be effective (e.g., if | |
731 | your rules specify a trailing inclusion/exclusion of '*', the auto-added | |
732 | rule would never be reached). | |
41059f75 | 733 | |
faa82484 | 734 | dit(bf(--backup-dir=DIR)) In combination with the bf(--backup) option, this |
ad75d18d WD |
735 | tells rsync to store all backups in the specified directory on the receiving |
736 | side. This can be used for incremental backups. You can additionally | |
faa82484 | 737 | specify a backup suffix using the bf(--suffix) option |
759ac870 DD |
738 | (otherwise the files backed up in the specified directory |
739 | will keep their original filenames). | |
66203a98 | 740 | |
cf0f454b WD |
741 | Note that if you specify a relative path, the backup directory will be |
742 | relative to the destination directory, so you probably want to specify | |
743 | either an absolute path or a path that starts with "../". If an rsync | |
744 | daemon is the receiver, the backup dir cannot go outside the module's path | |
745 | hierarchy, so take extra care not to delete it or copy into it. | |
746 | ||
b5679335 | 747 | dit(bf(--suffix=SUFFIX)) This option allows you to override the default |
faa82484 WD |
748 | backup suffix used with the bf(--backup) (bf(-b)) option. The default suffix is a ~ |
749 | if no -bf(-backup-dir) was specified, otherwise it is an empty string. | |
9ef53907 | 750 | |
4539c0d7 WD |
751 | dit(bf(-u, --update)) This forces rsync to skip any files which exist on |
752 | the destination and have a modified time that is newer than the source | |
42b06481 | 753 | file. (If an existing destination file has a modification time equal to the |
4539c0d7 | 754 | source file's, it will be updated if the sizes are different.) |
41059f75 | 755 | |
4a4622bb WD |
756 | Note that this does not affect the copying of symlinks or other special |
757 | files. Also, a difference of file format between the sender and receiver | |
758 | is always considered to be important enough for an update, no matter what | |
759 | date is on the objects. In other words, if the source has a directory | |
760 | where the destination has a file, the transfer would occur regardless of | |
761 | the timestamps. | |
adddd075 | 762 | |
fd2b6046 WD |
763 | This option is a transfer rule, not an exclude, so it doesn't affect the |
764 | data that goes into the file-lists, and thus it doesn't affect deletions. | |
765 | It just limits the files that the receiver requests to be transferred. | |
766 | ||
6f098b0f WD |
767 | dit(bf(--inplace)) This option changes how rsync transfers a file when |
768 | its data needs to be updated: instead of the default method of creating | |
adc4ebdd WD |
769 | a new copy of the file and moving it into place when it is complete, rsync |
770 | instead writes the updated data directly to the destination file. | |
771 | ||
58a79f4b MM |
772 | This has several effects: |
773 | ||
774 | quote(itemization( | |
775 | it() Hard links are not broken. This means the new data will be visible | |
776 | through other hard links to the destination file. Moreover, attempts to | |
777 | copy differing source files onto a multiply-linked destination file will | |
778 | result in a "tug of war" with the destination data changing back and forth. | |
779 | it() In-use binaries cannot be updated (either the OS will prevent this from | |
780 | happening, or binaries that attempt to swap-in their data will misbehave or | |
781 | crash). | |
782 | it() The file's data will be in an inconsistent state during the transfer | |
783 | and will be left that way if the transfer is interrupted or if an update | |
784 | fails. | |
e630fd11 WD |
785 | it() A file that rsync cannot write to cannot be updated. While a super user |
786 | can update any file, a normal user needs to be granted write permission for | |
787 | the open of the file for writing to be successful. | |
58a79f4b MM |
788 | it() The efficiency of rsync's delta-transfer algorithm may be reduced if |
789 | some data in the destination file is overwritten before it can be copied to | |
790 | a position later in the file. This does not apply if you use bf(--backup), | |
791 | since rsync is smart enough to use the backup file as the basis file for the | |
792 | transfer. | |
793 | )) | |
adc4ebdd WD |
794 | |
795 | WARNING: you should not use this option to update files that are being | |
796 | accessed by others, so be careful when choosing to use this for a copy. | |
a3221d2a | 797 | |
6f098b0f | 798 | This option is useful for transferring large files with block-based changes |
183150b7 | 799 | or appended data, and also on systems that are disk bound, not network |
e630fd11 WD |
800 | bound. It can also help keep a copy-on-write filesystem snapshot from |
801 | diverging the entire contents of a file that only has minor changes. | |
183150b7 | 802 | |
faa82484 WD |
803 | The option implies bf(--partial) (since an interrupted transfer does not delete |
804 | the file), but conflicts with bf(--partial-dir) and bf(--delay-updates). | |
b7c24819 WD |
805 | Prior to rsync 2.6.4 bf(--inplace) was also incompatible with bf(--compare-dest) |
806 | and bf(--link-dest). | |
a3221d2a | 807 | |
94f20a9f WD |
808 | dit(bf(--append)) This causes rsync to update a file by appending data onto |
809 | the end of the file, which presumes that the data that already exists on | |
810 | the receiving side is identical with the start of the file on the sending | |
022dec7a WD |
811 | side. If a file needs to be transferred and its size on the receiver is |
812 | the same or longer than the size on the sender, the file is skipped. This | |
813 | does not interfere with the updating of a file's non-content attributes | |
814 | (e.g. permissions, ownership, etc.) when the file does not need to be | |
815 | transferred, nor does it affect the updating of any non-regular files. | |
816 | Implies bf(--inplace), | |
07bbf870 WD |
817 | but does not conflict with bf(--sparse) (since it is always extending a |
818 | file's length). | |
819 | ||
820 | dit(bf(--append-verify)) This works just like the bf(--append) option, but | |
821 | the existing data on the receiving side is included in the full-file | |
822 | checksum verification step, which will cause a file to be resent if the | |
823 | final verification step fails (rsync uses a normal, non-appending | |
824 | bf(--inplace) transfer for the resend). | |
825 | ||
826 | Note: prior to rsync 3.0.0, the bf(--append) option worked like | |
827 | bf(--append-verify), so if you are interacting with an older rsync (or the | |
828 | transfer is using a protocol prior to 30), specifying either append option | |
829 | will initiate an bf(--append-verify) transfer. | |
94f20a9f | 830 | |
09ed3099 | 831 | dit(bf(-d, --dirs)) Tell the sending side to include any directories that |
faa82484 | 832 | are encountered. Unlike bf(--recursive), a directory's contents are not copied |
57b66a24 WD |
833 | unless the directory name specified is "." or ends with a trailing slash |
834 | (e.g. ".", "dir/.", "dir/", etc.). Without this option or the | |
faa82484 | 835 | bf(--recursive) option, rsync will skip all directories it encounters (and |
f40aa6fb | 836 | output a message to that effect for each one). If you specify both |
6e6cc163 | 837 | bf(--dirs) and bf(--recursive), bf(--recursive) takes precedence. |
09ed3099 | 838 | |
73cb6738 WD |
839 | The bf(--dirs) option is implied by the bf(--files-from) option |
840 | or the bf(--list-only) option (including an implied | |
32b9011a WD |
841 | bf(--list-only) usage) if bf(--recursive) wasn't specified (so that |
842 | directories are seen in the listing). Specify bf(--no-dirs) (or bf(--no-d)) | |
73cb6738 WD |
843 | if you want to turn this off. |
844 | ||
845 | There is also a backward-compatibility helper option, bf(--old-dirs) (or | |
846 | bf(--old-d)) that tells rsync to use a hack of "-r --exclude='/*/*'" to get | |
847 | an older rsync to list a single directory without recursing. | |
32b9011a | 848 | |
eb06fa95 MP |
849 | dit(bf(-l, --links)) When symlinks are encountered, recreate the |
850 | symlink on the destination. | |
41059f75 | 851 | |
f2ebbebe | 852 | dit(bf(-L, --copy-links)) When symlinks are encountered, the item that |
ef855d19 WD |
853 | they point to (the referent) is copied, rather than the symlink. In older |
854 | versions of rsync, this option also had the side-effect of telling the | |
855 | receiving side to follow symlinks, such as symlinks to directories. In a | |
faa82484 | 856 | modern rsync such as this one, you'll need to specify bf(--keep-dirlinks) (bf(-K)) |
ef855d19 | 857 | to get this extra behavior. The only exception is when sending files to |
faa82484 WD |
858 | an rsync that is too old to understand bf(-K) -- in that case, the bf(-L) option |
859 | will still have the side-effect of bf(-K) on that older receiving rsync. | |
b5313607 | 860 | |
eb06fa95 | 861 | dit(bf(--copy-unsafe-links)) This tells rsync to copy the referent of |
7af4227a | 862 | symbolic links that point outside the copied tree. Absolute symlinks |
eb06fa95 | 863 | are also treated like ordinary files, and so are any symlinks in the |
f2ebbebe WD |
864 | source path itself when bf(--relative) is used. This option has no |
865 | additional effect if bf(--copy-links) was also specified. | |
41059f75 | 866 | |
d310a212 | 867 | dit(bf(--safe-links)) This tells rsync to ignore any symbolic links |
7af4227a | 868 | which point outside the copied tree. All absolute symlinks are |
faa82484 WD |
869 | also ignored. Using this option in conjunction with bf(--relative) may |
870 | give unexpected results. | |
d310a212 | 871 | |
41adbcec WD |
872 | dit(bf(--munge-links)) This option tells rsync to (1) modify all symlinks on |
873 | the receiving side in a way that makes them unusable but recoverable (see | |
874 | below), or (2) to unmunge symlinks on the sending side that had been stored in | |
875 | a munged state. This is useful if you don't quite trust the source of the data | |
876 | to not try to slip in a symlink to a unexpected place. | |
877 | ||
878 | The way rsync disables the use of symlinks is to prefix each one with the | |
879 | string "/rsyncd-munged/". This prevents the links from being used as long as | |
880 | that directory does not exist. When this option is enabled, rsync will refuse | |
881 | to run if that path is a directory or a symlink to a directory. | |
882 | ||
883 | The option only affects the client side of the transfer, so if you need it to | |
884 | affect the server, specify it via bf(--remote-option). (Note that in a local | |
885 | transfer, the client side is the sender.) | |
886 | ||
887 | This option has no affect on a daemon, since the daemon configures whether it | |
888 | wants munged symlinks via its "munge symlinks" parameter. See also the | |
889 | "munge-symlinks" perl script in the support directory of the source code. | |
890 | ||
1a515b49 | 891 | dit(bf(-k, --copy-dirlinks)) This option causes the sending side to treat |
f2ebbebe WD |
892 | a symlink to a directory as though it were a real directory. This is |
893 | useful if you don't want symlinks to non-directories to be affected, as | |
894 | they would be using bf(--copy-links). | |
41059f75 | 895 | |
f2ebbebe WD |
896 | Without this option, if the sending side has replaced a directory with a |
897 | symlink to a directory, the receiving side will delete anything that is in | |
898 | the way of the new symlink, including a directory hierarchy (as long as | |
899 | bf(--force) or bf(--delete) is in effect). | |
41059f75 | 900 | |
f2ebbebe WD |
901 | See also bf(--keep-dirlinks) for an analogous option for the receiving |
902 | side. | |
41059f75 | 903 | |
ae03e0e0 MM |
904 | bf(--copy-dirlinks) applies to all symlinks to directories in the source. If |
905 | you want to follow only a few specified symlinks, a trick you can use is to | |
906 | pass them as additional source args with a trailing slash, using bf(--relative) | |
907 | to make the paths match up right. For example: | |
908 | ||
909 | quote(tt(rsync -r --relative src/./ src/./follow-me/ dest/)) | |
910 | ||
911 | This works because rsync calls bf(lstat)(2) on the source arg as given, and the | |
912 | trailing slash makes bf(lstat)(2) follow the symlink, giving rise to a directory | |
913 | in the file-list which overrides the symlink found during the scan of "src/./". | |
914 | ||
f2ebbebe WD |
915 | dit(bf(-K, --keep-dirlinks)) This option causes the receiving side to treat |
916 | a symlink to a directory as though it were a real directory, but only if it | |
917 | matches a real directory from the sender. Without this option, the | |
918 | receiver's symlink would be deleted and replaced with a real directory. | |
09ed3099 | 919 | |
f2ebbebe WD |
920 | For example, suppose you transfer a directory "foo" that contains a file |
921 | "file", but "foo" is a symlink to directory "bar" on the receiver. Without | |
922 | bf(--keep-dirlinks), the receiver deletes symlink "foo", recreates it as a | |
923 | directory, and receives the file into the new directory. With | |
924 | bf(--keep-dirlinks), the receiver keeps the symlink and "file" ends up in | |
925 | "bar". | |
926 | ||
ce055e86 WD |
927 | One note of caution: if you use bf(--keep-dirlinks), you must trust all |
928 | the symlinks in the copy! If it is possible for an untrusted user to | |
929 | create their own symlink to any directory, the user could then (on a | |
930 | subsequent copy) replace the symlink with a real directory and affect the | |
931 | content of whatever directory the symlink references. For backup copies, | |
932 | you are better off using something like a bind mount instead of a symlink | |
933 | to modify your receiving hierarchy. | |
934 | ||
f2ebbebe WD |
935 | See also bf(--copy-dirlinks) for an analogous option for the sending side. |
936 | ||
937 | dit(bf(-H, --hard-links)) This tells rsync to look for hard-linked files in | |
58a79f4b MM |
938 | the source and link together the corresponding files on the destination. |
939 | Without this option, hard-linked files in the source are treated | |
f2ebbebe WD |
940 | as though they were separate files. |
941 | ||
58a79f4b MM |
942 | This option does NOT necessarily ensure that the pattern of hard links on the |
943 | destination exactly matches that on the source. Cases in which the | |
944 | destination may end up with extra hard links include the following: | |
945 | ||
946 | quote(itemization( | |
da9b72b3 WD |
947 | it() If the destination contains extraneous hard-links (more linking than |
948 | what is present in the source file list), the copying algorithm will not | |
3bd9f519 WD |
949 | break them explicitly. However, if one or more of the paths have content |
950 | differences, the normal file-update process will break those extra links | |
951 | (unless you are using the bf(--inplace) option). | |
58a79f4b | 952 | it() If you specify a bf(--link-dest) directory that contains hard links, |
3bd9f519 WD |
953 | the linking of the destination files against the bf(--link-dest) files can |
954 | cause some paths in the destination to become linked together due to the | |
955 | bf(--link-dest) associations. | |
58a79f4b | 956 | )) |
5f0f2e08 WD |
957 | |
958 | Note that rsync can only detect hard links between files that are inside | |
959 | the transfer set. If rsync updates a file that has extra hard-link | |
960 | connections to files outside the transfer, that linkage will be broken. If | |
961 | you are tempted to use the bf(--inplace) option to avoid this breakage, be | |
962 | very careful that you know how your files are being updated so that you are | |
963 | certain that no unintended changes happen due to lingering hard links (and | |
964 | see the bf(--inplace) option for more caveats). | |
41059f75 | 965 | |
ba2d43d7 | 966 | If incremental recursion is active (see bf(--recursive)), rsync may transfer |
5f0f2e08 | 967 | a missing hard-linked file before it finds that another link for that contents |
968061bb | 968 | exists elsewhere in the hierarchy. This does not affect the accuracy of |
8030518d WD |
969 | the transfer (i.e. which files are hard-linked together), just its efficiency |
970 | (i.e. copying the data for a new, early copy of a hard-linked file that could | |
971 | have been found later in the transfer in another member of the hard-linked | |
972 | set of files). One way to avoid this inefficiency is to disable | |
27999aba | 973 | incremental recursion using the bf(--no-inc-recursive) option. |
ba2d43d7 | 974 | |
2d5279ac WD |
975 | dit(bf(-p, --perms)) This option causes the receiving rsync to set the |
976 | destination permissions to be the same as the source permissions. (See | |
977 | also the bf(--chmod) option for a way to modify what rsync considers to | |
978 | be the source permissions.) | |
8dc74608 | 979 | |
2d5279ac WD |
980 | When this option is em(off), permissions are set as follows: |
981 | ||
b8a6dae0 | 982 | quote(itemization( |
2d5279ac WD |
983 | it() Existing files (including updated files) retain their existing |
984 | permissions, though the bf(--executability) option might change just | |
985 | the execute permission for the file. | |
77ed253c | 986 | it() New files get their "normal" permission bits set to the source |
1c3344a1 WD |
987 | file's permissions masked with the receiving directory's default |
988 | permissions (either the receiving process's umask, or the permissions | |
989 | specified via the destination directory's default ACL), and | |
77ed253c WD |
990 | their special permission bits disabled except in the case where a new |
991 | directory inherits a setgid bit from its parent directory. | |
2d5279ac | 992 | )) |
77ed253c | 993 | |
2d5279ac WD |
994 | Thus, when bf(--perms) and bf(--executability) are both disabled, |
995 | rsync's behavior is the same as that of other file-copy utilities, | |
996 | such as bf(cp)(1) and bf(tar)(1). | |
997 | ||
77ed253c WD |
998 | In summary: to give destination files (both old and new) the source |
999 | permissions, use bf(--perms). To give new files the destination-default | |
1f77038e | 1000 | permissions (while leaving existing files unchanged), make sure that the |
77ed253c WD |
1001 | bf(--perms) option is off and use bf(--chmod=ugo=rwX) (which ensures that |
1002 | all non-masked bits get enabled). If you'd care to make this latter | |
1003 | behavior easier to type, you could define a popt alias for it, such as | |
58b7b3d6 | 1004 | putting this line in the file ~/.popt (the following defines the bf(-Z) option, |
662127e6 | 1005 | and includes --no-g to use the default group of the destination dir): |
77ed253c | 1006 | |
58b7b3d6 | 1007 | quote(tt( rsync alias -Z --no-p --no-g --chmod=ugo=rwX)) |
77ed253c WD |
1008 | |
1009 | You could then use this new option in a command such as this one: | |
1010 | ||
58b7b3d6 | 1011 | quote(tt( rsync -avZ src/ dest/)) |
77ed253c | 1012 | |
58b7b3d6 WD |
1013 | (Caveat: make sure that bf(-a) does not follow bf(-Z), or it will re-enable |
1014 | the two "--no-*" options mentioned above.) | |
662127e6 | 1015 | |
77ed253c WD |
1016 | The preservation of the destination's setgid bit on newly-created |
1017 | directories when bf(--perms) is off was added in rsync 2.6.7. Older rsync | |
1018 | versions erroneously preserved the three special permission bits for | |
1019 | newly-created files when bf(--perms) was off, while overriding the | |
1c3344a1 WD |
1020 | destination's setgid bit setting on a newly-created directory. Default ACL |
1021 | observance was added to the ACL patch for rsync 2.6.7, so older (or | |
1022 | non-ACL-enabled) rsyncs use the umask even if default ACLs are present. | |
1023 | (Keep in mind that it is the version of the receiving rsync that affects | |
1024 | these behaviors.) | |
77ed253c | 1025 | |
2d5279ac WD |
1026 | dit(bf(-E, --executability)) This option causes rsync to preserve the |
1027 | executability (or non-executability) of regular files when bf(--perms) is | |
1028 | not enabled. A regular file is considered to be executable if at least one | |
77ed253c WD |
1029 | 'x' is turned on in its permissions. When an existing destination file's |
1030 | executability differs from that of the corresponding source file, rsync | |
1031 | modifies the destination file's permissions as follows: | |
2d5279ac | 1032 | |
b8a6dae0 | 1033 | quote(itemization( |
2d5279ac WD |
1034 | it() To make a file non-executable, rsync turns off all its 'x' |
1035 | permissions. | |
1036 | it() To make a file executable, rsync turns on each 'x' permission that | |
1037 | has a corresponding 'r' permission enabled. | |
1038 | )) | |
1039 | ||
1040 | If bf(--perms) is enabled, this option is ignored. | |
41059f75 | 1041 | |
1c3344a1 | 1042 | dit(bf(-A, --acls)) This option causes rsync to update the destination |
0f6b4909 WD |
1043 | ACLs to be the same as the source ACLs. |
1044 | The option also implies bf(--perms). | |
1045 | ||
1046 | The source and destination systems must have compatible ACL entries for this | |
1047 | option to work properly. See the bf(--fake-super) option for a way to backup | |
1048 | and restore ACLs that are not compatible. | |
1c3344a1 | 1049 | |
5deb19e4 MM |
1050 | dit(bf(-X, --xattrs)) This option causes rsync to update the destination |
1051 | extended attributes to be the same as the source ones. | |
0f6b4909 WD |
1052 | |
1053 | For systems that support extended-attribute namespaces, a copy being done by a | |
1054 | super-user copies all namespaces except system.*. A normal user only copies | |
1055 | the user.* namespace. To be able to backup and restore non-user namespaces as | |
1056 | a normal user, see the bf(--fake-super) option. | |
16edf865 | 1057 | |
0d78a278 WD |
1058 | Note that this option does not copy rsyncs special xattr values (e.g. those |
1059 | used by bf(--fake-super)) unless you repeat the option (e.g. -XX). This | |
1060 | "copy all xattrs" mode cannot be used with bf(--fake-super). | |
1061 | ||
9f822556 | 1062 | dit(bf(--chmod)) This option tells rsync to apply one or more |
aef2b8ce | 1063 | comma-separated "chmod" modes to the permission of the files in the |
6f098b0f | 1064 | transfer. The resulting value is treated as though it were the permissions |
9f822556 WD |
1065 | that the sending side supplied for the file, which means that this option |
1066 | can seem to have no effect on existing files if bf(--perms) is not enabled. | |
1067 | ||
1068 | In addition to the normal parsing rules specified in the bf(chmod)(1) | |
1069 | manpage, you can specify an item that should only apply to a directory by | |
1070 | prefixing it with a 'D', or specify an item that should only apply to a | |
aef2b8ce WD |
1071 | file by prefixing it with a 'F'. For example, the following will ensure |
1072 | that all directories get marked set-gid, that no files are other-writable, | |
1073 | that both are user-writable and group-writable, and that both have | |
1074 | consistent executability across all bits: | |
9f822556 WD |
1075 | |
1076 | quote(--chmod=Dg+s,ug+w,Fo-w,+X) | |
1077 | ||
aef2b8ce WD |
1078 | Using octal mode numbers is also allowed: |
1079 | ||
1080 | quote(--chmod=D2775,F664) | |
1081 | ||
9f822556 WD |
1082 | It is also legal to specify multiple bf(--chmod) options, as each |
1083 | additional option is just appended to the list of changes to make. | |
1084 | ||
1085 | See the bf(--perms) and bf(--executability) options for how the resulting | |
1086 | permission value can be applied to the files in the transfer. | |
1087 | ||
eb06fa95 | 1088 | dit(bf(-o, --owner)) This option causes rsync to set the owner of the |
8641d287 WD |
1089 | destination file to be the same as the source file, but only if the |
1090 | receiving rsync is being run as the super-user (see also the bf(--super) | |
9439c0cb | 1091 | and bf(--fake-super) options). |
0f6b4909 WD |
1092 | Without this option, the owner of new and/or transferred files are set to |
1093 | the invoking user on the receiving side. | |
8641d287 WD |
1094 | |
1095 | The preservation of ownership will associate matching names by default, but | |
1096 | may fall back to using the ID number in some circumstances (see also the | |
1097 | bf(--numeric-ids) option for a full discussion). | |
41059f75 | 1098 | |
eb06fa95 MP |
1099 | dit(bf(-g, --group)) This option causes rsync to set the group of the |
1100 | destination file to be the same as the source file. If the receiving | |
8641d287 WD |
1101 | program is not running as the super-user (or if bf(--no-super) was |
1102 | specified), only groups that the invoking user on the receiving side | |
1103 | is a member of will be preserved. | |
1104 | Without this option, the group is set to the default group of the invoking | |
1105 | user on the receiving side. | |
1106 | ||
1107 | The preservation of group information will associate matching names by | |
1108 | default, but may fall back to using the ID number in some circumstances | |
1109 | (see also the bf(--numeric-ids) option for a full discussion). | |
41059f75 | 1110 | |
4e7d07c8 | 1111 | dit(bf(--devices)) This option causes rsync to transfer character and |
d38772e0 WD |
1112 | block device files to the remote system to recreate these devices. |
1113 | This option has no effect if the receiving rsync is not run as the | |
9439c0cb | 1114 | super-user (see also the bf(--super) and bf(--fake-super) options). |
41059f75 | 1115 | |
4e7d07c8 WD |
1116 | dit(bf(--specials)) This option causes rsync to transfer special files |
1117 | such as named sockets and fifos. | |
1118 | ||
1119 | dit(bf(-D)) The bf(-D) option is equivalent to bf(--devices) bf(--specials). | |
1120 | ||
41059f75 | 1121 | dit(bf(-t, --times)) This tells rsync to transfer modification times along |
baf3e504 DD |
1122 | with the files and update them on the remote system. Note that if this |
1123 | option is not used, the optimization that excludes files that have not been | |
faa82484 WD |
1124 | modified cannot be effective; in other words, a missing bf(-t) or bf(-a) will |
1125 | cause the next transfer to behave as if it used bf(-I), causing all files to be | |
adc4ebdd | 1126 | updated (though rsync's delta-transfer algorithm will make the update fairly efficient |
faa82484 | 1127 | if the files haven't actually changed, you're much better off using bf(-t)). |
41059f75 | 1128 | |
54e66f1d | 1129 | dit(bf(-O, --omit-dir-times)) This tells rsync to omit directories when |
faa82484 WD |
1130 | it is preserving modification times (see bf(--times)). If NFS is sharing |
1131 | the directories on the receiving side, it is a good idea to use bf(-O). | |
fbe5eeb8 | 1132 | This option is inferred if you use bf(--backup) without bf(--backup-dir). |
54e66f1d | 1133 | |
2624e005 WD |
1134 | dit(bf(-J, --omit-link-times)) This tells rsync to omit symlinks when |
1135 | it is preserving modification times (see bf(--times)). | |
1136 | ||
d38772e0 WD |
1137 | dit(bf(--super)) This tells the receiving side to attempt super-user |
1138 | activities even if the receiving rsync wasn't run by the super-user. These | |
1139 | activities include: preserving users via the bf(--owner) option, preserving | |
1140 | all groups (not just the current user's groups) via the bf(--groups) | |
1141 | option, and copying devices via the bf(--devices) option. This is useful | |
1142 | for systems that allow such activities without being the super-user, and | |
1143 | also for ensuring that you will get errors if the receiving side isn't | |
0cdb547f | 1144 | being run as the super-user. To turn off super-user activities, the |
d38772e0 WD |
1145 | super-user can use bf(--no-super). |
1146 | ||
9439c0cb | 1147 | dit(bf(--fake-super)) When this option is enabled, rsync simulates |
0f6b4909 WD |
1148 | super-user activities by saving/restoring the privileged attributes via |
1149 | special extended attributes that are attached to each file (as needed). This | |
9439c0cb WD |
1150 | includes the file's owner and group (if it is not the default), the file's |
1151 | device info (device & special files are created as empty text files), and | |
1152 | any permission bits that we won't allow to be set on the real file (e.g. | |
1153 | the real file gets u-s,g-s,o-t for safety) or that would limit the owner's | |
809724d7 WD |
1154 | access (since the real super-user can always access/change a file, the |
1155 | files we create can always be accessed/changed by the creating user). | |
0f6b4909 WD |
1156 | This option also handles ACLs (if bf(--acls) was specified) and non-user |
1157 | extended attributes (if bf(--xattrs) was specified). | |
1158 | ||
84e1a34e | 1159 | This is a good way to backup data without using a super-user, and to store |
0f6b4909 | 1160 | ACLs from incompatible systems. |
9439c0cb WD |
1161 | |
1162 | The bf(--fake-super) option only affects the side where the option is used. | |
7a2eca41 WD |
1163 | To affect the remote side of a remote-shell connection, use the |
1164 | bf(--remote-option) (bf(-M)) option: | |
9439c0cb | 1165 | |
7a2eca41 | 1166 | quote(tt( rsync -av -M--fake-super /src/ host:/dest/)) |
9439c0cb | 1167 | |
7a2eca41 WD |
1168 | For a local copy, this option affects both the source and the destination. |
1169 | If you wish a local copy to enable this option just for the destination | |
1170 | files, specify bf(-M--fake-super). If you wish a local copy to enable | |
1171 | this option just for the source files, combine bf(--fake-super) with | |
1172 | bf(-M--super). | |
9439c0cb WD |
1173 | |
1174 | This option is overridden by both bf(--super) and bf(--no-super). | |
1175 | ||
1176 | See also the "fake super" setting in the daemon's rsyncd.conf file. | |
1177 | ||
41059f75 | 1178 | dit(bf(-S, --sparse)) Try to handle sparse files efficiently so they take |
a8cbb57c WD |
1179 | up less space on the destination. Conflicts with bf(--inplace) because it's |
1180 | not possible to overwrite data in a sparse fashion. | |
41059f75 | 1181 | |
28b519c9 WD |
1182 | dit(bf(--preallocate)) This tells the receiver to allocate each destination |
1183 | file to its eventual size before writing data to the file. Rsync will only use | |
1184 | the real filesystem-level preallocation support provided by Linux's | |
1185 | bf(fallocate)(2) system call or Cygwin's bf(posix_fallocate)(3), not the slow | |
1186 | glibc implementation that writes a zero byte into each block. | |
1187 | ||
1188 | Without this option, larger files may not be entirely contiguous on the | |
1189 | filesystem, but with this option rsync will probably copy more slowly. If the | |
1190 | destination is not an extent-supporting filesystem (such as ext4, xfs, NTFS, | |
1191 | etc.), this option may have no positive effect at all. | |
1192 | ||
d100e733 WD |
1193 | dit(bf(-n, --dry-run)) This makes rsync perform a trial run that doesn't |
1194 | make any changes (and produces mostly the same output as a real run). It | |
1195 | is most commonly used in combination with the bf(-v, --verbose) and/or | |
1196 | bf(-i, --itemize-changes) options to see what an rsync command is going | |
1197 | to do before one actually runs it. | |
1198 | ||
1199 | The output of bf(--itemize-changes) is supposed to be exactly the same on a | |
1200 | dry run and a subsequent real run (barring intentional trickery and system | |
6f098b0f WD |
1201 | call failures); if it isn't, that's a bug. Other output should be mostly |
1202 | unchanged, but may differ in some areas. Notably, a dry run does not | |
d100e733 WD |
1203 | send the actual data for file transfers, so bf(--progress) has no effect, |
1204 | the "bytes sent", "bytes received", "literal data", and "matched data" | |
1205 | statistics are too small, and the "speedup" value is equivalent to a run | |
6f098b0f | 1206 | where no file transfers were needed. |
f2ebbebe | 1207 | |
adc4ebdd | 1208 | dit(bf(-W, --whole-file)) With this option rsync's delta-transfer algorithm |
f2ebbebe WD |
1209 | is not used and the whole file is sent as-is instead. The transfer may be |
1210 | faster if this option is used when the bandwidth between the source and | |
1211 | destination machines is higher than the bandwidth to disk (especially when the | |
1212 | "disk" is actually a networked filesystem). This is the default when both | |
63070274 WD |
1213 | the source and destination are specified as local paths, but only if no |
1214 | batch-writing option is in effect. | |
f2ebbebe | 1215 | |
4e5baafe WD |
1216 | dit(bf(-x, --one-file-system)) This tells rsync to avoid crossing a |
1217 | filesystem boundary when recursing. This does not limit the user's ability | |
1218 | to specify items to copy from multiple filesystems, just rsync's recursion | |
1219 | through the hierarchy of each directory that the user specified, and also | |
1220 | the analogous recursion on the receiving side during deletion. Also keep | |
1221 | in mind that rsync treats a "bind" mount to the same device as being on the | |
77ed253c | 1222 | same filesystem. |
4e5baafe WD |
1223 | |
1224 | If this option is repeated, rsync omits all mount-point directories from | |
1225 | the copy. Otherwise, it includes an empty directory at each mount-point it | |
1226 | encounters (using the attributes of the mounted directory because those of | |
1227 | the underlying mount-point directory are inaccessible). | |
1228 | ||
1229 | If rsync has been told to collapse symlinks (via bf(--copy-links) or | |
1230 | bf(--copy-unsafe-links)), a symlink to a directory on another device is | |
49140b27 WD |
1231 | treated like a mount-point. Symlinks to non-directories are unaffected |
1232 | by this option. | |
6d8c6bdb | 1233 | |
9639c718 | 1234 | dit(bf(--existing, --ignore-non-existing)) This tells rsync to skip |
58a06312 WD |
1235 | creating files (including directories) that do not exist |
1236 | yet on the destination. If this option is | |
9639c718 | 1237 | combined with the bf(--ignore-existing) option, no files will be updated |
8e3b627d | 1238 | (which can be useful if all you want to do is delete extraneous files). |
9639c718 | 1239 | |
fd2b6046 WD |
1240 | This option is a transfer rule, not an exclude, so it doesn't affect the |
1241 | data that goes into the file-lists, and thus it doesn't affect deletions. | |
1242 | It just limits the files that the receiver requests to be transferred. | |
1243 | ||
58a06312 WD |
1244 | dit(bf(--ignore-existing)) This tells rsync to skip updating files that |
1245 | already exist on the destination (this does em(not) ignore existing | |
c5b6e57a | 1246 | directories, or nothing would get done). See also bf(--existing). |
1347d512 | 1247 | |
fd2b6046 WD |
1248 | This option is a transfer rule, not an exclude, so it doesn't affect the |
1249 | data that goes into the file-lists, and thus it doesn't affect deletions. | |
1250 | It just limits the files that the receiver requests to be transferred. | |
1251 | ||
8e3b627d WD |
1252 | This option can be useful for those doing backups using the bf(--link-dest) |
1253 | option when they need to continue a backup run that got interrupted. Since | |
1254 | a bf(--link-dest) run is copied into a new directory hierarchy (when it is | |
1255 | used properly), using bf(--ignore existing) will ensure that the | |
1256 | already-handled files don't get tweaked (which avoids a change in | |
1257 | permissions on the hard-linked files). This does mean that this option | |
1258 | is only looking at the existing files in the destination hierarchy itself. | |
1259 | ||
47c11975 | 1260 | dit(bf(--remove-source-files)) This tells rsync to remove from the sending |
fb41a3c6 WD |
1261 | side the files (meaning non-directories) that are a part of the transfer |
1262 | and have been successfully duplicated on the receiving side. | |
96110304 | 1263 | |
852585b1 WD |
1264 | Note that you should only use this option on source files that are quiescent. |
1265 | If you are using this to move files that show up in a particular directory over | |
1266 | to another host, make sure that the finished files get renamed into the source | |
1267 | directory, not directly written into it, so that rsync can't possibly transfer | |
1268 | a file that is not yet fully written. If you can't first write the files into | |
1269 | a different directory, you should use a naming idiom that lets rsync avoid | |
1270 | transferring files that are not yet finished (e.g. name the file "foo.new" when | |
1271 | it is written, rename it to "foo" when it is done, and then use the option | |
1272 | bf(--exclude='*.new') for the rsync transfer). | |
1273 | ||
1274 | Starting with 3.1.0, rsync will skip the sender-side removal (and output an | |
1275 | error) if the file's size or modify time has not stayed unchanged. | |
1276 | ||
2c0fa6c5 | 1277 | dit(bf(--delete)) This tells rsync to delete extraneous files from the |
e8b155a3 WD |
1278 | receiving side (ones that aren't on the sending side), but only for the |
1279 | directories that are being synchronized. You must have asked rsync to | |
1280 | send the whole directory (e.g. "dir" or "dir/") without using a wildcard | |
1281 | for the directory's contents (e.g. "dir/*") since the wildcard is expanded | |
ae76a740 | 1282 | by the shell and rsync thus gets a request to transfer individual files, not |
d252e47d | 1283 | the files' parent directory. Files that are excluded from the transfer are |
0dfffb88 WD |
1284 | also excluded from being deleted unless you use the bf(--delete-excluded) |
1285 | option or mark the rules as only matching on the sending side (see the | |
1286 | include/exclude modifiers in the FILTER RULES section). | |
41059f75 | 1287 | |
505ada14 | 1288 | Prior to rsync 2.6.7, this option would have no effect unless bf(--recursive) |
d9f46544 WD |
1289 | was enabled. Beginning with 2.6.7, deletions will also occur when bf(--dirs) |
1290 | (bf(-d)) is enabled, but only for directories whose contents are being copied. | |
24986abd | 1291 | |
32b9011a WD |
1292 | This option can be dangerous if used incorrectly! It is a very good idea to |
1293 | first try a run using the bf(--dry-run) option (bf(-n)) to see what files are | |
1294 | going to be deleted. | |
41059f75 | 1295 | |
e8b155a3 | 1296 | If the sending side detects any I/O errors, then the deletion of any |
3e578a19 AT |
1297 | files at the destination will be automatically disabled. This is to |
1298 | prevent temporary filesystem failures (such as NFS errors) on the | |
6f098b0f | 1299 | sending side from causing a massive deletion of files on the |
faa82484 | 1300 | destination. You can override this with the bf(--ignore-errors) option. |
41059f75 | 1301 | |
faa82484 WD |
1302 | The bf(--delete) option may be combined with one of the --delete-WHEN options |
1303 | without conflict, as well as bf(--delete-excluded). However, if none of the | |
d9f46544 | 1304 | --delete-WHEN options are specified, rsync will choose the |
d252e47d | 1305 | bf(--delete-during) algorithm when talking to rsync 3.0.0 or newer, and |
d9f46544 WD |
1306 | the bf(--delete-before) algorithm when talking to an older rsync. See also |
1307 | bf(--delete-delay) and bf(--delete-after). | |
2c0fa6c5 WD |
1308 | |
1309 | dit(bf(--delete-before)) Request that the file-deletions on the receiving | |
d9f46544 | 1310 | side be done before the transfer starts. |
faa82484 | 1311 | See bf(--delete) (which is implied) for more details on file-deletion. |
2c0fa6c5 WD |
1312 | |
1313 | Deleting before the transfer is helpful if the filesystem is tight for space | |
aaca3daa | 1314 | and removing extraneous files would help to make the transfer possible. |
ae76a740 | 1315 | However, it does introduce a delay before the start of the transfer, |
faa82484 | 1316 | and this delay might cause the transfer to timeout (if bf(--timeout) was |
d9f46544 WD |
1317 | specified). It also forces rsync to use the old, non-incremental recursion |
1318 | algorithm that requires rsync to scan all the files in the transfer into | |
1319 | memory at once (see bf(--recursive)). | |
ae76a740 | 1320 | |
2c0fa6c5 | 1321 | dit(bf(--delete-during, --del)) Request that the file-deletions on the |
d252e47d WD |
1322 | receiving side be done incrementally as the transfer happens. The |
1323 | per-directory delete scan is done right before each directory is checked | |
1324 | for updates, so it behaves like a more efficient bf(--delete-before), | |
1325 | including doing the deletions prior to any per-directory filter files | |
1326 | being updated. This option was first added in rsync version 2.6.4. | |
faa82484 | 1327 | See bf(--delete) (which is implied) for more details on file-deletion. |
aaca3daa | 1328 | |
fd0a130c | 1329 | dit(bf(--delete-delay)) Request that the file-deletions on the receiving |
d252e47d WD |
1330 | side be computed during the transfer (like bf(--delete-during)), and then |
1331 | removed after the transfer completes. This is useful when combined with | |
1332 | bf(--delay-updates) and/or bf(--fuzzy), and is more efficient than using | |
1333 | bf(--delete-after) (but can behave differently, since bf(--delete-after) | |
1334 | computes the deletions in a separate pass after all updates are done). | |
1335 | If the number of removed files overflows an internal buffer, a | |
d9f46544 WD |
1336 | temporary file will be created on the receiving side to hold the names (it |
1337 | is removed while open, so you shouldn't see it during the transfer). If | |
1338 | the creation of the temporary file fails, rsync will try to fall back to | |
1339 | using bf(--delete-after) (which it cannot do if bf(--recursive) is doing an | |
1340 | incremental scan). | |
d252e47d | 1341 | See bf(--delete) (which is implied) for more details on file-deletion. |
fd0a130c | 1342 | |
2c0fa6c5 | 1343 | dit(bf(--delete-after)) Request that the file-deletions on the receiving |
ae76a740 WD |
1344 | side be done after the transfer has completed. This is useful if you |
1345 | are sending new per-directory merge files as a part of the transfer and | |
1346 | you want their exclusions to take effect for the delete phase of the | |
d9f46544 WD |
1347 | current transfer. It also forces rsync to use the old, non-incremental |
1348 | recursion algorithm that requires rsync to scan all the files in the | |
1349 | transfer into memory at once (see bf(--recursive)). | |
faa82484 | 1350 | See bf(--delete) (which is implied) for more details on file-deletion. |
e8b155a3 | 1351 | |
866925bf WD |
1352 | dit(bf(--delete-excluded)) In addition to deleting the files on the |
1353 | receiving side that are not on the sending side, this tells rsync to also | |
faa82484 | 1354 | delete any files on the receiving side that are excluded (see bf(--exclude)). |
0dfffb88 WD |
1355 | See the FILTER RULES section for a way to make individual exclusions behave |
1356 | this way on the receiver, and for a way to protect files from | |
1357 | bf(--delete-excluded). | |
faa82484 | 1358 | See bf(--delete) (which is implied) for more details on file-deletion. |
866925bf | 1359 | |
42d8ec61 WD |
1360 | dit(bf(--ignore-missing-args)) When rsync is first processing the explicitly |
1361 | requested source files (e.g. command-line arguments or bf(--files-from) | |
1362 | entries), it is normally an error if the file cannot be found. This option | |
1363 | suppresses that error, and does not try to transfer the file. This does not | |
1364 | affect subsequent vanished-file errors if a file was initially found to be | |
1365 | present and later is no longer there. | |
1366 | ||
1367 | dit(bf(--delete-missing-args)) This option takes the behavior of (the implied) | |
1368 | bf(--ignore-missing-args) option a step farther: each missing arg will become | |
1369 | a deletion request of the corresponding destination file on the receiving side | |
1370 | (should it exist). If the destination file is a non-empty directory, it will | |
1371 | only be successfully deleted if --force or --delete are in effect. Other than | |
1372 | that, this option is independent of any other type of delete processing. | |
1373 | ||
1374 | The missing source files are represented by special file-list entries which | |
1375 | display as a "*missing" entry in the bf(--list-only) output. | |
ce66f417 | 1376 | |
faa82484 | 1377 | dit(bf(--ignore-errors)) Tells bf(--delete) to go ahead and delete files |
b5accaba | 1378 | even when there are I/O errors. |
2c5548d2 | 1379 | |
b3964d1d WD |
1380 | dit(bf(--force)) This option tells rsync to delete a non-empty directory |
1381 | when it is to be replaced by a non-directory. This is only relevant if | |
1382 | deletions are not active (see bf(--delete) for details). | |
1383 | ||
1384 | Note for older rsync versions: bf(--force) used to still be required when | |
1385 | using bf(--delete-after), and it used to be non-functional unless the | |
1386 | bf(--recursive) option was also enabled. | |
41059f75 | 1387 | |
e2124620 | 1388 | dit(bf(--max-delete=NUM)) This tells rsync not to delete more than NUM |
e6109f49 WD |
1389 | files or directories. If that limit is exceeded, a warning is output |
1390 | and rsync exits with an error code of 25 (new for 3.0.0). | |
1391 | ||
1392 | Also new for version 3.0.0, you may specify bf(--max-delete=0) to be warned | |
1393 | about any extraneous files in the destination without removing any of them. | |
1394 | Older clients interpreted this as "unlimited", so if you don't know what | |
1395 | version the client is, you can use the less obvious bf(--max-delete=-1) as | |
1396 | a backward-compatible way to specify that no deletions be allowed (though | |
1397 | older versions didn't warn when the limit was exceeded). | |
e2124620 WD |
1398 | |
1399 | dit(bf(--max-size=SIZE)) This tells rsync to avoid transferring any | |
1400 | file that is larger than the specified SIZE. The SIZE value can be | |
926d86d1 | 1401 | suffixed with a string to indicate a size multiplier, and |
e2124620 WD |
1402 | may be a fractional value (e.g. "bf(--max-size=1.5m)"). |
1403 | ||
fd2b6046 WD |
1404 | This option is a transfer rule, not an exclude, so it doesn't affect the |
1405 | data that goes into the file-lists, and thus it doesn't affect deletions. | |
1406 | It just limits the files that the receiver requests to be transferred. | |
1407 | ||
bee9df73 WD |
1408 | The suffixes are as follows: "K" (or "KiB") is a kibibyte (1024), |
1409 | "M" (or "MiB") is a mebibyte (1024*1024), and "G" (or "GiB") is a | |
1410 | gibibyte (1024*1024*1024). | |
1411 | If you want the multiplier to be 1000 instead of 1024, use "KB", | |
1412 | "MB", or "GB". (Note: lower-case is also accepted for all values.) | |
926d86d1 WD |
1413 | Finally, if the suffix ends in either "+1" or "-1", the value will |
1414 | be offset by one byte in the indicated direction. | |
bee9df73 WD |
1415 | |
1416 | Examples: --max-size=1.5mb-1 is 1499999 bytes, and --max-size=2g+1 is | |
926d86d1 WD |
1417 | 2147483649 bytes. |
1418 | ||
59dd6786 WD |
1419 | dit(bf(--min-size=SIZE)) This tells rsync to avoid transferring any |
1420 | file that is smaller than the specified SIZE, which can help in not | |
1421 | transferring small, junk files. | |
fd2b6046 | 1422 | See the bf(--max-size) option for a description of SIZE and other information. |
59dd6786 | 1423 | |
3ed8eb3f | 1424 | dit(bf(-B, --block-size=BLOCKSIZE)) This forces the block size used in |
adc4ebdd | 1425 | rsync's delta-transfer algorithm to a fixed value. It is normally selected based on |
3ed8eb3f | 1426 | the size of each file being updated. See the technical report for details. |
41059f75 | 1427 | |
b5679335 | 1428 | dit(bf(-e, --rsh=COMMAND)) This option allows you to choose an alternative |
41059f75 | 1429 | remote shell program to use for communication between the local and |
43cd760f WD |
1430 | remote copies of rsync. Typically, rsync is configured to use ssh by |
1431 | default, but you may prefer to use rsh on a local network. | |
41059f75 | 1432 | |
bef49340 | 1433 | If this option is used with bf([user@]host::module/path), then the |
5a727522 | 1434 | remote shell em(COMMAND) will be used to run an rsync daemon on the |
bef49340 WD |
1435 | remote host, and all data will be transmitted through that remote |
1436 | shell connection, rather than through a direct socket connection to a | |
754a080f WD |
1437 | running rsync daemon on the remote host. See the section "USING |
1438 | RSYNC-DAEMON FEATURES VIA A REMOTE-SHELL CONNECTION" above. | |
bef49340 | 1439 | |
ea7f8108 | 1440 | Command-line arguments are permitted in COMMAND provided that COMMAND is |
5d9530fe WD |
1441 | presented to rsync as a single argument. You must use spaces (not tabs |
1442 | or other whitespace) to separate the command and args from each other, | |
1443 | and you can use single- and/or double-quotes to preserve spaces in an | |
1444 | argument (but not backslashes). Note that doubling a single-quote | |
1445 | inside a single-quoted string gives you a single-quote; likewise for | |
1446 | double-quotes (though you need to pay attention to which quotes your | |
1447 | shell is parsing and which quotes rsync is parsing). Some examples: | |
98393ae2 | 1448 | |
5d9530fe WD |
1449 | quote( |
1450 | tt( -e 'ssh -p 2234')nl() | |
1451 | tt( -e 'ssh -o "ProxyCommand nohup ssh firewall nc -w1 %h %p"')nl() | |
1452 | ) | |
98393ae2 WD |
1453 | |
1454 | (Note that ssh users can alternately customize site-specific connect | |
1455 | options in their .ssh/config file.) | |
1456 | ||
41059f75 | 1457 | You can also choose the remote shell program using the RSYNC_RSH |
faa82484 | 1458 | environment variable, which accepts the same range of values as bf(-e). |
41059f75 | 1459 | |
faa82484 | 1460 | See also the bf(--blocking-io) option which is affected by this option. |
735a816e | 1461 | |
68e169ab WD |
1462 | dit(bf(--rsync-path=PROGRAM)) Use this to specify what program is to be run |
1463 | on the remote machine to start-up rsync. Often used when rsync is not in | |
1464 | the default remote-shell's path (e.g. --rsync-path=/usr/local/bin/rsync). | |
1465 | Note that PROGRAM is run with the help of a shell, so it can be any | |
1466 | program, script, or command sequence you'd care to run, so long as it does | |
1467 | not corrupt the standard-in & standard-out that rsync is using to | |
1468 | communicate. | |
1469 | ||
1470 | One tricky example is to set a different default directory on the remote | |
1471 | machine for use with the bf(--relative) option. For instance: | |
1472 | ||
c5b6e57a | 1473 | quote(tt( rsync -avR --rsync-path="cd /a/b && rsync" host:c/d /e/)) |
41059f75 | 1474 | |
7a2eca41 WD |
1475 | dit(bf(-M, --remote-option=OPTION)) This option is used for more advanced |
1476 | situations where you want certain effects to be limited to one side of the | |
1477 | transfer only. For instance, if you want to pass bf(--log-file=FILE) and | |
1478 | bf(--fake-super) to the remote system, specify it like this: | |
1479 | ||
1480 | quote(tt( rsync -av -M --log-file=foo -M--fake-super src/ dest/)) | |
1481 | ||
1482 | If you want to have an option affect only the local side of a transfer when | |
1483 | it normally affects both sides, send its negation to the remote side. Like | |
1484 | this: | |
1485 | ||
1486 | quote(tt( rsync -av -x -M--no-x src/ dest/)) | |
1487 | ||
1488 | Be cautious using this, as it is possible to toggle an option that will cause | |
1489 | rsync to have a different idea about what data to expect next over the socket, | |
1490 | and that will make it fail in a cryptic fashion. | |
1491 | ||
1492 | Note that it is best to use a separate bf(--remote-option) for each option you | |
1493 | want to pass. This makes your useage compatible with the bf(--protect-args) | |
1494 | option. If that option is off, any spaces in your remote options will be split | |
1495 | by the remote shell unless you take steps to protect them. | |
1496 | ||
1497 | When performing a local transfer, the "local" side is the sender and the | |
1498 | "remote" side is the receiver. | |
1499 | ||
1500 | Note some versions of the popt option-parsing library have a bug in them that | |
1501 | prevents you from using an adjacent arg with an equal in it next to a short | |
1502 | option letter (e.g. tt(-M--log-file=/tmp/foo). If this bug affects your | |
1503 | version of popt, you can use the version of popt that is included with rsync. | |
1504 | ||
f177b7cc WD |
1505 | dit(bf(-C, --cvs-exclude)) This is a useful shorthand for excluding a |
1506 | broad range of files that you often don't want to transfer between | |
c575f8ce | 1507 | systems. It uses a similar algorithm to CVS to determine if |
f177b7cc WD |
1508 | a file should be ignored. |
1509 | ||
c575f8ce WD |
1510 | The exclude list is initialized to exclude the following items (these |
1511 | initial items are marked as perishable -- see the FILTER RULES section): | |
f177b7cc | 1512 | |
faa82484 | 1513 | quote(quote(tt(RCS SCCS CVS CVS.adm RCSLOG cvslog.* tags TAGS .make.state |
9520ce4b | 1514 | .nse_depinfo *~ #* .#* ,* _$* *$ *.old *.bak *.BAK *.orig *.rej .del-* |
86e90c58 | 1515 | *.a *.olb *.o *.obj *.so *.exe *.Z *.elc *.ln core .svn/ .git/ .hg/ .bzr/))) |
f177b7cc | 1516 | |
c575f8ce | 1517 | then, files listed in a $HOME/.cvsignore are added to the list and any |
2a383be0 WD |
1518 | files listed in the CVSIGNORE environment variable (all cvsignore names |
1519 | are delimited by whitespace). | |
1520 | ||
f177b7cc | 1521 | Finally, any file is ignored if it is in the same directory as a |
bafa4875 WD |
1522 | .cvsignore file and matches one of the patterns listed therein. Unlike |
1523 | rsync's filter/exclude files, these patterns are split on whitespace. | |
49f4cfdf | 1524 | See the bf(cvs)(1) manual for more information. |
f177b7cc | 1525 | |
bafa4875 WD |
1526 | If you're combining bf(-C) with your own bf(--filter) rules, you should |
1527 | note that these CVS excludes are appended at the end of your own rules, | |
3753975f | 1528 | regardless of where the bf(-C) was placed on the command-line. This makes them |
bafa4875 WD |
1529 | a lower priority than any rules you specified explicitly. If you want to |
1530 | control where these CVS excludes get inserted into your filter rules, you | |
1531 | should omit the bf(-C) as a command-line option and use a combination of | |
1532 | bf(--filter=:C) and bf(--filter=-C) (either on your command-line or by | |
1533 | putting the ":C" and "-C" rules into a filter file with your other rules). | |
1534 | The first option turns on the per-directory scanning for the .cvsignore | |
1535 | file. The second option does a one-time import of the CVS excludes | |
1536 | mentioned above. | |
1537 | ||
16e5de84 WD |
1538 | dit(bf(-f, --filter=RULE)) This option allows you to add rules to selectively |
1539 | exclude certain files from the list of files to be transferred. This is | |
1540 | most useful in combination with a recursive transfer. | |
41059f75 | 1541 | |
faa82484 | 1542 | You may use as many bf(--filter) options on the command line as you like |
5f0f2e08 WD |
1543 | to build up the list of files to exclude. If the filter contains whitespace, |
1544 | be sure to quote it so that the shell gives the rule to rsync as a single | |
1545 | argument. The text below also mentions that you can use an underscore to | |
1546 | replace the space that separates a rule from its arg. | |
41059f75 | 1547 | |
16e5de84 WD |
1548 | See the FILTER RULES section for detailed information on this option. |
1549 | ||
faa82484 | 1550 | dit(bf(-F)) The bf(-F) option is a shorthand for adding two bf(--filter) rules to |
16e5de84 WD |
1551 | your command. The first time it is used is a shorthand for this rule: |
1552 | ||
78be8e0f | 1553 | quote(tt( --filter='dir-merge /.rsync-filter')) |
16e5de84 WD |
1554 | |
1555 | This tells rsync to look for per-directory .rsync-filter files that have | |
1556 | been sprinkled through the hierarchy and use their rules to filter the | |
faa82484 | 1557 | files in the transfer. If bf(-F) is repeated, it is a shorthand for this |
16e5de84 WD |
1558 | rule: |
1559 | ||
78be8e0f | 1560 | quote(tt( --filter='exclude .rsync-filter')) |
16e5de84 WD |
1561 | |
1562 | This filters out the .rsync-filter files themselves from the transfer. | |
1563 | ||
1564 | See the FILTER RULES section for detailed information on how these options | |
1565 | work. | |
1566 | ||
1567 | dit(bf(--exclude=PATTERN)) This option is a simplified form of the | |
faa82484 | 1568 | bf(--filter) option that defaults to an exclude rule and does not allow |
16e5de84 WD |
1569 | the full rule-parsing syntax of normal filter rules. |
1570 | ||
1571 | See the FILTER RULES section for detailed information on this option. | |
41059f75 | 1572 | |
78be8e0f WD |
1573 | dit(bf(--exclude-from=FILE)) This option is related to the bf(--exclude) |
1574 | option, but it specifies a FILE that contains exclude patterns (one per line). | |
1575 | Blank lines in the file and lines starting with ';' or '#' are ignored. | |
1576 | If em(FILE) is bf(-), the list will be read from standard input. | |
f8a94f0d | 1577 | |
16e5de84 | 1578 | dit(bf(--include=PATTERN)) This option is a simplified form of the |
faa82484 | 1579 | bf(--filter) option that defaults to an include rule and does not allow |
16e5de84 | 1580 | the full rule-parsing syntax of normal filter rules. |
43bd68e5 | 1581 | |
16e5de84 | 1582 | See the FILTER RULES section for detailed information on this option. |
43bd68e5 | 1583 | |
78be8e0f WD |
1584 | dit(bf(--include-from=FILE)) This option is related to the bf(--include) |
1585 | option, but it specifies a FILE that contains include patterns (one per line). | |
1586 | Blank lines in the file and lines starting with ';' or '#' are ignored. | |
1587 | If em(FILE) is bf(-), the list will be read from standard input. | |
f8a94f0d | 1588 | |
f177b7cc | 1589 | dit(bf(--files-from=FILE)) Using this option allows you to specify the |
78be8e0f | 1590 | exact list of files to transfer (as read from the specified FILE or bf(-) |
c769702f | 1591 | for standard input). It also tweaks the default behavior of rsync to make |
faa82484 WD |
1592 | transferring just the specified files and directories easier: |
1593 | ||
b8a6dae0 | 1594 | quote(itemization( |
faa82484 WD |
1595 | it() The bf(--relative) (bf(-R)) option is implied, which preserves the path |
1596 | information that is specified for each item in the file (use | |
f40aa6fb | 1597 | bf(--no-relative) or bf(--no-R) if you want to turn that off). |
faa82484 WD |
1598 | it() The bf(--dirs) (bf(-d)) option is implied, which will create directories |
1599 | specified in the list on the destination rather than noisily skipping | |
f40aa6fb | 1600 | them (use bf(--no-dirs) or bf(--no-d) if you want to turn that off). |
faa82484 WD |
1601 | it() The bf(--archive) (bf(-a)) option's behavior does not imply bf(--recursive) |
1602 | (bf(-r)), so specify it explicitly, if you want it. | |
f40aa6fb WD |
1603 | it() These side-effects change the default state of rsync, so the position |
1604 | of the bf(--files-from) option on the command-line has no bearing on how | |
1605 | other options are parsed (e.g. bf(-a) works the same before or after | |
1606 | bf(--files-from), as does bf(--no-R) and all other options). | |
faa82484 | 1607 | )) |
f177b7cc | 1608 | |
809724d7 | 1609 | The filenames that are read from the FILE are all relative to the |
f177b7cc WD |
1610 | source dir -- any leading slashes are removed and no ".." references are |
1611 | allowed to go higher than the source dir. For example, take this | |
1612 | command: | |
1613 | ||
faa82484 | 1614 | quote(tt( rsync -a --files-from=/tmp/foo /usr remote:/backup)) |
f177b7cc WD |
1615 | |
1616 | If /tmp/foo contains the string "bin" (or even "/bin"), the /usr/bin | |
51cc96e4 WD |
1617 | directory will be created as /backup/bin on the remote host. If it |
1618 | contains "bin/" (note the trailing slash), the immediate contents of | |
1619 | the directory would also be sent (without needing to be explicitly | |
1620 | mentioned in the file -- this began in version 2.6.4). In both cases, | |
1621 | if the bf(-r) option was enabled, that dir's entire hierarchy would | |
1622 | also be transferred (keep in mind that bf(-r) needs to be specified | |
1623 | explicitly with bf(--files-from), since it is not implied by bf(-a)). | |
1624 | Also note | |
faa82484 | 1625 | that the effect of the (enabled by default) bf(--relative) option is to |
f177b7cc WD |
1626 | duplicate only the path info that is read from the file -- it does not |
1627 | force the duplication of the source-spec path (/usr in this case). | |
1628 | ||
faa82484 | 1629 | In addition, the bf(--files-from) file can be read from the remote host |
f177b7cc WD |
1630 | instead of the local host if you specify a "host:" in front of the file |
1631 | (the host must match one end of the transfer). As a short-cut, you can | |
1632 | specify just a prefix of ":" to mean "use the remote end of the | |
1633 | transfer". For example: | |
1634 | ||
faa82484 | 1635 | quote(tt( rsync -a --files-from=:/path/file-list src:/ /tmp/copy)) |
f177b7cc WD |
1636 | |
1637 | This would copy all the files specified in the /path/file-list file that | |
1638 | was located on the remote "src" host. | |
1639 | ||
0dd2310c WD |
1640 | If the bf(--iconv) and bf(--protect-args) options are specified and the |
1641 | bf(--files-from) filenames are being sent from one host to another, the | |
1642 | filenames will be translated from the sending host's charset to the | |
1643 | receiving host's charset. | |
1644 | ||
49eb0c4a WD |
1645 | NOTE: sorting the list of files in the --files-from input helps rsync to be |
1646 | more efficient, as it will avoid re-visiting the path elements that are shared | |
1647 | between adjacent entries. If the input is not sorted, some path elements | |
1648 | (implied directories) may end up being scanned multiple times, and rsync will | |
1649 | eventually unduplicate them after they get turned into file-list elements. | |
1650 | ||
fa92818a | 1651 | dit(bf(-0, --from0)) This tells rsync that the rules/filenames it reads from a |
f177b7cc | 1652 | file are terminated by a null ('\0') character, not a NL, CR, or CR+LF. |
faa82484 WD |
1653 | This affects bf(--exclude-from), bf(--include-from), bf(--files-from), and any |
1654 | merged files specified in a bf(--filter) rule. | |
1655 | It does not affect bf(--cvs-exclude) (since all names read from a .cvsignore | |
f01b6368 | 1656 | file are split on whitespace). |
41059f75 | 1657 | |
0dd2310c | 1658 | dit(bf(-s, --protect-args)) This option sends all filenames and most options to |
82f37486 WD |
1659 | the remote rsync without allowing the remote shell to interpret them. This |
1660 | means that spaces are not split in names, and any non-wildcard special | |
1661 | characters are not translated (such as ~, $, ;, &, etc.). Wildcards are | |
1662 | expanded on the remote host by rsync (instead of the shell doing it). | |
1663 | ||
0dd2310c WD |
1664 | If you use this option with bf(--iconv), the args related to the remote |
1665 | side will also be translated | |
0b52f94d | 1666 | from the local to the remote character-set. The translation happens before |
82f37486 WD |
1667 | wild-cards are expanded. See also the bf(--files-from) option. |
1668 | ||
2b2a4738 WD |
1669 | You may also control this option via the RSYNC_PROTECT_ARGS environment |
1670 | variable. If this variable has a non-zero value, this option will be enabled | |
1671 | by default, otherwise it will be disabled by default. Either state is | |
1672 | overridden by a manually specified positive or negative version of this option | |
1673 | (note that bf(--no-s) and bf(--no-protect-args) are the negative versions). | |
1674 | Since this option was first introduced in 3.0.0, you'll need to make sure it's | |
1675 | disabled if you ever need to interact with a remote rsync that is older than | |
1676 | that. | |
1677 | ||
1678 | Rsync can also be configured (at build time) to have this option enabled by | |
1679 | default (with is overridden by both the environment and the command-line). | |
1680 | This option will eventually become a new default setting at some | |
1681 | as-yet-undetermined point in the future. | |
1682 | ||
b5679335 | 1683 | dit(bf(-T, --temp-dir=DIR)) This option instructs rsync to use DIR as a |
a9af5d8e WD |
1684 | scratch directory when creating temporary copies of the files transferred |
1685 | on the receiving side. The default behavior is to create each temporary | |
1686 | file in the same directory as the associated destination file. | |
41059f75 | 1687 | |
9ec1ef25 WD |
1688 | This option is most often used when the receiving disk partition does not |
1689 | have enough free space to hold a copy of the largest file in the transfer. | |
d770837e | 1690 | In this case (i.e. when the scratch directory is on a different disk |
9ec1ef25 WD |
1691 | partition), rsync will not be able to rename each received temporary file |
1692 | over the top of the associated destination file, but instead must copy it | |
1693 | into place. Rsync does this by copying the file over the top of the | |
1694 | destination file, which means that the destination file will contain | |
a9af5d8e WD |
1695 | truncated data during this copy. If this were not done this way (even if |
1696 | the destination file were first removed, the data locally copied to a | |
1697 | temporary file in the destination directory, and then renamed into place) | |
1698 | it would be possible for the old file to continue taking up disk space (if | |
1699 | someone had it open), and thus there might not be enough room to fit the | |
1700 | new version on the disk at the same time. | |
9ec1ef25 WD |
1701 | |
1702 | If you are using this option for reasons other than a shortage of disk | |
1703 | space, you may wish to combine it with the bf(--delay-updates) option, | |
a0d9819f WD |
1704 | which will ensure that all copied files get put into subdirectories in the |
1705 | destination hierarchy, awaiting the end of the transfer. If you don't | |
1706 | have enough room to duplicate all the arriving files on the destination | |
1707 | partition, another way to tell rsync that you aren't overly concerned | |
1708 | about disk space is to use the bf(--partial-dir) option with a relative | |
1709 | path; because this tells rsync that it is OK to stash off a copy of a | |
1710 | single file in a subdir in the destination hierarchy, rsync will use the | |
1711 | partial-dir as a staging area to bring over the copied file, and then | |
1712 | rename it into place from there. (Specifying a bf(--partial-dir) with | |
1713 | an absolute path does not have this side-effect.) | |
9ec1ef25 | 1714 | |
5b483755 WD |
1715 | dit(bf(-y, --fuzzy)) This option tells rsync that it should look for a |
1716 | basis file for any destination file that is missing. The current algorithm | |
1717 | looks in the same directory as the destination file for either a file that | |
1718 | has an identical size and modified-time, or a similarly-named file. If | |
1719 | found, rsync uses the fuzzy basis file to try to speed up the transfer. | |
1720 | ||
1721 | Note that the use of the bf(--delete) option might get rid of any potential | |
1722 | fuzzy-match files, so either use bf(--delete-after) or specify some | |
1723 | filename exclusions if you need to prevent this. | |
1724 | ||
b127c1dc | 1725 | dit(bf(--compare-dest=DIR)) This option instructs rsync to use em(DIR) on |
e49f61f5 WD |
1726 | the destination machine as an additional hierarchy to compare destination |
1727 | files against doing transfers (if the files are missing in the destination | |
1728 | directory). If a file is found in em(DIR) that is identical to the | |
1729 | sender's file, the file will NOT be transferred to the destination | |
1730 | directory. This is useful for creating a sparse backup of just files that | |
1731 | have changed from an earlier backup. | |
1732 | ||
faa82484 | 1733 | Beginning in version 2.6.4, multiple bf(--compare-dest) directories may be |
99eb41b2 WD |
1734 | provided, which will cause rsync to search the list in the order specified |
1735 | for an exact match. | |
2f03ce67 WD |
1736 | If a match is found that differs only in attributes, a local copy is made |
1737 | and the attributes updated. | |
99eb41b2 WD |
1738 | If a match is not found, a basis file from one of the em(DIR)s will be |
1739 | selected to try to speed up the transfer. | |
e49f61f5 WD |
1740 | |
1741 | If em(DIR) is a relative path, it is relative to the destination directory. | |
2f03ce67 | 1742 | See also bf(--copy-dest) and bf(--link-dest). |
b127c1dc | 1743 | |
2f03ce67 WD |
1744 | dit(bf(--copy-dest=DIR)) This option behaves like bf(--compare-dest), but |
1745 | rsync will also copy unchanged files found in em(DIR) to the destination | |
1746 | directory using a local copy. | |
1747 | This is useful for doing transfers to a new destination while leaving | |
1748 | existing files intact, and then doing a flash-cutover when all files have | |
1749 | been successfully transferred. | |
1750 | ||
1751 | Multiple bf(--copy-dest) directories may be provided, which will cause | |
1752 | rsync to search the list in the order specified for an unchanged file. | |
1753 | If a match is not found, a basis file from one of the em(DIR)s will be | |
1754 | selected to try to speed up the transfer. | |
1755 | ||
1756 | If em(DIR) is a relative path, it is relative to the destination directory. | |
1757 | See also bf(--compare-dest) and bf(--link-dest). | |
1758 | ||
1759 | dit(bf(--link-dest=DIR)) This option behaves like bf(--copy-dest), but | |
e49f61f5 WD |
1760 | unchanged files are hard linked from em(DIR) to the destination directory. |
1761 | The files must be identical in all preserved attributes (e.g. permissions, | |
1762 | possibly ownership) in order for the files to be linked together. | |
8429aa9e WD |
1763 | An example: |
1764 | ||
faa82484 | 1765 | quote(tt( rsync -av --link-dest=$PWD/prior_dir host:src_dir/ new_dir/)) |
59c95e42 | 1766 | |
45c37e73 WD |
1767 | If file's aren't linking, double-check their attributes. Also check if some |
1768 | attributes are getting forced outside of rsync's control, such a mount option | |
1769 | that squishes root to a single user, or mounts a removable drive with generic | |
1770 | ownership (such as OS X's "Ignore ownership on this volume" option). | |
1771 | ||
99eb41b2 WD |
1772 | Beginning in version 2.6.4, multiple bf(--link-dest) directories may be |
1773 | provided, which will cause rsync to search the list in the order specified | |
1774 | for an exact match. | |
2f03ce67 WD |
1775 | If a match is found that differs only in attributes, a local copy is made |
1776 | and the attributes updated. | |
99eb41b2 WD |
1777 | If a match is not found, a basis file from one of the em(DIR)s will be |
1778 | selected to try to speed up the transfer. | |
e49f61f5 | 1779 | |
33689f48 WD |
1780 | This option works best when copying into an empty destination hierarchy, as |
1781 | rsync treats existing files as definitive (so it never looks in the link-dest | |
1782 | dirs when a destination file already exists), and as malleable (so it might | |
1783 | change the attributes of a destination file, which affects all the hard-linked | |
1784 | versions). | |
1785 | ||
d04e95e9 WD |
1786 | Note that if you combine this option with bf(--ignore-times), rsync will not |
1787 | link any files together because it only links identical files together as a | |
1788 | substitute for transferring the file, never as an additional check after the | |
1789 | file is updated. | |
1790 | ||
e49f61f5 | 1791 | If em(DIR) is a relative path, it is relative to the destination directory. |
2f03ce67 | 1792 | See also bf(--compare-dest) and bf(--copy-dest). |
b127c1dc | 1793 | |
e0204f56 | 1794 | Note that rsync versions prior to 2.6.1 had a bug that could prevent |
d38772e0 WD |
1795 | bf(--link-dest) from working properly for a non-super-user when bf(-o) was |
1796 | specified (or implied by bf(-a)). You can work-around this bug by avoiding | |
1797 | the bf(-o) option when sending to an old rsync. | |
e0204f56 | 1798 | |
32a5edf4 WD |
1799 | dit(bf(-z, --compress)) With this option, rsync compresses the file data |
1800 | as it is sent to the destination machine, which reduces the amount of data | |
1801 | being transmitted -- something that is useful over a slow connection. | |
41059f75 | 1802 | |
02184920 | 1803 | Note that this option typically achieves better compression ratios than can |
32a5edf4 WD |
1804 | be achieved by using a compressing remote shell or a compressing transport |
1805 | because it takes advantage of the implicit information in the matching data | |
1806 | blocks that are not explicitly sent over the connection. | |
41059f75 | 1807 | |
2b967218 WD |
1808 | See the bf(--skip-compress) option for the default list of file suffixes |
1809 | that will not be compressed. | |
1810 | ||
bad01106 WD |
1811 | dit(bf(--compress-level=NUM)) Explicitly set the compression level to use |
1812 | (see bf(--compress)) instead of letting it default. If NUM is non-zero, | |
1813 | the bf(--compress) option is implied. | |
1814 | ||
2b967218 WD |
1815 | dit(bf(--skip-compress=LIST)) Override the list of file suffixes that will |
1816 | not be compressed. The bf(LIST) should be one or more file suffixes | |
1817 | (without the dot) separated by slashes (/). | |
1818 | ||
1819 | You may specify an empty string to indicate that no file should be skipped. | |
1820 | ||
1821 | Simple character-class matching is supported: each must consist of a list | |
1822 | of letters inside the square brackets (e.g. no special classes, such as | |
4b660bae | 1823 | "[:alpha:]", are supported, and '-' has no special meaning). |
2b967218 WD |
1824 | |
1825 | The characters asterisk (*) and question-mark (?) have no special meaning. | |
1826 | ||
1827 | Here's an example that specifies 6 suffixes to skip (since 1 of the 5 rules | |
1828 | matches 2 suffixes): | |
1829 | ||
1830 | verb( --skip-compress=gz/jpg/mp[34]/7z/bz2) | |
1831 | ||
4b660bae WD |
1832 | The default list of suffixes that will not be compressed is this (in this |
1833 | version of rsync): | |
1834 | ||
1835 | bf(7z) | |
1836 | bf(ace) | |
1837 | bf(avi) | |
1838 | bf(bz2) | |
1839 | bf(deb) | |
1840 | bf(gpg) | |
1841 | bf(gz) | |
1842 | bf(iso) | |
1843 | bf(jpeg) | |
1844 | bf(jpg) | |
aff48500 | 1845 | bf(lz) |
4b660bae WD |
1846 | bf(lzma) |
1847 | bf(lzo) | |
1848 | bf(mov) | |
1849 | bf(mp3) | |
1850 | bf(mp4) | |
1851 | bf(ogg) | |
aff48500 | 1852 | bf(png) |
4b660bae WD |
1853 | bf(rar) |
1854 | bf(rpm) | |
1855 | bf(rzip) | |
1856 | bf(tbz) | |
1857 | bf(tgz) | |
aff48500 WD |
1858 | bf(tlz) |
1859 | bf(txz) | |
1860 | bf(xz) | |
4b660bae WD |
1861 | bf(z) |
1862 | bf(zip) | |
2b967218 WD |
1863 | |
1864 | This list will be replaced by your bf(--skip-compress) list in all but one | |
1865 | situation: a copy from a daemon rsync will add your skipped suffixes to | |
1866 | its list of non-compressing files (and its list may be configured to a | |
1867 | different default). | |
1868 | ||
41059f75 | 1869 | dit(bf(--numeric-ids)) With this option rsync will transfer numeric group |
4d888108 | 1870 | and user IDs rather than using user and group names and mapping them |
41059f75 AT |
1871 | at both ends. |
1872 | ||
4d888108 | 1873 | By default rsync will use the username and groupname to determine |
41059f75 | 1874 | what ownership to give files. The special uid 0 and the special group |
faa82484 | 1875 | 0 are never mapped via user/group names even if the bf(--numeric-ids) |
41059f75 AT |
1876 | option is not specified. |
1877 | ||
ec40899b WD |
1878 | If a user or group has no name on the source system or it has no match |
1879 | on the destination system, then the numeric ID | |
1880 | from the source system is used instead. See also the comments on the | |
a2b0471f WD |
1881 | "use chroot" setting in the rsyncd.conf manpage for information on how |
1882 | the chroot setting affects rsync's ability to look up the names of the | |
1883 | users and groups and what you can do about it. | |
41059f75 | 1884 | |
2df20057 WD |
1885 | dit(bf(--usermap=STRING, --groupmap=STRING)) These options allow you to |
1886 | specify users and groups that should be mapped to other values by the | |
1887 | receiving side. The bf(STRING) is one or more bf(FROM):bf(TO) pairs of | |
1888 | values separated by commas. Any matching bf(FROM) value from the sender is | |
1889 | replaced with a bf(TO) value from the receiver. You may specify usernames | |
1890 | or user IDs for the bf(FROM) and bf(TO) values, and the bf(FROM) value may | |
1891 | also be a wild-card string, which will be matched against the sender's | |
1892 | names (wild-cards do NOT match against ID numbers, though see below for | |
1893 | why a '*' matches everything). You may instead specify a range of ID | |
1894 | numbers via an inclusive range: LOW-HIGH. For example: | |
1895 | ||
1896 | verb( --usermap=0-99:nobody,wayne:admin,*:normal --groupmap=usr:1,1:usr) | |
1897 | ||
1898 | The first match in the list is the one that is used. You should specify | |
1899 | all your user mappings using a single bf(--usermap) option, and/or all | |
1900 | your group mappings using a single bf(--groupmap) option. | |
1901 | ||
1902 | Note that the sender's name for the 0 user and group are not transmitted | |
1903 | to the receiver, so you should either match these values using a 0, or use | |
1904 | the names in effect on the receiving side (typically "root"). All other | |
1905 | bf(FROM) names match those in use on the sending side. All bf(TO) names | |
1906 | match those in use on the receiving side. | |
1907 | ||
1908 | Any IDs that do not have a name on the sending side are treated as having an | |
1909 | empty name for the purpose of matching. This allows them to be matched via | |
1910 | a "*" or using an empty name. For instance: | |
1911 | ||
1912 | verb( --usermap=:nobody --groupmap=*:nobody) | |
1913 | ||
1914 | When the bf(--numeric-ids) option is used, the sender does not send any | |
1915 | names, so all the IDs are treated as having an empty name. This means that | |
1916 | you will need to specify numeric bf(FROM) values if you want to map these | |
1917 | nameless IDs to different values. | |
1918 | ||
1919 | For the bf(--usermap) option to have any effect, the bf(-o) (bf(--owner)) | |
1920 | option must be used (or implied), and the receiver will need to be running | |
1921 | as a super-user (see also the bf(--fake-super) option). For the bf(--groupmap) | |
1922 | option to have any effect, the bf(-g) (bf(--groups)) option must be used | |
1923 | (or implied), and the receiver will need to have permissions to set that | |
1924 | group. | |
1925 | ||
1926 | dit(bf(--chown=USER:GROUP)) This option forces all files to be owned by USER | |
1927 | with group GROUP. This is a simpler interface than using bf(--usermap) and | |
1928 | bf(--groupmap) directly, but it is implemented using those options internally, | |
1929 | so you cannot mix them. If either the USER or GROUP is empty, no mapping for | |
1930 | the omitted user/group will occur. If GROUP is empty, the trailing colon may | |
1931 | be omitted, but if USER is empty, a leading colon must be supplied. | |
1932 | ||
1933 | If you specify "--chown=foo:bar, this is exactly the same as specifying | |
1934 | "--usermap=*:foo --groupmap=*:bar", only easier. | |
1935 | ||
b5accaba | 1936 | dit(bf(--timeout=TIMEOUT)) This option allows you to set a maximum I/O |
de2fd20e AT |
1937 | timeout in seconds. If no data is transferred for the specified time |
1938 | then rsync will exit. The default is 0, which means no timeout. | |
41059f75 | 1939 | |
ba22c9e2 WD |
1940 | dit(bf(--contimeout)) This option allows you to set the amount of time |
1941 | that rsync will wait for its connection to an rsync daemon to succeed. | |
1942 | If the timeout is reached, rsync exits with an error. | |
1943 | ||
3ae5367f WD |
1944 | dit(bf(--address)) By default rsync will bind to the wildcard address when |
1945 | connecting to an rsync daemon. The bf(--address) option allows you to | |
1946 | specify a specific IP address (or hostname) to bind to. See also this | |
1947 | option in the bf(--daemon) mode section. | |
1948 | ||
c259892c WD |
1949 | dit(bf(--port=PORT)) This specifies an alternate TCP port number to use |
1950 | rather than the default of 873. This is only needed if you are using the | |
1951 | double-colon (::) syntax to connect with an rsync daemon (since the URL | |
1952 | syntax has a way to specify the port as a part of the URL). See also this | |
faa82484 | 1953 | option in the bf(--daemon) mode section. |
c259892c | 1954 | |
04f48837 WD |
1955 | dit(bf(--sockopts)) This option can provide endless fun for people |
1956 | who like to tune their systems to the utmost degree. You can set all | |
1957 | sorts of socket options which may make transfers faster (or | |
49f4cfdf | 1958 | slower!). Read the man page for the code(setsockopt()) system call for |
04f48837 WD |
1959 | details on some of the options you may be able to set. By default no |
1960 | special socket options are set. This only affects direct socket | |
1961 | connections to a remote rsync daemon. This option also exists in the | |
1962 | bf(--daemon) mode section. | |
1963 | ||
b5accaba | 1964 | dit(bf(--blocking-io)) This tells rsync to use blocking I/O when launching |
314a74d7 WD |
1965 | a remote shell transport. If the remote shell is either rsh or remsh, |
1966 | rsync defaults to using | |
b5accaba WD |
1967 | blocking I/O, otherwise it defaults to using non-blocking I/O. (Note that |
1968 | ssh prefers non-blocking I/O.) | |
64c704f0 | 1969 | |
0cfdf226 | 1970 | dit(bf(-i, --itemize-changes)) Requests a simple itemized list of the |
4f90eb43 | 1971 | changes that are being made to each file, including attribute changes. |
4b90820d | 1972 | This is exactly the same as specifying bf(--out-format='%i %n%L'). |
14cbb645 WD |
1973 | If you repeat the option, unchanged files will also be output, but only |
1974 | if the receiving rsync is at least version 2.6.7 (you can use bf(-vv) | |
1975 | with older versions of rsync, but that also turns on the output of other | |
1976 | verbose messages). | |
ea67c715 | 1977 | |
1c3344a1 WD |
1978 | The "%i" escape has a cryptic output that is 11 letters long. The general |
1979 | format is like the string bf(YXcstpoguax), where bf(Y) is replaced by the | |
4f417448 | 1980 | type of update being done, bf(X) is replaced by the file-type, and the |
a314f7c1 | 1981 | other letters represent attributes that may be output if they are being |
ee171c6d | 1982 | modified. |
ea67c715 | 1983 | |
2d5279ac | 1984 | The update types that replace the bf(Y) are as follows: |
ea67c715 | 1985 | |
b8a6dae0 | 1986 | quote(itemization( |
cc3e0770 | 1987 | it() A bf(<) means that a file is being transferred to the remote host |
a314f7c1 | 1988 | (sent). |
cc3e0770 WD |
1989 | it() A bf(>) means that a file is being transferred to the local host |
1990 | (received). | |
c48cff9f | 1991 | it() A bf(c) means that a local change/creation is occurring for the item |
ee171c6d | 1992 | (such as the creation of a directory or the changing of a symlink, etc.). |
02184920 | 1993 | it() A bf(h) means that the item is a hard link to another item (requires |
b4875de4 | 1994 | bf(--hard-links)). |
ee171c6d WD |
1995 | it() A bf(.) means that the item is not being updated (though it might |
1996 | have attributes that are being modified). | |
59658acf WD |
1997 | it() A bf(*) means that the rest of the itemized-output area contains |
1998 | a message (e.g. "deleting"). | |
a314f7c1 | 1999 | )) |
ea67c715 | 2000 | |
a314f7c1 | 2001 | The file-types that replace the bf(X) are: bf(f) for a file, a bf(d) for a |
4e7d07c8 WD |
2002 | directory, an bf(L) for a symlink, a bf(D) for a device, and a bf(S) for a |
2003 | special file (e.g. named sockets and fifos). | |
ea67c715 | 2004 | |
a314f7c1 | 2005 | The other letters in the string above are the actual letters that |
ea67c715 WD |
2006 | will be output if the associated attribute for the item is being updated or |
2007 | a "." for no change. Three exceptions to this are: (1) a newly created | |
b9f0ca72 WD |
2008 | item replaces each letter with a "+", (2) an identical item replaces the |
2009 | dots with spaces, and (3) an unknown attribute replaces each letter with | |
81c453b1 | 2010 | a "?" (this can happen when talking to an older rsync). |
ea67c715 WD |
2011 | |
2012 | The attribute that is associated with each letter is as follows: | |
2013 | ||
b8a6dae0 | 2014 | quote(itemization( |
1ed9018e WD |
2015 | it() A bf(c) means either that a regular file has a different checksum |
2016 | (requires bf(--checksum)) or that a symlink, device, or special file has | |
2017 | a changed value. | |
600b56b3 | 2018 | Note that if you are sending files to an rsync prior to 3.0.1, this |
11faa893 WD |
2019 | change flag will be present only for checksum-differing regular files. |
2020 | it() A bf(s) means the size of a regular file is different and will be updated | |
ea67c715 WD |
2021 | by the file transfer. |
2022 | it() A bf(t) means the modification time is different and is being updated | |
5a727522 | 2023 | to the sender's value (requires bf(--times)). An alternate value of bf(T) |
42b06481 | 2024 | means that the modification time will be set to the transfer time, which happens |
1ed56a05 WD |
2025 | when a file/symlink/device is updated without bf(--times) and when a |
2026 | symlink is changed and the receiver can't set its time. | |
1ed9018e WD |
2027 | (Note: when using an rsync 3.0.0 client, you might see the bf(s) flag combined |
2028 | with bf(t) instead of the proper bf(T) flag for this time-setting failure.) | |
ea67c715 | 2029 | it() A bf(p) means the permissions are different and are being updated to |
5a727522 | 2030 | the sender's value (requires bf(--perms)). |
4dc67d5e | 2031 | it() An bf(o) means the owner is different and is being updated to the |
d38772e0 | 2032 | sender's value (requires bf(--owner) and super-user privileges). |
4dc67d5e | 2033 | it() A bf(g) means the group is different and is being updated to the |
5a727522 | 2034 | sender's value (requires bf(--group) and the authority to set the group). |
7869953b | 2035 | it() The bf(u) slot is reserved for future use. |
1c3344a1 | 2036 | it() The bf(a) means that the ACL information changed. |
7869953b | 2037 | it() The bf(x) means that the extended attribute information changed. |
ea67c715 WD |
2038 | )) |
2039 | ||
2040 | One other output is possible: when deleting files, the "%i" will output | |
ee171c6d | 2041 | the string "*deleting" for each item that is being removed (assuming that |
ea67c715 WD |
2042 | you are talking to a recent enough rsync that it logs deletions instead of |
2043 | outputting them as a verbose message). | |
dc0f2497 | 2044 | |
4b90820d | 2045 | dit(bf(--out-format=FORMAT)) This allows you to specify exactly what the |
951e826b WD |
2046 | rsync client outputs to the user on a per-update basis. The format is a |
2047 | text string containing embedded single-character escape sequences prefixed | |
2048 | with a percent (%) character. A default format of "%n%L" is assumed if | |
2049 | either bf(--info=name) or bf(-v) is specified (this tells you just the name | |
2050 | of the file and, if the item is a link, where it points). For a full list | |
2051 | of the possible escape characters, see the "log format" setting in the | |
2052 | rsyncd.conf manpage. | |
2053 | ||
2054 | Specifying the bf(--out-format) option implies the bf(--info=name) option, | |
2055 | which will mention each file, dir, etc. that gets updated in a significant | |
2056 | way (a transferred file, a recreated symlink/device, or a touched | |
2057 | directory). In addition, if the itemize-changes escape (%i) is included in | |
2058 | the string (e.g. if the bf(--itemize-changes) option was used), the logging | |
2059 | of names increases to mention any item that is changed in any way (as long | |
2060 | as the receiving side is at least 2.6.4). See the bf(--itemize-changes) | |
2061 | option for a description of the output of "%i". | |
ea67c715 | 2062 | |
4b90820d | 2063 | Rsync will output the out-format string prior to a file's transfer unless |
ea67c715 WD |
2064 | one of the transfer-statistic escapes is requested, in which case the |
2065 | logging is done at the end of the file's transfer. When this late logging | |
2066 | is in effect and bf(--progress) is also specified, rsync will also output | |
2067 | the name of the file being transferred prior to its progress information | |
4b90820d WD |
2068 | (followed, of course, by the out-format output). |
2069 | ||
2070 | dit(bf(--log-file=FILE)) This option causes rsync to log what it is doing | |
2071 | to a file. This is similar to the logging that a daemon does, but can be | |
2072 | requested for the client side and/or the server side of a non-daemon | |
2073 | transfer. If specified as a client option, transfer logging will be | |
2074 | enabled with a default format of "%i %n%L". See the bf(--log-file-format) | |
2075 | option if you wish to override this. | |
2076 | ||
2077 | Here's a example command that requests the remote side to log what is | |
2078 | happening: | |
2079 | ||
7a2eca41 | 2080 | verb( rsync -av --remote-option=--log-file=/tmp/rlog src/ dest/) |
4b90820d WD |
2081 | |
2082 | This is very useful if you need to debug why a connection is closing | |
2083 | unexpectedly. | |
2084 | ||
2085 | dit(bf(--log-file-format=FORMAT)) This allows you to specify exactly what | |
2086 | per-update logging is put into the file specified by the bf(--log-file) option | |
2087 | (which must also be specified for this option to have any effect). If you | |
2088 | specify an empty string, updated files will not be mentioned in the log file. | |
2089 | For a list of the possible escape characters, see the "log format" setting | |
2090 | in the rsyncd.conf manpage. | |
b6062654 | 2091 | |
e129500c WD |
2092 | The default FORMAT used if bf(--log-file) is specified and this option is not |
2093 | is '%i %n%L'. | |
2094 | ||
b72f24c7 | 2095 | dit(bf(--stats)) This tells rsync to print a verbose set of statistics |
adc4ebdd | 2096 | on the file transfer, allowing you to tell how effective rsync's delta-transfer |
951e826b WD |
2097 | algorithm is for your data. This option is equivalent to bf(--info=stats2) |
2098 | if combined with 0 or 1 bf(-v) options, or bf(--info=stats3) if combined | |
2099 | with 2 or more bf(-v) options. | |
b72f24c7 | 2100 | |
b8a6dae0 | 2101 | The current statistics are as follows: quote(itemization( |
7b13ff97 | 2102 | it() bf(Number of files) is the count of all "files" (in the generic |
b320b7d6 WD |
2103 | sense), which includes directories, symlinks, etc. The total count will |
2104 | be followed by a list of counts by filetype (if the total is non-zero). | |
2105 | For example: "(reg: 5, dir: 3, link: 2, dev: 1, special: 1)" lists the | |
2106 | totals for regular files, directories, symlinks, devices, and special | |
2107 | files. If any of value is 0, it is completely omitted from the list. | |
2108 | it() bf(Number of created files) is the count of how many "files" (generic | |
2109 | sense) were created (as opposed to updated). The total count will be | |
2110 | followed by a list of counts by filetype (if the total is non-zero). | |
2111 | it() bf(Number of deleted files) is the count of how many "files" (generic | |
2112 | sense) were created (as opposed to updated). The total count will be | |
2113 | followed by a list of counts by filetype (if the total is non-zero). | |
2114 | Note that this line is only output if deletions are in effect, and only | |
2115 | if protocol 31 is being used (the default for rsync 3.1.x). | |
2116 | it() bf(Number of regular files transferred) is the count of normal files | |
2117 | that were updated via rsync's delta-transfer algorithm, which does not | |
2118 | include dirs, symlinks, etc. Note that rsync 3.1.0 added the word | |
2119 | "regular" into this heading. | |
7b13ff97 WD |
2120 | it() bf(Total file size) is the total sum of all file sizes in the transfer. |
2121 | This does not count any size for directories or special files, but does | |
2122 | include the size of symlinks. | |
2123 | it() bf(Total transferred file size) is the total sum of all files sizes | |
2124 | for just the transferred files. | |
2125 | it() bf(Literal data) is how much unmatched file-update data we had to | |
2126 | send to the receiver for it to recreate the updated files. | |
2127 | it() bf(Matched data) is how much data the receiver got locally when | |
2128 | recreating the updated files. | |
2129 | it() bf(File list size) is how big the file-list data was when the sender | |
2130 | sent it to the receiver. This is smaller than the in-memory size for the | |
2131 | file list due to some compressing of duplicated data when rsync sends the | |
2132 | list. | |
2133 | it() bf(File list generation time) is the number of seconds that the | |
2134 | sender spent creating the file list. This requires a modern rsync on the | |
2135 | sending side for this to be present. | |
2136 | it() bf(File list transfer time) is the number of seconds that the sender | |
2137 | spent sending the file list to the receiver. | |
2138 | it() bf(Total bytes sent) is the count of all the bytes that rsync sent | |
2139 | from the client side to the server side. | |
2140 | it() bf(Total bytes received) is the count of all non-message bytes that | |
2141 | rsync received by the client side from the server side. "Non-message" | |
2142 | bytes means that we don't count the bytes for a verbose message that the | |
2143 | server sent to us, which makes the stats more consistent. | |
38a4b9c2 | 2144 | )) |
7b13ff97 | 2145 | |
a6a27602 | 2146 | dit(bf(-8, --8-bit-output)) This tells rsync to leave all high-bit characters |
d0022dd9 WD |
2147 | unescaped in the output instead of trying to test them to see if they're |
2148 | valid in the current locale and escaping the invalid ones. All control | |
2149 | characters (but never tabs) are always escaped, regardless of this option's | |
2150 | setting. | |
2151 | ||
2152 | The escape idiom that started in 2.6.7 is to output a literal backslash (\) | |
2153 | and a hash (#), followed by exactly 3 octal digits. For example, a newline | |
2154 | would output as "\#012". A literal backslash that is in a filename is not | |
2155 | escaped unless it is followed by a hash and 3 digits (0-9). | |
2156 | ||
955c3145 | 2157 | dit(bf(-h, --human-readable)) Output numbers in a more human-readable format. |
adc2476f WD |
2158 | There are 3 possible levels: (1) output numbers with a separator between each |
2159 | set of 3 digits (either a comma or a period, depending on if the decimal point | |
2160 | is represented by a period or a comma); (2) output numbers in units of 1000 | |
2161 | (with a character suffix for larger units -- see below); (3) output numbers in | |
2162 | units of 1024. | |
2163 | ||
2164 | The default is human-readable level 1. Each bf(-h) option increases the level | |
2165 | by one. You can take the level down to 0 (to output numbers as pure digits) by | |
2166 | specifing the bf(--no-human-readable) (bf(--no-h)) option. | |
2167 | ||
2168 | The unit letters that are appended in levels 2 and 3 are: K (kilo), M (mega), | |
2169 | G (giga), or T (tera). For example, a 1234567-byte file would output as 1.23M | |
2170 | in level-2 (assuming that a period is your local decimal point). | |
2171 | ||
2172 | Backward compatibility note: versions of rsync prior to 3.1.0 do not support | |
2173 | human-readable level 1, and they default to level 0. Thus, specifying one or | |
b320b7d6 WD |
2174 | two bf(-h) options will behave in a comparable manner in old and new versions |
2175 | as long as you didn't specify a bf(--no-h) option prior to one or more bf(-h) | |
2176 | options. See the bf(--list-only) option for one difference. | |
3b4ecc6b | 2177 | |
d9fcc198 AT |
2178 | dit(bf(--partial)) By default, rsync will delete any partially |
2179 | transferred file if the transfer is interrupted. In some circumstances | |
2180 | it is more desirable to keep partially transferred files. Using the | |
faa82484 | 2181 | bf(--partial) option tells rsync to keep the partial file which should |
d9fcc198 AT |
2182 | make a subsequent transfer of the rest of the file much faster. |
2183 | ||
c2582307 WD |
2184 | dit(bf(--partial-dir=DIR)) A better way to keep partial files than the |
2185 | bf(--partial) option is to specify a em(DIR) that will be used to hold the | |
2186 | partial data (instead of writing it out to the destination file). | |
2187 | On the next transfer, rsync will use a file found in this | |
9ec1ef25 | 2188 | dir as data to speed up the resumption of the transfer and then delete it |
c2582307 | 2189 | after it has served its purpose. |
9ec1ef25 | 2190 | |
c2582307 WD |
2191 | Note that if bf(--whole-file) is specified (or implied), any partial-dir |
2192 | file that is found for a file that is being updated will simply be removed | |
2193 | (since | |
adc4ebdd | 2194 | rsync is sending files without using rsync's delta-transfer algorithm). |
44cad59f | 2195 | |
c2582307 WD |
2196 | Rsync will create the em(DIR) if it is missing (just the last dir -- not |
2197 | the whole path). This makes it easy to use a relative path (such as | |
2198 | "bf(--partial-dir=.rsync-partial)") to have rsync create the | |
2199 | partial-directory in the destination file's directory when needed, and then | |
2200 | remove it again when the partial file is deleted. | |
44cad59f | 2201 | |
ee554411 WD |
2202 | If the partial-dir value is not an absolute path, rsync will add an exclude |
2203 | rule at the end of all your existing excludes. This will prevent the | |
2204 | sending of any partial-dir files that may exist on the sending side, and | |
2205 | will also prevent the untimely deletion of partial-dir items on the | |
2206 | receiving side. An example: the above bf(--partial-dir) option would add | |
f49c8376 | 2207 | the equivalent of "bf(-f '-p .rsync-partial/')" at the end of any other |
ee554411 WD |
2208 | filter rules. |
2209 | ||
2210 | If you are supplying your own exclude rules, you may need to add your own | |
2211 | exclude/hide/protect rule for the partial-dir because (1) the auto-added | |
2212 | rule may be ineffective at the end of your other rules, or (2) you may wish | |
2213 | to override rsync's exclude choice. For instance, if you want to make | |
2214 | rsync clean-up any left-over partial-dirs that may be lying around, you | |
2215 | should specify bf(--delete-after) and add a "risk" filter rule, e.g. | |
2216 | bf(-f 'R .rsync-partial/'). (Avoid using bf(--delete-before) or | |
2217 | bf(--delete-during) unless you don't need rsync to use any of the | |
2218 | left-over partial-dir data during the current run.) | |
44cad59f | 2219 | |
faa82484 | 2220 | IMPORTANT: the bf(--partial-dir) should not be writable by other users or it |
b4d1e854 WD |
2221 | is a security risk. E.g. AVOID "/tmp". |
2222 | ||
2223 | You can also set the partial-dir value the RSYNC_PARTIAL_DIR environment | |
faa82484 | 2224 | variable. Setting this in the environment does not force bf(--partial) to be |
02184920 | 2225 | enabled, but rather it affects where partial files go when bf(--partial) is |
faa82484 WD |
2226 | specified. For instance, instead of using bf(--partial-dir=.rsync-tmp) |
2227 | along with bf(--progress), you could set RSYNC_PARTIAL_DIR=.rsync-tmp in your | |
2228 | environment and then just use the bf(-P) option to turn on the use of the | |
9ec1ef25 WD |
2229 | .rsync-tmp dir for partial transfers. The only times that the bf(--partial) |
2230 | option does not look for this environment value are (1) when bf(--inplace) was | |
2231 | specified (since bf(--inplace) conflicts with bf(--partial-dir)), and (2) when | |
faa82484 | 2232 | bf(--delay-updates) was specified (see below). |
01b835c2 | 2233 | |
5a727522 | 2234 | For the purposes of the daemon-config's "refuse options" setting, |
c2582307 WD |
2235 | bf(--partial-dir) does em(not) imply bf(--partial). This is so that a |
2236 | refusal of the bf(--partial) option can be used to disallow the overwriting | |
2237 | of destination files with a partial transfer, while still allowing the | |
2238 | safer idiom provided by bf(--partial-dir). | |
2239 | ||
01b835c2 | 2240 | dit(bf(--delay-updates)) This option puts the temporary file from each |
c2582307 | 2241 | updated file into a holding directory until the end of the |
01b835c2 WD |
2242 | transfer, at which time all the files are renamed into place in rapid |
2243 | succession. This attempts to make the updating of the files a little more | |
c2582307 | 2244 | atomic. By default the files are placed into a directory named ".~tmp~" in |
64318670 | 2245 | each file's destination directory, but if you've specified the |
ee554411 WD |
2246 | bf(--partial-dir) option, that directory will be used instead. See the |
2247 | comments in the bf(--partial-dir) section for a discussion of how this | |
2248 | ".~tmp~" dir will be excluded from the transfer, and what you can do if | |
c5b6e57a | 2249 | you want rsync to cleanup old ".~tmp~" dirs that might be lying around. |
64318670 | 2250 | Conflicts with bf(--inplace) and bf(--append). |
01b835c2 WD |
2251 | |
2252 | This option uses more memory on the receiving side (one bit per file | |
2253 | transferred) and also requires enough free disk space on the receiving | |
2254 | side to hold an additional copy of all the updated files. Note also that | |
5efbddba WD |
2255 | you should not use an absolute path to bf(--partial-dir) unless (1) |
2256 | there is no | |
01b835c2 WD |
2257 | chance of any of the files in the transfer having the same name (since all |
2258 | the updated files will be put into a single directory if the path is | |
5efbddba WD |
2259 | absolute) |
2260 | and (2) there are no mount points in the hierarchy (since the | |
2261 | delayed updates will fail if they can't be renamed into place). | |
01b835c2 WD |
2262 | |
2263 | See also the "atomic-rsync" perl script in the "support" subdir for an | |
faa82484 | 2264 | update algorithm that is even more atomic (it uses bf(--link-dest) and a |
01b835c2 | 2265 | parallel hierarchy of files). |
44cad59f | 2266 | |
a272ff8c | 2267 | dit(bf(-m, --prune-empty-dirs)) This option tells the receiving rsync to get |
fb72aaba WD |
2268 | rid of empty directories from the file-list, including nested directories |
2269 | that have no non-directory children. This is useful for avoiding the | |
2270 | creation of a bunch of useless directories when the sending rsync is | |
2271 | recursively scanning a hierarchy of files using include/exclude/filter | |
a272ff8c WD |
2272 | rules. |
2273 | ||
fd2b6046 WD |
2274 | Note that the use of transfer rules, such as the bf(--min-size) option, does |
2275 | not affect what goes into the file list, and thus does not leave directories | |
2276 | empty, even if none of the files in a directory match the transfer rule. | |
2277 | ||
a272ff8c WD |
2278 | Because the file-list is actually being pruned, this option also affects |
2279 | what directories get deleted when a delete is active. However, keep in | |
2280 | mind that excluded files and directories can prevent existing items from | |
fd2b6046 WD |
2281 | being deleted due to an exclude both hiding source files and protecting |
2282 | destination files. See the perishable filter-rule option for how to avoid | |
2283 | this. | |
a272ff8c WD |
2284 | |
2285 | You can prevent the pruning of certain empty directories from the file-list | |
2286 | by using a global "protect" filter. For instance, this option would ensure | |
2287 | that the directory "emptydir" was kept in the file-list: | |
2288 | ||
2289 | quote( --filter 'protect emptydir/') | |
fb72aaba WD |
2290 | |
2291 | Here's an example that copies all .pdf files in a hierarchy, only creating | |
2292 | the necessary destination directories to hold the .pdf files, and ensures | |
2293 | that any superfluous files and directories in the destination are removed | |
a272ff8c WD |
2294 | (note the hide filter of non-directories being used instead of an exclude): |
2295 | ||
58718881 | 2296 | quote( rsync -avm --del --include='*.pdf' -f 'hide,! */' src/ dest) |
fb72aaba | 2297 | |
a272ff8c | 2298 | If you didn't want to remove superfluous destination files, the more |
4743f0f4 | 2299 | time-honored options of "bf(--include='*/' --exclude='*')" would work fine |
a272ff8c | 2300 | in place of the hide-filter (if that is more natural to you). |
fb72aaba | 2301 | |
eb86d661 AT |
2302 | dit(bf(--progress)) This option tells rsync to print information |
2303 | showing the progress of the transfer. This gives a bored user | |
2304 | something to watch. | |
951e826b WD |
2305 | With a modern rsync this is the same as specifying |
2306 | bf(--info=flist2,name,progress), but any user-supplied settings for those | |
2307 | info flags takes precedence (e.g. "--info=flist0 --progress"). | |
7b10f91d | 2308 | |
5e1f082d WD |
2309 | While rsync is transferring a regular file, it updates a progress line that |
2310 | looks like this: | |
68f9910d | 2311 | |
faa82484 | 2312 | verb( 782448 63% 110.64kB/s 0:00:04) |
68f9910d | 2313 | |
5e1f082d WD |
2314 | In this example, the receiver has reconstructed 782448 bytes or 63% of the |
2315 | sender's file, which is being reconstructed at a rate of 110.64 kilobytes | |
2316 | per second, and the transfer will finish in 4 seconds if the current rate | |
2317 | is maintained until the end. | |
2318 | ||
adc4ebdd | 2319 | These statistics can be misleading if rsync's delta-transfer algorithm is |
5e1f082d WD |
2320 | in use. For example, if the sender's file consists of the basis file |
2321 | followed by additional data, the reported rate will probably drop | |
2322 | dramatically when the receiver gets to the literal data, and the transfer | |
2323 | will probably take much longer to finish than the receiver estimated as it | |
2324 | was finishing the matched part of the file. | |
2325 | ||
2326 | When the file transfer finishes, rsync replaces the progress line with a | |
2327 | summary line that looks like this: | |
2328 | ||
8d10cbfc | 2329 | verb( 1,238,099 100% 146.38kB/s 0:00:08 (xfr#5, to-chk=169/396)) |
5e1f082d | 2330 | |
8d10cbfc | 2331 | In this example, the file was 1,238,099 bytes long in total, the average rate |
5e1f082d WD |
2332 | of transfer for the whole file was 146.38 kilobytes per second over the 8 |
2333 | seconds that it took to complete, it was the 5th transfer of a regular file | |
2334 | during the current rsync session, and there are 169 more files for the | |
2335 | receiver to check (to see if they are up-to-date or not) remaining out of | |
2336 | the 396 total files in the file-list. | |
68f9910d | 2337 | |
8d10cbfc WD |
2338 | In an incremental recursion scan, rsync won't know the total number of files |
2339 | in the file-list until it reaches the ends of the scan, but since it starts to | |
2340 | transfer files during the scan, it will display a line with the text "ir-chk" | |
2341 | (for incremental recursion check) instead of "to-chk" until the point that it | |
2342 | knows the full size of the list, at which point it will switch to using | |
2343 | "to-chk". Thus, seeing "ir-chk" lets you know that the total count of files | |
2344 | in the file list is still going to increase (and each time it does, the count | |
2345 | of files left to check will increase by the number of the files added to the | |
2346 | list). | |
2347 | ||
faa82484 | 2348 | dit(bf(-P)) The bf(-P) option is equivalent to bf(--partial) bf(--progress). Its |
183150b7 WD |
2349 | purpose is to make it much easier to specify these two options for a long |
2350 | transfer that may be interrupted. | |
d9fcc198 | 2351 | |
951e826b WD |
2352 | There is also a bf(--info=progress2) option that outputs statistics based |
2353 | on the whole transfer, rather than individual files. Use this flag without | |
2354 | outputting a filename (e.g. avoid bf(-v) or specify bf(--info=name0) if you | |
2355 | want to see how the transfer is doing without scrolling the screen with a | |
2356 | lot of names. (You don't need to specify the bf(--progress) option in | |
2357 | order to use bf(--info=progress2).) | |
2358 | ||
9586e593 WD |
2359 | dit(bf(--password-file)) This option allows you to provide a password in a |
2360 | file for accessing an rsync daemon. The file must not be world readable. | |
6437b817 WD |
2361 | It should contain just the password as the first line of the file (all |
2362 | other lines are ignored). | |
9586e593 | 2363 | |
b2057d38 WD |
2364 | This option does not supply a password to a remote shell transport such as |
2365 | ssh; to learn how to do that, consult the remote shell's documentation. | |
9586e593 WD |
2366 | When accessing an rsync daemon using a remote shell as the transport, this |
2367 | option only comes into effect after the remote shell finishes its | |
2368 | authentication (i.e. if you have also specified a password in the daemon's | |
2369 | config file). | |
65575e96 | 2370 | |
09ed3099 | 2371 | dit(bf(--list-only)) This option will cause the source files to be listed |
b4c7c1ca WD |
2372 | instead of transferred. This option is inferred if there is a single source |
2373 | arg and no destination specified, so its main uses are: (1) to turn a copy | |
2374 | command that includes a | |
32b9011a WD |
2375 | destination arg into a file-listing command, or (2) to be able to specify |
2376 | more than one source arg (note: be sure to include the destination). | |
2377 | Caution: keep in mind that a source arg with a wild-card is expanded by the | |
2378 | shell into multiple args, so it is never safe to try to list such an arg | |
b4c7c1ca WD |
2379 | without using this option. For example: |
2380 | ||
2381 | verb( rsync -av --list-only foo* dest/) | |
09ed3099 | 2382 | |
b320b7d6 WD |
2383 | Starting with rsync 3.1.0, the sizes output by bf(--list-only) are affected |
2384 | by the bf(--human-readable) option. By default they will contain digit | |
2385 | separators, but higher levels of readability will output the sizes with | |
2386 | unit suffixes. Note also that the column width for the size output has | |
2387 | increased from 11 to 14 characters for all human-readable levels. Use | |
2388 | bf(--no-h) if you want just digits in the sizes, and the old column width | |
2389 | of 11 characters. | |
2390 | ||
32b9011a WD |
2391 | Compatibility note: when requesting a remote listing of files from an rsync |
2392 | that is version 2.6.3 or older, you may encounter an error if you ask for a | |
2393 | non-recursive listing. This is because a file listing implies the bf(--dirs) | |
2394 | option w/o bf(--recursive), and older rsyncs don't have that option. To | |
2395 | avoid this problem, either specify the bf(--no-dirs) option (if you don't | |
2396 | need to expand a directory's content), or turn on recursion and exclude | |
2397 | the content of subdirectories: bf(-r --exclude='/*/*'). | |
2398 | ||
ce795fcd WD |
2399 | dit(bf(--bwlimit=RATE)) This option allows you to specify the maximum transfer |
2400 | rate for the data sent over the socket, specified in units per second. The | |
2401 | RATE value can be suffixed with a string to indicate a size multiplier, and may | |
2402 | be a fractional value (e.g. "bf(--bwlimit=1.5m)"). If no suffix is specified, | |
2403 | the value will be assumed to be in units of 1024 bytes (as if "K" or "KiB" had | |
2404 | been appended). See the bf(--max-size) option for a description of all the | |
2405 | available suffixes. A value of zero specifies no limit. | |
2406 | ||
2407 | For backward-compatibility reasons, the rate limit will be rounded to the | |
2408 | nearest KiB unit, so no rate smaller than 1024 bytes per second is possible. | |
2409 | ||
2410 | Rsync writes data over the socket in blocks, and this option both limits the | |
2411 | size of the blocks that rsync writes, and tries to keep the average transfer | |
2412 | rate at the requested limit. Some "burstiness" may be seen where rsync writes | |
2413 | out a block of data and then sleeps to bring the average rate into compliance. | |
2414 | ||
2415 | Due to the internal buffering of data, the bf(--progress) option may not be an | |
2416 | accurate reflection on how fast the data is being sent. This is because some | |
2417 | files can show up as being rapidly sent when the data is quickly buffered, | |
2418 | while other can show up as very slow when the flushing of the output buffer | |
2419 | occurs. This may be fixed in a future version. | |
ef5d23eb | 2420 | |
b9f592fb | 2421 | dit(bf(--write-batch=FILE)) Record a file that can later be applied to |
faa82484 | 2422 | another identical destination with bf(--read-batch). See the "BATCH MODE" |
32c7f91a | 2423 | section for details, and also the bf(--only-write-batch) option. |
6902ed17 | 2424 | |
326bb56e WD |
2425 | dit(bf(--only-write-batch=FILE)) Works like bf(--write-batch), except that |
2426 | no updates are made on the destination system when creating the batch. | |
2427 | This lets you transport the changes to the destination system via some | |
32c7f91a WD |
2428 | other means and then apply the changes via bf(--read-batch). |
2429 | ||
2430 | Note that you can feel free to write the batch directly to some portable | |
2431 | media: if this media fills to capacity before the end of the transfer, you | |
2432 | can just apply that partial transfer to the destination and repeat the | |
2433 | whole process to get the rest of the changes (as long as you don't mind a | |
2434 | partially updated destination system while the multi-update cycle is | |
2435 | happening). | |
2436 | ||
2437 | Also note that you only save bandwidth when pushing changes to a remote | |
2438 | system because this allows the batched data to be diverted from the sender | |
2439 | into the batch file without having to flow over the wire to the receiver | |
2440 | (when pulling, the sender is remote, and thus can't write the batch). | |
326bb56e | 2441 | |
b9f592fb | 2442 | dit(bf(--read-batch=FILE)) Apply all of the changes stored in FILE, a |
faa82484 | 2443 | file previously generated by bf(--write-batch). |
78be8e0f | 2444 | If em(FILE) is bf(-), the batch data will be read from standard input. |
c769702f | 2445 | See the "BATCH MODE" section for details. |
6902ed17 | 2446 | |
0b941479 WD |
2447 | dit(bf(--protocol=NUM)) Force an older protocol version to be used. This |
2448 | is useful for creating a batch file that is compatible with an older | |
2449 | version of rsync. For instance, if rsync 2.6.4 is being used with the | |
2450 | bf(--write-batch) option, but rsync 2.6.3 is what will be used to run the | |
81c453b1 WD |
2451 | bf(--read-batch) option, you should use "--protocol=28" when creating the |
2452 | batch file to force the older protocol version to be used in the batch | |
2453 | file (assuming you can't upgrade the rsync on the reading system). | |
0b941479 | 2454 | |
332cf6df WD |
2455 | dit(bf(--iconv=CONVERT_SPEC)) Rsync can convert filenames between character |
2456 | sets using this option. Using a CONVERT_SPEC of "." tells rsync to look up | |
2457 | the default character-set via the locale setting. Alternately, you can | |
2458 | fully specify what conversion to do by giving a local and a remote charset | |
0b52f94d WD |
2459 | separated by a comma in the order bf(--iconv=LOCAL,REMOTE), e.g. |
2460 | bf(--iconv=utf8,iso88591). This order ensures that the option | |
2461 | will stay the same whether you're pushing or pulling files. | |
2462 | Finally, you can specify either bf(--no-iconv) or a CONVERT_SPEC of "-" | |
2463 | to turn off any conversion. | |
332cf6df WD |
2464 | The default setting of this option is site-specific, and can also be |
2465 | affected via the RSYNC_ICONV environment variable. | |
2466 | ||
0b52f94d WD |
2467 | For a list of what charset names your local iconv library supports, you can |
2468 | run "iconv --list". | |
2469 | ||
82f37486 WD |
2470 | If you specify the bf(--protect-args) option (bf(-s)), rsync will translate |
2471 | the filenames you specify on the command-line that are being sent to the | |
2472 | remote host. See also the bf(--files-from) option. | |
2473 | ||
332cf6df | 2474 | Note that rsync does not do any conversion of names in filter files |
82f37486 WD |
2475 | (including include/exclude files). It is up to you to ensure that you're |
2476 | specifying matching rules that can match on both sides of the transfer. | |
2477 | For instance, you can specify extra include/exclude rules if there are | |
2478 | filename differences on the two sides that need to be accounted for. | |
332cf6df | 2479 | |
0b52f94d WD |
2480 | When you pass an bf(--iconv) option to an rsync daemon that allows it, the |
2481 | daemon uses the charset specified in its "charset" configuration parameter | |
2482 | regardless of the remote charset you actually pass. Thus, you may feel free to | |
2483 | specify just the local charset for a daemon transfer (e.g. bf(--iconv=utf8)). | |
2484 | ||
e40a46de WD |
2485 | dit(bf(-4, --ipv4) or bf(-6, --ipv6)) Tells rsync to prefer IPv4/IPv6 |
2486 | when creating sockets. This only affects sockets that rsync has direct | |
2487 | control over, such as the outgoing socket when directly contacting an | |
faa82484 | 2488 | rsync daemon. See also these options in the bf(--daemon) mode section. |
e40a46de | 2489 | |
24d677fc WD |
2490 | If rsync was complied without support for IPv6, the bf(--ipv6) option |
2491 | will have no effect. The bf(--version) output will tell you if this | |
2492 | is the case. | |
2493 | ||
e129500c | 2494 | dit(bf(--checksum-seed=NUM)) Set the checksum seed to the integer |
c8d895de | 2495 | NUM. This 4 byte checksum seed is included in each block and file |
e129500c | 2496 | checksum calculation. By default the checksum seed is generated |
49f4cfdf | 2497 | by the server and defaults to the current code(time()). This option |
c8d895de WD |
2498 | is used to set a specific checksum seed, which is useful for |
2499 | applications that want repeatable block and file checksums, or | |
2500 | in the case where the user wants a more random checksum seed. | |
886df221 | 2501 | Setting NUM to 0 causes rsync to use the default of code(time()) |
b9f592fb | 2502 | for checksum seed. |
41059f75 AT |
2503 | enddit() |
2504 | ||
faa82484 WD |
2505 | manpagesection(DAEMON OPTIONS) |
2506 | ||
bdf278f7 WD |
2507 | The options allowed when starting an rsync daemon are as follows: |
2508 | ||
2509 | startdit() | |
bdf278f7 | 2510 | dit(bf(--daemon)) This tells rsync that it is to run as a daemon. The |
62f27e3c WD |
2511 | daemon you start running may be accessed using an rsync client using |
2512 | the bf(host::module) or bf(rsync://host/module/) syntax. | |
bdf278f7 WD |
2513 | |
2514 | If standard input is a socket then rsync will assume that it is being | |
2515 | run via inetd, otherwise it will detach from the current terminal and | |
2516 | become a background daemon. The daemon will read the config file | |
2517 | (rsyncd.conf) on each connect made by a client and respond to | |
49f4cfdf | 2518 | requests accordingly. See the bf(rsyncd.conf)(5) man page for more |
bdf278f7 WD |
2519 | details. |
2520 | ||
3ae5367f WD |
2521 | dit(bf(--address)) By default rsync will bind to the wildcard address when |
2522 | run as a daemon with the bf(--daemon) option. The bf(--address) option | |
2523 | allows you to specify a specific IP address (or hostname) to bind to. This | |
2524 | makes virtual hosting possible in conjunction with the bf(--config) option. | |
2525 | See also the "address" global option in the rsyncd.conf manpage. | |
bdf278f7 | 2526 | |
ce795fcd WD |
2527 | dit(bf(--bwlimit=RATE)) This option allows you to specify the maximum transfer |
2528 | rate for the data the daemon sends over the socket. The client can still | |
2529 | specify a smaller bf(--bwlimit) value, but no larger value will be allowed. | |
2530 | See the client version of this option (above) for some extra details. | |
1f69bec4 | 2531 | |
bdf278f7 | 2532 | dit(bf(--config=FILE)) This specifies an alternate config file than |
faa82484 | 2533 | the default. This is only relevant when bf(--daemon) is specified. |
bdf278f7 | 2534 | The default is /etc/rsyncd.conf unless the daemon is running over |
d38772e0 | 2535 | a remote shell program and the remote user is not the super-user; in that case |
bdf278f7 WD |
2536 | the default is rsyncd.conf in the current directory (typically $HOME). |
2537 | ||
2206abf8 WD |
2538 | dit(bf(-M, --dparam=OVERRIDE)) This option can be used to set a daemon-config |
2539 | parameter when starting up rsync in daemon mode. It is equivalent to adding | |
2540 | the parameter at the end of the global settings prior to the first module's | |
2541 | definition. The parameter names can be specified without spaces, if you so | |
2542 | desire. For instance: | |
2543 | ||
2544 | verb( rsync --daemon -M pidfile=/path/rsync.pid ) | |
2545 | ||
bdf278f7 WD |
2546 | dit(bf(--no-detach)) When running as a daemon, this option instructs |
2547 | rsync to not detach itself and become a background process. This | |
2548 | option is required when running as a service on Cygwin, and may also | |
2549 | be useful when rsync is supervised by a program such as | |
2550 | bf(daemontools) or AIX's bf(System Resource Controller). | |
2551 | bf(--no-detach) is also recommended when rsync is run under a | |
2552 | debugger. This option has no effect if rsync is run from inetd or | |
2553 | sshd. | |
2554 | ||
c259892c WD |
2555 | dit(bf(--port=PORT)) This specifies an alternate TCP port number for the |
2556 | daemon to listen on rather than the default of 873. See also the "port" | |
2557 | global option in the rsyncd.conf manpage. | |
bdf278f7 | 2558 | |
a2ed5801 WD |
2559 | dit(bf(--log-file=FILE)) This option tells the rsync daemon to use the |
2560 | given log-file name instead of using the "log file" setting in the config | |
2561 | file. | |
2562 | ||
4b90820d WD |
2563 | dit(bf(--log-file-format=FORMAT)) This option tells the rsync daemon to use the |
2564 | given FORMAT string instead of using the "log format" setting in the config | |
2565 | file. It also enables "transfer logging" unless the string is empty, in which | |
2566 | case transfer logging is turned off. | |
2567 | ||
04f48837 WD |
2568 | dit(bf(--sockopts)) This overrides the bf(socket options) setting in the |
2569 | rsyncd.conf file and has the same syntax. | |
2570 | ||
24b0922b WD |
2571 | dit(bf(-v, --verbose)) This option increases the amount of information the |
2572 | daemon logs during its startup phase. After the client connects, the | |
2573 | daemon's verbosity level will be controlled by the options that the client | |
2574 | used and the "max verbosity" setting in the module's config section. | |
2575 | ||
bdf278f7 WD |
2576 | dit(bf(-4, --ipv4) or bf(-6, --ipv6)) Tells rsync to prefer IPv4/IPv6 |
2577 | when creating the incoming sockets that the rsync daemon will use to | |
2578 | listen for connections. One of these options may be required in older | |
2579 | versions of Linux to work around an IPv6 bug in the kernel (if you see | |
2580 | an "address already in use" error when nothing else is using the port, | |
faa82484 | 2581 | try specifying bf(--ipv6) or bf(--ipv4) when starting the daemon). |
bdf278f7 | 2582 | |
24d677fc WD |
2583 | If rsync was complied without support for IPv6, the bf(--ipv6) option |
2584 | will have no effect. The bf(--version) output will tell you if this | |
2585 | is the case. | |
2586 | ||
faa82484 | 2587 | dit(bf(-h, --help)) When specified after bf(--daemon), print a short help |
bdf278f7 | 2588 | page describing the options available for starting an rsync daemon. |
bdf278f7 WD |
2589 | enddit() |
2590 | ||
16e5de84 | 2591 | manpagesection(FILTER RULES) |
43bd68e5 | 2592 | |
16e5de84 WD |
2593 | The filter rules allow for flexible selection of which files to transfer |
2594 | (include) and which files to skip (exclude). The rules either directly | |
2595 | specify include/exclude patterns or they specify a way to acquire more | |
2596 | include/exclude patterns (e.g. to read them from a file). | |
43bd68e5 | 2597 | |
16e5de84 WD |
2598 | As the list of files/directories to transfer is built, rsync checks each |
2599 | name to be transferred against the list of include/exclude patterns in | |
2600 | turn, and the first matching pattern is acted on: if it is an exclude | |
2601 | pattern, then that file is skipped; if it is an include pattern then that | |
2602 | filename is not skipped; if no matching pattern is found, then the | |
43bd68e5 AT |
2603 | filename is not skipped. |
2604 | ||
16e5de84 WD |
2605 | Rsync builds an ordered list of filter rules as specified on the |
2606 | command-line. Filter rules have the following syntax: | |
2607 | ||
faa82484 | 2608 | quote( |
d91de046 WD |
2609 | tt(RULE [PATTERN_OR_FILENAME])nl() |
2610 | tt(RULE,MODIFIERS [PATTERN_OR_FILENAME])nl() | |
16e5de84 WD |
2611 | ) |
2612 | ||
d91de046 WD |
2613 | You have your choice of using either short or long RULE names, as described |
2614 | below. If you use a short-named rule, the ',' separating the RULE from the | |
2615 | MODIFIERS is optional. The PATTERN or FILENAME that follows (when present) | |
2616 | must come after either a single space or an underscore (_). | |
2617 | Here are the available rule prefixes: | |
16e5de84 | 2618 | |
faa82484 | 2619 | quote( |
d91de046 WD |
2620 | bf(exclude, -) specifies an exclude pattern. nl() |
2621 | bf(include, +) specifies an include pattern. nl() | |
2622 | bf(merge, .) specifies a merge-file to read for more rules. nl() | |
2623 | bf(dir-merge, :) specifies a per-directory merge-file. nl() | |
0dfffb88 WD |
2624 | bf(hide, H) specifies a pattern for hiding files from the transfer. nl() |
2625 | bf(show, S) files that match the pattern are not hidden. nl() | |
2626 | bf(protect, P) specifies a pattern for protecting files from deletion. nl() | |
2627 | bf(risk, R) files that match the pattern are not protected. nl() | |
d91de046 | 2628 | bf(clear, !) clears the current include/exclude list (takes no arg) nl() |
16e5de84 WD |
2629 | ) |
2630 | ||
d91de046 WD |
2631 | When rules are being read from a file, empty lines are ignored, as are |
2632 | comment lines that start with a "#". | |
2633 | ||
faa82484 | 2634 | Note that the bf(--include)/bf(--exclude) command-line options do not allow the |
16e5de84 | 2635 | full range of rule parsing as described above -- they only allow the |
d91de046 WD |
2636 | specification of include/exclude patterns plus a "!" token to clear the |
2637 | list (and the normal comment parsing when rules are read from a file). | |
2638 | If a pattern | |
16e5de84 WD |
2639 | does not begin with "- " (dash, space) or "+ " (plus, space), then the |
2640 | rule will be interpreted as if "+ " (for an include option) or "- " (for | |
faa82484 | 2641 | an exclude option) were prefixed to the string. A bf(--filter) option, on |
d91de046 WD |
2642 | the other hand, must always contain either a short or long rule name at the |
2643 | start of the rule. | |
16e5de84 | 2644 | |
faa82484 | 2645 | Note also that the bf(--filter), bf(--include), and bf(--exclude) options take one |
16e5de84 | 2646 | rule/pattern each. To add multiple ones, you can repeat the options on |
faa82484 WD |
2647 | the command-line, use the merge-file syntax of the bf(--filter) option, or |
2648 | the bf(--include-from)/bf(--exclude-from) options. | |
16e5de84 | 2649 | |
16e5de84 WD |
2650 | manpagesection(INCLUDE/EXCLUDE PATTERN RULES) |
2651 | ||
0dfffb88 WD |
2652 | You can include and exclude files by specifying patterns using the "+", |
2653 | "-", etc. filter rules (as introduced in the FILTER RULES section above). | |
bb5f4e72 WD |
2654 | The include/exclude rules each specify a pattern that is matched against |
2655 | the names of the files that are going to be transferred. These patterns | |
2656 | can take several forms: | |
16e5de84 | 2657 | |
b8a6dae0 | 2658 | itemization( |
16e5de84 WD |
2659 | it() if the pattern starts with a / then it is anchored to a |
2660 | particular spot in the hierarchy of files, otherwise it is matched | |
2661 | against the end of the pathname. This is similar to a leading ^ in | |
2662 | regular expressions. | |
809724d7 | 2663 | Thus "/foo" would match a name of "foo" at either the "root of the |
16e5de84 WD |
2664 | transfer" (for a global rule) or in the merge-file's directory (for a |
2665 | per-directory rule). | |
809724d7 WD |
2666 | An unqualified "foo" would match a name of "foo" anywhere in the |
2667 | tree because the algorithm is applied recursively from the | |
16e5de84 | 2668 | top down; it behaves as if each path component gets a turn at being the |
809724d7 | 2669 | end of the filename. Even the unanchored "sub/foo" would match at |
16e5de84 WD |
2670 | any point in the hierarchy where a "foo" was found within a directory |
2671 | named "sub". See the section on ANCHORING INCLUDE/EXCLUDE PATTERNS for | |
2672 | a full discussion of how to specify a pattern that matches at the root | |
2673 | of the transfer. | |
16e5de84 | 2674 | it() if the pattern ends with a / then it will only match a |
809724d7 | 2675 | directory, not a regular file, symlink, or device. |
9639c718 WD |
2676 | it() rsync chooses between doing a simple string match and wildcard |
2677 | matching by checking if the pattern contains one of these three wildcard | |
2678 | characters: '*', '?', and '[' . | |
7fdb3bda | 2679 | it() a '*' matches any path component, but it stops at slashes. |
9639c718 WD |
2680 | it() use '**' to match anything, including slashes. |
2681 | it() a '?' matches any character except a slash (/). | |
2682 | it() a '[' introduces a character class, such as [a-z] or [[:alpha:]]. | |
2683 | it() in a wildcard pattern, a backslash can be used to escape a wildcard | |
2684 | character, but it is matched literally when no wildcards are present. | |
2685 | it() if the pattern contains a / (not counting a trailing /) or a "**", | |
16e5de84 WD |
2686 | then it is matched against the full pathname, including any leading |
2687 | directories. If the pattern doesn't contain a / or a "**", then it is | |
2688 | matched only against the final component of the filename. | |
2689 | (Remember that the algorithm is applied recursively so "full filename" | |
ae283632 | 2690 | can actually be any portion of a path from the starting directory on |
16e5de84 | 2691 | down.) |
d3db3eef | 2692 | it() a trailing "dir_name/***" will match both the directory (as if |
809724d7 | 2693 | "dir_name/" had been specified) and everything in the directory |
c575f8ce WD |
2694 | (as if "dir_name/**" had been specified). This behavior was added in |
2695 | version 2.6.7. | |
16e5de84 WD |
2696 | ) |
2697 | ||
faa82484 WD |
2698 | Note that, when using the bf(--recursive) (bf(-r)) option (which is implied by |
2699 | bf(-a)), every subcomponent of every path is visited from the top down, so | |
16e5de84 WD |
2700 | include/exclude patterns get applied recursively to each subcomponent's |
2701 | full name (e.g. to include "/foo/bar/baz" the subcomponents "/foo" and | |
2702 | "/foo/bar" must not be excluded). | |
2703 | The exclude patterns actually short-circuit the directory traversal stage | |
2704 | when rsync finds the files to send. If a pattern excludes a particular | |
2705 | parent directory, it can render a deeper include pattern ineffectual | |
2706 | because rsync did not descend through that excluded section of the | |
2707 | hierarchy. This is particularly important when using a trailing '*' rule. | |
2708 | For instance, this won't work: | |
2709 | ||
faa82484 WD |
2710 | quote( |
2711 | tt(+ /some/path/this-file-will-not-be-found)nl() | |
2712 | tt(+ /file-is-included)nl() | |
2713 | tt(- *)nl() | |
16e5de84 WD |
2714 | ) |
2715 | ||
2716 | This fails because the parent directory "some" is excluded by the '*' | |
2717 | rule, so rsync never visits any of the files in the "some" or "some/path" | |
2718 | directories. One solution is to ask for all directories in the hierarchy | |
a5a26484 | 2719 | to be included by using a single rule: "+ */" (put it somewhere before the |
58718881 WD |
2720 | "- *" rule), and perhaps use the bf(--prune-empty-dirs) option. Another |
2721 | solution is to add specific include rules for all | |
16e5de84 WD |
2722 | the parent dirs that need to be visited. For instance, this set of rules |
2723 | works fine: | |
2724 | ||
faa82484 WD |
2725 | quote( |
2726 | tt(+ /some/)nl() | |
2727 | tt(+ /some/path/)nl() | |
2728 | tt(+ /some/path/this-file-is-found)nl() | |
2729 | tt(+ /file-also-included)nl() | |
2730 | tt(- *)nl() | |
16e5de84 WD |
2731 | ) |
2732 | ||
2733 | Here are some examples of exclude/include matching: | |
2734 | ||
b8a6dae0 | 2735 | itemization( |
809724d7 | 2736 | it() "- *.o" would exclude all names matching *.o |
58718881 WD |
2737 | it() "- /foo" would exclude a file (or directory) named foo in the |
2738 | transfer-root directory | |
2739 | it() "- foo/" would exclude any directory named foo | |
2740 | it() "- /foo/*/bar" would exclude any file named bar which is at two | |
2741 | levels below a directory named foo in the transfer-root directory | |
2742 | it() "- /foo/**/bar" would exclude any file named bar two | |
2743 | or more levels below a directory named foo in the transfer-root directory | |
faa82484 | 2744 | it() The combination of "+ */", "+ *.c", and "- *" would include all |
58718881 WD |
2745 | directories and C source files but nothing else (see also the |
2746 | bf(--prune-empty-dirs) option) | |
16e5de84 WD |
2747 | it() The combination of "+ foo/", "+ foo/bar.c", and "- *" would include |
2748 | only the foo directory and foo/bar.c (the foo directory must be | |
2749 | explicitly included or it would be excluded by the "*") | |
2750 | ) | |
2751 | ||
d960af72 MM |
2752 | The following modifiers are accepted after a "+" or "-": |
2753 | ||
2754 | itemization( | |
2755 | it() A bf(/) specifies that the include/exclude rule should be matched | |
2756 | against the absolute pathname of the current item. For example, | |
2757 | "-/ /etc/passwd" would exclude the passwd file any time the transfer | |
2758 | was sending files from the "/etc" directory, and "-/ subdir/foo" | |
2759 | would always exclude "foo" when it is in a dir named "subdir", even | |
2760 | if "foo" is at the root of the current transfer. | |
2761 | it() A bf(!) specifies that the include/exclude should take effect if | |
2762 | the pattern fails to match. For instance, "-! */" would exclude all | |
2763 | non-directories. | |
2764 | it() A bf(C) is used to indicate that all the global CVS-exclude rules | |
2765 | should be inserted as excludes in place of the "-C". No arg should | |
2766 | follow. | |
2767 | it() An bf(s) is used to indicate that the rule applies to the sending | |
2768 | side. When a rule affects the sending side, it prevents files from | |
2769 | being transferred. The default is for a rule to affect both sides | |
2770 | unless bf(--delete-excluded) was specified, in which case default rules | |
2771 | become sender-side only. See also the hide (H) and show (S) rules, | |
2772 | which are an alternate way to specify sending-side includes/excludes. | |
2773 | it() An bf(r) is used to indicate that the rule applies to the receiving | |
2774 | side. When a rule affects the receiving side, it prevents files from | |
2775 | being deleted. See the bf(s) modifier for more info. See also the | |
2776 | protect (P) and risk (R) rules, which are an alternate way to | |
2777 | specify receiver-side includes/excludes. | |
2778 | it() A bf(p) indicates that a rule is perishable, meaning that it is | |
2779 | ignored in directories that are being deleted. For instance, the bf(-C) | |
2780 | option's default rules that exclude things like "CVS" and "*.o" are | |
2781 | marked as perishable, and will not prevent a directory that was removed | |
2782 | on the source from being deleted on the destination. | |
2783 | ) | |
2784 | ||
16e5de84 WD |
2785 | manpagesection(MERGE-FILE FILTER RULES) |
2786 | ||
2787 | You can merge whole files into your filter rules by specifying either a | |
d91de046 WD |
2788 | merge (.) or a dir-merge (:) filter rule (as introduced in the FILTER RULES |
2789 | section above). | |
16e5de84 WD |
2790 | |
2791 | There are two kinds of merged files -- single-instance ('.') and | |
2792 | per-directory (':'). A single-instance merge file is read one time, and | |
2793 | its rules are incorporated into the filter list in the place of the "." | |
2794 | rule. For per-directory merge files, rsync will scan every directory that | |
2795 | it traverses for the named file, merging its contents when the file exists | |
2796 | into the current list of inherited rules. These per-directory rule files | |
2797 | must be created on the sending side because it is the sending side that is | |
2798 | being scanned for the available files to transfer. These rule files may | |
2799 | also need to be transferred to the receiving side if you want them to | |
2800 | affect what files don't get deleted (see PER-DIRECTORY RULES AND DELETE | |
2801 | below). | |
2802 | ||
2803 | Some examples: | |
2804 | ||
faa82484 | 2805 | quote( |
d91de046 | 2806 | tt(merge /etc/rsync/default.rules)nl() |
faa82484 | 2807 | tt(. /etc/rsync/default.rules)nl() |
d91de046 WD |
2808 | tt(dir-merge .per-dir-filter)nl() |
2809 | tt(dir-merge,n- .non-inherited-per-dir-excludes)nl() | |
faa82484 | 2810 | tt(:n- .non-inherited-per-dir-excludes)nl() |
16e5de84 WD |
2811 | ) |
2812 | ||
d91de046 | 2813 | The following modifiers are accepted after a merge or dir-merge rule: |
16e5de84 | 2814 | |
b8a6dae0 | 2815 | itemization( |
62bf783f | 2816 | it() A bf(-) specifies that the file should consist of only exclude |
d91de046 | 2817 | patterns, with no other rule-parsing except for in-file comments. |
62bf783f | 2818 | it() A bf(+) specifies that the file should consist of only include |
d91de046 WD |
2819 | patterns, with no other rule-parsing except for in-file comments. |
2820 | it() A bf(C) is a way to specify that the file should be read in a | |
2821 | CVS-compatible manner. This turns on 'n', 'w', and '-', but also | |
2822 | allows the list-clearing token (!) to be specified. If no filename is | |
2823 | provided, ".cvsignore" is assumed. | |
2824 | it() A bf(e) will exclude the merge-file name from the transfer; e.g. | |
a5a26484 | 2825 | "dir-merge,e .rules" is like "dir-merge .rules" and "- .rules". |
62bf783f WD |
2826 | it() An bf(n) specifies that the rules are not inherited by subdirectories. |
2827 | it() A bf(w) specifies that the rules are word-split on whitespace instead | |
16e5de84 WD |
2828 | of the normal line-splitting. This also turns off comments. Note: the |
2829 | space that separates the prefix from the rule is treated specially, so | |
d91de046 WD |
2830 | "- foo + bar" is parsed as two rules (assuming that prefix-parsing wasn't |
2831 | also disabled). | |
2832 | it() You may also specify any of the modifiers for the "+" or "-" rules | |
d960af72 | 2833 | (above) in order to have the rules that are read in from the file |
c8fa85b2 MM |
2834 | default to having that modifier set (except for the bf(!) modifier, which |
2835 | would not be useful). For instance, "merge,-/ .excl" would | |
0dfffb88 WD |
2836 | treat the contents of .excl as absolute-path excludes, |
2837 | while "dir-merge,s .filt" and ":sC" would each make all their | |
c8fa85b2 MM |
2838 | per-directory rules apply only on the sending side. If the merge rule |
2839 | specifies sides to affect (via the bf(s) or bf(r) modifier or both), | |
2840 | then the rules in the file must not specify sides (via a modifier or | |
2841 | a rule prefix such as bf(hide)). | |
16e5de84 WD |
2842 | ) |
2843 | ||
2844 | Per-directory rules are inherited in all subdirectories of the directory | |
2845 | where the merge-file was found unless the 'n' modifier was used. Each | |
2846 | subdirectory's rules are prefixed to the inherited per-directory rules | |
2847 | from its parents, which gives the newest rules a higher priority than the | |
d91de046 | 2848 | inherited rules. The entire set of dir-merge rules are grouped together in |
16e5de84 | 2849 | the spot where the merge-file was specified, so it is possible to override |
d91de046 | 2850 | dir-merge rules via a rule that got specified earlier in the list of global |
16e5de84 WD |
2851 | rules. When the list-clearing rule ("!") is read from a per-directory |
2852 | file, it only clears the inherited rules for the current merge file. | |
2853 | ||
d91de046 | 2854 | Another way to prevent a single rule from a dir-merge file from being inherited is to |
16e5de84 WD |
2855 | anchor it with a leading slash. Anchored rules in a per-directory |
2856 | merge-file are relative to the merge-file's directory, so a pattern "/foo" | |
d91de046 | 2857 | would only match the file "foo" in the directory where the dir-merge filter |
16e5de84 WD |
2858 | file was found. |
2859 | ||
faa82484 | 2860 | Here's an example filter file which you'd specify via bf(--filter=". file":) |
16e5de84 | 2861 | |
faa82484 | 2862 | quote( |
d91de046 | 2863 | tt(merge /home/user/.global-filter)nl() |
faa82484 | 2864 | tt(- *.gz)nl() |
d91de046 | 2865 | tt(dir-merge .rules)nl() |
faa82484 WD |
2866 | tt(+ *.[ch])nl() |
2867 | tt(- *.o)nl() | |
16e5de84 WD |
2868 | ) |
2869 | ||
2870 | This will merge the contents of the /home/user/.global-filter file at the | |
2871 | start of the list and also turns the ".rules" filename into a per-directory | |
467688dc | 2872 | filter file. All rules read in prior to the start of the directory scan |
16e5de84 WD |
2873 | follow the global anchoring rules (i.e. a leading slash matches at the root |
2874 | of the transfer). | |
2875 | ||
2876 | If a per-directory merge-file is specified with a path that is a parent | |
2877 | directory of the first transfer directory, rsync will scan all the parent | |
2878 | dirs from that starting point to the transfer directory for the indicated | |
faa82484 | 2879 | per-directory file. For instance, here is a common filter (see bf(-F)): |
16e5de84 | 2880 | |
faa82484 | 2881 | quote(tt(--filter=': /.rsync-filter')) |
16e5de84 WD |
2882 | |
2883 | That rule tells rsync to scan for the file .rsync-filter in all | |
2884 | directories from the root down through the parent directory of the | |
2885 | transfer prior to the start of the normal directory scan of the file in | |
2886 | the directories that are sent as a part of the transfer. (Note: for an | |
2887 | rsync daemon, the root is always the same as the module's "path".) | |
2888 | ||
2889 | Some examples of this pre-scanning for per-directory files: | |
2890 | ||
faa82484 WD |
2891 | quote( |
2892 | tt(rsync -avF /src/path/ /dest/dir)nl() | |
2893 | tt(rsync -av --filter=': ../../.rsync-filter' /src/path/ /dest/dir)nl() | |
2894 | tt(rsync -av --filter=': .rsync-filter' /src/path/ /dest/dir)nl() | |
16e5de84 WD |
2895 | ) |
2896 | ||
2897 | The first two commands above will look for ".rsync-filter" in "/" and | |
2898 | "/src" before the normal scan begins looking for the file in "/src/path" | |
2899 | and its subdirectories. The last command avoids the parent-dir scan | |
2900 | and only looks for the ".rsync-filter" files in each directory that is | |
2901 | a part of the transfer. | |
2902 | ||
2903 | If you want to include the contents of a ".cvsignore" in your patterns, | |
d91de046 WD |
2904 | you should use the rule ":C", which creates a dir-merge of the .cvsignore |
2905 | file, but parsed in a CVS-compatible manner. You can | |
faa82484 | 2906 | use this to affect where the bf(--cvs-exclude) (bf(-C)) option's inclusion of the |
d91de046 | 2907 | per-directory .cvsignore file gets placed into your rules by putting the |
16e5de84 | 2908 | ":C" wherever you like in your filter rules. Without this, rsync would |
d91de046 | 2909 | add the dir-merge rule for the .cvsignore file at the end of all your other |
16e5de84 WD |
2910 | rules (giving it a lower priority than your command-line rules). For |
2911 | example: | |
2912 | ||
faa82484 WD |
2913 | quote( |
2914 | tt(cat <<EOT | rsync -avC --filter='. -' a/ b)nl() | |
2915 | tt(+ foo.o)nl() | |
2916 | tt(:C)nl() | |
2917 | tt(- *.old)nl() | |
2918 | tt(EOT)nl() | |
2919 | tt(rsync -avC --include=foo.o -f :C --exclude='*.old' a/ b)nl() | |
16e5de84 WD |
2920 | ) |
2921 | ||
2922 | Both of the above rsync commands are identical. Each one will merge all | |
2923 | the per-directory .cvsignore rules in the middle of the list rather than | |
2924 | at the end. This allows their dir-specific rules to supersede the rules | |
bafa4875 WD |
2925 | that follow the :C instead of being subservient to all your rules. To |
2926 | affect the other CVS exclude rules (i.e. the default list of exclusions, | |
2927 | the contents of $HOME/.cvsignore, and the value of $CVSIGNORE) you should | |
2928 | omit the bf(-C) command-line option and instead insert a "-C" rule into | |
4743f0f4 | 2929 | your filter rules; e.g. "bf(--filter=-C)". |
16e5de84 WD |
2930 | |
2931 | manpagesection(LIST-CLEARING FILTER RULE) | |
2932 | ||
2933 | You can clear the current include/exclude list by using the "!" filter | |
2934 | rule (as introduced in the FILTER RULES section above). The "current" | |
2935 | list is either the global list of rules (if the rule is encountered while | |
2936 | parsing the filter options) or a set of per-directory rules (which are | |
2937 | inherited in their own sub-list, so a subdirectory can use this to clear | |
2938 | out the parent's rules). | |
2939 | ||
2940 | manpagesection(ANCHORING INCLUDE/EXCLUDE PATTERNS) | |
2941 | ||
2942 | As mentioned earlier, global include/exclude patterns are anchored at the | |
2943 | "root of the transfer" (as opposed to per-directory patterns, which are | |
2944 | anchored at the merge-file's directory). If you think of the transfer as | |
2945 | a subtree of names that are being sent from sender to receiver, the | |
2946 | transfer-root is where the tree starts to be duplicated in the destination | |
2947 | directory. This root governs where patterns that start with a / match. | |
a4b6f305 WD |
2948 | |
2949 | Because the matching is relative to the transfer-root, changing the | |
faa82484 | 2950 | trailing slash on a source path or changing your use of the bf(--relative) |
a4b6f305 WD |
2951 | option affects the path you need to use in your matching (in addition to |
2952 | changing how much of the file tree is duplicated on the destination | |
16e5de84 | 2953 | host). The following examples demonstrate this. |
a4b6f305 | 2954 | |
b5ebe6d9 WD |
2955 | Let's say that we want to match two source files, one with an absolute |
2956 | path of "/home/me/foo/bar", and one with a path of "/home/you/bar/baz". | |
2957 | Here is how the various command choices differ for a 2-source transfer: | |
a4b6f305 | 2958 | |
faa82484 WD |
2959 | quote( |
2960 | Example cmd: rsync -a /home/me /home/you /dest nl() | |
2961 | +/- pattern: /me/foo/bar nl() | |
2962 | +/- pattern: /you/bar/baz nl() | |
2963 | Target file: /dest/me/foo/bar nl() | |
2964 | Target file: /dest/you/bar/baz nl() | |
2965 | ) | |
2966 | ||
2967 | quote( | |
2968 | Example cmd: rsync -a /home/me/ /home/you/ /dest nl() | |
2969 | +/- pattern: /foo/bar (note missing "me") nl() | |
2970 | +/- pattern: /bar/baz (note missing "you") nl() | |
2971 | Target file: /dest/foo/bar nl() | |
2972 | Target file: /dest/bar/baz nl() | |
2973 | ) | |
2974 | ||
2975 | quote( | |
2976 | Example cmd: rsync -a --relative /home/me/ /home/you /dest nl() | |
2977 | +/- pattern: /home/me/foo/bar (note full path) nl() | |
2978 | +/- pattern: /home/you/bar/baz (ditto) nl() | |
2979 | Target file: /dest/home/me/foo/bar nl() | |
2980 | Target file: /dest/home/you/bar/baz nl() | |
2981 | ) | |
2982 | ||
2983 | quote( | |
2984 | Example cmd: cd /home; rsync -a --relative me/foo you/ /dest nl() | |
2985 | +/- pattern: /me/foo/bar (starts at specified path) nl() | |
2986 | +/- pattern: /you/bar/baz (ditto) nl() | |
2987 | Target file: /dest/me/foo/bar nl() | |
2988 | Target file: /dest/you/bar/baz nl() | |
a4b6f305 WD |
2989 | ) |
2990 | ||
16e5de84 | 2991 | The easiest way to see what name you should filter is to just |
faa82484 WD |
2992 | look at the output when using bf(--verbose) and put a / in front of the name |
2993 | (use the bf(--dry-run) option if you're not yet ready to copy any files). | |
d1cce1dd | 2994 | |
16e5de84 | 2995 | manpagesection(PER-DIRECTORY RULES AND DELETE) |
43bd68e5 | 2996 | |
16e5de84 WD |
2997 | Without a delete option, per-directory rules are only relevant on the |
2998 | sending side, so you can feel free to exclude the merge files themselves | |
2999 | without affecting the transfer. To make this easy, the 'e' modifier adds | |
3000 | this exclude for you, as seen in these two equivalent commands: | |
27b9a19b | 3001 | |
faa82484 WD |
3002 | quote( |
3003 | tt(rsync -av --filter=': .excl' --exclude=.excl host:src/dir /dest)nl() | |
3004 | tt(rsync -av --filter=':e .excl' host:src/dir /dest)nl() | |
43bd68e5 AT |
3005 | ) |
3006 | ||
16e5de84 WD |
3007 | However, if you want to do a delete on the receiving side AND you want some |
3008 | files to be excluded from being deleted, you'll need to be sure that the | |
3009 | receiving side knows what files to exclude. The easiest way is to include | |
faa82484 | 3010 | the per-directory merge files in the transfer and use bf(--delete-after), |
16e5de84 WD |
3011 | because this ensures that the receiving side gets all the same exclude |
3012 | rules as the sending side before it tries to delete anything: | |
43bd68e5 | 3013 | |
faa82484 | 3014 | quote(tt(rsync -avF --delete-after host:src/dir /dest)) |
20af605e | 3015 | |
16e5de84 WD |
3016 | However, if the merge files are not a part of the transfer, you'll need to |
3017 | either specify some global exclude rules (i.e. specified on the command | |
3018 | line), or you'll need to maintain your own per-directory merge files on | |
3019 | the receiving side. An example of the first is this (assume that the | |
3020 | remote .rules files exclude themselves): | |
20af605e | 3021 | |
faa82484 WD |
3022 | verb(rsync -av --filter=': .rules' --filter='. /my/extra.rules' |
3023 | --delete host:src/dir /dest) | |
20af605e | 3024 | |
16e5de84 WD |
3025 | In the above example the extra.rules file can affect both sides of the |
3026 | transfer, but (on the sending side) the rules are subservient to the rules | |
3027 | merged from the .rules files because they were specified after the | |
3028 | per-directory merge rule. | |
43bd68e5 | 3029 | |
16e5de84 WD |
3030 | In one final example, the remote side is excluding the .rsync-filter |
3031 | files from the transfer, but we want to use our own .rsync-filter files | |
3032 | to control what gets deleted on the receiving side. To do this we must | |
3033 | specifically exclude the per-directory merge files (so that they don't get | |
3034 | deleted) and then put rules into the local files to control what else | |
3035 | should not get deleted. Like one of these commands: | |
3036 | ||
faa82484 WD |
3037 | verb( rsync -av --filter=':e /.rsync-filter' --delete \ |
3038 | host:src/dir /dest | |
3039 | rsync -avFF --delete host:src/dir /dest) | |
43bd68e5 | 3040 | |
6902ed17 MP |
3041 | manpagesection(BATCH MODE) |
3042 | ||
088aac85 DD |
3043 | Batch mode can be used to apply the same set of updates to many |
3044 | identical systems. Suppose one has a tree which is replicated on a | |
3045 | number of hosts. Now suppose some changes have been made to this | |
3046 | source tree and those changes need to be propagated to the other | |
3047 | hosts. In order to do this using batch mode, rsync is run with the | |
3048 | write-batch option to apply the changes made to the source tree to one | |
3049 | of the destination trees. The write-batch option causes the rsync | |
b9f592fb WD |
3050 | client to store in a "batch file" all the information needed to repeat |
3051 | this operation against other, identical destination trees. | |
3052 | ||
b9f592fb WD |
3053 | Generating the batch file once saves having to perform the file |
3054 | status, checksum, and data block generation more than once when | |
088aac85 | 3055 | updating multiple destination trees. Multicast transport protocols can |
b9f592fb WD |
3056 | be used to transfer the batch update files in parallel to many hosts |
3057 | at once, instead of sending the same data to every host individually. | |
088aac85 | 3058 | |
7f2591ea WD |
3059 | To apply the recorded changes to another destination tree, run rsync |
3060 | with the read-batch option, specifying the name of the same batch | |
3061 | file, and the destination tree. Rsync updates the destination tree | |
3062 | using the information stored in the batch file. | |
3063 | ||
3064 | For your convenience, a script file is also created when the write-batch | |
3065 | option is used: it will be named the same as the batch file with ".sh" | |
3066 | appended. This script file contains a command-line suitable for updating a | |
3067 | destination tree using the associated batch file. It can be executed using | |
3068 | a Bourne (or Bourne-like) shell, optionally passing in an alternate | |
3069 | destination tree pathname which is then used instead of the original | |
3070 | destination path. This is useful when the destination tree path on the | |
3071 | current host differs from the one used to create the batch file. | |
3072 | ||
4602eafa | 3073 | Examples: |
088aac85 | 3074 | |
faa82484 WD |
3075 | quote( |
3076 | tt($ rsync --write-batch=foo -a host:/source/dir/ /adest/dir/)nl() | |
3077 | tt($ scp foo* remote:)nl() | |
3078 | tt($ ssh remote ./foo.sh /bdest/dir/)nl() | |
4602eafa WD |
3079 | ) |
3080 | ||
faa82484 WD |
3081 | quote( |
3082 | tt($ rsync --write-batch=foo -a /source/dir/ /adest/dir/)nl() | |
3083 | tt($ ssh remote rsync --read-batch=- -a /bdest/dir/ <foo)nl() | |
4602eafa WD |
3084 | ) |
3085 | ||
98f51bfb WD |
3086 | In these examples, rsync is used to update /adest/dir/ from /source/dir/ |
3087 | and the information to repeat this operation is stored in "foo" and | |
3088 | "foo.sh". The host "remote" is then updated with the batched data going | |
3089 | into the directory /bdest/dir. The differences between the two examples | |
3090 | reveals some of the flexibility you have in how you deal with batches: | |
3091 | ||
b8a6dae0 | 3092 | itemization( |
98f51bfb WD |
3093 | it() The first example shows that the initial copy doesn't have to be |
3094 | local -- you can push or pull data to/from a remote host using either the | |
3095 | remote-shell syntax or rsync daemon syntax, as desired. | |
98f51bfb WD |
3096 | it() The first example uses the created "foo.sh" file to get the right |
3097 | rsync options when running the read-batch command on the remote host. | |
98f51bfb WD |
3098 | it() The second example reads the batch data via standard input so that |
3099 | the batch file doesn't need to be copied to the remote machine first. | |
3100 | This example avoids the foo.sh script because it needed to use a modified | |
faa82484 | 3101 | bf(--read-batch) option, but you could edit the script file if you wished to |
98f51bfb | 3102 | make use of it (just be sure that no other option is trying to use |
faa82484 | 3103 | standard input, such as the "bf(--exclude-from=-)" option). |
98f51bfb | 3104 | ) |
088aac85 DD |
3105 | |
3106 | Caveats: | |
3107 | ||
98f51bfb | 3108 | The read-batch option expects the destination tree that it is updating |
088aac85 DD |
3109 | to be identical to the destination tree that was used to create the |
3110 | batch update fileset. When a difference between the destination trees | |
0b941479 | 3111 | is encountered the update might be discarded with a warning (if the file |
7432ccf4 WD |
3112 | appears to be up-to-date already) or the file-update may be attempted |
3113 | and then, if the file fails to verify, the update discarded with an | |
3114 | error. This means that it should be safe to re-run a read-batch operation | |
59d73bf3 | 3115 | if the command got interrupted. If you wish to force the batched-update to |
faa82484 | 3116 | always be attempted regardless of the file's size and date, use the bf(-I) |
59d73bf3 WD |
3117 | option (when reading the batch). |
3118 | If an error occurs, the destination tree will probably be in a | |
7432ccf4 | 3119 | partially updated state. In that case, rsync can |
088aac85 DD |
3120 | be used in its regular (non-batch) mode of operation to fix up the |
3121 | destination tree. | |
3122 | ||
b9f592fb | 3123 | The rsync version used on all destinations must be at least as new as the |
59d73bf3 WD |
3124 | one used to generate the batch file. Rsync will die with an error if the |
3125 | protocol version in the batch file is too new for the batch-reading rsync | |
0b941479 WD |
3126 | to handle. See also the bf(--protocol) option for a way to have the |
3127 | creating rsync generate a batch file that an older rsync can understand. | |
3128 | (Note that batch files changed format in version 2.6.3, so mixing versions | |
3129 | older than that with newer versions will not work.) | |
088aac85 | 3130 | |
7432ccf4 WD |
3131 | When reading a batch file, rsync will force the value of certain options |
3132 | to match the data in the batch file if you didn't set them to the same | |
3133 | as the batch-writing command. Other options can (and should) be changed. | |
bb5f4e72 WD |
3134 | For instance bf(--write-batch) changes to bf(--read-batch), |
3135 | bf(--files-from) is dropped, and the | |
3136 | bf(--filter)/bf(--include)/bf(--exclude) options are not needed unless | |
3137 | one of the bf(--delete) options is specified. | |
b9f592fb | 3138 | |
faa82484 | 3139 | The code that creates the BATCH.sh file transforms any filter/include/exclude |
98f51bfb WD |
3140 | options into a single list that is appended as a "here" document to the |
3141 | shell script file. An advanced user can use this to modify the exclude | |
faa82484 | 3142 | list if a change in what gets deleted by bf(--delete) is desired. A normal |
98f51bfb | 3143 | user can ignore this detail and just use the shell script as an easy way |
faa82484 | 3144 | to run the appropriate bf(--read-batch) command for the batched data. |
98f51bfb | 3145 | |
59d73bf3 WD |
3146 | The original batch mode in rsync was based on "rsync+", but the latest |
3147 | version uses a new implementation. | |
6902ed17 | 3148 | |
eb06fa95 MP |
3149 | manpagesection(SYMBOLIC LINKS) |
3150 | ||
f28bd833 | 3151 | Three basic behaviors are possible when rsync encounters a symbolic |
eb06fa95 MP |
3152 | link in the source directory. |
3153 | ||
3154 | By default, symbolic links are not transferred at all. A message | |
3155 | "skipping non-regular" file is emitted for any symlinks that exist. | |
3156 | ||
3157 | If bf(--links) is specified, then symlinks are recreated with the same | |
3158 | target on the destination. Note that bf(--archive) implies | |
3159 | bf(--links). | |
3160 | ||
3161 | If bf(--copy-links) is specified, then symlinks are "collapsed" by | |
3162 | copying their referent, rather than the symlink. | |
3163 | ||
6f098b0f WD |
3164 | Rsync can also distinguish "safe" and "unsafe" symbolic links. An |
3165 | example where this might be used is a web site mirror that wishes to | |
3166 | ensure that the rsync module that is copied does not include symbolic links to | |
eb06fa95 MP |
3167 | bf(/etc/passwd) in the public section of the site. Using |
3168 | bf(--copy-unsafe-links) will cause any links to be copied as the file | |
3169 | they point to on the destination. Using bf(--safe-links) will cause | |
6efe9416 WD |
3170 | unsafe links to be omitted altogether. (Note that you must specify |
3171 | bf(--links) for bf(--safe-links) to have any effect.) | |
eb06fa95 | 3172 | |
7bd0cf5b | 3173 | Symbolic links are considered unsafe if they are absolute symlinks |
4743f0f4 | 3174 | (start with bf(/)), empty, or if they contain enough ".." |
7bd0cf5b MP |
3175 | components to ascend from the directory being copied. |
3176 | ||
6efe9416 WD |
3177 | Here's a summary of how the symlink options are interpreted. The list is |
3178 | in order of precedence, so if your combination of options isn't mentioned, | |
3179 | use the first line that is a complete subset of your options: | |
3180 | ||
3181 | dit(bf(--copy-links)) Turn all symlinks into normal files (leaving no | |
3182 | symlinks for any other options to affect). | |
3183 | ||
3184 | dit(bf(--links --copy-unsafe-links)) Turn all unsafe symlinks into files | |
3185 | and duplicate all safe symlinks. | |
3186 | ||
3187 | dit(bf(--copy-unsafe-links)) Turn all unsafe symlinks into files, noisily | |
3188 | skip all safe symlinks. | |
3189 | ||
02184920 | 3190 | dit(bf(--links --safe-links)) Duplicate safe symlinks and skip unsafe |
6efe9416 WD |
3191 | ones. |
3192 | ||
3193 | dit(bf(--links)) Duplicate all symlinks. | |
3194 | ||
faa82484 | 3195 | manpagediagnostics() |
d310a212 | 3196 | |
14d43f1f | 3197 | rsync occasionally produces error messages that may seem a little |
d310a212 | 3198 | cryptic. The one that seems to cause the most confusion is "protocol |
faa82484 | 3199 | version mismatch -- is your shell clean?". |
d310a212 AT |
3200 | |
3201 | This message is usually caused by your startup scripts or remote shell | |
3202 | facility producing unwanted garbage on the stream that rsync is using | |
14d43f1f | 3203 | for its transport. The way to diagnose this problem is to run your |
d310a212 AT |
3204 | remote shell like this: |
3205 | ||
faa82484 WD |
3206 | quote(tt(ssh remotehost /bin/true > out.dat)) |
3207 | ||
d310a212 | 3208 | then look at out.dat. If everything is working correctly then out.dat |
2cfeab21 | 3209 | should be a zero length file. If you are getting the above error from |
d310a212 AT |
3210 | rsync then you will probably find that out.dat contains some text or |
3211 | data. Look at the contents and try to work out what is producing | |
14d43f1f | 3212 | it. The most common cause is incorrectly configured shell startup |
d310a212 AT |
3213 | scripts (such as .cshrc or .profile) that contain output statements |
3214 | for non-interactive logins. | |
3215 | ||
16e5de84 | 3216 | If you are having trouble debugging filter patterns, then |
faa82484 | 3217 | try specifying the bf(-vv) option. At this level of verbosity rsync will |
e6c64e79 MP |
3218 | show why each individual file is included or excluded. |
3219 | ||
55b64e4b MP |
3220 | manpagesection(EXIT VALUES) |
3221 | ||
3222 | startdit() | |
a73de5f3 | 3223 | dit(bf(0)) Success |
faa82484 WD |
3224 | dit(bf(1)) Syntax or usage error |
3225 | dit(bf(2)) Protocol incompatibility | |
a73de5f3 WD |
3226 | dit(bf(3)) Errors selecting input/output files, dirs |
3227 | dit(bf(4)) Requested action not supported: an attempt | |
8212336a | 3228 | was made to manipulate 64-bit files on a platform that cannot support |
f28bd833 | 3229 | them; or an option was specified that is supported by the client and |
8212336a | 3230 | not by the server. |
a73de5f3 | 3231 | dit(bf(5)) Error starting client-server protocol |
124f349e | 3232 | dit(bf(6)) Daemon unable to append to log-file |
faa82484 WD |
3233 | dit(bf(10)) Error in socket I/O |
3234 | dit(bf(11)) Error in file I/O | |
3235 | dit(bf(12)) Error in rsync protocol data stream | |
3236 | dit(bf(13)) Errors with program diagnostics | |
3237 | dit(bf(14)) Error in IPC code | |
3238 | dit(bf(20)) Received SIGUSR1 or SIGINT | |
49f4cfdf | 3239 | dit(bf(21)) Some error returned by code(waitpid()) |
faa82484 | 3240 | dit(bf(22)) Error allocating core memory buffers |
3c1e2ad9 WD |
3241 | dit(bf(23)) Partial transfer due to error |
3242 | dit(bf(24)) Partial transfer due to vanished source files | |
124f349e | 3243 | dit(bf(25)) The --max-delete limit stopped deletions |
faa82484 | 3244 | dit(bf(30)) Timeout in data send/receive |
ba22c9e2 | 3245 | dit(bf(35)) Timeout waiting for daemon connection |
55b64e4b MP |
3246 | enddit() |
3247 | ||
de2fd20e AT |
3248 | manpagesection(ENVIRONMENT VARIABLES) |
3249 | ||
3250 | startdit() | |
de2fd20e | 3251 | dit(bf(CVSIGNORE)) The CVSIGNORE environment variable supplements any |
faa82484 | 3252 | ignore patterns in .cvsignore files. See the bf(--cvs-exclude) option for |
de2fd20e | 3253 | more details. |
332cf6df | 3254 | dit(bf(RSYNC_ICONV)) Specify a default bf(--iconv) setting using this |
2b2a4738 WD |
3255 | environment variable. (First supported in 3.0.0.) |
3256 | dit(bf(RSYNC_PROTECT_ARGS)) Specify a non-zero numeric value if you want the | |
3257 | bf(--protect-args) option to be enabled by default, or a zero value to make | |
3258 | sure that it is disabled by default. (First supported in 3.1.0.) | |
de2fd20e | 3259 | dit(bf(RSYNC_RSH)) The RSYNC_RSH environment variable allows you to |
ea7f8108 | 3260 | override the default shell used as the transport for rsync. Command line |
faa82484 | 3261 | options are permitted after the command name, just as in the bf(-e) option. |
4c3b4b25 AT |
3262 | dit(bf(RSYNC_PROXY)) The RSYNC_PROXY environment variable allows you to |
3263 | redirect your rsync client to use a web proxy when connecting to a | |
3264 | rsync daemon. You should set RSYNC_PROXY to a hostname:port pair. | |
de2fd20e | 3265 | dit(bf(RSYNC_PASSWORD)) Setting RSYNC_PASSWORD to the required |
bb18e755 | 3266 | password allows you to run authenticated rsync connections to an rsync |
de2fd20e | 3267 | daemon without user intervention. Note that this does not supply a |
b2057d38 WD |
3268 | password to a remote shell transport such as ssh; to learn how to do that, |
3269 | consult the remote shell's documentation. | |
de2fd20e | 3270 | dit(bf(USER) or bf(LOGNAME)) The USER or LOGNAME environment variables |
5a727522 | 3271 | are used to determine the default username sent to an rsync daemon. |
4b2f6a7c | 3272 | If neither is set, the username defaults to "nobody". |
14d43f1f | 3273 | dit(bf(HOME)) The HOME environment variable is used to find the user's |
de2fd20e | 3274 | default .cvsignore file. |
de2fd20e AT |
3275 | enddit() |
3276 | ||
41059f75 AT |
3277 | manpagefiles() |
3278 | ||
30e8c8e1 | 3279 | /etc/rsyncd.conf or rsyncd.conf |
41059f75 AT |
3280 | |
3281 | manpageseealso() | |
3282 | ||
49f4cfdf | 3283 | bf(rsyncd.conf)(5) |
41059f75 | 3284 | |
41059f75 AT |
3285 | manpagebugs() |
3286 | ||
02184920 | 3287 | times are transferred as *nix time_t values |
41059f75 | 3288 | |
f28bd833 | 3289 | When transferring to FAT filesystems rsync may re-sync |
38843171 | 3290 | unmodified files. |
faa82484 | 3291 | See the comments on the bf(--modify-window) option. |
38843171 | 3292 | |
b5accaba | 3293 | file permissions, devices, etc. are transferred as native numerical |
41059f75 AT |
3294 | values |
3295 | ||
faa82484 | 3296 | see also the comments on the bf(--delete) option |
41059f75 | 3297 | |
b553a3dd | 3298 | Please report bugs! See the web site at |
38843171 | 3299 | url(http://rsync.samba.org/)(http://rsync.samba.org/) |
41059f75 | 3300 | |
15997547 WD |
3301 | manpagesection(VERSION) |
3302 | ||
db8f3f73 | 3303 | This man page is current for version 3.0.3 of rsync. |
15997547 | 3304 | |
4e0bf977 WD |
3305 | manpagesection(INTERNAL OPTIONS) |
3306 | ||
3307 | The options bf(--server) and bf(--sender) are used internally by rsync, | |
3308 | and should never be typed by a user under normal circumstances. Some | |
3309 | awareness of these options may be needed in certain scenarios, such as | |
3310 | when setting up a login that can only run an rsync command. For instance, | |
3311 | the support directory of the rsync distribution has an example script | |
3312 | named rrsync (for restricted rsync) that can be used with a restricted | |
3313 | ssh login. | |
3314 | ||
41059f75 AT |
3315 | manpagesection(CREDITS) |
3316 | ||
3317 | rsync is distributed under the GNU public license. See the file | |
3318 | COPYING for details. | |
3319 | ||
41059f75 | 3320 | A WEB site is available at |
3cd5eb3b MP |
3321 | url(http://rsync.samba.org/)(http://rsync.samba.org/). The site |
3322 | includes an FAQ-O-Matic which may cover questions unanswered by this | |
3323 | manual page. | |
9e3c856a AT |
3324 | |
3325 | The primary ftp site for rsync is | |
3326 | url(ftp://rsync.samba.org/pub/rsync)(ftp://rsync.samba.org/pub/rsync). | |
41059f75 AT |
3327 | |
3328 | We would be delighted to hear from you if you like this program. | |
03646b49 | 3329 | Please contact the mailing-list at rsync@lists.samba.org. |
41059f75 | 3330 | |
9e3c856a AT |
3331 | This program uses the excellent zlib compression library written by |
3332 | Jean-loup Gailly and Mark Adler. | |
41059f75 AT |
3333 | |
3334 | manpagesection(THANKS) | |
3335 | ||
6f098b0f | 3336 | Special thanks go out to: John Van Essen, Matt McCutchen, Wesley W. Terpstra, |
03646b49 WD |
3337 | David Dykstra, Jos Backus, Sebastian Krahmer, Martin Pool, and our |
3338 | gone-but-not-forgotten compadre, J.W. Schultz. | |
7ff701e8 | 3339 | |
03646b49 WD |
3340 | Thanks also to Richard Brent, Brendan Mackay, Bill Waite, Stephen Rothwell |
3341 | and David Bell. I've probably missed some people, my apologies if I have. | |
41059f75 AT |
3342 | |
3343 | manpageauthor() | |
3344 | ||
ce5f2732 | 3345 | rsync was originally written by Andrew Tridgell and Paul Mackerras. |
03646b49 WD |
3346 | Many people have later contributed to it. It is currently maintained |
3347 | by Wayne Davison. | |
3cd5eb3b | 3348 | |
a5d74a18 | 3349 | Mailing lists for support and development are available at |
faa82484 | 3350 | url(http://lists.samba.org)(lists.samba.org) |