diff options
author | Ramakrishnan Muthukrishnan <vu3rdd@gmail.com> | 2010-03-18 18:24:27 +0530 |
---|---|---|
committer | Ramakrishnan Muthukrishnan <vu3rdd@gmail.com> | 2010-03-18 18:24:27 +0530 |
commit | 53cb199bdf55de6023e0b69832901d8286bf0594 (patch) | |
tree | 9ad3158040df72b9ad0d72fac2ce87fdb8146427 /docs/libcurl/libcurl-easy.3 |
Imported Upstream version 7.20.0
Diffstat (limited to 'docs/libcurl/libcurl-easy.3')
-rw-r--r-- | docs/libcurl/libcurl-easy.3 | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/libcurl/libcurl-easy.3 b/docs/libcurl/libcurl-easy.3 new file mode 100644 index 00000000..58e75f16 --- /dev/null +++ b/docs/libcurl/libcurl-easy.3 @@ -0,0 +1,28 @@ +.\" You can view this file with: +.\" nroff -man [file] +.\" $Id: libcurl-easy.3,v 1.5 2009-05-19 12:48:14 yangtse Exp $ +.\" +.TH libcurl 3 "12 Aug 2003" "libcurl 7.10.7" "libcurl easy interface" +.SH NAME +libcurl-easy \- easy interface overview +.SH DESCRIPTION +When using libcurl's "easy" interface you init your session and get a handle +(often referred to as an "easy handle"), which you use as input to the easy +interface functions you use. Use \fIcurl_easy_init(3)\fP to get the handle. + +You continue by setting all the options you want in the upcoming transfer, the +most important among them is the URL itself (you can't transfer anything +without a specified URL as you may have figured out yourself). You might want +to set some callbacks as well that will be called from the library when data +is available etc. \fIcurl_easy_setopt(3)\fP is used for all this. + +When all is setup, you tell libcurl to perform the transfer using +\fIcurl_easy_perform(3)\fP. It will then do the entire operation and won't +return until it is done (successfully or not). + +After the transfer has been made, you can set new options and make another +transfer, or if you're done, cleanup the session by calling +\fIcurl_easy_cleanup(3)\fP. If you want persistent connections, you don't +cleanup immediately, but instead run ahead and perform other transfers using +the same easy handle. + |