8c9f5e51cd4e7d42a621eb1209fbe71bbbb0871f
[external/curl.git] / docs / libcurl / libcurl-easy.html
1 <html><head>
2 <title>libcurl man page</title>
3 <meta name="generator" content="roffit 0.7">
4 <STYLE type="text/css">
5 P.level0 {
6  padding-left: 2em;
7 }
8
9 P.level1 {
10  padding-left: 4em;
11 }
12
13 P.level2 {
14  padding-left: 6em;
15 }
16
17 span.emphasis {
18  font-style: italic;
19 }
20
21 span.bold {
22  font-weight: bold;
23 }
24
25 span.manpage {
26  font-weight: bold;
27 }
28
29 h2.nroffsh {
30  background-color: #e0e0e0;
31 }
32
33 span.nroffip {
34  font-weight: bold;
35  font-size: 120%;
36  font-family: monospace;
37 }
38
39 p.roffit {
40  text-align: center;
41  font-size: 80%;
42 }
43 </STYLE>
44 </head><body>
45
46 <p class="level0"><a name="NAME"></a><h2 class="nroffsh">NAME</h2>
47 <p class="level0">libcurl-easy - easy interface overview <a name="DESCRIPTION"></a><h2 class="nroffsh">DESCRIPTION</h2>
48 <p class="level0">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 <a class="emphasis" href="./curl_easy_init.html">curl_easy_init(3)</a> to get the handle. 
49 <p class="level0">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. <a class="emphasis" href="./curl_easy_setopt.html">curl_easy_setopt(3)</a> is used for all this. 
50 <p class="level0">When all is setup, you tell libcurl to perform the transfer using <a class="emphasis" href="./curl_easy_perform.html">curl_easy_perform(3)</a>.  It will then do the entire operation and won't return until it is done (successfully or not). 
51 <p class="level0">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 <a class="emphasis" href="./curl_easy_cleanup.html">curl_easy_cleanup(3)</a>. If you want persistent connections, you don't cleanup immediately, but instead run ahead and perform other transfers using the same easy handle. 
52 <p class="level0"><p class="roffit">
53  This HTML page was made with <a href="http://daniel.haxx.se/projects/roffit/">roffit</a>.
54 </body></html>