aboutsummaryrefslogtreecommitdiff
path: root/docs/libcurl
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2004-03-01 08:02:50 +0000
committerDaniel Stenberg <daniel@haxx.se>2004-03-01 08:02:50 +0000
commit45c7f064d45d5ff084002aadb10a6fe2c879b64a (patch)
tree7faf1e73236de81719e34773e84fc1007efc9639 /docs/libcurl
parent4dfc0a78e70cc77ba61de60df6815a889f4c6b4b (diff)
mention how to make a curl handle use the share
Diffstat (limited to 'docs/libcurl')
-rw-r--r--docs/libcurl/curl_share_init.34
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/libcurl/curl_share_init.3 b/docs/libcurl/curl_share_init.3
index 35fd5a1c9..eb0b23e4e 100644
--- a/docs/libcurl/curl_share_init.3
+++ b/docs/libcurl/curl_share_init.3
@@ -13,6 +13,10 @@ This function returns a CURLSH handle to be used as input to all the other
share-functions, sometimes refered to as a share handle on some places in the
documentation. This init call MUST have a corresponding call to
\fIcurl_share_cleanup\fP when all operations using the share are complete.
+
+This \fIshare handle\fP is what you pass to curl using the \fICURLOPT_SHARE\fP
+option with \fIcurl_easy_setopt(3)\fP, to make that specific curl handle use
+the data in this share.
.SH RETURN VALUE
If this function returns NULL, something went wrong (out of memory, etc.)
and therefore the share object was not created.