updated to libcurl 7.7 conditions
authorDaniel Stenberg <daniel@haxx.se>
Mon, 5 Mar 2001 15:51:34 +0000 (15:51 +0000)
committerDaniel Stenberg <daniel@haxx.se>
Mon, 5 Mar 2001 15:51:34 +0000 (15:51 +0000)
12 files changed:
docs/curl_easy_cleanup.3
docs/curl_easy_getinfo.3
docs/curl_easy_init.3
docs/curl_easy_perform.3
docs/curl_easy_setopt.3
docs/curl_formfree.3
docs/curl_formparse.3
docs/curl_getdate.3
docs/curl_getenv.3
docs/curl_slist_append.3
docs/curl_slist_free_all.3
docs/curl_version.3

index 3e021f329ab442a251fd3077bf2f93db6305e196..4dd4f1fcc681658b6a7e7e393fbe0c53449ef168 100644 (file)
@@ -2,13 +2,13 @@
 .\" nroff -man [file]
 .\" Written by daniel@haxx.se
 .\"
-.TH curl_easy_cleanup 3 "22 May 2000" "Curl 7.0" "libcurl Manual"
+.TH curl_easy_cleanup 3 "5 March 2001" "libcurl 7.7" "libcurl Manual"
 .SH NAME
-curl_easy_cleanup - End a libcurl "easy" session
+curl_easy_cleanup - End a libcurl session
 .SH SYNOPSIS
-.B #include <curl/easy.h>
+.B #include <curl/curl.h>
 .sp
-.BI "curl_easy_cleanup(CURL *" handle ");
+.BI "curl_easy_cleanup(CURL *" handle ");"
 .ad
 .SH DESCRIPTION
 This function must be the last function to call for a curl session. It is the
@@ -17,6 +17,10 @@ opposite of the
 function and must be called with the same
 .I handle
 as input as the curl_easy_init call returned.
+
+This will effectively close all connections libcurl has been used and possibly
+has kept open until now. Don't call this function if you intend to transfer
+more files (libcurl 7.7 or later).
 .SH RETURN VALUE
 None
 .SH "SEE ALSO"
index ed540a85d885dfb075805dfc53d5ed28b62fe588..cf7ee9757779c319ba3814490c53142ea125ad53 100644 (file)
@@ -2,11 +2,11 @@
 .\" nroff -man [file]
 .\" Written by daniel@haxx.se
 .\"
-.TH curl_easy_init 3 "4 February 2001" "Curl 7.6.1" "libcurl Manual"
+.TH curl_easy_init 3 "5 March 2001" "libcurl 7.6.1" "libcurl Manual"
 .SH NAME
 curl_easy_getinfo - Extract information from a curl session (added in 7.4)
 .SH SYNOPSIS
-.B #include <curl/easy.h>
+.B #include <curl/curl.h>
 .sp
 .BI "CURLcode curl_easy_getinfo(CURL *curl, CURLINFO info, ... );"
 .ad
@@ -83,8 +83,8 @@ verification that was requested (using the CURLOPT_SSL_VERIFYPEER option to
 curl_easy_setopt). (Added in 7.4.2)
 .TP
 .B CURLINFO_CONTENT_LENGTH_DOWNLOAD
-Pass a pointer to a double to receive the content-length of the download.
-(Added in 7.6.1)
+Pass a pointer to a double to receive the content-length of the download. This
+is the value read from the Content-Length: field.  (Added in 7.6.1)
 .TP
 .B CURLINFO_CONTENT_LENGTH_UPLOAD
 Pass a pointer to a double to receive the specified size of the upload.
index 4bc9d2b5a2dcfc6025e1c691af7d2444865c757b..7f5c2a32606feb7c419ddb9b675350501e59026a 100644 (file)
@@ -2,11 +2,11 @@
 .\" nroff -man [file]
 .\" Written by daniel@haxx.se
 .\"
-.TH curl_easy_init 3 "26 September 2000" "Curl 7.0" "libcurl Manual"
+.TH curl_easy_init 3 "5 March 2001" "libcurl 7.7" "libcurl Manual"
 .SH NAME
-curl_easy_init - Start a libcurl "easy" session
+curl_easy_init - Start a libcurl session
 .SH SYNOPSIS
-.B #include <curl/easy.h>
+.B #include <curl/curl.h>
 .sp
 .BI "CURL *curl_easy_init( );"
 .ad
