mirror of
https://github.com/moparisthebest/curl
synced 2024-11-05 17:15:04 -05:00
a3e5d81765
made the libcurl.3 one a more generic overview
30 lines
1.3 KiB
Groff
30 lines
1.3 KiB
Groff
.\" You can view this file with:
|
|
.\" nroff -man [file]
|
|
.\" $Id$
|
|
.\"
|
|
.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" in various docs and sources), which you
|
|
use as input to the easy interface functions you use. Use
|
|
\fIcurl_easy_init()\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()\fP is used for all this.
|
|
|
|
When all is setup, you tell libcurl to perform the transfer using
|
|
\fIcurl_easy_perform()\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()\fP. If you want persistant connections, you don't
|
|
cleanup immediately, but instead run ahead and perform other transfers using
|
|
the same easy handle.
|
|
|