1--- 2c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. 3SPDX-License-Identifier: curl 4Long: limit-rate 5Arg: <speed> 6Help: Limit transfer speed to RATE 7Category: connection 8Added: 7.10 9Multi: single 10See-also: 11 - rate 12 - speed-limit 13 - speed-time 14Example: 15 - --limit-rate 100K $URL 16 - --limit-rate 1000 $URL 17 - --limit-rate 10M $URL 18--- 19 20# `--limit-rate` 21 22Specify the maximum transfer rate you want curl to use - for both downloads 23and uploads. This feature is useful if you have a limited pipe and you would 24like your transfer not to use your entire bandwidth. To make it slower than it 25otherwise would be. 26 27The given speed is measured in bytes/second, unless a suffix is appended. 28Appending 'k' or 'K' counts the number as kilobytes, 'm' or 'M' makes it 29megabytes, while 'g' or 'G' makes it gigabytes. The suffixes (k, M, G, T, P) 30are 1024 based. For example 1k is 1024. Examples: 200K, 3m and 1G. 31 32The rate limiting logic works on averaging the transfer speed to no more than 33the set threshold over a period of multiple seconds. 34 35If you also use the --speed-limit option, that option takes precedence and 36might cripple the rate-limiting slightly, to help keeping the speed-limit 37logic working. 38