@@ -19,6 +19,10 @@ when the operation is complete.
 
 On win32 systems, you need to init the winsock stuff manually, libcurl will
 not do that for you. WSAStartup() and WSACleanup() should be used accordingly.
+
+Using libcurl 7.7 and later, you should perform all your sequential file
+transfers using the same curl handle. This enables libcurl to use persistant
+connections where possible.
 .SH RETURN VALUE
 If this function returns NULL, something went wrong and you cannot use the
 other curl functions.
index f892fd3fee334450f53f243c273070ab25c71883..e1ff0188a3b725f28a2a3ea675d15c108e7cac10 100644 (file)
@@ -2,11 +2,11 @@
 .\" nroff -man [file]
 .\" Written by daniel@haxx.se
 .\"
-.TH curl_easy_perform 3 "1 Mar 2001" "Curl 7.0" "libcurl Manual"
+.TH curl_easy_perform 3 "5 Mar 2001" "libcurl 7.7" "libcurl Manual"
 .SH NAME
-curl_easy_perform - Do the actual transfer in a "easy" session
+curl_easy_perform - Perform a file transfer
 .SH SYNOPSIS
-.B #include <curl/easy.h>
+.B #include <curl/curl.h>
 .sp
 .BI "CURLcode curl_easy_perform(CURL *" handle ");
 .ad
@@ -17,9 +17,22 @@ It must be called with the same
 .I handle
 as input as the curl_easy_init call returned.
 
-You are only allowed to call this function once using the same handle. If you
-want to do repeated calls, you must call curl_easy_cleanup and curl_easy_init
-again first.
+libcurl version 7.7 or later (for older versions see below): You can do any
+amount of calls to curl_easy_perform() while using the same handle. If you
+intend to transfer more than one file, you are even encouraged to do
+so. libcurl will then attempt to re-use the same connection for the following
+transfers, thus making the operations faster, less CPU intense and using less
+network resources. Just note that you will have to use
+.I curl_easy_setopt
+between the invokes to set options for the following curl_easy_perform.
+
+You must never call this function simultaneously from two places using the
+same handle. Let the function return first before invoking it another time. If
+you want parallel transfers, you must use several curl handles.
+
+Before libcurl version 7.7: You are only allowed to call this function once
+using the same handle. If you want to do repeated calls, you must call
+curl_easy_cleanup and curl_easy_init again first.
 .SH RETURN VALUE
 0 means everything was ok, non-zero means an error occurred as
 .I <curl/curl.h>
index df42f3630dd3dd7df41d5f2d536f7331a8cae1e2..80a8ae6aef82f6ee29899278ec9cd7707a9ff5ad 100644 (file)
@@ -2,11 +2,11 @@
 .\" nroff -man [file]
 .\" Written by daniel@haxx.se
 .\"
-.TH curl_easy_setopt 3 "2 February 2001" "Curl 7.5" "libcurl Manual"
+.TH curl_easy_setopt 3 "5 March 2001" "libcurl 7.5" "libcurl Manual"
 .SH NAME
 curl_easy_setopt - Set curl easy-session options
 .SH SYNOPSIS
-.B #include <curl/easy.h>
+.B #include <curl/curl.h>
 .sp
 .BI "CURLcode curl_easy_setopt(CURL *" handle ", CURLoption "option ", ...);
 .ad
@@ -20,7 +20,7 @@ followed by a parameter. That parameter can be a long, a function pointer or
 an object pointer, all depending on what the option in question expects. Read
 this manual carefully as bad input values may cause libcurl to behave badly!
 You can only set one option in each function call. A typical application uses
-many calls in the setup phase.
+many curl_easy_setopt() calls in the setup phase.
 
 The
 .I "handle"
index ea013be23cbcced4706378bee253945ee6bcca7b..cf341956518124871458780dc711077cb1fa0349 100644 (file)
@@ -2,7 +2,7 @@
 .\" nroff -man [file]
 .\" Written by daniel@haxx.se
 .\"
-.TH curl_formfree 3 "17 November 2000" "Curl 7.5" "libcurl Manual"
+.TH curl_formfree 3 "5 March 2001" "libcurl 7.5" "libcurl Manual"
 .SH NAME
 curl_formfree - free a previously build multipart/formdata HTTP POST chain
 .SH SYNOPSIS
index 38b98e276af583cadc06ad788fbd14ca1680cb76..a0d44187e8bd81c5e5c257dc69e14cf6894c8ed8 100644 (file)
@@ -2,7 +2,7 @@
 .\" nroff -man [file]
 .\" Written by daniel@haxx.se
 .\"
