diff --git a/docs/Makefile.am b/docs/Makefile.am index d9e4820993..2d4836a7eb 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -12,6 +12,7 @@ man_MANS = \ curl_easy_init.3 \ curl_easy_perform.3 \ curl_easy_setopt.3 \ + curl_easy_duphandle.3 \ curl_formparse.3 \ curl_formadd.3 \ curl_formfree.3 \ @@ -39,6 +40,7 @@ HTMLPAGES = \ curl_easy_init.html \ curl_easy_perform.html \ curl_easy_setopt.html \ + curl_easy_duphandle.html \ curl_formadd.html \ curl_formparse.html \ curl_formfree.html \ diff --git a/docs/curl_easy_duphandle.3 b/docs/curl_easy_duphandle.3 new file mode 100644 index 0000000000..b570dc4327 --- /dev/null +++ b/docs/curl_easy_duphandle.3 @@ -0,0 +1,37 @@ +.\" You can view this file with: +.\" nroff -man [file] +.\" $Id$ +.\" +.TH curl_easy_duphandle 3 "18 September 2001" "libcurl 7.9" "libcurl Manual" +.SH NAME +curl_easy_duphandle - Clone a libcurl session handle +.SH SYNOPSIS +.B #include +.sp +.BI "CURL *curl_easy_duphandle(CURL *"handle ");" +.ad +.SH DESCRIPTION +This function will return a new curl handle, a duplicate, using all the +options previously set in the input curl \fIhandle\fP. Both handles can +subsequently be used independently and they must both be freed with +\fIcurl_easy_cleanup()\fP. + +All strings that the input handle has been told to point to (as opposed to +copy) with previous calls to \fIcurl_easy_setopt\fP using char * inputs, will +be pointed to by the new handle as well. You must therefore make sure to keep +the data around until both handles have been cleaned up. + +The new handle will \fBnot\fP inherit any state information, no connections, +no SSL sessions and no cookies. + +\fBNote\fP that even in multi-threaded programs, this function must be called +in a synchronous way, the input handle may not be in use when cloned. + +This function was added in libcurl 7.9. +.SH RETURN VALUE +If this function returns NULL, something went wrong and no valid handle was +returned. +.SH "SEE ALSO" +.BR curl_easy_init "(3)," curl_easy_cleanup "(3)," curl_global_init "(3) +.SH BUGS +Surely there are some, you tell me!