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