curl/docs/cmdline-opts/limit-rate.d

c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Long: limit-rate
Arg: <speed>
Help: Limit transfer speed to RATE
Category: connection
Example: --limit-rate 100K $URL
Example: --limit-rate 1000 $URL
Example: --limit-rate 10M $URL
Added: 7.10
See-also: speed-limit speed-time
Multi: single
---
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' will count 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 will take precedence and
might cripple the rate-limiting slightly, to help keeping the speed-limit
logic working.
docs/cmdline-opts: add copyright and license identifier to each file gen.pl now insists on C: and SPDX-License-Identifier: fields to be present in all files. Closes #9002 2022-06-14 06:12:03 +08:00			`c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al.`
			`SPDX-License-Identifier: curl`
cmdline-docs: more options converted over 2016-11-16 06:44:58 +08:00			`Long: limit-rate`
			`Arg: <speed>`
			`Help: Limit transfer speed to RATE`
docs: add categories to all cmdline opts Adapted gen.pl with 'listcats' This commit is a part of "--help me if you can" Closes #5680 2020-07-13 20:15:04 +08:00			`Category: connection`
curl.1: provide examples for each option The file format for each option now features a "Example:" header that can provide one or more examples that get rendered appropriately in the output. All options MUST have at least one example or gen.pl complains at build-time. This fix also does a few other minor format and consistency cleanups. Closes #7654 2021-08-31 22:37:14 +08:00			`Example: --limit-rate 100K $URL`
			`Example: --limit-rate 1000 $URL`
			`Example: --limit-rate 10M $URL`
cmdline-opts: made the 'Added:' field mandatory Since "too old" versions are no longer included in the generated man page, this field is now mandatory so that it won't be forgotten and then not included in the documentation. Closes #7786 2021-09-28 17:50:07 +08:00			`Added: 7.10`
curl.1: require "see also" for every documented option gen.pl now generates a warning if the "See Also" field is not filled in for a command line option All command line options now provide one or more related options. 167 "See alsos" added! Closes #8019 2021-11-15 22:58:20 +08:00			`See-also: speed-limit speed-time`
cmdline/docs: add a required 'multi' keyword for each option The keyword specifies how option works when specified multiple times: - single: the last provided value replaces the earlier ones - append: it supports being provided multiple times - boolean: on/off values - mutex: flag-like option that disable anoter flag The 'gen.pl' script then outputs the proper and unified language for each option's multi-use behavior in the generated man page. The multi: header is requires in each .d file and will cause build error if missing or set to an unknown value. Closes #9759 2022-10-18 16:39:43 +08:00			`Multi: single`
cmdline-docs: more options converted over 2016-11-16 06:44:58 +08:00			`---`
			`Specify the maximum transfer rate you want curl to use - for both downloads`
docs: reduce/avoid English contractions You're => You are Hasn't => Has not Doesn't => Does not Don't => Do not You'll => You will etc Closes #7930 2021-10-31 23:34:44 +08:00			`and uploads. This feature is useful if you have a limited pipe and you would like`
cmdline-docs: more options converted over 2016-11-16 06:44:58 +08:00			`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.`
tool_getparam: Support size modifiers for --max-filesize - Move the size modifier detection code from limit-rate to its own function so that it can also be used with max-filesize. Size modifiers are the suffixes such as G (gigabyte), M (megabyte) etc. For example --max-filesize 1G Ref: https://curl.haxx.se/mail/archive-2017-12/0000.html Closes https://github.com/curl/curl/pull/2179 2017-12-18 06:26:10 +08:00			`Appending 'k' or 'K' will count the number as kilobytes, 'm' or 'M' makes it`
limit-rate.d: clarify base unit Fixes #7439 Closes #7494 2021-07-26 06:49:07 +08:00			`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.`
cmdline-docs: more options converted over 2016-11-16 06:44:58 +08:00
limit-rate.d: this is average over several seconds Closes #7970 2021-11-06 19:44:52 +08:00			`The rate limiting logic works on averaging the transfer speed to no more than`
			`the set threshold over a period of multiple seconds.`

cmdline-docs: more options converted over 2016-11-16 06:44:58 +08:00			`If you also use the --speed-limit option, that option will take precedence and`
			`might cripple the rate-limiting slightly, to help keeping the speed-limit`
			`logic working.`