aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/curl_global_init.318
1 files changed, 14 insertions, 4 deletions
diff --git a/docs/curl_global_init.3 b/docs/curl_global_init.3
index 1879cc732..be6aeaa29 100644
--- a/docs/curl_global_init.3
+++ b/docs/curl_global_init.3
@@ -1,8 +1,8 @@
.\" You can view this file with:
.\" nroff -man [file]
-.\" Written by daniel@haxx.se
+.\" $Id$
.\"
-.TH curl_global_init 3 "29 May 2001" "libcurl 7.8" "libcurl Manual"
+.TH curl_global_init 3 "31 May 2001" "libcurl 7.8" "libcurl Manual"
.SH NAME
curl_global_init - Global libcurl initialisation
.SH SYNOPSIS
@@ -17,13 +17,23 @@ sessions that'll be used) by every application that uses libcurl.
If this function hasn't been invoked when \fIcurl_easy_init\fP is called, it
will be done automatically by libcurl.
-The flags option should be set to zero. It will be used to tell libcurl what
-specific features it should \fBnot\fP init.
+The flags option is a bit pattern that tells libcurl exact what features to
+init, as described below. Set the desired bits by ORing the values together.
You must however \fBalways\fP use the \fIcurl_global_cleanup\fP function, as
that cannot be called automatically for you by libcurl.
This function was added in libcurl 7.8.
+.SH FLAGS
+.TP 5
+.B CURL_GLOBAL_ALL
+Initialise everyting possible. This sets all known bits.
+.TP
+.B CURL_GLOBAL_SSL
+Initialise SSL
+.TP
+.B CURL_GLOBAL_NOTHING
+Initialise nothing extra. This sets no bit.
.SH RETURN VALUE
If this function returns non-zero, something went wrong and you cannot use the
other curl functions.