X-Git-Url: https://mattmccutchen.net/rsync/rsync.git/blobdiff_plain/27b9a19be0e90919fe8be3f939f9760d53b221c0..69c6522734897c0b81b184c5ebcc6cd9461f6da3:/rsync.yo

diff --git a/rsync.yo b/rsync.yo
index ccb458d6..03b71d2f 100644
--- a/rsync.yo
+++ b/rsync.yo
@@ -273,6 +273,7 @@ verb(
      --progress              show progress during transfer
      --log-format=FORMAT     log file transfers using specified format
      --password-file=FILE    get password from FILE
+     --bwlimit=KBPS          limit I/O bandwidth, KBytes per second
  -h, --help                  show this help screen
 )
 
@@ -643,6 +644,14 @@ transport, not when using a remote shell as the transport. The file
 must not be world readable. It should contain just the password as a
 single line.
 
+dit(bf(--bwlimit=KBPS)) This option allows you to specify a maximum
+transfer rate in kilobytes per second. This option is most effective when
+using rsync with large files (several megabytes and up). Due to the nature
+of rsync transfers, blocks of data are sent, then if rsync determines the
+transfer was too fast, it will wait before sending the next data block. The
+result is an average transfer rate equalling the specified limit. A value
+of zero specifies no limit.
+
 enddit()
 
 manpagesection(EXCLUDE PATTERNS)