docs/libcurl/curl_version_info.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2017, 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 "December 29, 2017" "libcurl 7.59.0" "libcurl Manual"
  24
  25 .SH NAME
  26 curl_version_info - returns run-time libcurl version info
  27 .SH SYNOPSIS
  28 .B #include <curl/curl.h>
  29 .sp
  30 .BI "curl_version_info_data *curl_version_info( CURLversion "age ");"
  31 .ad
  32 .SH DESCRIPTION
  33 Returns a pointer to a filled in static struct with information about various
  34 features in the running version of libcurl. \fIage\fP should be set to the
  35 version of this functionality by the time you write your program. This way,
  36 libcurl will always return a proper struct that your program understands,
  37 while programs in the future might get a different
  38 struct. \fBCURLVERSION_NOW\fP will be the most recent one for the library you
  39 have installed:
  40
  41         data = curl_version_info(CURLVERSION_NOW);
  42
  43 Applications should use this information to judge if things are possible to do
  44 or not, instead of using compile-time checks, as dynamic/DLL libraries can be
  45 changed independent of applications.
  46
  47 The curl_version_info_data struct looks like this
  48
  49 .nf
  50 typedef struct {
  51   CURLversion age;          /* see description below */
  52
  53   /* when 'age' is 0 or higher, the members below also exist: */
  54   const char *version;      /* human readable string */
  55   unsigned int version_num; /* numeric representation */
  56   const char *host;         /* human readable string */
  57   int features;             /* bitmask, see below */
  58   char *ssl_version;        /* human readable string */
  59   long ssl_version_num;     /* not used, always zero */
  60   const char *libz_version; /* human readable string */
  61   const char * const *protocols; /* protocols */
  62
  63   /* when 'age' is 1 or higher, the members below also exist: */
  64   const char *ares;         /* human readable string */
  65   int ares_num;             /* number */
  66
  67   /* when 'age' is 2 or higher, the member below also exists: */
  68   const char *libidn;       /* human readable string */
  69
  70   /* when 'age' is 3 or higher (7.16.1 or later), the members below also
  71      exist  */
  72   int iconv_ver_num;       /* '_libiconv_version' if iconv support enabled */
  73
  74   const char *libssh_version; /* human readable string */
  75
  76   /* when 'age' is 4 or higher (7.57.0 or later), the members below also
  77      exist  */
  78   unsigned int brotli_ver_num; /* Numeric Brotli version
  79                                   (MAJOR << 24) | (MINOR << 12) | PATCH */
  80   const char *brotli_version; /* human readable string. */
  81
  82 } curl_version_info_data;
  83 .fi
  84
  85 \fIage\fP describes what the age of this struct is. The number depends on how
  86 new the libcurl you're using is. You are however guaranteed to get a struct
  87 that you have a matching struct for in the header, as you tell libcurl your
  88 "age" with the input argument.
  89
  90 \fIversion\fP is just an ascii string for the libcurl version.
  91
  92 \fIversion_num\fP is a 24 bit number created like this: <8 bits major number>
  93 | <8 bits minor number> | <8 bits patch number>. Version 7.9.8 is therefore
  94 returned as 0x070908.
  95
  96 \fIhost\fP is an ascii string showing what host information that this libcurl
  97 was built for. As discovered by a configure script or set by the build
  98 environment.
  99
 100 \fIfeatures\fP can have none, one or more bits set, and the currently defined
 101 bits are:
 102 .RS
 103 .IP CURL_VERSION_IPV6
 104 supports IPv6
 105 .IP CURL_VERSION_KERBEROS4
 106 supports Kerberos V4 (when using FTP)
 107 .IP CURL_VERSION_KERBEROS5
 108 supports Kerberos V5 authentication for FTP, IMAP, POP3, SMTP and SOCKSv5 proxy
 109 (Added in 7.40.0)
 110 .IP CURL_VERSION_SSL
 111 supports SSL (HTTPS/FTPS) (Added in 7.10)
 112 .IP CURL_VERSION_LIBZ
 113 supports HTTP deflate using libz (Added in 7.10)
 114 .IP CURL_VERSION_NTLM
 115 supports HTTP NTLM (added in 7.10.6)
 116 .IP CURL_VERSION_GSSNEGOTIATE
 117 supports HTTP GSS-Negotiate (added in 7.10.6)
 118 .IP CURL_VERSION_DEBUG
 119 libcurl was built with debug capabilities (added in 7.10.6)
 120 .IP CURL_VERSION_CURLDEBUG
 121 libcurl was built with memory tracking debug capabilities. This is mainly of
 122 interest for libcurl hackers. (added in 7.19.6)
 123 .IP CURL_VERSION_ASYNCHDNS
 124 libcurl was built with support for asynchronous name lookups, which allows
 125 more exact timeouts (even on Windows) and less blocking when using the multi
 126 interface. (added in 7.10.7)
 127 .IP CURL_VERSION_SPNEGO
 128 libcurl was built with support for SPNEGO authentication (Simple and Protected
 129 GSS-API Negotiation Mechanism, defined in RFC 2478.) (added in 7.10.8)
 130 .IP CURL_VERSION_LARGEFILE
 131 libcurl was built with support for large files. (Added in 7.11.1)
 132 .IP CURL_VERSION_IDN
 133 libcurl was built with support for IDNA, domain names with international
 134 letters. (Added in 7.12.0)
 135 .IP CURL_VERSION_SSPI
 136 libcurl was built with support for SSPI. This is only available on Windows and
 137 makes libcurl use Windows-provided functions for Kerberos, NTLM, SPNEGO and
 138 Digest authentication. It also allows libcurl to use the current user
 139 credentials without the app having to pass them on. (Added in 7.13.2)
 140 .IP CURL_VERSION_GSSAPI
 141 libcurl was built with support for GSS-API. This makes libcurl use provided
 142 functions for Kerberos and SPNEGO authentication. It also allows libcurl
 143 to use the current user credentials without the app having to pass them on.
 144 (Added in 7.38.0)
 145 .IP CURL_VERSION_CONV
 146 libcurl was built with support for character conversions, as provided by the
 147 CURLOPT_CONV_* callbacks. (Added in 7.15.4)
 148 .IP CURL_VERSION_TLSAUTH_SRP
 149 libcurl was built with support for TLS-SRP. (Added in 7.21.4)
 150 .IP CURL_VERSION_NTLM_WB
 151 libcurl was built with support for NTLM delegation to a winbind helper.
 152 (Added in 7.22.0)
 153 .IP CURL_VERSION_HTTP2
 154 libcurl was built with support for HTTP2.
 155 (Added in 7.33.0)
 156 .IP CURL_VERSION_UNIX_SOCKETS
 157 libcurl was built with support for Unix domain sockets.
 158 (Added in 7.40.0)
 159 .IP CURL_VERSION_PSL
 160 libcurl was built with support for Mozilla's Public Suffix List. This makes
 161 libcurl ignore cookies with a domain that's on the list.
 162 (Added in 7.47.0)
 163 .IP CURL_VERSION_HTTPS_PROXY
 164 libcurl was built with support for HTTPS-proxy.
 165 (Added in 7.52.0)
 166 .IP CURL_VERSION_MULTI_SSL
 167 libcurl was built with multiple SSL backends. For details, see
 168 \fIcurl_global_sslset(3)\fP.
 169 (Added in 7.56.0)
 170 .IP CURL_VERSION_BROTLI
 171 supports HTTP Brotli content encoding using libbrotlidec (Added in 7.57.0)
 172 .RE
 173 \fIssl_version\fP is an ASCII string for the OpenSSL version used. If libcurl
 174 has no SSL support, this is NULL.
 175
 176 \fIssl_version_num\fP is always 0.
 177
 178 \fIlibz_version\fP is an ASCII string (there is no numerical version). If
 179 libcurl has no libz support, this is NULL.
 180
 181 \fIprotocols\fP is a pointer to an array of char * pointers, containing the
 182 names protocols that libcurl supports (using lowercase letters). The protocol
 183 names are the same as would be used in URLs. The array is terminated by a NULL
 184 entry.
 185 .SH RETURN VALUE
 186 A pointer to a curl_version_info_data struct.
 187 .SH "SEE ALSO"
 188 \fIcurl_version(3)\fP
 189