Document the change in the -h option.

[rsync/rsync.git] / rsync.yo

diff --git a/rsync.yo b/rsync.yo
index ad7276e..aec04ee 100644 (file)
--- a/rsync.yo
+++ b/rsync.yo
@@ -372,6 +372,8 @@ to the detailed description below for a complete description.  verb(
      --port=PORT             specify double-colon alternate port number
      --blocking-io           use blocking I/O for the remote shell
      --stats                 give some file-transfer stats
+ -h, --human-readable        output numbers in a human-readable format
+     --si                    like human-readable, but use powers of 1000
      --progress              show progress during transfer
  -P                          same as --partial --progress
  -i, --itemize-changes       output a change-summary for all updates
@@ -387,7 +389,7 @@ to the detailed description below for a complete description.  verb(
  -4, --ipv4                  prefer IPv4
  -6, --ipv6                  prefer IPv6
      --version               print version number
- -h, --help                  show this help screen)
+     --help                  show this help screen)
 
 Rsync can also be run as a daemon, in which case the following options are
 accepted: verb(
@@ -400,7 +402,7 @@ accepted: verb(
  -v, --verbose               increase verbosity
  -4, --ipv4                  prefer IPv4
  -6, --ipv6                  prefer IPv6
- -h, --help                  show this help screen)
+     --help                  show this help screen)
 
 manpageoptions()
 
@@ -411,8 +413,10 @@ The '=' for options that take a parameter is optional; whitespace
 can be used instead.
 
 startdit()
-dit(bf(-h, --help)) Print a short help page describing the options
-available in rsync.
+dit(bf(--help)) Print a short help page describing the options
+available in rsync and exit.  For backward-compatibility with older
+versions of rsync, the same help output can also be requested by using
+the bf(-h) option without any other args.
 
 dit(bf(--version)) print the rsync version number and exit.
 
@@ -816,14 +820,15 @@ file that is larger than the specified SIZE. The SIZE value can be
 suffixed with a string to indicate a size multiplier, and
 may be a fractional value (e.g. "bf(--max-size=1.5m)").
 
-The suffixes are as follows: "K" (or "k") is a kilobyte (1024),
-"M" (or "m") is a megabyte (1024*1024), and "G" (or "g") is a
-gigabyte (1024*1024*1024).
-If you want the multiplier to be 1000 instead of 1024, suffix the K, G, or
-M with a "T" (or "t") to indicate that a power of 10 is desired.
+The suffixes are as follows: "K" (or "KiB") is a kibibyte (1024),
+"M" (or "MiB") is a mebibyte (1024*1024), and "G" (or "GiB") is a
+gibibyte (1024*1024*1024).
+If you want the multiplier to be 1000 instead of 1024, use "KB",
+"MB", or "GB".  (Note: lower-case is also accepted for all values.)
 Finally, if the suffix ends in either "+1" or "-1", the value will
 be offset by one byte in the indicated direction.
-Examples: --max-size=1.5mt-1 is 1499999 bytes, and --max-size=2g+1 is
+
+Examples: --max-size=1.5mb-1 is 1499999 bytes, and --max-size=2g+1 is
 2147483649 bytes.
 
 dit(bf(--min-size=SIZE)) This tells rsync to avoid transferring any
@@ -1226,6 +1231,13 @@ dit(bf(--stats)) This tells rsync to print a verbose set of statistics
 on the file transfer, allowing you to tell how effective the rsync
 algorithm is for your data.
 
+dit(bf(-h, --human-readable)) Output numbers in a more human-readable format.
+Large numbers may be output in larger units, with a K (1024), M (1024*1024),
+or G (1024*1024*1024) suffix.
+
+dit(bf(--si)) Similar to the bf(--human-readable) option, but using powers
+of 1000 instead of 1024.
+
 dit(bf(--partial)) By default, rsync will delete any partially
 transferred file if the transfer is interrupted. In some circumstances
 it is more desirable to keep partially transferred files. Using the