Commit 306192ba authored by Daniel Stenberg's avatar Daniel Stenberg
Browse files

curl_global_init.3: improved formatting of the flags

parent bbd99a27
Loading
Loading
Loading
Loading
+7 −13
Original line number Original line Diff line number Diff line
@@ -56,14 +56,12 @@ during that time and it could cause a deadlock.


See the description in \fIlibcurl(3)\fP of global environment requirements for
See the description in \fIlibcurl(3)\fP of global environment requirements for
details of how to use this function.
details of how to use this function.

.SH FLAGS
.SH FLAGS
.TP 5
.IP CURL_GLOBAL_ALL
.B CURL_GLOBAL_ALL
Initialize everything possible. This sets all known bits except
Initialize everything possible. This sets all known bits except
\fBCURL_GLOBAL_ACK_EINTR\fP.
\fBCURL_GLOBAL_ACK_EINTR\fP.
.TP

.B CURL_GLOBAL_SSL
.IP CURL_GLOBAL_SSL
Initialize SSL.
Initialize SSL.


The implication here is that if this bit is not set, the initialization of the
The implication here is that if this bit is not set, the initialization of the
@@ -73,23 +71,19 @@ backend libcurl uses.


Doing TLS based transfers without having the TLS layer initialized may lead to
Doing TLS based transfers without having the TLS layer initialized may lead to
unexpected behaviors.
unexpected behaviors.
.TP
.IP CURL_GLOBAL_WIN32
.B CURL_GLOBAL_WIN32
Initialize the Win32 socket libraries.
Initialize the Win32 socket libraries.


The implication here is that if this bit is not set, the initialization of
The implication here is that if this bit is not set, the initialization of
winsock has to be done by the application or you risk getting undefined
winsock has to be done by the application or you risk getting undefined
behaviors. This option exists for when the initialization is handled outside
behaviors. This option exists for when the initialization is handled outside
of libcurl so there's no need for libcurl to do it again.
of libcurl so there's no need for libcurl to do it again.
.TP
.IP CURL_GLOBAL_NOTHING
.B CURL_GLOBAL_NOTHING
Initialise nothing extra. This sets no bit.
Initialise nothing extra. This sets no bit.
.TP
.IP CURL_GLOBAL_DEFAULT
.B CURL_GLOBAL_DEFAULT
A sensible default. It will init both SSL and Win32. Right now, this equals
A sensible default. It will init both SSL and Win32. Right now, this equals
the functionality of the \fBCURL_GLOBAL_ALL\fP mask.
the functionality of the \fBCURL_GLOBAL_ALL\fP mask.
.TP
.IP CURL_GLOBAL_ACK_EINTR
.B CURL_GLOBAL_ACK_EINTR
When this flag is set, curl will acknowledge EINTR condition when connecting
When this flag is set, curl will acknowledge EINTR condition when connecting
or when waiting for data.  Otherwise, curl waits until full timeout
or when waiting for data.  Otherwise, curl waits until full timeout
elapses. (Added in 7.30.0)
elapses. (Added in 7.30.0)