Documented the new log-format escapes: %n, %L, and %i.

[rsync/rsync.git] / rsync.yo

diff --git a/rsync.yo b/rsync.yo
index 0c21a92..98ef3bf 100644 (file)
--- a/rsync.yo
+++ b/rsync.yo
@@ -373,7 +373,7 @@ to the detailed description below for a complete description.  verb(
      --stats                 give some file-transfer stats
      --progress              show progress during transfer
  -P                          same as --partial --progress
- -w, --what-has-changed      output a change summary for all updates
+ -i, --itemize-changes       output a change-summary for all updates
      --log-format=FORMAT     log file-transfers using specified format
      --password-file=FILE    read password from FILE
      --list-only             list the files instead of copying them
@@ -665,15 +665,6 @@ dit(bf(--ignore-existing))
 This tells rsync not to update files that already exist on
 the destination.
 
-dit(bf(--max-delete=NUM)) This tells rsync not to delete more than NUM
-files or directories. This is useful when mirroring very large trees
-to prevent disasters.
-
-dit(bf(--max-size=SIZE)) This tells rsync to avoid transferring any
-file that is larger than the specified SIZE. The SIZE value can be
-suffixed with a letter to indicate a size multiplier (K, M, or G) and
-may be a fractional value (e.g. "bf(--max-size=1.5m)").
-
 dit(bf(--delete)) This tells rsync to delete extraneous files from the
 receiving side (ones that aren't on the sending side), but only for the
 directories that are being synchronized.  You must have asked rsync to
@@ -743,6 +734,15 @@ they are not empty when they are to be replaced by non-directories.  This
 is only relevant without bf(--delete) because deletions are now done depth-first.
 Requires the bf(--recursive) option (which is implied by bf(-a)) to have any effect.
 
+dit(bf(--max-delete=NUM)) This tells rsync not to delete more than NUM
+files or directories. This is useful when mirroring very large trees
+to prevent disasters.
+
+dit(bf(--max-size=SIZE)) This tells rsync to avoid transferring any
+file that is larger than the specified SIZE. The SIZE value can be
+suffixed with a letter to indicate a size multiplier (K, M, or G) and
+may be a fractional value (e.g. "bf(--max-size=1.5m)").
+
 dit(bf(-B, --block-size=BLOCKSIZE)) This forces the block size used in
 the rsync algorithm to a fixed value.  It is normally selected based on
 the size of each file being updated.  See the technical report for details.
@@ -1012,7 +1012,7 @@ ssh prefers non-blocking I/O.)
 dit(bf(--no-blocking-io)) Turn off bf(--blocking-io), for use when it is the
 default.
 
-dit(bf(--what-has-changed)) Outputs a change-summary for each updated
+dit(bf(-i, --itemize-changes)) Outputs a change-summary for each updated
 item.  The format is as follows:
 
 quote(tt(  *XcstpogDL ITEM_NAME))
@@ -1026,8 +1026,8 @@ attribute for the item is being updated; if not the letter will be replaced
 by either a "-" if no change is occurring, or a "+" if this is a new item.
 The meanings of the attribute letters are as follows:
 
-itemize(
-  it() The bf(c) means the checksum of the file is different and will be
+quote(itemize(
+  it() A bf(c) means the checksum of the file is different and will be
   updated by the file transfer (requries bf(--checksum)).
   it() A bf(s) means the size of the file is different and will be updated
   by the file transfer.
@@ -1036,14 +1036,14 @@ itemize(
   marked with a bf(T) because the time is updated to the transfer time).
   it() A bf(p) means the permissions are being updated (requires
   bf(--perms)).
-  it() The bf(o) means the owner is being updated (requires bf(--owner) and
+  it() An bf(o) means the owner is being updated (requires bf(--owner) and
   root privileges).
-  it() The bf(g) means the group is being updated (requires bf(--group)).
-  it() The bf(D) means the device is being updated (requires bf(--devices)
+  it() A bf(g) means the group is being updated (requires bf(--group)).
+  it() A bf(D) means the device is being updated (requires bf(--devices)
   and root privileges).
-  it() The bf(L) means the symlink value is being updated (requires
+  it() An bf(L) means the symlink value is being updated (requires
   --links).
-)
+))
 
 dit(bf(--log-format=FORMAT)) This allows you to specify exactly what the
 rsync client logs to stdout on a per-file basis. The log format is