8ac77dbe40484ab9ac361917c87ebd3443ada68f
[platform/upstream/curl.git] / docs / curl-config.1
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2005, 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 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 .\" * $Id$
22 .\" **************************************************************************
23 .\"
24 .TH curl-config 1 "25 Jan 2004" "Curl 7.13.0" "curl-config manual"
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 a previous 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 thw include path to the curl include files.
40 .IP "--feature"
41 Lists what particular main features the installed libcurl was built with. At
42 the time of writing, this list may include SSL, KRB4 or IPv6. Do not assume
43 any particular order. The keywords will be separated by newlines. There may be
44 none, one or several keywords in the list.
45 .IP "--help"
46 Displays the available options.
47 .IP "--libs"
48 Shows the complete set of libs and other linker options you will need in order
49 to link your application with libcurl.
50 .IP "--prefix"
51 This is the prefix used when libcurl was installed. Libcurl is then installed
52 in $prefix/lib and its header files are installed in $prefix/include and so
53 on. The prefix is set with "configure --prefix".
54 .IP "--protocols"
55 Lists what particular protocols the installed libcurl was built to support. At
56 the time of writing, this list may include HTTP, HTTPS, FTP, FTPS, FILE,
57 TELNET, LDAP, DICT. Do not assume any particular order. The protocols will
58 be listed using uppercase and are separated by newlines. There may be none,
59 one or several protocols in the list. (Added in 7.13.0)
60 .IP "--version"
61 Outputs version information about the installed libcurl.
62 .IP "--vernum"
63 Outputs version information about the installed libcurl, in numerical mode.
64 This outputs the version number, in hexadecimal, with 8 bits for each part;
65 major, minor, patch. So that libcurl 7.7.4 would appear as 070704 and libcurl
66 12.13.14 would appear as 0c0d0e... Note that the initial zero might be
67 omitted. (This option was broken in the 7.15.0 release.)
68 .SH "EXAMPLES"
69 What linker options do I need when I link with libcurl?
70
71   $ curl-config --libs
72
73 What compiler options do I need when I compile using libcurl functions?
74
75   $ curl-config --cflags
76
77 How do I know if libcurl was built with SSL support?
78
79   $ curl-config --feature | grep SSL
80
81 What's the installed libcurl version?
82
83   $ curl-config --version
84
85 How do I build a single file with a one-line command?
86
87   $ `curl-config --cc --cflags --libs` -o example example.c
88
89 .SH "SEE ALSO"
90 .BR curl (1)