Added one more example to the new include/exclude section to show how

[rsync/rsync.git] / rsync.yo

diff --git a/rsync.yo b/rsync.yo
index 1e2f2c7..ee3474e 100644 (file)
--- a/rsync.yo
+++ b/rsync.yo
@@ -458,6 +458,8 @@ very useful for incremental backups.  You can additionally
 specify a backup suffix using the --suffix option
 (otherwise the files backed up in the specified directory
 will keep their original filenames).
 specify a backup suffix using the --suffix option
 (otherwise the files backed up in the specified directory
 will keep their original filenames).

+If DIR is a relative path, it is relative to the destination directory
+(which changes in a recursive transfer).

 
 dit(bf(--suffix=SUFFIX)) This option allows you to override the default
 backup suffix used with the --backup (-b) option. The default suffix is a ~
 
 dit(bf(--suffix=SUFFIX)) This option allows you to override the default
 backup suffix used with the --backup (-b) option. The default suffix is a ~


@@ -727,14 +729,14 @@ although this skips files that haven't changed; see also --link-dest).
 This option increases the usefulness of --partial because partially
 transferred files will remain in the new temporary destination until they
 have a chance to be completed.  If DIR is a relative path, it is relative
 This option increases the usefulness of --partial because partially
 transferred files will remain in the new temporary destination until they
 have a chance to be completed.  If DIR is a relative path, it is relative

-to the destination directory.
+to the destination directory (which changes in a recursive transfer).

 
 dit(bf(--link-dest=DIR)) This option behaves like bf(--compare-dest) but
 also will create hard links from em(DIR) to the destination directory for
 unchanged files.  Files with changed ownership or permissions will not be
 linked.
 Like bf(--compare-dest) if DIR is a relative path, it is relative
 
 dit(bf(--link-dest=DIR)) This option behaves like bf(--compare-dest) but
 also will create hard links from em(DIR) to the destination directory for
 unchanged files.  Files with changed ownership or permissions will not be
 linked.
 Like bf(--compare-dest) if DIR is a relative path, it is relative

-to the destination directory.
+to the destination directory (which changes in a recursive transfer).

 
 dit(bf(-z, --compress)) With this option, rsync compresses any data from
 the files that it sends to the destination machine.  This
 
 dit(bf(-z, --compress)) With this option, rsync compresses any data from
 the files that it sends to the destination machine.  This


@@ -887,7 +889,7 @@ manpagesection(EXCLUDE PATTERNS)
 The exclude and include patterns specified to rsync allow for flexible
 selection of which files to transfer and which files to skip.
 
 The exclude and include patterns specified to rsync allow for flexible
 selection of which files to transfer and which files to skip.
 

-rsync builds an ordered list of include/exclude options as specified on
+Rsync builds an ordered list of include/exclude options as specified on

 the command line. Rsync checks each file and directory 
 name against each exclude/include pattern in turn. The first matching
 pattern is acted on. If it is an exclude pattern, then that file is
 the command line. Rsync checks each file and directory 
 name against each exclude/include pattern in turn. The first matching
 pattern is acted on. If it is an exclude pattern, then that file is


@@ -926,13 +928,19 @@ verb(
    Source root: /home/me
    +/- pattern: /home/me/foo/bar      (note full path)
    Target file: /dest/home/me/foo/bar
    Source root: /home/me
    +/- pattern: /home/me/foo/bar      (note full path)
    Target file: /dest/home/me/foo/bar

+
+   Example cmd: cd /home; rsync -a --relative me/foo/ /dest
+   Source root: ./me/foo         (source is not absolute)
+   +/- pattern: /me/foo/bar      (only uses specified path)
+   Target file: /dest/me/foo/bar

 )
 
 The easiest way to see what name you should include/exclude is to just
 look at the output when using --verbose and put a / in front of the name
 (use the --dry-run option if you're not yet ready to copy any files).
 
 )
 
 The easiest way to see what name you should include/exclude is to just
 look at the output when using --verbose and put a / in front of the name
 (use the --dry-run option if you're not yet ready to copy any files).
 

-Note that when used with -r (which is implied by -a), every subcomponent of
+Note that, when using the --recursive (-r) option (which is implied by -a),
+every subcomponent of

 every path is visited from the top down, so include/exclude patterns get
 applied recursively to each subcomponent.
 
 every path is visited from the top down, so include/exclude patterns get
 applied recursively to each subcomponent.