blob: 14a9d2ba871090ee4fd161d6822dac0b409d08c3 [file] [log] [blame]
Lucas Eckels9bd90e62012-08-06 15:07:02 -07001.\" **************************************************************************
2.\" * _ _ ____ _
3.\" * Project ___| | | | _ \| |
4.\" * / __| | | | |_) | |
5.\" * | (__| |_| | _ <| |___
6.\" * \___|\___/|_| \_\_____|
7.\" *
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -07008.\" * Copyright (C) 1998 - 2012, 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
12.\" * are also available at http://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-config 1 "25 Oct 2007" "Curl 7.17.1" "curl-config manual"
24.SH NAME
25curl-config \- Get information about a libcurl installation
26.SH SYNOPSIS
27.B curl-config [options]
28.SH DESCRIPTION
29.B curl-config
30displays information about the curl and libcurl installation.
31.SH OPTIONS
32.IP "--ca"
33Displays the built-in path to the CA cert bundle this libcurl uses.
34.IP "--cc"
35Displays the compiler used to build libcurl.
36.IP "--cflags"
37Set of compiler options (CFLAGS) to use when compiling files that use
38libcurl. Currently that is only the include path to the curl include files.
39.IP "--checkfor [version]"
40Specify the oldest possible libcurl version string you want, and this
41script will return 0 if the current installation is new enough or it
42returns 1 and outputs a text saying that the current version is not new
43enough. (Added in 7.15.4)
44.IP "--configure"
45Displays the arguments given to configure when building curl.
46.IP "--feature"
47Lists what particular main features the installed libcurl was built with. At
48the time of writing, this list may include SSL, KRB4 or IPv6. Do not assume
49any particular order. The keywords will be separated by newlines. There may be
50none, one, or several keywords in the list.
51.IP "--help"
52Displays the available options.
53.IP "--libs"
54Shows the complete set of libs and other linker options you will need in order
55to link your application with libcurl.
56.IP "--prefix"
57This is the prefix used when libcurl was installed. Libcurl is then installed
58in $prefix/lib and its header files are installed in $prefix/include and so
59on. The prefix is set with "configure --prefix".
60.IP "--protocols"
61Lists what particular protocols the installed libcurl was built to support. At
62the time of writing, this list may include HTTP, HTTPS, FTP, FTPS, FILE,
63TELNET, LDAP, DICT. Do not assume any particular order. The protocols will
64be listed using uppercase and are separated by newlines. There may be none,
65one, or several protocols in the list. (Added in 7.13.0)
66.IP "--static-libs"
67Shows the complete set of libs and other linker options you will need in order
68to link your application with libcurl statically. (Added in 7.17.1)
69.IP "--version"
70Outputs version information about the installed libcurl.
71.IP "--vernum"
72Outputs version information about the installed libcurl, in numerical mode.
73This outputs the version number, in hexadecimal, with 8 bits for each part;
74major, minor, patch. So that libcurl 7.7.4 would appear as 070704 and libcurl
7512.13.14 would appear as 0c0d0e... Note that the initial zero might be
76omitted. (This option was broken in the 7.15.0 release.)
77.SH "EXAMPLES"
78What linker options do I need when I link with libcurl?
79
80 $ curl-config --libs
81
82What compiler options do I need when I compile using libcurl functions?
83
84 $ curl-config --cflags
85
86How do I know if libcurl was built with SSL support?
87
88 $ curl-config --feature | grep SSL
89
90What's the installed libcurl version?
91
92 $ curl-config --version
93
94How do I build a single file with a one-line command?
95
Bertrand SIMONNETe6cd7382015-07-01 15:39:44 -070096 $ `curl-config --cc --cflags` -o example example.c `curl-config --libs`
Lucas Eckels9bd90e62012-08-06 15:07:02 -070097.SH "SEE ALSO"
98.BR curl (1)