-.TH curl_formparse 3 "22 February 2001" "Curl 7.0" "libcurl Manual"
+.TH curl_formparse 3 "5 March 2001" "libcurl 7.0" "libcurl Manual"
 .SH NAME
 curl_formparse - add a section to a multipart/formdata HTTP POST
 .SH SYNOPSIS
index 5562a6aca9a9f0ff81f5b4d9e7d60536d9ea8cd2..35c70b77b29be7953503ee5aba56e48487129d62 100644 (file)
@@ -2,7 +2,7 @@
 .\" nroff -man [file]
 .\" Written by daniel@haxx.se
 .\"
-.TH curl_getdate 3 "2 June 2000" "Curl 7.0" "libcurl Manual"
+.TH curl_getdate 3 "5 March 2001" "libcurl 7.0" "libcurl Manual"
 .SH NAME
 curl_getdate - Convert an date in a ASCII string to number of seconds since
 January 1, 1970
index 594203b46c244587de687ad37b67ceaaeee4d1ba..853be89e9c4a6a7410c3dea592e156632973e61f 100644 (file)
@@ -2,7 +2,7 @@
 .\" nroff -man [file]
 .\" Written by daniel@haxx.se
 .\"
-.TH curl_getenv 3 "2 June 2000" "Curl 7.0" "libcurl Manual"
+.TH curl_getenv 3 "5 March 2001" "libcurl 7.0" "libcurl Manual"
 .SH NAME
 curl_getenv - return value for environment name
 .SH SYNOPSIS
index 3780980db308c88234e225b6f098eeb569afd419..5ef98ff700ea8ad48fa84b35d7d0e34658018e69 100644 (file)
@@ -2,7 +2,7 @@
 .\" nroff -man [file]
 .\" Written by daniel@haxx.se
 .\"
-.TH curl_slist_append 3 "1 Mar 2001" "Curl 7.7" "libcurl Manual"
+.TH curl_slist_append 3 "5 March 2001" "libcurl 7.0" "libcurl Manual"
 .SH NAME
 curl_slist_append - add a string to an slist
 .SH SYNOPSIS
index 67c824d363f3a23e38cfdcfbcb1064cb70d65c02..4e603d67ac7ffb66e2aa626c80a7061562874733 100644 (file)
@@ -2,13 +2,13 @@
 .\" nroff -man [file]
 .\" Written by daniel@haxx.se
 .\"
-.TH curl_slist_free_all 3 "2 June 2000" "Curl 7.0" "libcurl Manual"
+.TH curl_slist_free_all 3 "5 March 2001" "libcurl 7.0" "libcurl Manual"
 .SH NAME
 curl_slist_free_all - free an entire curl_slist list
 .SH SYNOPSIS
 .B #include <curl/curl.h>
 .sp
-.BI "void curl_slist_free_all(struct curl_slit *" list);
+.BI "void curl_slist_free_all(struct curl_slist *" list);
 .ad
 .SH DESCRIPTION
 curl_slist_free_all() removes all traces of a previously built curl_slist
index 95f1dc19598021c1947b60fc904e93189bf88d2d..f3c4ceb6430f7a3152ce3fc81a11b9a4e23c9d0a 100644 (file)
@@ -2,11 +2,11 @@
 .\" nroff -man [file]
 .\" Written by daniel@haxx.se
 .\"
-.TH curl_version 3 "2 June 2000" "Curl 7.0" "libcurl Manual"
+.TH curl_version 3 "5 March 2001" "libcurl 7.0" "libcurl Manual"
 .SH NAME
 curl_version - returns the libcurl version string
 .SH SYNOPSIS
-.B #include <curl/easy.h>
+.B #include <curl/curl.h>
 .sp
 .BI "char *curl_version( );"
 .ad
@@ -14,9 +14,9 @@ curl_version - returns the libcurl version string
 Returns a human readable string with the version number of libcurl and some of
 its important components (like OpenSSL version).
 
-Do note that this returns the actual running lib's version, you might have
-installed a newer lib's include files in your system which may turn your
-LIBCURL_VERSION #define value to differ from this result.
+Note: this returns the actual running lib's version, you might have installed
+a newer lib's include files in your system which may turn your LIBCURL_VERSION
+#define value to differ from this result.
 .SH RETURN VALUE
 A pointer to a zero terminated string.
 .SH "SEE ALSO"