mirror of
https://github.com/curl/curl.git
synced 2024-12-21 06:50:10 +08:00
e7219c2bdc
Use imperative mood consistently for the first sentence describing an option. "Set this" instead "tell curl to set" or "this sets..." Plus some extra cleanups and rephrasing. Closes #13106
38 lines
1.2 KiB
Markdown
38 lines
1.2 KiB
Markdown
---
|
|
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
SPDX-License-Identifier: curl
|
|
Long: limit-rate
|
|
Arg: <speed>
|
|
Help: Limit transfer speed to RATE
|
|
Category: connection
|
|
Added: 7.10
|
|
Multi: single
|
|
See-also:
|
|
- rate
|
|
- speed-limit
|
|
- speed-time
|
|
Example:
|
|
- --limit-rate 100K $URL
|
|
- --limit-rate 1000 $URL
|
|
- --limit-rate 10M $URL
|
|
---
|
|
|
|
# `--limit-rate`
|
|
|
|
Specify the maximum transfer rate you want curl to use - for both downloads
|
|
and uploads. This feature is useful if you have a limited pipe and you would
|
|
like your transfer not to use your entire bandwidth. To make it slower than it
|
|
otherwise would be.
|
|
|
|
The given speed is measured in bytes/second, unless a suffix is appended.
|
|
Appending 'k' or 'K' counts the number as kilobytes, 'm' or 'M' makes it
|
|
megabytes, while 'g' or 'G' makes it gigabytes. The suffixes (k, M, G, T, P)
|
|
are 1024 based. For example 1k is 1024. Examples: 200K, 3m and 1G.
|
|
|
|
The rate limiting logic works on averaging the transfer speed to no more than
|
|
the set threshold over a period of multiple seconds.
|
|
|
|
If you also use the --speed-limit option, that option takes precedence and
|
|
might cripple the rate-limiting slightly, to help keeping the speed-limit
|
|
logic working.
|