Annotation of embedaddon/curl/docs/curl-config.1, revision 1.1.1.1

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

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>