1*6236dae4SAndroid Build Coastguard Worker--- 2*6236dae4SAndroid Build Coastguard Workerc: Copyright (C) Daniel Stenberg, <[email protected]>, et al. 3*6236dae4SAndroid Build Coastguard WorkerSPDX-License-Identifier: curl 4*6236dae4SAndroid Build Coastguard WorkerLong: limit-rate 5*6236dae4SAndroid Build Coastguard WorkerArg: <speed> 6*6236dae4SAndroid Build Coastguard WorkerHelp: Limit transfer speed to RATE 7*6236dae4SAndroid Build Coastguard WorkerCategory: connection 8*6236dae4SAndroid Build Coastguard WorkerAdded: 7.10 9*6236dae4SAndroid Build Coastguard WorkerMulti: single 10*6236dae4SAndroid Build Coastguard WorkerSee-also: 11*6236dae4SAndroid Build Coastguard Worker - rate 12*6236dae4SAndroid Build Coastguard Worker - speed-limit 13*6236dae4SAndroid Build Coastguard Worker - speed-time 14*6236dae4SAndroid Build Coastguard WorkerExample: 15*6236dae4SAndroid Build Coastguard Worker - --limit-rate 100K $URL 16*6236dae4SAndroid Build Coastguard Worker - --limit-rate 1000 $URL 17*6236dae4SAndroid Build Coastguard Worker - --limit-rate 10M $URL 18*6236dae4SAndroid Build Coastguard Worker--- 19*6236dae4SAndroid Build Coastguard Worker 20*6236dae4SAndroid Build Coastguard Worker# `--limit-rate` 21*6236dae4SAndroid Build Coastguard Worker 22*6236dae4SAndroid Build Coastguard WorkerSpecify the maximum transfer rate you want curl to use - for both downloads 23*6236dae4SAndroid Build Coastguard Workerand uploads. This feature is useful if you have a limited pipe and you would 24*6236dae4SAndroid Build Coastguard Workerlike your transfer not to use your entire bandwidth. To make it slower than it 25*6236dae4SAndroid Build Coastguard Workerotherwise would be. 26*6236dae4SAndroid Build Coastguard Worker 27*6236dae4SAndroid Build Coastguard WorkerThe given speed is measured in bytes/second, unless a suffix is appended. 28*6236dae4SAndroid Build Coastguard WorkerAppending 'k' or 'K' counts the number as kilobytes, 'm' or 'M' makes it 29*6236dae4SAndroid Build Coastguard Workermegabytes, while 'g' or 'G' makes it gigabytes. The suffixes (k, M, G, T, P) 30*6236dae4SAndroid Build Coastguard Workerare 1024 based. For example 1k is 1024. Examples: 200K, 3m and 1G. 31*6236dae4SAndroid Build Coastguard Worker 32*6236dae4SAndroid Build Coastguard WorkerThe rate limiting logic works on averaging the transfer speed to no more than 33*6236dae4SAndroid Build Coastguard Workerthe set threshold over a period of multiple seconds. 34*6236dae4SAndroid Build Coastguard Worker 35*6236dae4SAndroid Build Coastguard WorkerIf you also use the --speed-limit option, that option takes precedence and 36*6236dae4SAndroid Build Coastguard Workermight cripple the rate-limiting slightly, to help keeping the speed-limit 37*6236dae4SAndroid Build Coastguard Workerlogic working. 38