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