aboutsummaryrefslogtreecommitdiff
path: root/docs/libcurl/curl_share_init.3
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2003-08-11 07:25:02 +0000
committerDaniel Stenberg <daniel@haxx.se>2003-08-11 07:25:02 +0000
commit8fa43b469a221a6f87ade73b077a6178d6b8e4b7 (patch)
tree274e8fec37d53816b2686ee80e91cefd58441784 /docs/libcurl/curl_share_init.3
parent894e52f61af1baac296a24b4e1c664cb4d4539bd (diff)
documenting the share interface
Diffstat (limited to 'docs/libcurl/curl_share_init.3')
-rw-r--r--docs/libcurl/curl_share_init.321
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/libcurl/curl_share_init.3 b/docs/libcurl/curl_share_init.3
new file mode 100644
index 000000000..2f6581363
--- /dev/null
+++ b/docs/libcurl/curl_share_init.3
@@ -0,0 +1,21 @@
+.\" $Id$
+.\"
+.TH curl_share_init 3 "8 Aug 2003" "libcurl 7.10.7" "libcurl Manual"
+.SH NAME
+curl_share_init - Create a shared object
+.SH SYNOPSIS
+.B #include <curl/curl.h>
+.sp
+.BI "CURLSH *curl_share_init( );"
+.ad
+.SH DESCRIPTION
+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.
+.SH RETURN VALUE
+If this function returns NULL, something went wrong and you got no share
+object to use.
+.SH "SEE ALSO"
+.BR curl_share_cleanup "(3), " curl_share_setopt "(3)"
+