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