aboutsummaryrefslogtreecommitdiff
path: root/docs/curl_global_init.3
diff options
context:
space:
mode:
Diffstat (limited to 'docs/curl_global_init.3')
-rw-r--r--docs/curl_global_init.329
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/curl_global_init.3 b/docs/curl_global_init.3
new file mode 100644
index 000000000..228cd4c5e
--- /dev/null
+++ b/docs/curl_global_init.3
@@ -0,0 +1,29 @@
+.\" You can view this file with:
+.\" nroff -man [file]
+.\" Written by daniel@haxx.se
+.\"
+.TH curl_global_init 3 "28 May 2001" "libcurl 7.8" "libcurl Manual"
+.SH NAME
+curl_global_init - Global libcurl initialisation
+.SH SYNOPSIS
+.B #include <curl/curl.h>
+.sp
+.BI "CURLcode curl_global_init(void);"
+.ad
+.SH DESCRIPTION
+This function should be called once (no matter how many threads or libcurl
+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.
+
+You must however \fBalways\fP use the \fIcurl_global_cleanup\fP function, as
+that cannot be called automatically for you by libcurl.
+.SH RETURN VALUE
+If this function returns non-zero, something went wrong and you cannot use the
+other curl functions.
+.SH "SEE ALSO"
+.BR curl_global_cleanup "(3), "
+.SH BUGS
+None.
+