comparison mupdf-source/thirdparty/curl/docs/libcurl/curl_version_info.3 @ 2:b50eed0cc0ef upstream

ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. The directory name has changed: no version number in the expanded directory now.
author Franz Glasner <fzglas.hg@dom66.de>
date Mon, 15 Sep 2025 11:43:07 +0200
parents
children
comparison
equal deleted inserted replaced
1:1d09e1dec1d9 2:b50eed0cc0ef
1 .\" **************************************************************************
2 .\" * _ _ ____ _
3 .\" * Project ___| | | | _ \| |
4 .\" * / __| | | | |_) | |
5 .\" * | (__| |_| | _ <| |___
6 .\" * \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2019, Daniel Stenberg, <daniel@haxx.se>, et al.
9 .\" *
10 .\" * This software is licensed as described in the file COPYING, which
11 .\" * you should have received as part of this distribution. The terms
12 .\" * are also available at https://curl.haxx.se/docs/copyright.html.
13 .\" *
14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15 .\" * copies of the Software, and permit persons to whom the Software is
16 .\" * furnished to do so, under the terms of the COPYING file.
17 .\" *
18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 .\" * KIND, either express or implied.
20 .\" *
21 .\" **************************************************************************
22 .\"
23 .TH curl_version_info 3 "2 Nov 2014" "libcurl 7.40.0" "libcurl Manual"
24 .SH NAME
25 curl_version_info - returns run-time libcurl version info
26 .SH SYNOPSIS
27 .B #include <curl/curl.h>
28 .sp
29 .BI "curl_version_info_data *curl_version_info( CURLversion "age ");"
30 .ad
31 .SH DESCRIPTION
32 Returns a pointer to a filled in static struct with information about various
33 features in the running version of libcurl. \fIage\fP should be set to the
34 version of this functionality by the time you write your program. This way,
35 libcurl will always return a proper struct that your program understands,
36 while programs in the future might get a different
37 struct. \fBCURLVERSION_NOW\fP will be the most recent one for the library you
38 have installed:
39
40 data = curl_version_info(CURLVERSION_NOW);
41
42 Applications should use this information to judge if things are possible to do
43 or not, instead of using compile-time checks, as dynamic/DLL libraries can be
44 changed independent of applications.
45
46 The curl_version_info_data struct looks like this
47
48 .nf
49 typedef struct {
50 CURLversion age; /* see description below */
51
52 /* when 'age' is 0 or higher, the members below also exist: */
53 const char *version; /* human readable string */
54 unsigned int version_num; /* numeric representation */
55 const char *host; /* human readable string */
56 int features; /* bitmask, see below */
57 char *ssl_version; /* human readable string */
58 long ssl_version_num; /* not used, always zero */
59 const char *libz_version; /* human readable string */
60 const char * const *protocols; /* protocols */
61
62 /* when 'age' is 1 or higher, the members below also exist: */
63 const char *ares; /* human readable string */
64 int ares_num; /* number */
65
66 /* when 'age' is 2 or higher, the member below also exists: */
67 const char *libidn; /* human readable string */
68
69 /* when 'age' is 3 or higher (7.16.1 or later), the members below also
70 exist */
71 int iconv_ver_num; /* '_libiconv_version' if iconv support enabled */
72
73 const char *libssh_version; /* human readable string */
74
75 /* when 'age' is 4 or higher (7.57.0 or later), the members below also
76 exist */
77 unsigned int brotli_ver_num; /* Numeric Brotli version
78 (MAJOR << 24) | (MINOR << 12) | PATCH */
79 const char *brotli_version; /* human readable string. */
80
81 /* when 'age is CURLVERSION_SIXTH or alter (7.66.0 or later), these fields
82 also exist */
83 unsigned int nghttp2_ver_num; /* Numeric nghttp2 version
84 (MAJOR << 16) | (MINOR << 8) | PATCH */
85 const char *nghttp2_version; /* human readable string. */
86
87 const char *quic_version; /* human readable quic (+ HTTP/3) library +
88 version or NULL */
89
90 } curl_version_info_data;
91 .fi
92
93 \fIage\fP describes what the age of this struct is. The number depends on how
94 new the libcurl you're using is. You are however guaranteed to get a struct
95 that you have a matching struct for in the header, as you tell libcurl your
96 "age" with the input argument.
97
98 \fIversion\fP is just an ascii string for the libcurl version.
99
100 \fIversion_num\fP is a 24 bit number created like this: <8 bits major number>
101 | <8 bits minor number> | <8 bits patch number>. Version 7.9.8 is therefore
102 returned as 0x070908.
103
104 \fIhost\fP is an ascii string showing what host information that this libcurl
105 was built for. As discovered by a configure script or set by the build
106 environment.
107
108 \fIfeatures\fP can have none, one or more bits set, and the currently defined
109 bits are:
110 .RS
111 .IP CURL_VERSION_ALTSVC
112 HTTP Alt-Svc parsing and the associated options (Added in 7.64.1)
113 .IP CURL_VERSION_ASYNCHDNS
114 libcurl was built with support for asynchronous name lookups, which allows
115 more exact timeouts (even on Windows) and less blocking when using the multi
116 interface. (added in 7.10.7)
117 .IP CURL_VERSION_BROTLI
118 supports HTTP Brotli content encoding using libbrotlidec (Added in 7.57.0)
119 .IP CURL_VERSION_CONV
120 libcurl was built with support for character conversions, as provided by the
121 CURLOPT_CONV_* callbacks. (Added in 7.15.4)
122 .IP CURL_VERSION_CURLDEBUG
123 libcurl was built with memory tracking debug capabilities. This is mainly of
124 interest for libcurl hackers. (added in 7.19.6)
125 .IP CURL_VERSION_DEBUG
126 libcurl was built with debug capabilities (added in 7.10.6)
127 .IP CURL_VERSION_GSSAPI
128 libcurl was built with support for GSS-API. This makes libcurl use provided
129 functions for Kerberos and SPNEGO authentication. It also allows libcurl
130 to use the current user credentials without the app having to pass them on.
131 (Added in 7.38.0)
132 .IP CURL_VERSION_GSSNEGOTIATE
133 supports HTTP GSS-Negotiate (added in 7.10.6)
134 .IP CURL_VERSION_HTTPS_PROXY
135 libcurl was built with support for HTTPS-proxy.
136 (Added in 7.52.0)
137 .IP CURL_VERSION_HTTP2
138 libcurl was built with support for HTTP2.
139 (Added in 7.33.0)
140 .IP CURL_VERSION_HTTP3
141 HTTP/3 and QUIC support are built-in (Added in 7.66.0)
142 .IP CURL_VERSION_IDN
143 libcurl was built with support for IDNA, domain names with international
144 letters. (Added in 7.12.0)
145 .IP CURL_VERSION_IPV6
146 supports IPv6
147 .IP CURL_VERSION_KERBEROS4
148 supports Kerberos V4 (when using FTP)
149 .IP CURL_VERSION_KERBEROS5
150 supports Kerberos V5 authentication for FTP, IMAP, POP3, SMTP and SOCKSv5 proxy
151 (Added in 7.40.0)
152 .IP CURL_VERSION_LARGEFILE
153 libcurl was built with support for large files. (Added in 7.11.1)
154 .IP CURL_VERSION_LIBZ
155 supports HTTP deflate using libz (Added in 7.10)
156 .IP CURL_VERSION_MULTI_SSL
157 libcurl was built with multiple SSL backends. For details, see
158 \fIcurl_global_sslset(3)\fP.
159 (Added in 7.56.0)
160 .IP CURL_VERSION_NTLM
161 supports HTTP NTLM (added in 7.10.6)
162 .IP CURL_VERSION_NTLM_WB
163 libcurl was built with support for NTLM delegation to a winbind helper.
164 (Added in 7.22.0)
165 .IP CURL_VERSION_PSL
166 libcurl was built with support for Mozilla's Public Suffix List. This makes
167 libcurl ignore cookies with a domain that's on the list.
168 (Added in 7.47.0)
169 .IP CURL_VERSION_SPNEGO
170 libcurl was built with support for SPNEGO authentication (Simple and Protected
171 GSS-API Negotiation Mechanism, defined in RFC 2478.) (added in 7.10.8)
172 .IP CURL_VERSION_SSL
173 supports SSL (HTTPS/FTPS) (Added in 7.10)
174 .IP CURL_VERSION_SSPI
175 libcurl was built with support for SSPI. This is only available on Windows and
176 makes libcurl use Windows-provided functions for Kerberos, NTLM, SPNEGO and
177 Digest authentication. It also allows libcurl to use the current user
178 credentials without the app having to pass them on. (Added in 7.13.2)
179 .IP CURL_VERSION_TLSAUTH_SRP
180 libcurl was built with support for TLS-SRP. (Added in 7.21.4)
181 .IP CURL_VERSION_UNIX_SOCKETS
182 libcurl was built with support for Unix domain sockets.
183 (Added in 7.40.0)
184 .RE
185 \fIssl_version\fP is an ASCII string for the TLS library name + version
186 used. If libcurl has no SSL support, this is NULL. For example "Schannel",
187 \&"SecureTransport" or "OpenSSL/1.1.0g".
188
189 \fIssl_version_num\fP is always 0.
190
191 \fIlibz_version\fP is an ASCII string (there is no numerical version). If
192 libcurl has no libz support, this is NULL.
193
194 \fIprotocols\fP is a pointer to an array of char * pointers, containing the
195 names protocols that libcurl supports (using lowercase letters). The protocol
196 names are the same as would be used in URLs. The array is terminated by a NULL
197 entry.
198 .SH RETURN VALUE
199 A pointer to a curl_version_info_data struct.
200 .SH "SEE ALSO"
201 \fIcurl_version(3)\fP