← Back to branch summary

~ubuntu-branches/ubuntu/lucid/curl/lucid-security

« back to all changes in this revision

Viewing changes to docs/libcurl/libcurl.3

  • Committer: Bazaar Package Importer
  • Author(s): Michael Vogt
  • Date: 2009-04-29 11:10:29 UTC
  • mfrom: (3.2.3 sid)
  • Revision ID: james.westby@ubuntu.com-20090429111029-2j5eiyokfw2bw049
Tags: 7.19.4-1ubuntu1
* Merge from debian unstable, remaining changes:
  - Drop build dependencies: stunnel, libdb4.6-dev, libssh2-1-dev
  - Add build-dependency on openssh-server
  - Drop libssh2-1-dev from libcurl4-openssl-dev's Depends.
  - Call automake-1.9 with --add-missing --copy --force
* drop debian/patches/security_CVE-2009-0037.patch 
  - this patch is part of 7.19.4

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/libcurl/libcurl.3
1
 
.\" $Id: libcurl.3,v 1.13 2006-06-21 17:34:29 bagder Exp $
 
1
.\" $Id: libcurl.3,v 1.14 2008-12-22 13:07:14 bagder Exp $
2
2
.\"
3
3
.TH libcurl 3 "19 March 2002" "libcurl 7.9.6" "libcurl overview"
4
4
.SH NAME
5
5
libcurl \- client-side URL transfers
6
6
.SH DESCRIPTION
7
 
This is an short overview on how to use libcurl in your C programs. There are
 
7
This is a short overview on how to use libcurl in your C programs. There are
8
8
specific man pages for each function mentioned in here. There are also the
9
9
\fIlibcurl-easy(3)\fP man page, the \fIlibcurl-multi(3)\fP man page, the
10
10
\fIlibcurl-share(3)\fP man page and the \fIlibcurl-tutorial(3)\fP man page for
25
25
 
26
26
The easy interface is a synchronous interface with which you call
27
27
\fIcurl_easy_perform(3)\fP and let it perform the transfer. When it is
28
 
completed, the function return and you can continue. More details are found in
 
28
completed, the function returns and you can continue. More details are found in
29
29
the \fIlibcurl-easy(3)\fP man page.
30
30
 
31
31
The multi interface on the other hand is an asynchronous interface, that you
32
32
call and that performs only a little piece of the transfer on each invoke. It
33
33
is perfect if you want to do things while the transfer is in progress, or
34
34
similar. The multi interface allows you to select() on libcurl action, and
35
 
even to easily download multiple files simultaneously using a single thread. See further deails in the \fIlibcurl-multi(3)\fP man page.
 
35
even to easily download multiple files simultaneously using a single thread. See further details in the \fIlibcurl-multi(3)\fP man page.
36
36
 
37
37
You can have multiple easy handles share certain data, even if they are used
38
38
in different threads. This magic is setup using the share interface, as
106
106
you call \fIcurl_easy_cleanup(3)\fP, all the possibly open connections held by
107
107
libcurl will be closed and forgotten.
108
108
 
109
 
Note that the options set with \fIcurl_easy_setopt(3)\fP will be used in on
 
109
Note that the options set with \fIcurl_easy_setopt(3)\fP will be used on
110
110
every repeated \fIcurl_easy_perform(3)\fP call.
111
111
 
112
112
.SH "GLOBAL CONSTANTS"
161
161
modules in the program use libcurl, they all will separately call the
162
162
libcurl functions, and that's OK because only the first
163
163
\fIcurl_global_init()\fP and the last \fIcurl_global_cleanup()\fP in a
164
 
program changes anything.  (libcurl uses a reference count in static
 
164
program change anything.  (libcurl uses a reference count in static
165
165
memory).
166
166
 
167
167
In a C++ module, it is common to deal with the global constant