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