1
1
mailto(rsync-bugs@samba.org)
2
manpage(rsync)(1)(8 Apr 2008)()()
2
manpage(rsync)(1)(29 Jun 2008)()()
3
3
manpagename(rsync)(a fast, versatile, remote (and local) file-copying tool)
697
697
where the destination has a file, the transfer would occur regardless of
700
dit(bf(--inplace)) This causes rsync not to create a new copy of the file
701
and then move it into place. Instead rsync will overwrite the existing
702
file, meaning that the rsync algorithm can't accomplish the full amount of
703
network reduction it might be able to otherwise (since it does not yet try
704
to sort data matches). One exception to this is if you combine the option
705
with bf(--backup), since rsync is smart enough to use the backup file as the
706
basis file for the transfer.
700
dit(bf(--inplace)) This option changes how rsync transfers a file when the
701
file's data needs to be updated: instead of the default method of creating
702
a new copy of the file and moving it into place when it is complete, rsync
703
instead writes the updated data directly to the destination file.
705
This has several effects: (1) in-use binaries cannot be updated (either the
706
OS will prevent this from happening, or binaries that attempt to swap-in
707
their data will misbehave or crash), (2) the file's data will be in an
708
inconsistent state during the transfer, (3) a file's data may be left in an
709
inconsistent state after the transfer if the transfer is interrupted or if
710
an update fails, (4) a file that does not have write permissions can not be
711
updated, and (5) the efficiency of rsync's delta-transfer algorithm may be
712
reduced if some data in the destination file is overwritten before it can
713
be copied to a position later in the file (one exception to this is if you
714
combine this option with bf(--backup), since rsync is smart enough to use
715
the backup file as the basis file for the transfer).
717
WARNING: you should not use this option to update files that are being
718
accessed by others, so be careful when choosing to use this for a copy.
708
720
This option is useful for transfer of large files with block-based changes
709
721
or appended data, and also on systems that are disk bound, not network
714
726
Prior to rsync 2.6.4 bf(--inplace) was also incompatible with bf(--compare-dest)
715
727
and bf(--link-dest).
717
WARNING: The file's data will be in an inconsistent state during the
718
transfer (and possibly afterward if the transfer gets interrupted), so you
719
should not use this option to update files that are in use. Also note that
720
rsync will be unable to update a file in-place that is not writable by the
723
729
dit(bf(--append)) This causes rsync to update a file by appending data onto
724
730
the end of the file, which presumes that the data that already exists on
725
731
the receiving side is identical with the start of the file on the sending
986
992
option is not used, the optimization that excludes files that have not been
987
993
modified cannot be effective; in other words, a missing bf(-t) or bf(-a) will
988
994
cause the next transfer to behave as if it used bf(-I), causing all files to be
989
updated (though the rsync algorithm will make the update fairly efficient
995
updated (though rsync's delta-transfer algorithm will make the update fairly efficient
990
996
if the files haven't actually changed, you're much better off using bf(-t)).
992
998
dit(bf(-O, --omit-dir-times)) This tells rsync to omit directories when
1058
1064
statistics are too small, and the "speedup" value is equivalent to a run
1059
1065
where no file transfers are needed.
1061
dit(bf(-W, --whole-file)) With this option the delta-transfer algorithm
1067
dit(bf(-W, --whole-file)) With this option rsync's delta-transfer algorithm
1062
1068
is not used and the whole file is sent as-is instead. The transfer may be
1063
1069
faster if this option is used when the bandwidth between the source and
1064
1070
destination machines is higher than the bandwidth to disk (especially when the
1225
1231
See the bf(--max-size) option for a description of SIZE.
1227
1233
dit(bf(-B, --block-size=BLOCKSIZE)) This forces the block size used in
1228
the rsync algorithm to a fixed value. It is normally selected based on
1234
rsync's delta-transfer algorithm to a fixed value. It is normally selected based on
1229
1235
the size of each file being updated. See the technical report for details.
1231
1237
dit(bf(-e, --rsh=COMMAND)) This option allows you to choose an alternative
1759
1765
in the rsyncd.conf manpage.
1761
1767
dit(bf(--stats)) This tells rsync to print a verbose set of statistics
1762
on the file transfer, allowing you to tell how effective the rsync
1768
on the file transfer, allowing you to tell how effective rsync's delta-transfer
1763
1769
algorithm is for your data.
1765
1771
The current statistics are as follows: quote(itemization(
1766
1772
it() bf(Number of files) is the count of all "files" (in the generic
1767
1773
sense), which includes directories, symlinks, etc.
1768
1774
it() bf(Number of files transferred) is the count of normal files that
1769
were updated via the rsync algorithm, which does not include created
1775
were updated via rsync's delta-transfer algorithm, which does not include created
1770
1776
dirs, symlinks, etc.
1771
1777
it() bf(Total file size) is the total sum of all file sizes in the transfer.
1772
1778
This does not count any size for directories or special files, but does
1827
1833
Note that if bf(--whole-file) is specified (or implied), any partial-dir
1828
1834
file that is found for a file that is being updated will simply be removed
1830
rsync is sending files without using the delta transfer algorithm).
1836
rsync is sending files without using rsync's delta-transfer algorithm).
1832
1838
Rsync will create the em(DIR) if it is missing (just the last dir -- not
1833
1839
the whole path). This makes it easy to use a relative path (such as
1945
1951
per second, and the transfer will finish in 4 seconds if the current rate
1946
1952
is maintained until the end.
1948
These statistics can be misleading if the delta transfer algorithm is
1954
These statistics can be misleading if rsync's delta-transfer algorithm is
1949
1955
in use. For example, if the sender's file consists of the basis file
1950
1956
followed by additional data, the reported rate will probably drop
1951
1957
dramatically when the receiver gets to the literal data, and the transfer
added
removed
rsync.yo
