curl-config.1 4.4 KB

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