aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2005-09-12 20:36:17 +0000
committerDaniel Stenberg <daniel@haxx.se>2005-09-12 20:36:17 +0000
commit0b7f5ad508337f2c9647debf19cbd5fbffda3484 (patch)
tree61ac4a35b9637234c6338a2318de1554948a5f08
parent8a38805e82e8bc8facf7fbd5f9ff10efd059de55 (diff)
CURLOPT_BUFFERSIZE clarification
-rw-r--r--docs/libcurl/curl_easy_setopt.312
1 files changed, 8 insertions, 4 deletions
diff --git a/docs/libcurl/curl_easy_setopt.3 b/docs/libcurl/curl_easy_setopt.3
index 3153042d4..d92dd5396 100644
--- a/docs/libcurl/curl_easy_setopt.3
+++ b/docs/libcurl/curl_easy_setopt.3
@@ -331,10 +331,14 @@ thread-safe and this will use a global variable.
to using the share interface instead! See \fICURLOPT_SHARE\fP and
\fIcurl_share_init(3)\fP.
.IP CURLOPT_BUFFERSIZE
-Pass a long specifying your preferred size for the receive buffer in libcurl.
-The main point of this would be that the write callback gets called more often
-and with smaller chunks. This is just treated as a request, not an order. You
-cannot be guaranteed to actually get the given size. (Added in 7.10)
+Pass a long specifying your preferred size (in bytes) for the receive buffer
+in libcurl. The main point of this would be that the write callback gets
+called more often and with smaller chunks. This is just treated as a request,
+not an order. You cannot be guaranteed to actually get the given size. (Added
+in 7.10)
+
+This size is by default set as big as possible (CURL_MAX_WRITE_SIZE), so it
+only makse sense to use this option if you want it smaller.
.IP CURLOPT_PORT
Pass a long specifying what remote port number to connect to, instead of the
one specified in the URL or the default port for the used protocol.