diff options
author | Jay Satiro <raysatiro@yahoo.com> | 2021-07-21 01:00:44 -0400 |
---|---|---|
committer | Jay Satiro <raysatiro@yahoo.com> | 2021-07-21 01:03:06 -0400 |
commit | ecf0225461590f3204f237f57919131efcebb3b7 (patch) | |
tree | 80142cdfb5ba33df5d577b06950f3ba025df1a2e /docs/libcurl | |
parent | 9bd629bfadeb3988df473ae4747e04f1ee3df610 (diff) | |
download | curl-ecf0225461590f3204f237f57919131efcebb3b7.tar.gz |
docs: mention max-filesize options also apply to MQTT transfers
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
Diffstat (limited to 'docs/libcurl')
-rw-r--r-- | docs/libcurl/opts/CURLOPT_MAXFILESIZE.3 | 8 | ||||
-rw-r--r-- | docs/libcurl/opts/CURLOPT_MAXFILESIZE_LARGE.3 | 8 |
2 files changed, 8 insertions, 8 deletions
diff --git a/docs/libcurl/opts/CURLOPT_MAXFILESIZE.3 b/docs/libcurl/opts/CURLOPT_MAXFILESIZE.3 index 172ae81c9..0f368fea8 100644 --- a/docs/libcurl/opts/CURLOPT_MAXFILESIZE.3 +++ b/docs/libcurl/opts/CURLOPT_MAXFILESIZE.3 @@ -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 be returned. -The file size is not always known prior to download, and for such files this -option has no effect even if the file transfer ends up being larger than this -given limit. This concerns both FTP and HTTP transfers. +For protocols where the size is not known in advance (including FTP and HTTP) +this option has no effect even if the file transfer ends up being larger than +the given limit. If you want a limit above 2GB, use \fICURLOPT_MAXFILESIZE_LARGE(3)\fP. .SH DEFAULT None .SH PROTOCOLS -FTP and HTTP +FTP, HTTP and MQTT .SH EXAMPLE .nf CURL *curl = curl_easy_init(); diff --git a/docs/libcurl/opts/CURLOPT_MAXFILESIZE_LARGE.3 b/docs/libcurl/opts/CURLOPT_MAXFILESIZE_LARGE.3 index 3af97f83f..fa492e284 100644 --- a/docs/libcurl/opts/CURLOPT_MAXFILESIZE_LARGE.3 +++ b/docs/libcurl/opts/CURLOPT_MAXFILESIZE_LARGE.3 @@ -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 \fICURLE_FILESIZE_EXCEEDED\fP will be returned. -The file size is not always known prior to download, and for such files this -option has no effect even if the file transfer ends up being larger than this -given limit. This concerns both FTP and HTTP transfers. +For protocols where the size is not known in advance (including FTP and HTTP) +this option has no effect even if the file transfer ends up being larger than +the given limit. .SH DEFAULT None .SH PROTOCOLS -FTP and HTTP +FTP, HTTP and MQTT .SH EXAMPLE .nf CURL *curl = curl_easy_init(); |