blob: da469e5333295d7dd4541dad63c28a1fd44b7e5a [file] [log] [blame]
Lucas Eckels9bd90e62012-08-06 15:07:02 -07001.\" **************************************************************************
2.\" * _ _ ____ _
3.\" * Project ___| | | | _ \| |
4.\" * / __| | | | |_) | |
5.\" * | (__| |_| | _ <| |___
6.\" * \___|\___/|_| \_\_____|
7.\" *
Haibo Huang24c77a12020-04-29 13:49:57 -07008.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
Lucas Eckels9bd90e62012-08-06 15:07:02 -07009.\" *
10.\" * This software is licensed as described in the file COPYING, which
11.\" * you should have received as part of this distribution. The terms
Alex Deymo8f1a2142016-06-28 14:49:26 -070012.\" * are also available at https://curl.haxx.se/docs/copyright.html.
Lucas Eckels9bd90e62012-08-06 15:07:02 -070013.\" *
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.\"
Haibo Huangca2a8022020-07-10 20:17:42 -070023.TH curl-config 1 "April 26, 2020" "Curl 7.71.1" "curl-config manual"
Elliott Hughes82be86d2017-09-20 17:00:17 -070024
Lucas Eckels9bd90e62012-08-06 15:07:02 -070025.SH NAME
26curl-config \- Get information about a libcurl installation
27.SH SYNOPSIS
28.B curl-config [options]
29.SH DESCRIPTION
30.B curl-config
31displays information about the curl and libcurl installation.
32.SH OPTIONS
33.IP "--ca"
34Displays the built-in path to the CA cert bundle this libcurl uses.
35.IP "--cc"
36Displays the compiler used to build libcurl.
37.IP "--cflags"
38Set of compiler options (CFLAGS) to use when compiling files that use
39libcurl. Currently that is only the include path to the curl include files.
40.IP "--checkfor [version]"
41Specify the oldest possible libcurl version string you want, and this
42script will return 0 if the current installation is new enough or it
43returns 1 and outputs a text saying that the current version is not new
44enough. (Added in 7.15.4)
45.IP "--configure"
46Displays the arguments given to configure when building curl.
47.IP "--feature"
48Lists what particular main features the installed libcurl was built with. At
49the time of writing, this list may include SSL, KRB4 or IPv6. Do not assume
50any particular order. The keywords will be separated by newlines. There may be
51none, one, or several keywords in the list.
52.IP "--help"
53Displays the available options.
54.IP "--libs"
55Shows the complete set of libs and other linker options you will need in order
56to link your application with libcurl.
57.IP "--prefix"
58This is the prefix used when libcurl was installed. Libcurl is then installed
59in $prefix/lib and its header files are installed in $prefix/include and so
60on. The prefix is set with "configure --prefix".
61.IP "--protocols"
62Lists what particular protocols the installed libcurl was built to support. At
63the time of writing, this list may include HTTP, HTTPS, FTP, FTPS, FILE,
64TELNET, LDAP, DICT. Do not assume any particular order. The protocols will
65be listed using uppercase and are separated by newlines. There may be none,
66one, or several protocols in the list. (Added in 7.13.0)
Elliott Hughes0128fe42018-02-27 14:57:55 -080067.IP "--ssl-backends"
68Lists the SSL backends that were enabled when libcurl was built. It might be
69no, one or several names. If more than one name, they will appear
70comma-separated. (Added in 7.58.0)
Lucas Eckels9bd90e62012-08-06 15:07:02 -070071.IP "--static-libs"
72Shows the complete set of libs and other linker options you will need in order
73to link your application with libcurl statically. (Added in 7.17.1)
74.IP "--version"
75Outputs version information about the installed libcurl.
76.IP "--vernum"
77Outputs version information about the installed libcurl, in numerical mode.
Haibo Huang24c77a12020-04-29 13:49:57 -070078This outputs the version number, in hexadecimal, with 8 bits for each part:
79major, minor, and patch. So that libcurl 7.7.4 would appear as 070704 and libcurl
Lucas Eckels9bd90e62012-08-06 15:07:02 -07008012.13.14 would appear as 0c0d0e... Note that the initial zero might be
81omitted. (This option was broken in the 7.15.0 release.)
82.SH "EXAMPLES"
83What linker options do I need when I link with libcurl?
84
85 $ curl-config --libs
86
87What compiler options do I need when I compile using libcurl functions?
88
89 $ curl-config --cflags
90
91How do I know if libcurl was built with SSL support?
92
93 $ curl-config --feature | grep SSL
94
95What's the installed libcurl version?
96
97 $ curl-config --version
98
99How do I build a single file with a one-line command?
100
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -0700101 $ `curl-config --cc --cflags` -o example example.c `curl-config --libs`
Lucas Eckels9bd90e62012-08-06 15:07:02 -0700102.SH "SEE ALSO"
103.BR curl (1)