Commit e49f61f5 authored by Wayne Davison's avatar Wayne Davison

Make some of the --*-dest comments clearer and more complete.

parent 22f5bd5e
...@@ -537,7 +537,7 @@ bound. ...@@ -537,7 +537,7 @@ bound.
The option implies --partial (since an interrupted transfer does not delete The option implies --partial (since an interrupted transfer does not delete
the file), but conflicts with --partial-dir, --compare-dest, --copy-dest, and the file), but conflicts with --partial-dir, --compare-dest, --copy-dest, and
--link-dest (a future rsync version will hopefully update the protocol to --link-dest (a future rsync version will hopefully update the protocol to
remove these restrictions). remove some of these restrictions).
WARNING: The file's data will be in an inconsistent state during the WARNING: The file's data will be in an inconsistent state during the
transfer (and possibly afterward if the transfer gets interrupted), so you transfer (and possibly afterward if the transfer gets interrupted), so you
...@@ -810,36 +810,48 @@ transferred on the receiving side. The default behavior is to create ...@@ -810,36 +810,48 @@ transferred on the receiving side. The default behavior is to create
the temporary files in the receiving directory. the temporary files in the receiving directory.
dit(bf(--compare-dest=DIR)) This option instructs rsync to use em(DIR) on dit(bf(--compare-dest=DIR)) This option instructs rsync to use em(DIR) on
the destination machine as an additional directory to compare destination the destination machine as an additional hierarchy to compare destination
files against when doing transfers if the files are missing in the files against doing transfers (if the files are missing in the destination
destination directory. Files that are identical to one of the specified directory). If a file is found in em(DIR) that is identical to the
directories are not transferred. This is useful for creating a sparse sender's file, the file will NOT be transferred to the destination
backup into a new hierarchy. If em(DIR) is a relative path, it is relative directory. This is useful for creating a sparse backup of just files that
to the destination directory. See also --copy-dest and --link-dest. have changed from an earlier backup.
Beginning in version 2.6.4, multiple --compare-dest directories may be
provided and rsync will search the list in the order specified until it
finds an existing file. That first discovery is used as the basis file,
and also determines if the transfer needs to happen.
If em(DIR) is a relative path, it is relative to the destination directory.
See also --copy-dest and --link-dest.
dit(bf(--copy-dest=DIR)) This option behaves like bf(--compare-dest), but dit(bf(--copy-dest=DIR)) This option behaves like bf(--compare-dest), but
rsync will also copy unchanged files found in em(DIR) to the destination rsync will also copy unchanged files found in em(DIR) to the destination
directory (using the data in the em(DIR) for an efficient copy). This is directory (using the data in the em(DIR) for an efficient copy). This is
useful for doing transfers to a new destination while leaving existing useful for doing transfers to a new destination while leaving existing
files intact, and then doing a flash-cutover when all files have been files intact, and then doing a flash-cutover when all files have been
successfully transferred. If em(DIR) is a relative path, it is relative to successfully transferred.
the destination directory. See also --compare-dest and --link-dest.
If em(DIR) is a relative path, it is relative to the destination directory.
See also --compare-dest and --link-dest.
dit(bf(--link-dest=DIR)) This option behaves like bf(--copy-dest), but dit(bf(--link-dest=DIR)) This option behaves like bf(--copy-dest), but
unchanged files are hard linked from em(DIR) to the destination directory unchanged files are hard linked from em(DIR) to the destination directory.
(The files must be identical in ownership and permissions--if those items The files must be identical in all preserved attributes (e.g. permissions,
are being preserved--in order for the files to be linked together. If possibly ownership) in order for the files to be linked together.
em(DIR) is a relative path, it is relative to the destination directory.
An example: An example:
verb( verb(
rsync -av --link-dest=$PWD/prior_dir host:src_dir/ new_dir/ rsync -av --link-dest=$PWD/prior_dir host:src_dir/ new_dir/
) )
If more than one --link-dest option is specified, rsync will try to find an Beginning with version 2.6.4, if more than one --link-dest option is
exact match to link with (searching the list in the order specified), and specified, rsync will try to find an exact match to link with (searching
if not found, a basis file from one of the em(DIR)s will be selected to try the list in the order specified), and if not found, a basis file from one
to speed up the transfer. See also --compare-dest and --copy-dest. of the em(DIR)s will be selected to try to speed up the transfer.
If em(DIR) is a relative path, it is relative to the destination directory.
See also --compare-dest and --copy-dest.
Note that rsync versions prior to 2.6.1 had a bug that could prevent Note that rsync versions prior to 2.6.1 had a bug that could prevent
--link-dest from working properly for a non-root user when -o was specified --link-dest from working properly for a non-root user when -o was specified
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment