Added a comment.
[rsync/rsync.git] / rsync.yo
index eb01a29..60149d6 100644 (file)
--- a/rsync.yo
+++ b/rsync.yo
@@ -76,9 +76,6 @@ different remote shell by default, such as rsh or remsh.
 You can also specify any remote shell you like, either by using the bf(-e)
 command line option, or by setting the RSYNC_RSH environment variable.
 
-One common substitute is to use ssh, which offers a high degree of
-security.
-
 Note that rsync must be installed on both the source and destination
 machines.
 
@@ -605,7 +602,9 @@ side.  If that is not true, the file will fail the checksum test, and the
 resend will do a normal bf(--inplace) update to correct the mismatched data.
 Only files on the receiving side that are shorter than the corresponding
 file on the sending side (as well as new files) are sent.
-Implies bf(--inplace).
+Implies bf(--inplace), but does not conflict with bf(--sparse) (though the
+bf(--sparse) option will be auto-disabled if a resend of the already-existing
+data is required).
 
 dit(bf(-d, --dirs)) Tell the sending side to include any directories that
 are encountered.  Unlike bf(--recursive), a directory's contents are not copied
@@ -700,7 +699,8 @@ dit(bf(-n, --dry-run)) This tells rsync to not do any file transfers,
 instead it will just report the actions it would have taken.
 
 dit(bf(-S, --sparse)) Try to handle sparse files efficiently so they take
-up less space on the destination.
+up less space on the destination.  Conflicts with bf(--inplace) because it's
+not possible to overwrite data in a sparse fashion.
 
 NOTE: Don't use this option when the destination is a Solaris "tmpfs"
 filesystem. It doesn't seem to handle seeks over null regions
@@ -886,14 +886,14 @@ See the FILTER RULES section for detailed information on this option.
 dit(bf(-F)) The bf(-F) option is a shorthand for adding two bf(--filter) rules to
 your command.  The first time it is used is a shorthand for this rule:
 
-quote(tt(   --filter=': /.rsync-filter'))
+quote(tt(   --filter='dir-merge /.rsync-filter'))
 
 This tells rsync to look for per-directory .rsync-filter files that have
 been sprinkled through the hierarchy and use their rules to filter the
 files in the transfer.  If bf(-F) is repeated, it is a shorthand for this
 rule:
 
-quote(tt(   --filter='- .rsync-filter'))
+quote(tt(   --filter='exclude .rsync-filter'))
 
 This filters out the .rsync-filter files themselves from the transfer.
 
@@ -906,11 +906,10 @@ the full rule-parsing syntax of normal filter rules.
 
 See the FILTER RULES section for detailed information on this option.
 
-dit(bf(--exclude-from=FILE)) This option is similar to the bf(--exclude)
-option, but instead it adds all exclude patterns listed in the file
-FILE to the exclude list.  Blank lines in FILE and lines starting with
-';' or '#' are ignored.
-If em(FILE) is bf(-) the list will be read from standard input.
+dit(bf(--exclude-from=FILE)) This option is related to the bf(--exclude)
+option, but it specifies a FILE that contains exclude patterns (one per line).
+Blank lines in the file and lines starting with ';' or '#' are ignored.
+If em(FILE) is bf(-), the list will be read from standard input.
 
 dit(bf(--include=PATTERN)) This option is a simplified form of the
 bf(--filter) option that defaults to an include rule and does not allow
@@ -918,12 +917,13 @@ the full rule-parsing syntax of normal filter rules.
 
 See the FILTER RULES section for detailed information on this option.
 
-dit(bf(--include-from=FILE)) This specifies a list of include patterns
-from a file.
-If em(FILE) is "-" the list will be read from standard input.
+dit(bf(--include-from=FILE)) This option is related to the bf(--include)
+option, but it specifies a FILE that contains include patterns (one per line).
+Blank lines in the file and lines starting with ';' or '#' are ignored.
+If em(FILE) is bf(-), the list will be read from standard input.
 
 dit(bf(--files-from=FILE)) Using this option allows you to specify the
-exact list of files to transfer (as read from the specified FILE or "-"
+exact list of files to transfer (as read from the specified FILE or bf(-)
 for standard input).  It also tweaks the default behavior of rsync to make
 transferring just the specified files and directories easier:
 
@@ -1344,7 +1344,7 @@ into the batch file without having to flow over the wire to the receiver
 
 dit(bf(--read-batch=FILE)) Apply all of the changes stored in FILE, a
 file previously generated by bf(--write-batch).
-If em(FILE) is "-" the batch data will be read from standard input.
+If em(FILE) is bf(-), the batch data will be read from standard input.
 See the "BATCH MODE" section for details.
 
 dit(bf(--protocol=NUM)) Force an older protocol version to be used.  This