mirror of
https://github.com/curl/curl.git
synced 2024-12-27 06:59:43 +08:00
2494b8dd51
- switch all invidual files documenting command line options into .md, as the documentation is now markdown-looking. - made the parser treat 4-space indents as quotes - switch to building the curl.1 manpage using the "mainpage.idx" file, which lists the files to include to generate it, instead of using the previous page-footer/headers. Also, those files are now also .md ones, using the same format. I gave them underscore prefixes to make them sort separately: _NAME.md, _SYNOPSIS.md, _DESCRIPTION.md, _URL.md, _GLOBBING.md, _VARIABLES.md, _OUTPUT.md, _PROTOCOLS.md, _PROGRESS.md, _VERSION.md, _OPTIONS.md, _FILES.md, _ENVIRONMENT.md, _PROXYPREFIX.md, _EXITCODES.md, _BUGS.md, _AUTHORS.md, _WWW.md, _SEEALSO.md - updated test cases accordingly Closes #12751
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.
|