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