curl/docs/curl-config.1

.\" **************************************************************************
.\" *                                  _   _ ____  _
.\" *  Project                     ___| | | |  _ \| |
.\" *                             / __| | | | |_) | |
.\" *                            | (__| |_| |  _ <| |___
.\" *                             \___|\___/|_| \_\_____|
.\" *
.\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
.\" * are also available at https://curl.se/docs/copyright.html.
.\" *
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
.\" * copies of the Software, and permit persons to whom the Software is
.\" * furnished to do so, under the terms of the COPYING file.
.\" *
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
.\" * KIND, either express or implied.
.\" *
.\" * SPDX-License-Identifier: curl
.\" *
.\" **************************************************************************
.\"
.TH curl-config 1 "25 Oct 2007" "Curl 7.17.1" "curl-config manual"
.SH NAME
curl-config \- Get information about a libcurl installation
.SH SYNOPSIS
.B curl-config [options]
.SH DESCRIPTION
.B curl-config
displays information about the curl and libcurl installation.
.SH OPTIONS
.IP "--ca"
Displays the built-in path to the CA cert bundle this libcurl uses.
.IP "--cc"
Displays the compiler used to build libcurl.
.IP "--cflags"
Set of compiler options (CFLAGS) to use when compiling files that use
libcurl. Currently that is only the include path to the curl include files.
.IP "--checkfor [version]"
Specify the oldest possible libcurl version string you want, and this
script will return 0 if the current installation is new enough or it
returns 1 and outputs a text saying that the current version is not new
enough. (Added in 7.15.4)
.IP "--configure"
Displays the arguments given to configure when building curl.
.IP "--feature"
Lists what particular main features the installed libcurl was built with. At
the time of writing, this list may include SSL, KRB4 or IPv6. Do not assume
any particular order. The keywords will be separated by newlines. There may be
none, one, or several keywords in the list.
.IP "--help"
Displays the available options.
.IP "--libs"
Shows the complete set of libs and other linker options you will need in order
to link your application with libcurl.
.IP "--prefix"
This is the prefix used when libcurl was installed. Libcurl is then installed
in $prefix/lib and its header files are installed in $prefix/include and so
on. The prefix is set with "configure --prefix".
.IP "--protocols"
Lists what particular protocols the installed libcurl was built to support. At
the time of writing, this list may include HTTP, HTTPS, FTP, FTPS, FILE,
TELNET, LDAP, DICT and many more. Do not assume any particular order. The
protocols will be listed using uppercase and are separated by newlines. There
may be none, one, or several protocols in the list. (Added in 7.13.0)
.IP "--ssl-backends"
Lists the SSL backends that were enabled when libcurl was built. It might be
no, one or several names. If more than one name, they will appear
comma-separated. (Added in 7.58.0)
.IP "--static-libs"
Shows the complete set of libs and other linker options you will need in order
to link your application with libcurl statically. (Added in 7.17.1)
.IP "--version"
Outputs version information about the installed libcurl.
.IP "--vernum"
Outputs version information about the installed libcurl, in numerical mode.
This outputs the version number, in hexadecimal, with 8 bits for each part:
major, minor, and patch. So that libcurl 7.7.4 would appear as 070704 and libcurl
12.13.14 would appear as 0c0d0e... Note that the initial zero might be
omitted. (This option was broken in the 7.15.0 release.)
.SH "EXAMPLES"
What linker options do I need when I link with libcurl?
.nf
  $ curl-config --libs
.fi
What compiler options do I need when I compile using libcurl functions?
.nf
  $ curl-config --cflags
.fi
How do I know if libcurl was built with SSL support?
.nf
  $ curl-config --feature | grep SSL
.fi
What's the installed libcurl version?
.nf
  $ curl-config --version
.fi
How do I build a single file with a one-line command?
.nf
  $ `curl-config --cc --cflags` -o example example.c `curl-config --libs`
.fi
.SH "SEE ALSO"
.BR curl (1)
mention the new --protocols 2004-12-24 17:02:23 +08:00			`.\" **************************************************************************`
			`.\" * _ _ ____ _`
			`.\" * Project ___\| \| \| \| _ \\| \|`
			`.\" * / __\| \| \| \| \|_) \| \|`
			`.\" * \| (__\| \|_\| \| _ <\| \|___`
			`.\" * \___\|\___/\|_\| \_\_____\|`
			`.\" *`
copyright: update all copyright lines and remove year ranges - they are mostly pointless in all major jurisdictions - many big corporations and projects already don't use them - saves us from pointless churn - git keeps history for us - the year range is kept in COPYING checksrc is updated to allow non-year using copyright statements Closes #10205 2023-01-02 20:51:48 +08:00			`.\" * Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.`
mention the new --protocols 2004-12-24 17:02:23 +08:00			`.\" *`
			`.\" * This software is licensed as described in the file COPYING, which`
			`.\" * you should have received as part of this distribution. The terms`
