~ubuntu-branches/ubuntu/hardy/curl/hardy-updates

« back to all changes in this revision

Viewing changes to docs/libcurl/curl_global_init.3

  • Committer: Bazaar Package Importer
  • Author(s): Martin Pitt
  • Date: 2006-10-30 10:56:48 UTC
  • mfrom: (1.1.6 upstream)
  • Revision ID: james.westby@ubuntu.com-20061030105648-uo8q8w9xklb40b4k
Tags: 7.15.5-1ubuntu1
* Merge from debian unstable. Remaining Ubuntu changes:
  - debian/control: Drop libdb4.2 build dependency.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
.\" You can view this file with:
2
2
.\" nroff -man [file]
3
 
.\" $Id: curl_global_init.3,v 1.5 2006/01/15 23:55:53 bagder Exp $
 
3
.\" $Id: curl_global_init.3,v 1.6 2006-07-26 22:19:42 bagder Exp $
4
4
.\"
5
5
.TH curl_global_init 3 "11 May 2004" "libcurl 7.12" "libcurl Manual"
6
6
.SH NAME
11
11
.BI "CURLcode curl_global_init(long " flags ");"
12
12
.ad
13
13
.SH DESCRIPTION
14
 
This function sets up the program environment that libcurl needs.  Think
15
 
of it as an extension of the library loader.
 
14
This function sets up the program environment that libcurl needs.  Think of it
 
15
as an extension of the library loader.
16
16
 
17
 
This function must be called at least once within a program (a program is
18
 
all the code that shares a memory space) before the program calls any other
19
 
function in libcurl.  The environment it sets up is constant for the life
20
 
of the program and is the same for every program, so multiple calls have
21
 
the same effect as one call.
 
17
This function must be called at least once within a program (a program is all
 
18
the code that shares a memory space) before the program calls any other
 
19
function in libcurl.  The environment it sets up is constant for the life of
 
20
the program and is the same for every program, so multiple calls have the same
 
21
effect as one call.
22
22
 
23
23
The flags option is a bit pattern that tells libcurl exactly what features to
24
24
init, as described below. Set the desired bits by ORing the values together.
25
25
In normal operation, you must specify CURL_GLOBAL_ALL.  Don't use any other
26
 
value unless you are familiar with and mean to control internal operations
27
 
of libcurl.
28
 
 
29
 
\fBThis function is not thread safe.\fP  You must not call it when any
30
 
other thread in the program (i.e. a thread sharing the same memory) is
31
 
running.  This doesn't just mean no other thread that is using
32
 
libcurl.  Because \fIcurl_global_init()\fP calls functions of other
33
 
libraries that are similarly thread unsafe, it could conflict with any
34
 
other thread that uses these other libraries.
35
 
 
36
 
See the description in \fBlibcurl\fP(3) of global environment
37
 
requirements for details of how to use this function.
 
26
value unless you are familiar with and mean to control internal operations of
 
27
libcurl.
 
28
 
 
29
\fBThis function is not thread safe.\fP You must not call it when any other
 
30
thread in the program (i.e. a thread sharing the same memory) is running.
 
31
This doesn't just mean no other thread that is using libcurl.  Because
 
32
\fIcurl_global_init()\fP calls functions of other libraries that are similarly
 
33
thread unsafe, it could conflict with any other thread that uses these other
 
34
libraries.
 
35
 
 
36
See the description in \fBlibcurl\fP(3) of global environment requirements for
 
37
details of how to use this function.
38
38
 
39
39
.SH FLAGS
40
40
.TP 5