version 1.1.1.1, 2012/02/17 15:09:30
|
version 1.1.1.2, 2013/10/14 07:51:14
|
Line 1
|
Line 1
|
.TH "rsync" "1" "23 Sep 2011" "" "" | .TH "rsync" "1" "28 Sep 2013" "" "" |
.SH "NAME" |
.SH "NAME" |
rsync \- a fast, versatile, remote (and local) file\-copying tool |
rsync \- a fast, versatile, remote (and local) file\-copying tool |
.SH "SYNOPSIS" |
.SH "SYNOPSIS" |
Line 407 to the detailed description below for a complete descr
|
Line 407 to the detailed description below for a complete descr
|
.nf |
.nf |
|
|
\-v, \-\-verbose increase verbosity |
\-v, \-\-verbose increase verbosity |
|
\-\-info=FLAGS fine\-grained informational verbosity |
|
\-\-debug=FLAGS fine\-grained debug verbosity |
|
\-\-msgs2stderr special output handling for debugging |
\-q, \-\-quiet suppress non\-error messages |
\-q, \-\-quiet suppress non\-error messages |
\-\-no\-motd suppress daemon\-mode MOTD (see caveat) |
\-\-no\-motd suppress daemon\-mode MOTD (see caveat) |
\-c, \-\-checksum skip based on checksum, not mod\-time & size |
\-c, \-\-checksum skip based on checksum, not mod\-time & size |
Line 427 to the detailed description below for a complete descr
|
Line 430 to the detailed description below for a complete descr
|
\-L, \-\-copy\-links transform symlink into referent file/dir |
\-L, \-\-copy\-links transform symlink into referent file/dir |
\-\-copy\-unsafe\-links only \(dq\&unsafe\(dq\& symlinks are transformed |
\-\-copy\-unsafe\-links only \(dq\&unsafe\(dq\& symlinks are transformed |
\-\-safe\-links ignore symlinks that point outside the tree |
\-\-safe\-links ignore symlinks that point outside the tree |
|
\-\-munge\-links munge symlinks to make them safer |
\-k, \-\-copy\-dirlinks transform symlink to dir into referent dir |
\-k, \-\-copy\-dirlinks transform symlink to dir into referent dir |
\-K, \-\-keep\-dirlinks treat symlinked dir on receiver as dir |
\-K, \-\-keep\-dirlinks treat symlinked dir on receiver as dir |
\-H, \-\-hard\-links preserve hard links |
\-H, \-\-hard\-links preserve hard links |
Line 442 to the detailed description below for a complete descr
|
Line 446 to the detailed description below for a complete descr
|
\-D same as \-\-devices \-\-specials |
\-D same as \-\-devices \-\-specials |
\-t, \-\-times preserve modification times |
\-t, \-\-times preserve modification times |
\-O, \-\-omit\-dir\-times omit directories from \-\-times |
\-O, \-\-omit\-dir\-times omit directories from \-\-times |
|
\-J, \-\-omit\-link\-times omit symlinks from \-\-times |
\-\-super receiver attempts super\-user activities |
\-\-super receiver attempts super\-user activities |
\-\-fake\-super store/recover privileged attrs using xattrs |
\-\-fake\-super store/recover privileged attrs using xattrs |
\-S, \-\-sparse handle sparse files efficiently |
\-S, \-\-sparse handle sparse files efficiently |
|
\-\-preallocate allocate dest files before writing |
\-n, \-\-dry\-run perform a trial run with no changes made |
\-n, \-\-dry\-run perform a trial run with no changes made |
\-W, \-\-whole\-file copy files whole (w/o delta\-xfer algorithm) |
\-W, \-\-whole\-file copy files whole (w/o delta\-xfer algorithm) |
\-x, \-\-one\-file\-system don'\&t cross filesystem boundaries |
\-x, \-\-one\-file\-system don'\&t cross filesystem boundaries |
Line 461 to the detailed description below for a complete descr
|
Line 467 to the detailed description below for a complete descr
|
\-\-delete\-delay find deletions during, delete after |
\-\-delete\-delay find deletions during, delete after |
\-\-delete\-after receiver deletes after transfer, not during |
\-\-delete\-after receiver deletes after transfer, not during |
\-\-delete\-excluded also delete excluded files from dest dirs |
\-\-delete\-excluded also delete excluded files from dest dirs |
|
\-\-ignore\-missing\-args ignore missing source args without error |
|
\-\-delete\-missing\-args delete missing source args from destination |
\-\-ignore\-errors delete even if there are I/O errors |
\-\-ignore\-errors delete even if there are I/O errors |
\-\-force force deletion of dirs even if not empty |
\-\-force force deletion of dirs even if not empty |
\-\-max\-delete=NUM don'\&t delete more than NUM files |
\-\-max\-delete=NUM don'\&t delete more than NUM files |
Line 471 to the detailed description below for a complete descr
|
Line 479 to the detailed description below for a complete descr
|
\-\-delay\-updates put all updated files into place at end |
\-\-delay\-updates put all updated files into place at end |
\-m, \-\-prune\-empty\-dirs prune empty directory chains from file\-list |
\-m, \-\-prune\-empty\-dirs prune empty directory chains from file\-list |
\-\-numeric\-ids don'\&t map uid/gid values by user/group name |
\-\-numeric\-ids don'\&t map uid/gid values by user/group name |
|
\-\-usermap=STRING custom username mapping |
|
\-\-groupmap=STRING custom groupname mapping |
|
\-\-chown=USER:GROUP simple username/groupname mapping |
\-\-timeout=SECONDS set I/O timeout in seconds |
\-\-timeout=SECONDS set I/O timeout in seconds |
\-\-contimeout=SECONDS set daemon connection timeout in seconds |
\-\-contimeout=SECONDS set daemon connection timeout in seconds |
\-I, \-\-ignore\-times don'\&t skip files that match size and time |
\-I, \-\-ignore\-times don'\&t skip files that match size and time |
Line 499 to the detailed description below for a complete descr
|
Line 510 to the detailed description below for a complete descr
|
\-\-port=PORT specify double\-colon alternate port number |
\-\-port=PORT specify double\-colon alternate port number |
\-\-sockopts=OPTIONS specify custom TCP options |
\-\-sockopts=OPTIONS specify custom TCP options |
\-\-blocking\-io use blocking I/O for the remote shell |
\-\-blocking\-io use blocking I/O for the remote shell |
|
\-\-outbuf=N|L|B set out buffering to None, Line, or Block |
\-\-stats give some file\-transfer stats |
\-\-stats give some file\-transfer stats |
\-8, \-\-8\-bit\-output leave high\-bit chars unescaped in output |
\-8, \-\-8\-bit\-output leave high\-bit chars unescaped in output |
\-h, \-\-human\-readable output numbers in a human\-readable format |
\-h, \-\-human\-readable output numbers in a human\-readable format |
\-\-progress show progress during transfer |
\-\-progress show progress during transfer |
\-P same as \-\-partial \-\-progress |
\-P same as \-\-partial \-\-progress |
\-i, \-\-itemize\-changes output a change\-summary for all updates |
\-i, \-\-itemize\-changes output a change\-summary for all updates |
|
\-M, \-\-remote\-option=OPTION send OPTION to the remote side only |
\-\-out\-format=FORMAT output updates using the specified FORMAT |
\-\-out\-format=FORMAT output updates using the specified FORMAT |
\-\-log\-file=FILE log what we'\&re doing to the specified FILE |
\-\-log\-file=FILE log what we'\&re doing to the specified FILE |
\-\-log\-file\-format=FMT log updates using the specified FMT |
\-\-log\-file\-format=FMT log updates using the specified FMT |
\-\-password\-file=FILE read daemon\-access password from FILE |
\-\-password\-file=FILE read daemon\-access password from FILE |
\-\-list\-only list the files instead of copying them |
\-\-list\-only list the files instead of copying them |
\-\-bwlimit=KBPS limit I/O bandwidth; KBytes per second | \-\-bwlimit=RATE limit socket I/O bandwidth |
\-\-write\-batch=FILE write a batched update to FILE |
\-\-write\-batch=FILE write a batched update to FILE |
\-\-only\-write\-batch=FILE like \-\-write\-batch but w/o updating dest |
\-\-only\-write\-batch=FILE like \-\-write\-batch but w/o updating dest |
\-\-read\-batch=FILE read a batched update from FILE |
\-\-read\-batch=FILE read a batched update from FILE |
Line 530 accepted:
|
Line 543 accepted:
|
|
|
\-\-daemon run as an rsync daemon |
\-\-daemon run as an rsync daemon |
\-\-address=ADDRESS bind to the specified address |
\-\-address=ADDRESS bind to the specified address |
\-\-bwlimit=KBPS limit I/O bandwidth; KBytes per second | \-\-bwlimit=RATE limit socket I/O bandwidth |
\-\-config=FILE specify alternate rsyncd.conf file |
\-\-config=FILE specify alternate rsyncd.conf file |
|
\-M, \-\-dparam=OVERRIDE override global daemon config parameter |
\-\-no\-detach do not detach from the parent |
\-\-no\-detach do not detach from the parent |
\-\-port=PORT listen on alternate port number |
\-\-port=PORT listen on alternate port number |
\-\-log\-file=FILE override the \(dq\&log file\(dq\& setting |
\-\-log\-file=FILE override the \(dq\&log file\(dq\& setting |
Line 577 information on what files are being skipped and slight
|
Line 591 information on what files are being skipped and slight
|
information at the end. More than two \fB\-v\fP options should only be used if |
information at the end. More than two \fB\-v\fP options should only be used if |
you are debugging rsync. |
you are debugging rsync. |
.IP |
.IP |
Note that the names of the transferred files that are output are done using | In a modern rsync, the \fB\-v\fP option is equivalent to the setting of groups |
a default \fB\-\-out\-format\fP of \(dq\&%n%L\(dq\&, which tells you just the name of the | of \fB\-\-info\fP and \fB\-\-debug\fP options. You can choose to use these newer |
file and, if the item is a link, where it points. At the single \fB\-v\fP | options in addition to, or in place of using \fB\-\-verbose\fP, as any |
level of verbosity, this does not mention when a file gets its attributes | fine\-grained settings override the implied settings of \fB\-v\fP. Both |
changed. If you ask for an itemized list of changed attributes (either | \fB\-\-info\fP and \fB\-\-debug\fP have a way to ask for help that tells you |
\fB\-\-itemize\-changes\fP or adding \(dq\&%i\(dq\& to the \fB\-\-out\-format\fP setting), the | exactly what flags are set for each increase in verbosity. |
output (on the client) increases to mention all items that are changed in | |
any way. See the \fB\-\-out\-format\fP option for more details. | |
.IP |
.IP |
|
.IP "\fB\-\-info=FLAGS\fP" |
|
This option lets you have fine\-grained control over the |
|
information |
|
output you want to see. An individual flag name may be followed by a level |
|
number, with 0 meaning to silence that output, 1 being the default output |
|
level, and higher numbers increasing the output of that flag (for those |
|
that support higher levels). Use |
|
\fB\-\-info=help\fP |
|
to see all the available flag names, what they output, and what flag names |
|
are added for each increase in the verbose level. Some examples: |
|
.IP |
|
.nf |
|
rsync \-a \-\-info=progress2 src/ dest/ |
|
rsync \-avv \-\-info=stats2,misc1,flist0 src/ dest/ |
|
.fi |
|
|
|
.IP |
|
Note that \fB\-\-info=name\fP\(cq\&s output is affected by the \fB\-\-out\-format\fP and |
|
\fB\-\-itemize\-changes\fP (\fB\-i\fP) options. See those options for more |
|
information on what is output and when. |
|
.IP |
|
This option was added to 3.1.0, so an older rsync on the server side might |
|
reject your attempts at fine\-grained control (if one or more flags needed |
|
to be send to the server and the server was too old to understand them). |
|
.IP |
|
.IP "\fB\-\-debug=FLAGS\fP" |
|
This option lets you have fine\-grained control over the debug |
|
output you want to see. An individual flag name may be followed by a level |
|
number, with 0 meaning to silence that output, 1 being the default output |
|
level, and higher numbers increasing the output of that flag (for those |
|
that support higher levels). Use |
|
\fB\-\-debug=help\fP |
|
to see all the available flag names, what they output, and what flag names |
|
are added for each increase in the verbose level. Some examples: |
|
.IP |
|
.nf |
|
rsync \-avvv \-\-debug=none src/ dest/ |
|
rsync \-avA \-\-del \-\-debug=del2,acl src/ dest/ |
|
.fi |
|
|
|
.IP |
|
Note that some debug messages will only be output when \fB\-\-msgs2stderr\fP is |
|
specified, especially those pertaining to I/O and buffer debugging. |
|
.IP |
|
This option was added to 3.1.0, so an older rsync on the server side might |
|
reject your attempts at fine\-grained control (if one or more flags needed |
|
to be send to the server and the server was too old to understand them). |
|
.IP |
|
.IP "\fB\-\-msgs2stderr\fP" |
|
This option changes rsync to send all its output |
|
directly to stderr rather than to send messages to the client side via the |
|
protocol (which normally outputs info messages via stdout). This is mainly |
|
intended for debugging in order to avoid changing the data sent via the |
|
protocol, since the extra protocol data can change what is being tested. |
|
Keep in mind that a daemon connection does not have a stderr channel to send |
|
messages back to the client side, so if you are doing any daemon\-transfer |
|
debugging using this option, you should start up a daemon using \fB\-\-no\-detach\fP |
|
so that you can see the stderr output on the daemon side. |
|
.IP |
|
This option has the side\-effect of making stderr output get line\-buffered so |
|
that the merging of the output of 3 programs happens in a more readable manner. |
|
.IP |
.IP "\fB\-q, \-\-quiet\fP" |
.IP "\fB\-q, \-\-quiet\fP" |
This option decreases the amount of information you |
This option decreases the amount of information you |
are given during the transfer, notably suppressing information messages |
are given during the transfer, notably suppressing information messages |
Line 966 which point outside the copied tree. All absolute syml
|
Line 1040 which point outside the copied tree. All absolute syml
|
also ignored. Using this option in conjunction with \fB\-\-relative\fP may |
also ignored. Using this option in conjunction with \fB\-\-relative\fP may |
give unexpected results. |
give unexpected results. |
.IP |
.IP |
|
.IP "\fB\-\-munge\-links\fP" |
|
This option tells rsync to (1) modify all symlinks on |
|
the receiving side in a way that makes them unusable but recoverable (see |
|
below), or (2) to unmunge symlinks on the sending side that had been stored in |
|
a munged state. This is useful if you don\(cq\&t quite trust the source of the data |
|
to not try to slip in a symlink to a unexpected place. |
|
.IP |
|
The way rsync disables the use of symlinks is to prefix each one with the |
|
string \(dq\&/rsyncd\-munged/\(dq\&. This prevents the links from being used as long as |
|
that directory does not exist. When this option is enabled, rsync will refuse |
|
to run if that path is a directory or a symlink to a directory. |
|
.IP |
|
The option only affects the client side of the transfer, so if you need it to |
|
affect the server, specify it via \fB\-\-remote\-option\fP. (Note that in a local |
|
transfer, the client side is the sender.) |
|
.IP |
|
This option has no affect on a daemon, since the daemon configures whether it |
|
wants munged symlinks via its \(dq\&munge symlinks\(dq\& parameter. See also the |
|
\(dq\&munge\-symlinks\(dq\& perl script in the support directory of the source code. |
|
.IP |
.IP "\fB\-k, \-\-copy\-dirlinks\fP" |
.IP "\fB\-k, \-\-copy\-dirlinks\fP" |
This option causes the sending side to treat |
This option causes the sending side to treat |
a symlink to a directory as though it were a real directory. This is |
a symlink to a directory as though it were a real directory. This is |
Line 1182 consistent executability across all bits:
|
Line 1276 consistent executability across all bits:
|
.RE |
.RE |
|
|
.IP |
.IP |
|
Using octal mode numbers is also allowed: |
|
.IP |
|
.RS |
|
\-\-chmod=D2775,F664 |
|
.RE |
|
|
|
.IP |
It is also legal to specify multiple \fB\-\-chmod\fP options, as each |
It is also legal to specify multiple \fB\-\-chmod\fP options, as each |
additional option is just appended to the list of changes to make. |
additional option is just appended to the list of changes to make. |
.IP |
.IP |
Line 1241 it is preserving modification times (see \fB\-\-times\
|
Line 1342 it is preserving modification times (see \fB\-\-times\
|
the directories on the receiving side, it is a good idea to use \fB\-O\fP. |
the directories on the receiving side, it is a good idea to use \fB\-O\fP. |
This option is inferred if you use \fB\-\-backup\fP without \fB\-\-backup\-dir\fP. |
This option is inferred if you use \fB\-\-backup\fP without \fB\-\-backup\-dir\fP. |
.IP |
.IP |
|
.IP "\fB\-J, \-\-omit\-link\-times\fP" |
|
This tells rsync to omit symlinks when |
|
it is preserving modification times (see \fB\-\-times\fP). |
|
.IP |
.IP "\fB\-\-super\fP" |
.IP "\fB\-\-super\fP" |
This tells the receiving side to attempt super\-user |
This tells the receiving side to attempt super\-user |
activities even if the receiving rsync wasn\(cq\&t run by the super\-user. These |
activities even if the receiving rsync wasn\(cq\&t run by the super\-user. These |
Line 1269 This is a good way to backup data without using a supe
|
Line 1374 This is a good way to backup data without using a supe
|
ACLs from incompatible systems. |
ACLs from incompatible systems. |
.IP |
.IP |
The \fB\-\-fake\-super\fP option only affects the side where the option is used. |
The \fB\-\-fake\-super\fP option only affects the side where the option is used. |
To affect the remote side of a remote\-shell connection, specify an rsync | To affect the remote side of a remote\-shell connection, use the |
path: | \fB\-\-remote\-option\fP (\fB\-M\fP) option: |
.IP |
.IP |
.RS |
.RS |
\f(CW rsync \-av \-\-rsync\-path=\(dq\&rsync \-\-fake\-super\(dq\& /src/ host:/dest/\fP | \f(CW rsync \-av \-M\-\-fake\-super /src/ host:/dest/\fP |
.RE |
.RE |
|
|
.IP |
.IP |
Since there is only one \(dq\&side\(dq\& in a local copy, this option affects both | For a local copy, this option affects both the source and the destination. |
the sending and receiving of files. You\(cq\&ll need to specify a copy using | If you wish a local copy to enable this option just for the destination |
\(dq\&localhost\(dq\& if you need to avoid this, possibly using the \(dq\&lsh\(dq\& shell | files, specify \fB\-M\-\-fake\-super\fP. If you wish a local copy to enable |
script (from the support directory) as a substitute for an actual remote | this option just for the source files, combine \fB\-\-fake\-super\fP with |
shell (see \fB\-\-rsh\fP). | \fB\-M\-\-super\fP. |
.IP |
.IP |
This option is overridden by both \fB\-\-super\fP and \fB\-\-no\-super\fP. |
This option is overridden by both \fB\-\-super\fP and \fB\-\-no\-super\fP. |
.IP |
.IP |
Line 1292 Try to handle sparse files efficiently so they take
|
Line 1397 Try to handle sparse files efficiently so they take
|
up less space on the destination. Conflicts with \fB\-\-inplace\fP because it\(cq\&s |
up less space on the destination. Conflicts with \fB\-\-inplace\fP because it\(cq\&s |
not possible to overwrite data in a sparse fashion. |
not possible to overwrite data in a sparse fashion. |
.IP |
.IP |
|
.IP "\fB\-\-preallocate\fP" |
|
This tells the receiver to allocate each destination |
|
file to its eventual size before writing data to the file. Rsync will only use |
|
the real filesystem\-level preallocation support provided by Linux\(cq\&s |
|
\fBfallocate\fP(2) system call or Cygwin\(cq\&s \fBposix_fallocate\fP(3), not the slow |
|
glibc implementation that writes a zero byte into each block. |
|
.IP |
|
Without this option, larger files may not be entirely contiguous on the |
|
filesystem, but with this option rsync will probably copy more slowly. If the |
|
destination is not an extent\-supporting filesystem (such as ext4, xfs, NTFS, |
|
etc.), this option may have no positive effect at all. |
|
.IP |
.IP "\fB\-n, \-\-dry\-run\fP" |
.IP "\fB\-n, \-\-dry\-run\fP" |
This makes rsync perform a trial run that doesn\(cq\&t |
This makes rsync perform a trial run that doesn\(cq\&t |
make any changes (and produces mostly the same output as a real run). It |
make any changes (and produces mostly the same output as a real run). It |
Line 1379 transferring files that are not yet finished (e.g. nam
|
Line 1496 transferring files that are not yet finished (e.g. nam
|
it is written, rename it to \(dq\&foo\(dq\& when it is done, and then use the option |
it is written, rename it to \(dq\&foo\(dq\& when it is done, and then use the option |
\fB\-\-exclude='\&*.new'\&\fP for the rsync transfer). |
\fB\-\-exclude='\&*.new'\&\fP for the rsync transfer). |
.IP |
.IP |
|
Starting with 3.1.0, rsync will skip the sender\-side removal (and output an |
|
error) if the file\(cq\&s size or modify time has not stayed unchanged. |
|
.IP |
.IP "\fB\-\-delete\fP" |
.IP "\fB\-\-delete\fP" |
This tells rsync to delete extraneous files from the |
This tells rsync to delete extraneous files from the |
receiving side (ones that aren\(cq\&t on the sending side), but only for the |
receiving side (ones that aren\(cq\&t on the sending side), but only for the |
Line 1468 this way on the receiver, and for a way to protect fil
|
Line 1588 this way on the receiver, and for a way to protect fil
|
\fB\-\-delete\-excluded\fP. |
\fB\-\-delete\-excluded\fP. |
See \fB\-\-delete\fP (which is implied) for more details on file\-deletion. |
See \fB\-\-delete\fP (which is implied) for more details on file\-deletion. |
.IP |
.IP |
|
.IP "\fB\-\-ignore\-missing\-args\fP" |
|
When rsync is first processing the explicitly |
|
requested source files (e.g. command\-line arguments or \fB\-\-files\-from\fP |
|
entries), it is normally an error if the file cannot be found. This option |
|
suppresses that error, and does not try to transfer the file. This does not |
|
affect subsequent vanished\-file errors if a file was initially found to be |
|
present and later is no longer there. |
|
.IP |
|
.IP "\fB\-\-delete\-missing\-args\fP" |
|
This option takes the behavior of (the implied) |
|
\fB\-\-ignore\-missing\-args\fP option a step farther: each missing arg will become |
|
a deletion request of the corresponding destination file on the receiving side |
|
(should it exist). If the destination file is a non\-empty directory, it will |
|
only be successfully deleted if \-\-force or \-\-delete are in effect. Other than |
|
that, this option is independent of any other type of delete processing. |
|
.IP |
|
The missing source files are represented by special file\-list entries which |
|
display as a \(dq\&*missing\(dq\& entry in the \fB\-\-list\-only\fP output. |
|
.IP |
.IP "\fB\-\-ignore\-errors\fP" |
.IP "\fB\-\-ignore\-errors\fP" |
Tells \fB\-\-delete\fP to go ahead and delete files |
Tells \fB\-\-delete\fP to go ahead and delete files |
even when there are I/O errors. |
even when there are I/O errors. |
Line 1483 using \fB\-\-delete\-after\fP, and it used to be non\-
|
Line 1622 using \fB\-\-delete\-after\fP, and it used to be non\-
|
.IP |
.IP |
.IP "\fB\-\-max\-delete=NUM\fP" |
.IP "\fB\-\-max\-delete=NUM\fP" |
This tells rsync not to delete more than NUM |
This tells rsync not to delete more than NUM |
files or directories. If that limit is exceeded, a warning is output | files or directories. If that limit is exceeded, all further deletions are |
and rsync exits with an error code of 25 (new for 3.0.0). | skipped through the end of the transfer. At the end, rsync outputs a warning |
| (including a count of the skipped deletions) and exits with an error code |
| of 25 (unless some more important error condition also occurred). |
.IP |
.IP |
Also new for version 3.0.0, you may specify \fB\-\-max\-delete=0\fP to be warned | Beginning with version 3.0.0, you may specify \fB\-\-max\-delete=0\fP to be warned |
about any extraneous files in the destination without removing any of them. |
about any extraneous files in the destination without removing any of them. |
Older clients interpreted this as \(dq\&unlimited\(dq\&, so if you don\(cq\&t know what |
Older clients interpreted this as \(dq\&unlimited\(dq\&, so if you don\(cq\&t know what |
version the client is, you can use the less obvious \fB\-\-max\-delete=\-1\fP as |
version the client is, you can use the less obvious \fB\-\-max\-delete=\-1\fP as |
a backward\-compatible way to specify that no deletions be allowed (though |
a backward\-compatible way to specify that no deletions be allowed (though |
older versions didn\(cq\&t warn when the limit was exceeded). | really old versions didn\(cq\&t warn when the limit was exceeded). |
.IP |
.IP |
.IP "\fB\-\-max\-size=SIZE\fP" |
.IP "\fB\-\-max\-size=SIZE\fP" |
This tells rsync to avoid transferring any |
This tells rsync to avoid transferring any |
Line 1514 be offset by one byte in the indicated direction.
|
Line 1655 be offset by one byte in the indicated direction.
|
Examples: \-\-max\-size=1.5mb\-1 is 1499999 bytes, and \-\-max\-size=2g+1 is |
Examples: \-\-max\-size=1.5mb\-1 is 1499999 bytes, and \-\-max\-size=2g+1 is |
2147483649 bytes. |
2147483649 bytes. |
.IP |
.IP |
|
Note that rsync versions prior to 3.1.0 did not allow \fB\-\-max\-size=0\fP. |
|
.IP |
.IP "\fB\-\-min\-size=SIZE\fP" |
.IP "\fB\-\-min\-size=SIZE\fP" |
This tells rsync to avoid transferring any |
This tells rsync to avoid transferring any |
file that is smaller than the specified SIZE, which can help in not |
file that is smaller than the specified SIZE, which can help in not |
transferring small, junk files. |
transferring small, junk files. |
See the \fB\-\-max\-size\fP option for a description of SIZE and other information. |
See the \fB\-\-max\-size\fP option for a description of SIZE and other information. |
.IP |
.IP |
|
Note that rsync versions prior to 3.1.0 did not allow \fB\-\-min\-size=0\fP. |
|
.IP |
.IP "\fB\-B, \-\-block\-size=BLOCKSIZE\fP" |
.IP "\fB\-B, \-\-block\-size=BLOCKSIZE\fP" |
This forces the block size used in |
This forces the block size used in |
rsync\(cq\&s delta\-transfer algorithm to a fixed value. It is normally selected based on |
rsync\(cq\&s delta\-transfer algorithm to a fixed value. It is normally selected based on |
Line 1580 machine for use with the \fB\-\-relative\fP option. F
|
Line 1725 machine for use with the \fB\-\-relative\fP option. F
|
.RE |
.RE |
|
|
.IP |
.IP |
|
.IP "\fB\-M, \-\-remote\-option=OPTION\fP" |
|
This option is used for more advanced |
|
situations where you want certain effects to be limited to one side of the |
|
transfer only. For instance, if you want to pass \fB\-\-log\-file=FILE\fP and |
|
\fB\-\-fake\-super\fP to the remote system, specify it like this: |
|
.IP |
|
.RS |
|
\f(CW rsync \-av \-M \-\-log\-file=foo \-M\-\-fake\-super src/ dest/\fP |
|
.RE |
|
|
|
.IP |
|
If you want to have an option affect only the local side of a transfer when |
|
it normally affects both sides, send its negation to the remote side. Like |
|
this: |
|
.IP |
|
.RS |
|
\f(CW rsync \-av \-x \-M\-\-no\-x src/ dest/\fP |
|
.RE |
|
|
|
.IP |
|
Be cautious using this, as it is possible to toggle an option that will cause |
|
rsync to have a different idea about what data to expect next over the socket, |
|
and that will make it fail in a cryptic fashion. |
|
.IP |
|
Note that it is best to use a separate \fB\-\-remote\-option\fP for each option you |
|
want to pass. This makes your useage compatible with the \fB\-\-protect\-args\fP |
|
option. If that option is off, any spaces in your remote options will be split |
|
by the remote shell unless you take steps to protect them. |
|
.IP |
|
When performing a local transfer, the \(dq\&local\(dq\& side is the sender and the |
|
\(dq\&remote\(dq\& side is the receiver. |
|
.IP |
|
Note some versions of the popt option\-parsing library have a bug in them that |
|
prevents you from using an adjacent arg with an equal in it next to a short |
|
option letter (e.g. \f(CW\-M\-\-log\-file=/tmp/foo\fP. If this bug affects your |
|
version of popt, you can use the version of popt that is included with rsync. |
|
.IP |
.IP "\fB\-C, \-\-cvs\-exclude\fP" |
.IP "\fB\-C, \-\-cvs\-exclude\fP" |
This is a useful shorthand for excluding a |
This is a useful shorthand for excluding a |
broad range of files that you often don\(cq\&t want to transfer between |
broad range of files that you often don\(cq\&t want to transfer between |
Line 1776 side will also be translated
|
Line 1958 side will also be translated
|
from the local to the remote character\-set. The translation happens before |
from the local to the remote character\-set. The translation happens before |
wild\-cards are expanded. See also the \fB\-\-files\-from\fP option. |
wild\-cards are expanded. See also the \fB\-\-files\-from\fP option. |
.IP |
.IP |
|
You may also control this option via the RSYNC_PROTECT_ARGS environment |
|
variable. If this variable has a non\-zero value, this option will be enabled |
|
by default, otherwise it will be disabled by default. Either state is |
|
overridden by a manually specified positive or negative version of this option |
|
(note that \fB\-\-no\-s\fP and \fB\-\-no\-protect\-args\fP are the negative versions). |
|
Since this option was first introduced in 3.0.0, you\(cq\&ll need to make sure it\(cq\&s |
|
disabled if you ever need to interact with a remote rsync that is older than |
|
that. |
|
.IP |
|
Rsync can also be configured (at build time) to have this option enabled by |
|
default (with is overridden by both the environment and the command\-line). |
|
This option will eventually become a new default setting at some |
|
as\-yet\-undetermined point in the future. |
|
.IP |
.IP "\fB\-T, \-\-temp\-dir=DIR\fP" |
.IP "\fB\-T, \-\-temp\-dir=DIR\fP" |
This option instructs rsync to use DIR as a |
This option instructs rsync to use DIR as a |
scratch directory when creating temporary copies of the files transferred |
scratch directory when creating temporary copies of the files transferred |
Line 1816 looks in the same directory as the destination file fo
|
Line 2012 looks in the same directory as the destination file fo
|
has an identical size and modified\-time, or a similarly\-named file. If |
has an identical size and modified\-time, or a similarly\-named file. If |
found, rsync uses the fuzzy basis file to try to speed up the transfer. |
found, rsync uses the fuzzy basis file to try to speed up the transfer. |
.IP |
.IP |
|
If the option is repeated, the fuzzy scan will also be done in any matching |
|
alternate destination directories that are specified via \fB\-\-compare\-dest\fP, |
|
\fB\-\-copy\-dest\fP, or \fB\-\-link\-dest\fP. |
|
.IP |
Note that the use of the \fB\-\-delete\fP option might get rid of any potential |
Note that the use of the \fB\-\-delete\fP option might get rid of any potential |
fuzzy\-match files, so either use \fB\-\-delete\-after\fP or specify some |
fuzzy\-match files, so either use \fB\-\-delete\-after\fP or specify some |
filename exclusions if you need to prevent this. |
filename exclusions if you need to prevent this. |
Line 1828 directory). If a file is found in \fIDIR\fP that is i
|
Line 2028 directory). If a file is found in \fIDIR\fP that is i
|
sender\(cq\&s file, the file will NOT be transferred to the destination |
sender\(cq\&s file, the file will NOT be transferred to the destination |
directory. This is useful for creating a sparse backup of just files that |
directory. This is useful for creating a sparse backup of just files that |
have changed from an earlier backup. |
have changed from an earlier backup. |
|
This option is typically used to copy into an empty (or newly created) |
|
directory. |
.IP |
.IP |
Beginning in version 2.6.4, multiple \fB\-\-compare\-dest\fP directories may be |
Beginning in version 2.6.4, multiple \fB\-\-compare\-dest\fP directories may be |
provided, which will cause rsync to search the list in the order specified |
provided, which will cause rsync to search the list in the order specified |
Line 1840 selected to try to speed up the transfer.
|
Line 2042 selected to try to speed up the transfer.
|
If \fIDIR\fP is a relative path, it is relative to the destination directory. |
If \fIDIR\fP is a relative path, it is relative to the destination directory. |
See also \fB\-\-copy\-dest\fP and \fB\-\-link\-dest\fP. |
See also \fB\-\-copy\-dest\fP and \fB\-\-link\-dest\fP. |
.IP |
.IP |
|
NOTE: beginning with version 3.1.0, rsync will remove a file from a non\-empty |
|
destination hierarchy if an exact match is found in one of the compare\-dest |
|
hierarchies (making the end result more closely match a fresh copy). |
|
.IP |
.IP "\fB\-\-copy\-dest=DIR\fP" |
.IP "\fB\-\-copy\-dest=DIR\fP" |
This option behaves like \fB\-\-compare\-dest\fP, but |
This option behaves like \fB\-\-compare\-dest\fP, but |
rsync will also copy unchanged files found in \fIDIR\fP to the destination |
rsync will also copy unchanged files found in \fIDIR\fP to the destination |
Line 1882 If a match is not found, a basis file from one of the
|
Line 2088 If a match is not found, a basis file from one of the
|
selected to try to speed up the transfer. |
selected to try to speed up the transfer. |
.IP |
.IP |
This option works best when copying into an empty destination hierarchy, as |
This option works best when copying into an empty destination hierarchy, as |
rsync treats existing files as definitive (so it never looks in the link\-dest | existing files may get their attributes tweaked, and that can affect alternate |
dirs when a destination file already exists), and as malleable (so it might | destination files via hard\-links. Also, itemizing of changes can get a bit |
change the attributes of a destination file, which affects all the hard\-linked | muddled. Note that prior to version 3.1.0, an alternate\-directory exact match |
versions). | would never be found (nor linked into the destination) when a destination file |
| already exists. |
.IP |
.IP |
Note that if you combine this option with \fB\-\-ignore\-times\fP, rsync will not |
Note that if you combine this option with \fB\-\-ignore\-times\fP, rsync will not |
link any files together because it only links identical files together as a |
link any files together because it only links identical files together as a |
Line 1943 The default list of suffixes that will not be compress
|
Line 2150 The default list of suffixes that will not be compress
|
version of rsync): |
version of rsync): |
.IP |
.IP |
\fB7z\fP |
\fB7z\fP |
|
\fBace\fP |
\fBavi\fP |
\fBavi\fP |
\fBbz2\fP |
\fBbz2\fP |
\fBdeb\fP |
\fBdeb\fP |
|
\fBgpg\fP |
\fBgz\fP |
\fBgz\fP |
\fBiso\fP |
\fBiso\fP |
\fBjpeg\fP |
\fBjpeg\fP |
\fBjpg\fP |
\fBjpg\fP |
|
\fBlz\fP |
|
\fBlzma\fP |
|
\fBlzo\fP |
\fBmov\fP |
\fBmov\fP |
\fBmp3\fP |
\fBmp3\fP |
\fBmp4\fP |
\fBmp4\fP |
\fBogg\fP |
\fBogg\fP |
|
\fBpng\fP |
|
\fBrar\fP |
\fBrpm\fP |
\fBrpm\fP |
|
\fBrzip\fP |
\fBtbz\fP |
\fBtbz\fP |
\fBtgz\fP |
\fBtgz\fP |
|
\fBtlz\fP |
|
\fBtxz\fP |
|
\fBxz\fP |
\fBz\fP |
\fBz\fP |
\fBzip\fP |
\fBzip\fP |
.IP |
.IP |
Line 1982 from the source system is used instead. See also the
|
Line 2200 from the source system is used instead. See also the
|
the chroot setting affects rsync\(cq\&s ability to look up the names of the |
the chroot setting affects rsync\(cq\&s ability to look up the names of the |
users and groups and what you can do about it. |
users and groups and what you can do about it. |
.IP |
.IP |
|
.IP "\fB\-\-usermap=STRING, \-\-groupmap=STRING\fP" |
|
These options allow you to |
|
specify users and groups that should be mapped to other values by the |
|
receiving side. The \fBSTRING\fP is one or more \fBFROM\fP:\fBTO\fP pairs of |
|
values separated by commas. Any matching \fBFROM\fP value from the sender is |
|
replaced with a \fBTO\fP value from the receiver. You may specify usernames |
|
or user IDs for the \fBFROM\fP and \fBTO\fP values, and the \fBFROM\fP value may |
|
also be a wild\-card string, which will be matched against the sender\(cq\&s |
|
names (wild\-cards do NOT match against ID numbers, though see below for |
|
why a \(cq\&*\(cq\& matches everything). You may instead specify a range of ID |
|
numbers via an inclusive range: LOW\-HIGH. For example: |
|
.IP |
|
.nf |
|
\-\-usermap=0\-99:nobody,wayne:admin,*:normal \-\-groupmap=usr:1,1:usr |
|
.fi |
|
|
|
.IP |
|
The first match in the list is the one that is used. You should specify |
|
all your user mappings using a single \fB\-\-usermap\fP option, and/or all |
|
your group mappings using a single \fB\-\-groupmap\fP option. |
|
.IP |
|
Note that the sender\(cq\&s name for the 0 user and group are not transmitted |
|
to the receiver, so you should either match these values using a 0, or use |
|
the names in effect on the receiving side (typically \(dq\&root\(dq\&). All other |
|
\fBFROM\fP names match those in use on the sending side. All \fBTO\fP names |
|
match those in use on the receiving side. |
|
.IP |
|
Any IDs that do not have a name on the sending side are treated as having an |
|
empty name for the purpose of matching. This allows them to be matched via |
|
a \(dq\&*\(dq\& or using an empty name. For instance: |
|
.IP |
|
.nf |
|
\-\-usermap=:nobody \-\-groupmap=*:nobody |
|
.fi |
|
|
|
.IP |
|
When the \fB\-\-numeric\-ids\fP option is used, the sender does not send any |
|
names, so all the IDs are treated as having an empty name. This means that |
|
you will need to specify numeric \fBFROM\fP values if you want to map these |
|
nameless IDs to different values. |
|
.IP |
|
For the \fB\-\-usermap\fP option to have any effect, the \fB\-o\fP (\fB\-\-owner\fP) |
|
option must be used (or implied), and the receiver will need to be running |
|
as a super\-user (see also the \fB\-\-fake\-super\fP option). For the \fB\-\-groupmap\fP |
|
option to have any effect, the \fB\-g\fP (\fB\-\-groups\fP) option must be used |
|
(or implied), and the receiver will need to have permissions to set that |
|
group. |
|
.IP |
|
.IP "\fB\-\-chown=USER:GROUP\fP" |
|
This option forces all files to be owned by USER |
|
with group GROUP. This is a simpler interface than using \fB\-\-usermap\fP and |
|
\fB\-\-groupmap\fP directly, but it is implemented using those options internally, |
|
so you cannot mix them. If either the USER or GROUP is empty, no mapping for |
|
the omitted user/group will occur. If GROUP is empty, the trailing colon may |
|
be omitted, but if USER is empty, a leading colon must be supplied. |
|
.IP |
|
If you specify \(dq\&\-\-chown=foo:bar, this is exactly the same as specifying |
|
\(dq\&\-\-usermap=*:foo \-\-groupmap=*:bar\(dq\&, only easier. |
|
.IP |
.IP "\fB\-\-timeout=TIMEOUT\fP" |
.IP "\fB\-\-timeout=TIMEOUT\fP" |
This option allows you to set a maximum I/O |
This option allows you to set a maximum I/O |
timeout in seconds. If no data is transferred for the specified time |
timeout in seconds. If no data is transferred for the specified time |
Line 2024 rsync defaults to using
|
Line 2301 rsync defaults to using
|
blocking I/O, otherwise it defaults to using non\-blocking I/O. (Note that |
blocking I/O, otherwise it defaults to using non\-blocking I/O. (Note that |
ssh prefers non\-blocking I/O.) |
ssh prefers non\-blocking I/O.) |
.IP |
.IP |
|
.IP "\fB\-\-outbuf=MODE\fP" |
|
This sets the output buffering mode. The mode can be |
|
None (aka Unbuffered), Line, or Block (aka Full). You may specify as little |
|
as a single letter for the mode, and use upper or lower case. |
|
.IP |
|
The main use of this option is to change Full buffering to Line buffering |
|
when rsync\(cq\&s output is going to a file or pipe. |
|
.IP |
.IP "\fB\-i, \-\-itemize\-changes\fP" |
.IP "\fB\-i, \-\-itemize\-changes\fP" |
Requests a simple itemized list of the |
Requests a simple itemized list of the |
changes that are being made to each file, including attribute changes. |
changes that are being made to each file, including attribute changes. |
Line 2122 This allows you to specify exactly what the
|
Line 2407 This allows you to specify exactly what the
|
rsync client outputs to the user on a per\-update basis. The format is a |
rsync client outputs to the user on a per\-update basis. The format is a |
text string containing embedded single\-character escape sequences prefixed |
text string containing embedded single\-character escape sequences prefixed |
with a percent (%) character. A default format of \(dq\&%n%L\(dq\& is assumed if |
with a percent (%) character. A default format of \(dq\&%n%L\(dq\& is assumed if |
\fB\-v\fP is specified (which reports the name | either \fB\-\-info=name\fP or \fB\-v\fP is specified (this tells you just the name |
of the file and, if the item is a link, where it points). For a full list |
of the file and, if the item is a link, where it points). For a full list |
of the possible escape characters, see the \(dq\&log format\(dq\& setting in the |
of the possible escape characters, see the \(dq\&log format\(dq\& setting in the |
rsyncd.conf manpage. |
rsyncd.conf manpage. |
.IP |
.IP |
Specifying the \fB\-\-out\-format\fP option | Specifying the \fB\-\-out\-format\fP option implies the \fB\-\-info=name\fP option, |
will mention each file, dir, etc. that gets updated in a significant | which will mention each file, dir, etc. that gets updated in a significant |
way (a transferred file, a recreated symlink/device, or a touched |
way (a transferred file, a recreated symlink/device, or a touched |
directory). In addition, if the itemize\-changes escape (%i) is included in |
directory). In addition, if the itemize\-changes escape (%i) is included in |
the string (e.g. if the \fB\-\-itemize\-changes\fP option was used), the logging |
the string (e.g. if the \fB\-\-itemize\-changes\fP option was used), the logging |
Line 2155 Here\(cq\&s a example command that requests the remote
|
Line 2440 Here\(cq\&s a example command that requests the remote
|
happening: |
happening: |
.IP |
.IP |
.nf |
.nf |
rsync \-av \-\-rsync\-path=\(dq\&rsync \-\-log\-file=/tmp/rlog\(dq\& src/ dest/ | rsync \-av \-\-remote\-option=\-\-log\-file=/tmp/rlog src/ dest/ |
.fi |
.fi |
|
|
.IP |
.IP |
Line 2176 is \(cq\&%i %n%L\(cq\&.
|
Line 2461 is \(cq\&%i %n%L\(cq\&.
|
.IP "\fB\-\-stats\fP" |
.IP "\fB\-\-stats\fP" |
This tells rsync to print a verbose set of statistics |
This tells rsync to print a verbose set of statistics |
on the file transfer, allowing you to tell how effective rsync\(cq\&s delta\-transfer |
on the file transfer, allowing you to tell how effective rsync\(cq\&s delta\-transfer |
algorithm is for your data. | algorithm is for your data. This option is equivalent to \fB\-\-info=stats2\fP |
| if combined with 0 or 1 \fB\-v\fP options, or \fB\-\-info=stats3\fP if combined |
| with 2 or more \fB\-v\fP options. |
.IP |
.IP |
The current statistics are as follows: |
The current statistics are as follows: |
.RS |
.RS |
.IP o |
.IP o |
\fBNumber of files\fP is the count of all \(dq\&files\(dq\& (in the generic |
\fBNumber of files\fP is the count of all \(dq\&files\(dq\& (in the generic |
sense), which includes directories, symlinks, etc. | sense), which includes directories, symlinks, etc. The total count will |
| be followed by a list of counts by filetype (if the total is non\-zero). |
| For example: \(dq\&(reg: 5, dir: 3, link: 2, dev: 1, special: 1)\(dq\& lists the |
| totals for regular files, directories, symlinks, devices, and special |
| files. If any of value is 0, it is completely omitted from the list. |
.IP o |
.IP o |
\fBNumber of files transferred\fP is the count of normal files that | \fBNumber of created files\fP is the count of how many \(dq\&files\(dq\& (generic |
were updated via rsync\(cq\&s delta\-transfer algorithm, which does not include created | sense) were created (as opposed to updated). The total count will be |
dirs, symlinks, etc. | followed by a list of counts by filetype (if the total is non\-zero). |
.IP o |
.IP o |
|
\fBNumber of deleted files\fP is the count of how many \(dq\&files\(dq\& (generic |
|
sense) were created (as opposed to updated). The total count will be |
|
followed by a list of counts by filetype (if the total is non\-zero). |
|
Note that this line is only output if deletions are in effect, and only |
|
if protocol 31 is being used (the default for rsync 3.1.x). |
|
.IP o |
|
\fBNumber of regular files transferred\fP is the count of normal files |
|
that were updated via rsync\(cq\&s delta\-transfer algorithm, which does not |
|
include dirs, symlinks, etc. Note that rsync 3.1.0 added the word |
|
\(dq\®ular\(dq\& into this heading. |
|
.IP o |
\fBTotal file size\fP is the total sum of all file sizes in the transfer. |
\fBTotal file size\fP is the total sum of all file sizes in the transfer. |
This does not count any size for directories or special files, but does |
This does not count any size for directories or special files, but does |
include the size of symlinks. |
include the size of symlinks. |
Line 2237 escaped unless it is followed by a hash and 3 digits (
|
Line 2539 escaped unless it is followed by a hash and 3 digits (
|
.IP |
.IP |
.IP "\fB\-h, \-\-human\-readable\fP" |
.IP "\fB\-h, \-\-human\-readable\fP" |
Output numbers in a more human\-readable format. |
Output numbers in a more human\-readable format. |
This makes big numbers output using larger units, with a K, M, or G suffix. If | There are 3 possible levels: (1) output numbers with a separator between each |
this option was specified once, these units are K (1000), M (1000*1000), and | set of 3 digits (either a comma or a period, depending on if the decimal point |
G (1000*1000*1000); if the option is repeated, the units are powers of 1024 | is represented by a period or a comma); (2) output numbers in units of 1000 |
instead of 1000. | (with a character suffix for larger units \-\- see below); (3) output numbers in |
| units of 1024. |
.IP |
.IP |
|
The default is human\-readable level 1. Each \fB\-h\fP option increases the level |
|
by one. You can take the level down to 0 (to output numbers as pure digits) by |
|
specifing the \fB\-\-no\-human\-readable\fP (\fB\-\-no\-h\fP) option. |
|
.IP |
|
The unit letters that are appended in levels 2 and 3 are: K (kilo), M (mega), |
|
G (giga), or T (tera). For example, a 1234567\-byte file would output as 1.23M |
|
in level\-2 (assuming that a period is your local decimal point). |
|
.IP |
|
Backward compatibility note: versions of rsync prior to 3.1.0 do not support |
|
human\-readable level 1, and they default to level 0. Thus, specifying one or |
|
two \fB\-h\fP options will behave in a comparable manner in old and new versions |
|
as long as you didn\(cq\&t specify a \fB\-\-no\-h\fP option prior to one or more \fB\-h\fP |
|
options. See the \fB\-\-list\-only\fP option for one difference. |
|
.IP |
.IP "\fB\-\-partial\fP" |
.IP "\fB\-\-partial\fP" |
By default, rsync will delete any partially |
By default, rsync will delete any partially |
transferred file if the transfer is interrupted. In some circumstances |
transferred file if the transfer is interrupted. In some circumstances |
Line 2380 in place of the hide\-filter (if that is more natural
|
Line 2697 in place of the hide\-filter (if that is more natural
|
This option tells rsync to print information |
This option tells rsync to print information |
showing the progress of the transfer. This gives a bored user |
showing the progress of the transfer. This gives a bored user |
something to watch. |
something to watch. |
Implies \fB\-\-verbose\fP if it wasn\(cq\&t already specified. | With a modern rsync this is the same as specifying |
| \fB\-\-info=flist2,name,progress\fP, but any user\-supplied settings for those |
| info flags takes precedence (e.g. \(dq\&\-\-info=flist0 \-\-progress\(dq\&). |
.IP |
.IP |
While rsync is transferring a regular file, it updates a progress line that |
While rsync is transferring a regular file, it updates a progress line that |
looks like this: |
looks like this: |
Line 2406 When the file transfer finishes, rsync replaces the pr
|
Line 2725 When the file transfer finishes, rsync replaces the pr
|
summary line that looks like this: |
summary line that looks like this: |
.IP |
.IP |
.nf |
.nf |
1238099 100% 146.38kB/s 0:00:08 (xfer#5, to\-check=169/396) | 1,238,099 100% 146.38kB/s 0:00:08 (xfr#5, to\-chk=169/396) |
.fi |
.fi |
|
|
.IP |
.IP |
In this example, the file was 1238099 bytes long in total, the average rate | In this example, the file was 1,238,099 bytes long in total, the average rate |
of transfer for the whole file was 146.38 kilobytes per second over the 8 |
of transfer for the whole file was 146.38 kilobytes per second over the 8 |
seconds that it took to complete, it was the 5th transfer of a regular file |
seconds that it took to complete, it was the 5th transfer of a regular file |
during the current rsync session, and there are 169 more files for the |
during the current rsync session, and there are 169 more files for the |
receiver to check (to see if they are up\-to\-date or not) remaining out of |
receiver to check (to see if they are up\-to\-date or not) remaining out of |
the 396 total files in the file\-list. |
the 396 total files in the file\-list. |
.IP |
.IP |
|
In an incremental recursion scan, rsync won\(cq\&t know the total number of files |
|
in the file\-list until it reaches the ends of the scan, but since it starts to |
|
transfer files during the scan, it will display a line with the text \(dq\&ir\-chk\(dq\& |
|
(for incremental recursion check) instead of \(dq\&to\-chk\(dq\& until the point that it |
|
knows the full size of the list, at which point it will switch to using |
|
\(dq\&to\-chk\(dq\&. Thus, seeing \(dq\&ir\-chk\(dq\& lets you know that the total count of files |
|
in the file list is still going to increase (and each time it does, the count |
|
of files left to check will increase by the number of the files added to the |
|
list). |
|
.IP |
.IP "\fB\-P\fP" |
.IP "\fB\-P\fP" |
The \fB\-P\fP option is equivalent to \fB\-\-partial\fP \fB\-\-progress\fP. Its |
The \fB\-P\fP option is equivalent to \fB\-\-partial\fP \fB\-\-progress\fP. Its |
purpose is to make it much easier to specify these two options for a long |
purpose is to make it much easier to specify these two options for a long |
transfer that may be interrupted. |
transfer that may be interrupted. |
.IP |
.IP |
.IP "\fB\-\-password\-file\fP" | There is also a \fB\-\-info=progress2\fP option that outputs statistics based |
This option allows you to provide a password in a | on the whole transfer, rather than individual files. Use this flag without |
file for accessing an rsync daemon. The file must not be world readable. | outputting a filename (e.g. avoid \fB\-v\fP or specify \fB\-\-info=name0\fP if you |
It should contain just the password as the first line of the file (all | want to see how the transfer is doing without scrolling the screen with a |
other lines are ignored). | lot of names. (You don\(cq\&t need to specify the \fB\-\-progress\fP option in |
| order to use \fB\-\-info=progress2\fP.) |
.IP |
.IP |
|
.IP "\fB\-\-password\-file=FILE\fP" |
|
This option allows you to provide a password for |
|
accessing an rsync daemon via a file or via standard input if \fBFILE\fP is |
|
\fB\-\fP. The file should contain just the password on the first line (all other |
|
lines are ignored). Rsync will exit with an error if \fBFILE\fP is world |
|
readable or if a root\-run rsync command finds a non\-root\-owned file. |
|
.IP |
This option does not supply a password to a remote shell transport such as |
This option does not supply a password to a remote shell transport such as |
ssh; to learn how to do that, consult the remote shell\(cq\&s documentation. |
ssh; to learn how to do that, consult the remote shell\(cq\&s documentation. |
When accessing an rsync daemon using a remote shell as the transport, this |
When accessing an rsync daemon using a remote shell as the transport, this |
Line 2451 without using this option. For example:
|
Line 2788 without using this option. For example:
|
.fi |
.fi |
|
|
.IP |
.IP |
|
Starting with rsync 3.1.0, the sizes output by \fB\-\-list\-only\fP are affected |
|
by the \fB\-\-human\-readable\fP option. By default they will contain digit |
|
separators, but higher levels of readability will output the sizes with |
|
unit suffixes. Note also that the column width for the size output has |
|
increased from 11 to 14 characters for all human\-readable levels. Use |
|
\fB\-\-no\-h\fP if you want just digits in the sizes, and the old column width |
|
of 11 characters. |
|
.IP |
Compatibility note: when requesting a remote listing of files from an rsync |
Compatibility note: when requesting a remote listing of files from an rsync |
that is version 2.6.3 or older, you may encounter an error if you ask for a |
that is version 2.6.3 or older, you may encounter an error if you ask for a |
non\-recursive listing. This is because a file listing implies the \fB\-\-dirs\fP |
non\-recursive listing. This is because a file listing implies the \fB\-\-dirs\fP |
Line 2459 avoid this problem, either specify the \fB\-\-no\-dirs
|
Line 2804 avoid this problem, either specify the \fB\-\-no\-dirs
|
need to expand a directory\(cq\&s content), or turn on recursion and exclude |
need to expand a directory\(cq\&s content), or turn on recursion and exclude |
the content of subdirectories: \fB\-r \-\-exclude='\&/*/*'\&\fP. |
the content of subdirectories: \fB\-r \-\-exclude='\&/*/*'\&\fP. |
.IP |
.IP |
.IP "\fB\-\-bwlimit=KBPS\fP" | .IP "\fB\-\-bwlimit=RATE\fP" |
This option allows you to specify a maximum | This option allows you to specify the maximum transfer |
transfer rate in kilobytes per second. This option is most effective when | rate for the data sent over the socket, specified in units per second. The |
using rsync with large files (several megabytes and up). Due to the nature | RATE value can be suffixed with a string to indicate a size multiplier, and may |
of rsync transfers, blocks of data are sent, then if rsync determines the | be a fractional value (e.g. \(dq\&\fB\-\-bwlimit=1.5m\fP\(dq\&). If no suffix is specified, |
transfer was too fast, it will wait before sending the next data block. The | the value will be assumed to be in units of 1024 bytes (as if \(dq\&K\(dq\& or \(dq\&KiB\(dq\& had |
result is an average transfer rate equaling the specified limit. A value | been appended). See the \fB\-\-max\-size\fP option for a description of all the |
of zero specifies no limit. | available suffixes. A value of zero specifies no limit. |
.IP |
.IP |
|
For backward\-compatibility reasons, the rate limit will be rounded to the |
|
nearest KiB unit, so no rate smaller than 1024 bytes per second is possible. |
|
.IP |
|
Rsync writes data over the socket in blocks, and this option both limits the |
|
size of the blocks that rsync writes, and tries to keep the average transfer |
|
rate at the requested limit. Some \(dq\&burstiness\(dq\& may be seen where rsync writes |
|
out a block of data and then sleeps to bring the average rate into compliance. |
|
.IP |
|
Due to the internal buffering of data, the \fB\-\-progress\fP option may not be an |
|
accurate reflection on how fast the data is being sent. This is because some |
|
files can show up as being rapidly sent when the data is quickly buffered, |
|
while other can show up as very slow when the flushing of the output buffer |
|
occurs. This may be fixed in a future version. |
|
.IP |
.IP "\fB\-\-write\-batch=FILE\fP" |
.IP "\fB\-\-write\-batch=FILE\fP" |
Record a file that can later be applied to |
Record a file that can later be applied to |
another identical destination with \fB\-\-read\-batch\fP. See the \(dq\&BATCH MODE\(dq\& |
another identical destination with \fB\-\-read\-batch\fP. See the \(dq\&BATCH MODE\(dq\& |
Line 2548 will have no effect. The \fB\-\-version\fP output wil
|
Line 2907 will have no effect. The \fB\-\-version\fP output wil
|
is the case. |
is the case. |
.IP |
.IP |
.IP "\fB\-\-checksum\-seed=NUM\fP" |
.IP "\fB\-\-checksum\-seed=NUM\fP" |
Set the checksum seed to the integer | Set the checksum seed to the integer NUM. This 4 |
NUM. This 4 byte checksum seed is included in each block and file | byte checksum seed is included in each block and MD4 file checksum calculation |
checksum calculation. By default the checksum seed is generated | (the more modern MD5 file checksums don\(cq\&t use a seed). By default the checksum |
by the server and defaults to the current | seed is generated by the server and defaults to the current |
\f(CWtime()\fP |
\f(CWtime()\fP |
\&. This option | \&. This |
is used to set a specific checksum seed, which is useful for | option is used to set a specific checksum seed, which is useful for |
applications that want repeatable block and file checksums, or | applications that want repeatable block checksums, or in the case where the |
in the case where the user wants a more random checksum seed. | user wants a more random checksum seed. Setting NUM to 0 causes rsync to use |
Setting NUM to 0 causes rsync to use the default of | the default of |
\f(CWtime()\fP |
\f(CWtime()\fP |
for checksum seed. |
for checksum seed. |
| .IP |
.PP | |
.SH "DAEMON OPTIONS" |
.SH "DAEMON OPTIONS" |
|
|
.PP |
.PP |
Line 2586 allows you to specify a specific IP address (or hostna
|
Line 2944 allows you to specify a specific IP address (or hostna
|
makes virtual hosting possible in conjunction with the \fB\-\-config\fP option. |
makes virtual hosting possible in conjunction with the \fB\-\-config\fP option. |
See also the \(dq\&address\(dq\& global option in the rsyncd.conf manpage. |
See also the \(dq\&address\(dq\& global option in the rsyncd.conf manpage. |
.IP |
.IP |
.IP "\fB\-\-bwlimit=KBPS\fP" | .IP "\fB\-\-bwlimit=RATE\fP" |
This option allows you to specify a maximum | This option allows you to specify the maximum transfer |
transfer rate in kilobytes per second for the data the daemon sends. | rate for the data the daemon sends over the socket. The client can still |
The client can still specify a smaller \fB\-\-bwlimit\fP value, but their | specify a smaller \fB\-\-bwlimit\fP value, but no larger value will be allowed. |
requested value will be rounded down if they try to exceed it. See the | See the client version of this option (above) for some extra details. |
client version of this option (above) for some extra details. | |
.IP |
.IP |
.IP "\fB\-\-config=FILE\fP" |
.IP "\fB\-\-config=FILE\fP" |
This specifies an alternate config file than |
This specifies an alternate config file than |
Line 2600 The default is /etc/rsyncd.conf unless the daemon is r
|
Line 2957 The default is /etc/rsyncd.conf unless the daemon is r
|
a remote shell program and the remote user is not the super\-user; in that case |
a remote shell program and the remote user is not the super\-user; in that case |
the default is rsyncd.conf in the current directory (typically $HOME). |
the default is rsyncd.conf in the current directory (typically $HOME). |
.IP |
.IP |
|
.IP "\fB\-M, \-\-dparam=OVERRIDE\fP" |
|
This option can be used to set a daemon\-config |
|
parameter when starting up rsync in daemon mode. It is equivalent to adding |
|
the parameter at the end of the global settings prior to the first module\(cq\&s |
|
definition. The parameter names can be specified without spaces, if you so |
|
desire. For instance: |
|
.IP |
|
.nf |
|
rsync \-\-daemon \-M pidfile=/path/rsync.pid |
|
.fi |
|
|
|
.IP |
.IP "\fB\-\-no\-detach\fP" |
.IP "\fB\-\-no\-detach\fP" |
When running as a daemon, this option instructs |
When running as a daemon, this option instructs |
rsync to not detach itself and become a background process. This |
rsync to not detach itself and become a background process. This |
Line 3478 more details.
|
Line 3847 more details.
|
.IP "\fBRSYNC_ICONV\fP" |
.IP "\fBRSYNC_ICONV\fP" |
Specify a default \fB\-\-iconv\fP setting using this |
Specify a default \fB\-\-iconv\fP setting using this |
environment variable. (First supported in 3.0.0.) |
environment variable. (First supported in 3.0.0.) |
|
.IP "\fBRSYNC_PROTECT_ARGS\fP" |
|
Specify a non\-zero numeric value if you want the |
|
\fB\-\-protect\-args\fP option to be enabled by default, or a zero value to make |
|
sure that it is disabled by default. (First supported in 3.1.0.) |
.IP "\fBRSYNC_RSH\fP" |
.IP "\fBRSYNC_RSH\fP" |
The RSYNC_RSH environment variable allows you to |
The RSYNC_RSH environment variable allows you to |
override the default shell used as the transport for rsync. Command line |
override the default shell used as the transport for rsync. Command line |
Line 3531 http://rsync.samba.org/
|
Line 3904 http://rsync.samba.org/
|
.SH "VERSION" |
.SH "VERSION" |
|
|
.PP |
.PP |
This man page is current for version 3.0.9 of rsync. | This man page is current for version 3.1.0 of rsync. |
.PP |
.PP |
.SH "INTERNAL OPTIONS" |
.SH "INTERNAL OPTIONS" |
|
|
Line 3547 ssh login.
|
Line 3920 ssh login.
|
.SH "CREDITS" |
.SH "CREDITS" |
|
|
.PP |
.PP |
rsync is distributed under the GNU public license. See the file | rsync is distributed under the GNU General Public License. See the file |
COPYING for details. |
COPYING for details. |
.PP |
.PP |
A WEB site is available at |
A WEB site is available at |