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