curl.se: new home Closes #6172 2020-11-04 21:02:01 +08:00			`.\" * are also available at https://curl.se/docs/copyright.html.`
mention the new --protocols 2004-12-24 17:02:23 +08:00			`.\" *`
			`.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell`
			`.\" * copies of the Software, and permit persons to whom the Software is`
			`.\" * furnished to do so, under the terms of the COPYING file.`
			`.\" *`
			`.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY`
			`.\" * KIND, either express or implied.`
			`.\" *`
			`.\" * SPDX-License-Identifier: curl`
copyright: make repository REUSE compliant Add licensing and copyright information for all files in this repository. This either happens in the file itself as a comment header or in the file `.reuse/dep5`. This commit also adds a Github workflow to check pull requests and adapts copyright.pl to the changes. Closes #8869 2022-05-17 17:16:50 +08:00			`.\" *`
mention the new --protocols 2004-12-24 17:02:23 +08:00			`.\" **************************************************************************`
brand new command, brand new docs! 2001-04-18 21:16:34 +08:00			`.\"`
Added the --static-libs option to curl-config 2007-10-26 06:30:35 +08:00			`.TH curl-config 1 "25 Oct 2007" "Curl 7.17.1" "curl-config manual"`
brand new command, brand new docs! 2001-04-18 21:16:34 +08:00			`.SH NAME`
			`curl-config \- Get information about a libcurl installation`
			`.SH SYNOPSIS`
			`.B curl-config [options]`
			`.SH DESCRIPTION`
			`.B curl-config`
- Anthony Bryan provided a set of patches that cleaned up manual language, corrected spellings and more. 2008-12-22 21:07:13 +08:00			`displays information about the curl and libcurl installation.`
brand new command, brand new docs! 2001-04-18 21:16:34 +08:00			`.SH OPTIONS`
added --ca 2002-10-08 21:30:15 +08:00			`.IP "--ca"`
			`Displays the built-in path to the CA cert bundle this libcurl uses.`
added --cc description and an example 2002-01-21 22:57:07 +08:00			`.IP "--cc"`
			`Displays the compiler used to build libcurl.`
brand new command, brand new docs! 2001-04-18 21:16:34 +08:00			`.IP "--cflags"`
updated to the latest fixes to the shell script 2001-08-16 21:11:29 +08:00			`Set of compiler options (CFLAGS) to use when compiling files that use`
- Anthony Bryan provided a set of patches that cleaned up manual language, corrected spellings and more. 2008-12-22 21:07:13 +08:00			`libcurl. Currently that is only the include path to the curl include files.`
curl-config got a --checkfor option 2006-05-03 06:48:22 +08:00			`.IP "--checkfor [version]"`
removed trailing whitespace 2010-02-15 03:40:18 +08:00			`Specify the oldest possible libcurl version string you want, and this`
			`script will return 0 if the current installation is new enough or it`
			`returns 1 and outputs a text saying that the current version is not new`
curl-config got a --checkfor option 2006-05-03 06:48:22 +08:00			`enough. (Added in 7.15.4)`
Added '--configure' option to curl-config to display original configure arguments when curl was built 2009-11-15 03:23:26 +08:00			`.IP "--configure"`
			`Displays the arguments given to configure when building curl.`
brand new command, brand new docs! 2001-04-18 21:16:34 +08:00			`.IP "--feature"`
			`Lists what particular main features the installed libcurl was built with. At`
			`the time of writing, this list may include SSL, KRB4 or IPv6. Do not assume`
			`any particular order. The keywords will be separated by newlines. There may be`
- Anthony Bryan provided a set of patches that cleaned up manual language, corrected spellings and more. 2008-12-22 21:07:13 +08:00			`none, one, or several keywords in the list.`
brand new command, brand new docs! 2001-04-18 21:16:34 +08:00			`.IP "--help"`
			`Displays the available options.`
			`.IP "--libs"`
			`Shows the complete set of libs and other linker options you will need in order`
			`to link your application with libcurl.`
			`.IP "--prefix"`
			`This is the prefix used when libcurl was installed. Libcurl is then installed`
fixed an nroff syntax mistake 2001-04-19 19:19:54 +08:00			`in $prefix/lib and its header files are installed in $prefix/include and so`
brand new command, brand new docs! 2001-04-18 21:16:34 +08:00			`on. The prefix is set with "configure --prefix".`
mention the new --protocols 2004-12-24 17:02:23 +08:00			`.IP "--protocols"`
			`Lists what particular protocols the installed libcurl was built to support. At`
