aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/TODO5
-rw-r--r--docs/curl.114
-rw-r--r--docs/libcurl/curl_easy_setopt.39
3 files changed, 22 insertions, 6 deletions
diff --git a/docs/TODO b/docs/TODO
index a72fe2b2d..add94bf26 100644
--- a/docs/TODO
+++ b/docs/TODO
@@ -34,11 +34,6 @@ TODO
>4GB all over. Bug reports (and source reviews) show that it doesn't
currently work.
- * CURLOPT_MAXFILESIZE. Prevent downloads that are larger than the specified
- size. CURLE_FILESIZE_EXCEEDED would then be returned. Gautam Mani
- requested. That is, the download should not even begin but be aborted
- immediately.
-
LIBCURL - multi interface
* Add curl_multi_timeout() to make libcurl's ares-functionality better.
diff --git a/docs/curl.1 b/docs/curl.1
index 7c042780e..fc55ed2c9 100644
--- a/docs/curl.1
+++ b/docs/curl.1
@@ -2,7 +2,7 @@
.\" nroff -man curl.1
.\" Written by Daniel Stenberg
.\"
-.TH curl 1 "23 Sep 2003" "Curl 7.10.8" "Curl Manual"
+.TH curl 1 "17 Oct 2003" "Curl 7.10.8" "Curl Manual"
.SH NAME
curl \- transfer a URL
.SH SYNOPSIS
@@ -456,6 +456,14 @@ authentication info (which is plaintext in the case of HTTP Basic
authentication).
If this option is used twice, the second will again disable location following.
+.IP "--max-filesize <bytes>"
+Specify the maximum size (in bytes) of a file to download. If the file
+requested is larger than this value, the transfer will not start and curl will
+return with exit code 63.
+
+NOTE: 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.
.IP "-m/--max-time <seconds>"
Maximum time in seconds that you allow the whole operation to take. This is
useful for preventing your batch jobs from hanging for hours due to slow
@@ -1053,6 +1061,10 @@ Couldn't use specified SSL cipher
Problem with the CA cert (path? permission?)
.IP 61
Unrecognized transfer encoding
+.IP 62
+Invalid LDAP URL
+.IP 63
+Maximum file size exceeded
.IP XX
There will appear more error codes here in future releases. The existing ones
are meant to never change.
diff --git a/docs/libcurl/curl_easy_setopt.3 b/docs/libcurl/curl_easy_setopt.3
index 22563a1ff..b9aa05682 100644
--- a/docs/libcurl/curl_easy_setopt.3
+++ b/docs/libcurl/curl_easy_setopt.3
@@ -719,6 +719,15 @@ libcurl what the expected size of the infile is.
.B CURLOPT_UPLOAD
A non-zero parameter tells the library to prepare for an upload. The
CURLOPT_READDATA and CURLOPT_INFILESIZE are also interesting for uploads.
+.TP
+.B CURLOPT_MAXFILESIZE
+Pass a long as parameter. This allows you to specify the maximum size (in
+bytes) of a file to download. If the file requested is larger than this value,
+the transfer will not start and CURLE_FILESIZE_EXCEEDED will be returned.
+
+NOTE: 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.
.PP
.SH CONNECTION OPTIONS
.TP 0.4i