mention the speed unit for the _SPEED_LARGE options from bug #2226722
authorDaniel Stenberg <daniel@haxx.se>
Wed, 5 Nov 2008 21:48:00 +0000 (21:48 +0000)
committerDaniel Stenberg <daniel@haxx.se>
Wed, 5 Nov 2008 21:48:00 +0000 (21:48 +0000)
docs/libcurl/curl_easy_setopt.3

index 9d0ebe8..a8151b2 100644 (file)
@@ -1315,15 +1315,15 @@ Pass a long as parameter. It contains the time in seconds that the transfer
 should be below the \fICURLOPT_LOW_SPEED_LIMIT\fP for the library to consider
 it too slow and abort.
 .IP CURLOPT_MAX_SEND_SPEED_LARGE
-Pass a curl_off_t as parameter.  If an upload exceeds this speed on cumulative
-average during the transfer, the transfer will pause to keep the average rate
-less than or equal to the parameter value.  Defaults to unlimited
-speed. (Added in 7.15.5)
+Pass a curl_off_t as parameter.  If an upload exceeds this speed (counted in
+bytes per second) on cumulative average during the transfer, the transfer will
+pause to keep the average rate less than or equal to the parameter value.
+Defaults to unlimited speed. (Added in 7.15.5)
 .IP CURLOPT_MAX_RECV_SPEED_LARGE
-Pass a curl_off_t as parameter.  If a download exceeds this speed on
-cumulative average during the transfer, the transfer will pause to keep the
-average rate less than or equal to the parameter value. Defaults to unlimited
-speed. (Added in 7.15.5)
+Pass a curl_off_t as parameter.  If a download exceeds this speed (counted in
+bytes per second) on cumulative average during the transfer, the transfer will
+pause to keep the average rate less than or equal to the parameter
+value. Defaults to unlimited speed. (Added in 7.15.5)
 .IP CURLOPT_MAXCONNECTS
 Pass a long. The set number will be the persistent connection cache size. The
 set amount will be the maximum amount of simultaneously open connections that