David Shaw finally removed all traces of Gopher and we are now officially not supporting it. It hasn't been functioning for years anyway, so this is just finally stating what already was true. And a cleanup at the same time. 2006-01-17 06:14:37 +08:00			`the time of writing, this list may include HTTP, HTTPS, FTP, FTPS, FILE,`
docs/WebSockets.md: docs 2022-09-09 21:11:13 +08:00			`TELNET, LDAP, DICT and many more. Do not assume any particular order. The`
			`protocols will be listed using uppercase and are separated by newlines. There`
			`may be none, one, or several protocols in the list. (Added in 7.13.0)`
curl-config: add --ssl-backends Lists all SSL backends that were enabled at build-time. Suggested-by: Oleg Pudeyev Fixes #2128 2017-11-30 15:57:36 +08:00			`.IP "--ssl-backends"`
			`Lists the SSL backends that were enabled when libcurl was built. It might be`
			`no, one or several names. If more than one name, they will appear`
			`comma-separated. (Added in 7.58.0)`
Added the --static-libs option to curl-config 2007-10-26 06:30:35 +08:00			`.IP "--static-libs"`
			`Shows the complete set of libs and other linker options you will need in order`
mention --static-libs as added in 7.17.1 2007-10-26 15:46:02 +08:00			`to link your application with libcurl statically. (Added in 7.17.1)`
brand new command, brand new docs! 2001-04-18 21:16:34 +08:00			`.IP "--version"`
			`Outputs version information about the installed libcurl.`
added 'curl-config --vernum' for hardcore hex version output 2001-05-28 22:58:07 +08:00			`.IP "--vernum"`
			`Outputs version information about the installed libcurl, in numerical mode.`
docs: fix two typos Closes #5292 2020-04-24 22:23:22 +08:00			`This outputs the version number, in hexadecimal, with 8 bits for each part:`
			`major, minor, and patch. So that libcurl 7.7.4 would appear as 070704 and libcurl`
mention the maybe-missing initial zero in the vernum output 2004-12-12 02:38:47 +08:00			`12.13.14 would appear as 0c0d0e... Note that the initial zero might be`
mention brokenness 2005-10-28 20:59:37 +08:00			`omitted. (This option was broken in the 7.15.0 release.)`
Added an examples section with examples I made up for the web page 2001-04-20 22:45:15 +08:00			`.SH "EXAMPLES"`
updated to the latest fixes to the shell script 2001-08-16 21:11:29 +08:00			`What linker options do I need when I link with libcurl?`
docs: spellfixes Pointed by the new CI job 2022-09-21 05:30:19 +08:00			`.nf`
added --cc description and an example 2002-01-21 22:57:07 +08:00			`$ curl-config --libs`
docs: spellfixes Pointed by the new CI job 2022-09-21 05:30:19 +08:00			`.fi`
updated to the latest fixes to the shell script 2001-08-16 21:11:29 +08:00			`What compiler options do I need when I compile using libcurl functions?`
docs: spellfixes Pointed by the new CI job 2022-09-21 05:30:19 +08:00			`.nf`
added --cc description and an example 2002-01-21 22:57:07 +08:00			`$ curl-config --cflags`
docs: spellfixes Pointed by the new CI job 2022-09-21 05:30:19 +08:00			`.fi`
Added an examples section with examples I made up for the web page 2001-04-20 22:45:15 +08:00			`How do I know if libcurl was built with SSL support?`
docs: spellfixes Pointed by the new CI job 2022-09-21 05:30:19 +08:00			`.nf`
added --cc description and an example 2002-01-21 22:57:07 +08:00			`$ curl-config --feature \| grep SSL`
docs: spellfixes Pointed by the new CI job 2022-09-21 05:30:19 +08:00			`.fi`
Added an examples section with examples I made up for the web page 2001-04-20 22:45:15 +08:00			`What's the installed libcurl version?`
docs: spellfixes Pointed by the new CI job 2022-09-21 05:30:19 +08:00			`.nf`
added --cc description and an example 2002-01-21 22:57:07 +08:00			`$ curl-config --version`
docs: spellfixes Pointed by the new CI job 2022-09-21 05:30:19 +08:00			`.fi`
added --cc description and an example 2002-01-21 22:57:07 +08:00			`How do I build a single file with a one-line command?`
docs: spellfixes Pointed by the new CI job 2022-09-21 05:30:19 +08:00			`.nf`
curl-config.1: fix curl-config usage in example The curl-config command must be used twice in the single command line to work properly in some environments. Bug: http://curl.haxx.se/bug/view.cgi?id=3528241 Reported by: Julian Taylor 2012-05-20 21:38:54 +08:00			$ `curl-config --cc --cflags` -o example example.c `curl-config --libs`
docs: spellfixes Pointed by the new CI job 2022-09-21 05:30:19 +08:00			`.fi`
brand new command, brand new docs! 2001-04-18 21:16:34 +08:00			`.SH "SEE ALSO"`
			`.BR curl (1)`