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