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