curl/curl
1
1
Fork 0
mirror of https://github.com/curl/curl.git synced 2025-09-19 02:22:47 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs: mention max-filesize options also apply to MQTT transfers

Browse Source 
Also make it clearer that the caveat 'if the file size is unknown it
the option will have no effect' may apply to protocols other than FTP
and HTTP.

Reported-by: Josh Soref

Fixes https://github.com/curl/curl/issues/7453
This commit is contained in:
Jay Satiro 2021-07-21 01:00:44 -04:00
parent 9bd629bfad
commit ecf0225461
3 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/cmdline-opts/max-filesize.d
View File

@ -12,6 +12,6 @@ A size modifier may be used. For example, Appending 'k' or 'K' will count the
number as kilobytes, 'm' or 'M' makes it megabytes, while 'g' or 'G' makes it number as kilobytes, 'm' or 'M' makes it megabytes, while 'g' or 'G' makes it
gigabytes. Examples: 200K, 3m and 1G. (Added in 7.58.0) gigabytes. Examples: 200K, 3m and 1G. (Added in 7.58.0)
**NOTE**: The file size is not always known prior to download, and for such **NOTE**: For protocols where the size is not known in advance (including FTP
files this option has no effect even if the file transfer ends up being larger and HTTP) this option has no effect even if the file transfer ends up being
than this given limit. This concerns both FTP and HTTP transfers. larger than the given limit.

8
docs/libcurl/opts/CURLOPT_MAXFILESIZE.3
View File

@ -33,15 +33,15 @@ Pass a long as parameter. This allows you to specify the maximum \fIsize\fP
this value, the transfer will not start and \fICURLE_FILESIZE_EXCEEDED\fP will this value, the transfer will not start and \fICURLE_FILESIZE_EXCEEDED\fP will
be returned. be returned.
The file size is not always known prior to download, and for such files this For protocols where the size is not known in advance (including FTP and HTTP)
option has no effect even if the file transfer ends up being larger than this this option has no effect even if the file transfer ends up being larger than
given limit. This concerns both FTP and HTTP transfers. the given limit.
If you want a limit above 2GB, use \fICURLOPT_MAXFILESIZE_LARGE(3)\fP. If you want a limit above 2GB, use \fICURLOPT_MAXFILESIZE_LARGE(3)\fP.
.SH DEFAULT .SH DEFAULT
None None
.SH PROTOCOLS .SH PROTOCOLS
FTP and HTTP FTP, HTTP and MQTT
.SH EXAMPLE .SH EXAMPLE
.nf .nf
CURL *curl = curl_easy_init(); CURL *curl = curl_easy_init();

8
docs/libcurl/opts/CURLOPT_MAXFILESIZE_LARGE.3
View File

@ -35,13 +35,13 @@ Pass a curl_off_t as parameter. This allows you to specify the maximum
larger than this value, the transfer will not start and larger than this value, the transfer will not start and
\fICURLE_FILESIZE_EXCEEDED\fP will be returned. \fICURLE_FILESIZE_EXCEEDED\fP will be returned.
The file size is not always known prior to download, and for such files this For protocols where the size is not known in advance (including FTP and HTTP)
option has no effect even if the file transfer ends up being larger than this this option has no effect even if the file transfer ends up being larger than
given limit. This concerns both FTP and HTTP transfers. the given limit.
.SH DEFAULT .SH DEFAULT
None None
.SH PROTOCOLS .SH PROTOCOLS
FTP and HTTP FTP, HTTP and MQTT
.SH EXAMPLE .SH EXAMPLE
.nf .nf
CURL *curl = curl_easy_init(); CURL *curl = curl_easy_init();