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