xref: /aosp_15_r20/external/curl/docs/curl-config.md (revision 6236dae45794135f37c4eb022389c904c8b0090d)
1*6236dae4SAndroid Build Coastguard Worker---
2*6236dae4SAndroid Build Coastguard Workerc: Copyright (C) Daniel Stenberg, <[email protected]>, et al.
3*6236dae4SAndroid Build Coastguard WorkerSPDX-License-Identifier: curl
4*6236dae4SAndroid Build Coastguard WorkerTitle: curl-config
5*6236dae4SAndroid Build Coastguard WorkerSection: 1
6*6236dae4SAndroid Build Coastguard WorkerSource: curl-config
7*6236dae4SAndroid Build Coastguard WorkerSee-also:
8*6236dae4SAndroid Build Coastguard Worker  - curl (1)
9*6236dae4SAndroid Build Coastguard WorkerAdded-in: 7.7.2
10*6236dae4SAndroid Build Coastguard Worker---
11*6236dae4SAndroid Build Coastguard Worker
12*6236dae4SAndroid Build Coastguard Worker# NAME
13*6236dae4SAndroid Build Coastguard Worker
14*6236dae4SAndroid Build Coastguard Workercurl-config - Get information about a libcurl installation
15*6236dae4SAndroid Build Coastguard Worker
16*6236dae4SAndroid Build Coastguard Worker# SYNOPSIS
17*6236dae4SAndroid Build Coastguard Worker
18*6236dae4SAndroid Build Coastguard Worker**curl-config [options]**
19*6236dae4SAndroid Build Coastguard Worker
20*6236dae4SAndroid Build Coastguard Worker# DESCRIPTION
21*6236dae4SAndroid Build Coastguard Worker
22*6236dae4SAndroid Build Coastguard Worker**curl-config**
23*6236dae4SAndroid Build Coastguard Workerdisplays information about the curl and libcurl installation.
24*6236dae4SAndroid Build Coastguard Worker
25*6236dae4SAndroid Build Coastguard Worker# OPTIONS
26*6236dae4SAndroid Build Coastguard Worker
27*6236dae4SAndroid Build Coastguard Worker## --ca
28*6236dae4SAndroid Build Coastguard Worker
29*6236dae4SAndroid Build Coastguard WorkerDisplays the built-in path to the CA cert bundle this libcurl uses.
30*6236dae4SAndroid Build Coastguard Worker
31*6236dae4SAndroid Build Coastguard Worker## --cc
32*6236dae4SAndroid Build Coastguard Worker
33*6236dae4SAndroid Build Coastguard WorkerDisplays the compiler used to build libcurl.
34*6236dae4SAndroid Build Coastguard Worker
35*6236dae4SAndroid Build Coastguard Worker## --cflags
36*6236dae4SAndroid Build Coastguard Worker
37*6236dae4SAndroid Build Coastguard WorkerSet of compiler options (CFLAGS) to use when compiling files that use
38*6236dae4SAndroid Build Coastguard Workerlibcurl. Currently that is only the include path to the curl include files.
39*6236dae4SAndroid Build Coastguard Worker
40*6236dae4SAndroid Build Coastguard Worker## --checkfor [version]
41*6236dae4SAndroid Build Coastguard Worker
42*6236dae4SAndroid Build Coastguard WorkerSpecify the oldest possible libcurl version string you want, and this script
43*6236dae4SAndroid Build Coastguard Workerreturns 0 if the current installation is new enough or it returns 1 and
44*6236dae4SAndroid Build Coastguard Workeroutputs a text saying that the current version is not new enough. (Added in
45*6236dae4SAndroid Build Coastguard Worker7.15.4)
46*6236dae4SAndroid Build Coastguard Worker
47*6236dae4SAndroid Build Coastguard Worker## --configure
48*6236dae4SAndroid Build Coastguard Worker
49*6236dae4SAndroid Build Coastguard WorkerDisplays the arguments given to configure when building curl.
50*6236dae4SAndroid Build Coastguard Worker
51*6236dae4SAndroid Build Coastguard Worker## --feature
52*6236dae4SAndroid Build Coastguard Worker
53*6236dae4SAndroid Build Coastguard WorkerLists what particular main features the installed libcurl was built with. At
54*6236dae4SAndroid Build Coastguard Workerthe time of writing, this list may include SSL, KRB4 or IPv6. Do not assume
55*6236dae4SAndroid Build Coastguard Workerany particular order. The keywords are separated by newlines. There may be
56*6236dae4SAndroid Build Coastguard Workernone, one, or several keywords in the list.
57*6236dae4SAndroid Build Coastguard Worker
58*6236dae4SAndroid Build Coastguard Worker## --help
59*6236dae4SAndroid Build Coastguard Worker
60*6236dae4SAndroid Build Coastguard WorkerDisplays the available options.
61*6236dae4SAndroid Build Coastguard Worker
62*6236dae4SAndroid Build Coastguard Worker## --libs
63*6236dae4SAndroid Build Coastguard Worker
64*6236dae4SAndroid Build Coastguard WorkerShows the complete set of libs and other linker options you need in order to
65*6236dae4SAndroid Build Coastguard Workerlink your application with libcurl.
66*6236dae4SAndroid Build Coastguard Worker
67*6236dae4SAndroid Build Coastguard Worker## --prefix
68*6236dae4SAndroid Build Coastguard Worker
69*6236dae4SAndroid Build Coastguard WorkerThis is the prefix used when libcurl was installed. Libcurl is then installed
70*6236dae4SAndroid Build Coastguard Workerin $prefix/lib and its header files are installed in $prefix/include and so
71*6236dae4SAndroid Build Coastguard Workeron. The prefix is set with "configure --prefix".
72*6236dae4SAndroid Build Coastguard Worker
73*6236dae4SAndroid Build Coastguard Worker## --protocols
74*6236dae4SAndroid Build Coastguard Worker
75*6236dae4SAndroid Build Coastguard WorkerLists what particular protocols the installed libcurl was built to support. At
76*6236dae4SAndroid Build Coastguard Workerthe time of writing, this list may include HTTP, HTTPS, FTP, FTPS, FILE,
77*6236dae4SAndroid Build Coastguard WorkerTELNET, LDAP, DICT and many more. Do not assume any particular order. The
78*6236dae4SAndroid Build Coastguard Workerprotocols are listed using uppercase and are separated by newlines. There may
79*6236dae4SAndroid Build Coastguard Workerbe none, one, or several protocols in the list. (Added in 7.13.0)
80*6236dae4SAndroid Build Coastguard Worker
81*6236dae4SAndroid Build Coastguard Worker## --ssl-backends
82*6236dae4SAndroid Build Coastguard Worker
83*6236dae4SAndroid Build Coastguard WorkerLists the SSL backends that were enabled when libcurl was built. It might be
84*6236dae4SAndroid Build Coastguard Workerno, one or several names. If more than one name, they appear comma-separated.
85*6236dae4SAndroid Build Coastguard Worker(Added in 7.58.0)
86*6236dae4SAndroid Build Coastguard Worker
87*6236dae4SAndroid Build Coastguard Worker## --static-libs
88*6236dae4SAndroid Build Coastguard Worker
89*6236dae4SAndroid Build Coastguard WorkerShows the complete set of libs and other linker options you need in order to
90*6236dae4SAndroid Build Coastguard Workerlink your application with libcurl statically. (Added in 7.17.1)
91*6236dae4SAndroid Build Coastguard Worker
92*6236dae4SAndroid Build Coastguard Worker## --version
93*6236dae4SAndroid Build Coastguard Worker
94*6236dae4SAndroid Build Coastguard WorkerOutputs version information about the installed libcurl.
95*6236dae4SAndroid Build Coastguard Worker
96*6236dae4SAndroid Build Coastguard Worker## --vernum
97*6236dae4SAndroid Build Coastguard Worker
98*6236dae4SAndroid Build Coastguard WorkerOutputs version information about the installed libcurl, in numerical mode.
99*6236dae4SAndroid Build Coastguard WorkerThis shows the version number, in hexadecimal, using 8 bits for each part:
100*6236dae4SAndroid Build Coastguard Workermajor, minor, and patch numbers. This makes libcurl 7.7.4 appear as 070704 and
101*6236dae4SAndroid Build Coastguard Workerlibcurl 12.13.14 appear as 0c0d0e... Note that the initial zero might be
102*6236dae4SAndroid Build Coastguard Workeromitted. (This option was broken in the 7.15.0 release.)
103*6236dae4SAndroid Build Coastguard Worker
104*6236dae4SAndroid Build Coastguard Worker# EXAMPLES
105*6236dae4SAndroid Build Coastguard Worker
106*6236dae4SAndroid Build Coastguard WorkerWhat linker options do I need when I link with libcurl?
107*6236dae4SAndroid Build Coastguard Worker~~~
108*6236dae4SAndroid Build Coastguard Worker  $ curl-config --libs
109*6236dae4SAndroid Build Coastguard Worker~~~
110*6236dae4SAndroid Build Coastguard WorkerWhat compiler options do I need when I compile using libcurl functions?
111*6236dae4SAndroid Build Coastguard Worker~~~
112*6236dae4SAndroid Build Coastguard Worker  $ curl-config --cflags
113*6236dae4SAndroid Build Coastguard Worker~~~
114*6236dae4SAndroid Build Coastguard WorkerHow do I know if libcurl was built with SSL support?
115*6236dae4SAndroid Build Coastguard Worker~~~
116*6236dae4SAndroid Build Coastguard Worker  $ curl-config --feature | grep SSL
117*6236dae4SAndroid Build Coastguard Worker~~~
118*6236dae4SAndroid Build Coastguard WorkerWhat's the installed libcurl version?
119*6236dae4SAndroid Build Coastguard Worker~~~
120*6236dae4SAndroid Build Coastguard Worker  $ curl-config --version
121*6236dae4SAndroid Build Coastguard Worker~~~
122*6236dae4SAndroid Build Coastguard WorkerHow do I build a single file with a one-line command?
123*6236dae4SAndroid Build Coastguard Worker~~~
124*6236dae4SAndroid Build Coastguard Worker  $ `curl-config --cc --cflags` -o example source.c `curl-config --libs`
125*6236dae4SAndroid Build Coastguard Worker~~~
126