Install curl-7.21.1.tar.bz2
[msysgit.git] / mingw / share / man / man3 / libcurl-easy.3
blob803e542445ac62c4a3b0e5b2879fff8eac3b8fff
1 .\" You can view this file with:
2 .\" nroff -man [file]
3 .\"
4 .TH libcurl 3 "12 Aug 2003" "libcurl 7.10.7" "libcurl easy interface"
5 .SH NAME
6 libcurl-easy \- easy interface overview
7 .SH DESCRIPTION
8 When using libcurl's "easy" interface you init your session and get a handle
9 (often referred to as an "easy handle"), which you use as input to the easy
10 interface functions you use. Use \fIcurl_easy_init(3)\fP to get the handle.
12 You continue by setting all the options you want in the upcoming transfer, the
13 most important among them is the URL itself (you can't transfer anything
14 without a specified URL as you may have figured out yourself). You might want
15 to set some callbacks as well that will be called from the library when data
16 is available etc. \fIcurl_easy_setopt(3)\fP is used for all this.
18 When all is setup, you tell libcurl to perform the transfer using
19 \fIcurl_easy_perform(3)\fP.  It will then do the entire operation and won't
20 return until it is done (successfully or not).
22 After the transfer has been made, you can set new options and make another
23 transfer, or if you're done, cleanup the session by calling
24 \fIcurl_easy_cleanup(3)\fP. If you want persistent connections, you don't
25 cleanup immediately, but instead run ahead and perform other transfers using
26 the same easy handle.