1<!-- 2Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al. 3 4SPDX-License-Identifier: curl 5--> 6 7# Building with CMake 8 9This document describes how to configure, build and install curl and libcurl 10from source code using the CMake build tool. To build with CMake, you of 11course first have to install CMake. The minimum required version of CMake is 12specified in the file `CMakeLists.txt` found in the top of the curl source 13tree. Once the correct version of CMake is installed you can follow the 14instructions below for the platform you are building on. 15 16CMake builds can be configured either from the command line, or from one of 17CMake's GUIs. 18 19# Configuring 20 21A CMake configuration of curl is similar to the autotools build of curl. 22It consists of the following steps after you have unpacked the source. 23 24## Using `cmake` 25 26You can configure for in source tree builds or for a build tree 27that is apart from the source tree. 28 29 - Build in the source tree. 30 31 $ cmake -B . 32 33 - Build in a separate directory (parallel to the curl source tree in this 34 example). The build directory is created for you. 35 36 $ cmake -B ../curl-build 37 38### Fallback for CMake before version 3.13 39 40CMake before version 3.13 does not support the `-B` option. In that case, 41you must create the build directory yourself, `cd` to it and run `cmake` 42from there: 43 44 $ mkdir ../curl-build 45 $ cd ../curl-build 46 $ cmake ../curl 47 48If you want to build in the source tree, it is enough to do this: 49 50 $ cmake . 51 52### Build system generator selection 53 54You can override CMake's default by using `-G <generator-name>`. For example 55on Windows with multiple build systems if you have MinGW-w64 then you could use 56`-G "MinGW Makefiles"`. 57[List of generator names](https://cmake.org/cmake/help/latest/manual/cmake-generators.7.html). 58 59## Using `ccmake` 60 61CMake comes with a curses based interface called `ccmake`. To run `ccmake` 62on a curl use the instructions for the command line cmake, but substitute 63`ccmake` for `cmake`. 64 65This brings up a curses interface with instructions on the bottom of the 66screen. You can press the "c" key to configure the project, and the "g" key to 67generate the project. After the project is generated, you can run make. 68 69## Using `cmake-gui` 70 71CMake also comes with a Qt based GUI called `cmake-gui`. To configure with 72`cmake-gui`, you run `cmake-gui` and follow these steps: 73 74 1. Fill in the "Where is the source code" combo box with the path to 75 the curl source tree. 76 2. Fill in the "Where to build the binaries" combo box with the path to 77 the directory for your build tree, ideally this should not be the same 78 as the source tree, but a parallel directory called curl-build or 79 something similar. 80 3. Once the source and binary directories are specified, press the 81 "Configure" button. 82 4. Select the native build tool that you want to use. 83 5. At this point you can change any of the options presented in the GUI. 84 Once you have selected all the options you want, click the "Generate" 85 button. 86 87# Building 88 89Build (you have to specify the build directory). 90 91 $ cmake --build ../curl-build 92 93## Static builds 94 95The CMake build setup is primarily done to work with shared/dynamic third 96party dependencies. When linking with shared libraries, the dependency "chain" 97is handled automatically by the library loader - on all modern systems. 98 99If you instead link with a static library, you need to provide all the 100dependency libraries already at the link command line. 101 102Figuring out all the dependency libraries for a given library is hard, as it 103might involve figuring out the dependencies of the dependencies and they vary 104between platforms and can change between versions. 105 106When using static dependencies, the build scripts mostly assume that you, the 107user, provide all the necessary additional dependency libraries as additional 108arguments in the build. 109 110Building statically is not for the faint of heart. 111 112### Fallback for CMake before version 3.13 113 114CMake before version 3.13 does not support the `--build` option. In that 115case, you have to `cd` to the build directory and use the building tool that 116corresponds to the build files that CMake generated for you. This example 117assumes that CMake generates `Makefile`: 118 119 $ cd ../curl-build 120 $ make 121 122# Testing 123 124(The test suite does not yet work with the cmake build) 125 126# Installing 127 128Install to default location (you have to specify the build directory). 129 130 $ cmake --install ../curl-build 131 132### Fallback for CMake before version 3.15 133 134CMake before version 3.15 does not support the `--install` option. In that 135case, you have to `cd` to the build directory and use the building tool that 136corresponds to the build files that CMake generated for you. This example 137assumes that CMake generates `Makefile`: 138 139 $ cd ../curl-build 140 $ make install 141 142# CMake build options 143 144- `BUILD_CURL_EXE`: Build curl executable. Default: `ON` 145- `BUILD_EXAMPLES`: Build libcurl examples. Default: `ON` 146- `BUILD_LIBCURL_DOCS`: Build libcurl man pages. Default: `ON` 147- `BUILD_MISC_DOCS`: Build misc man pages (e.g. `curl-config` and `mk-ca-bundle`). Default: `ON` 148- `BUILD_SHARED_LIBS`: Build shared libraries. Default: `ON` 149- `BUILD_STATIC_CURL`: Build curl executable with static libcurl. Default: `OFF` 150- `BUILD_STATIC_LIBS`: Build static libraries. Default: `OFF` 151- `BUILD_TESTING`: Build tests. Default: `ON` 152- `CURL_DEFAULT_SSL_BACKEND`: Override default TLS backend in MultiSSL builds. 153 Accepted values in order of default priority: 154 `wolfssl`, `gnutls`, `mbedtls`, `openssl`, `secure-transport`, `schannel`, `bearssl`, `rustls` 155- `CURL_ENABLE_EXPORT_TARGET`: Enable CMake export target. Default: `ON` 156- `CURL_HIDDEN_SYMBOLS`: Hide libcurl internal symbols (=hide all symbols that are not officially external). Default: `ON` 157- `CURL_LIBCURL_SOVERSION`: Enable libcurl SOVERSION. Default: `ON` for supported platforms 158- `CURL_LIBCURL_VERSIONED_SYMBOLS`: Enable libcurl versioned symbols. Default: `OFF` 159- `CURL_LIBCURL_VERSIONED_SYMBOLS_PREFIX`: Override default versioned symbol prefix. Default: `<TLS-BACKEND>_` or `MULTISSL_` 160- `CURL_LTO`: Enable compiler Link Time Optimizations. Default: `OFF` 161- `CURL_STATIC_CRT`: Build libcurl with static CRT with MSVC (`/MT`). Default: `OFF` 162- `CURL_TARGET_WINDOWS_VERSION`: Minimum target Windows version as hex string. 163- `CURL_TEST_BUNDLES`: Bundle `libtest` and `unittest` tests into single binaries. Default: `OFF` 164- `CURL_WERROR`: Turn compiler warnings into errors. Default: `OFF` 165- `ENABLE_CURLDEBUG`: Enable TrackMemory debug feature: Default: =`ENABLE_DEBUG` 166- `ENABLE_CURL_MANUAL`: Build the man page for curl and enable its `-M`/`--manual` option. Default: `ON` 167- `ENABLE_DEBUG`: Enable curl debug features (for developing curl itself). Default: `OFF` 168- `IMPORT_LIB_SUFFIX`: Import library suffix. Default: `_imp` 169- `LIBCURL_OUTPUT_NAME`: Basename of the curl library. Default: `libcurl` 170- `PICKY_COMPILER`: Enable picky compiler options. Default: `ON` 171- `STATIC_LIB_SUFFIX`: Static library suffix. Default: (empty) 172 173## CA bundle options 174 175- `CURL_CA_BUNDLE`: Path to the CA bundle. Set `none` to disable or `auto` for auto-detection. Default: `auto` 176- `CURL_CA_EMBED`: Path to the CA bundle to embed in the curl tool. Default: (disabled) 177- `CURL_CA_FALLBACK`: Use built-in CA store of TLS backend. Default: `OFF` 178- `CURL_CA_PATH`: Location of default CA path. Set `none` to disable or `auto` for auto-detection. Default: `auto` 179- `CURL_CA_SEARCH_SAFE`: Enable safe CA bundle search (within the curl tool directory) on Windows. Default: `OFF` 180 181## Enabling features 182 183- `CURL_ENABLE_SSL`: Enable SSL support. Default: `ON` 184- `CURL_WINDOWS_SSPI`: Enable SSPI on Windows. Default: =`CURL_USE_SCHANNEL` 185- `ENABLE_IPV6`: Enable IPv6 support. Default: `ON` 186- `ENABLE_THREADED_RESOLVER`: Enable threaded DNS lookup. Default: `ON` if c-ares is not enabled 187- `ENABLE_UNICODE`: Use the Unicode version of the Windows API functions. Default: `OFF` 188- `ENABLE_UNIX_SOCKETS`: Enable Unix domain sockets support. Default: `ON` 189- `USE_ECH`: Enable ECH support. Default: `OFF` 190- `USE_HTTPSRR`: Enable HTTPS RR support for ECH (experimental). Default: `OFF` 191- `USE_OPENSSL_QUIC`: Use OpenSSL and nghttp3 libraries for HTTP/3 support. Default: `OFF` 192 193## Disabling features 194 195- `CURL_DISABLE_ALTSVC`: Disable alt-svc support. Default: `OFF` 196- `CURL_DISABLE_AWS`: Disable **aws-sigv4**. Default: `OFF` 197- `CURL_DISABLE_BASIC_AUTH`: Disable Basic authentication. Default: `OFF` 198- `CURL_DISABLE_BEARER_AUTH`: Disable Bearer authentication. Default: `OFF` 199- `CURL_DISABLE_BINDLOCAL`: Disable local binding support. Default: `OFF` 200- `CURL_DISABLE_CA_SEARCH`: Disable unsafe CA bundle search in PATH on Windows. Default: `OFF` 201- `CURL_DISABLE_COOKIES`: Disable cookies support. Default: `OFF` 202- `CURL_DISABLE_DICT`: Disable DICT. Default: `OFF` 203- `CURL_DISABLE_DIGEST_AUTH`: Disable Digest authentication. Default: `OFF` 204- `CURL_DISABLE_DOH`: Disable DNS-over-HTTPS. Default: `OFF` 205- `CURL_DISABLE_FILE`: Disable FILE. Default: `OFF` 206- `CURL_DISABLE_FORM_API`: Disable **form-api**: Default: =`CURL_DISABLE_MIME` 207- `CURL_DISABLE_FTP`: Disable FTP. Default: `OFF` 208- `CURL_DISABLE_GETOPTIONS`: Disable `curl_easy_options` API for existing options to `curl_easy_setopt`. Default: `OFF` 209- `CURL_DISABLE_GOPHER`: Disable Gopher. Default: `OFF` 210- `CURL_DISABLE_HEADERS_API`: Disable **headers-api** support. Default: `OFF` 211- `CURL_DISABLE_HSTS`: Disable HSTS support. Default: `OFF` 212- `CURL_DISABLE_HTTP`: Disable HTTP. Default: `OFF` 213- `CURL_DISABLE_HTTP_AUTH`: Disable all HTTP authentication methods. Default: `OFF` 214- `CURL_DISABLE_IMAP`: Disable IMAP. Default: `OFF` 215- `CURL_DISABLE_INSTALL`: Disable installation targets. Default: `OFF` 216- `CURL_DISABLE_IPFS`: Disable IPFS. Default: `OFF` 217- `CURL_DISABLE_KERBEROS_AUTH`: Disable Kerberos authentication. Default: `OFF` 218- `CURL_DISABLE_LDAP`: Disable LDAP. Default: `OFF` 219- `CURL_DISABLE_LDAPS`: Disable LDAPS. Default: =`CURL_DISABLE_LDAP` 220- `CURL_DISABLE_LIBCURL_OPTION`: Disable `--libcurl` option from the curl tool. Default: `OFF` 221- `CURL_DISABLE_MIME`: Disable MIME support. Default: `OFF` 222- `CURL_DISABLE_MQTT`: Disable MQTT. Default: `OFF` 223- `CURL_DISABLE_NEGOTIATE_AUTH`: Disable negotiate authentication. Default: `OFF` 224- `CURL_DISABLE_NETRC`: Disable netrc parser. Default: `OFF` 225- `CURL_DISABLE_NTLM`: Disable NTLM support. Default: `OFF` 226- `CURL_DISABLE_OPENSSL_AUTO_LOAD_CONFIG`: Disable automatic loading of OpenSSL configuration. Default: `OFF` 227- `CURL_DISABLE_PARSEDATE`: Disable date parsing. Default: `OFF` 228- `CURL_DISABLE_POP3`: Disable POP3. Default: `OFF` 229- `CURL_DISABLE_PROGRESS_METER`: Disable built-in progress meter. Default: `OFF` 230- `CURL_DISABLE_PROXY`: Disable proxy support. Default: `OFF` 231- `CURL_DISABLE_RTSP`: Disable RTSP. Default: `OFF` 232- `CURL_DISABLE_SHA512_256`: Disable SHA-512/256 hash algorithm. Default: `OFF` 233- `CURL_DISABLE_SHUFFLE_DNS`: Disable shuffle DNS feature. Default: `OFF` 234- `CURL_DISABLE_SMB`: Disable SMB. Default: `OFF` 235- `CURL_DISABLE_SMTP`: Disable SMTP. Default: `OFF` 236- `CURL_DISABLE_SOCKETPAIR`: Disable use of socketpair for curl_multi_poll. Default: `OFF` 237- `CURL_DISABLE_SRP`: Disable TLS-SRP support. Default: `OFF` 238- `CURL_DISABLE_TELNET`: Disable Telnet. Default: `OFF` 239- `CURL_DISABLE_TFTP`: Disable TFTP. Default: `OFF` 240- `CURL_DISABLE_VERBOSE_STRINGS`: Disable verbose strings. Default: `OFF` 241- `CURL_DISABLE_WEBSOCKETS`: Disable WebSocket. Default: `OFF` 242- `HTTP_ONLY`: Disable all protocols except HTTP (This overrides all `CURL_DISABLE_*` options). Default: `OFF` 243 244## Environment 245 246- `CI`: Assume running under CI if set. 247- `CURL_BUILDINFO`: Print `buildinfo.txt` if set. 248- `CURL_CI`: Assume running under CI if set. 249 250## CMake options 251 252- `CMAKE_DEBUG_POSTFIX`: Default: `-d` 253- `CMAKE_IMPORT_LIBRARY_SUFFIX` (see CMake) 254- `CMAKE_INSTALL_BINDIR` (see CMake) 255- `CMAKE_INSTALL_INCLUDEDIR` (see CMake) 256- `CMAKE_INSTALL_LIBDIR` (see CMake) 257- `CMAKE_INSTALL_PREFIX` (see CMake) 258- `CMAKE_STATIC_LIBRARY_SUFFIX` (see CMake) 259- `CMAKE_UNITY_BUILD_BATCH_SIZE`: Set the number of sources in a "unity" unit. Default: `0` (all) 260- `CMAKE_UNITY_BUILD`: Enable "unity" (aka jumbo) builds. Default: `OFF` 261 262Details via CMake 263[variables](https://cmake.org/cmake/help/latest/manual/cmake-variables.7.html) and 264[install directories](https://cmake.org/cmake/help/latest/module/GNUInstallDirs.html). 265 266## Dependencies 267 268- `CURL_BROTLI`: Use brotli. Default: `OFF` 269- `CURL_USE_BEARSSL`: Enable BearSSL for SSL/TLS. Default: `OFF` 270- `CURL_USE_GNUTLS`: Enable GnuTLS for SSL/TLS. Default: `OFF` 271- `CURL_USE_GSASL`: Use libgsasl. Default: `OFF` 272- `CURL_USE_GSSAPI`: Use GSSAPI implementation. Default: `OFF` 273- `CURL_USE_LIBPSL`: Use libpsl. Default: `ON` 274- `CURL_USE_LIBSSH2`: Use libssh2. Default: `ON` 275- `CURL_USE_LIBSSH`: Use libssh. Default: `OFF` 276- `CURL_USE_LIBUV`: Use libuv for event-based tests. Default: `OFF` 277- `CURL_USE_MBEDTLS`: Enable mbedTLS for SSL/TLS. Default: `OFF` 278- `CURL_USE_OPENSSL`: Enable OpenSSL for SSL/TLS. Default: `ON` if no other TLS backend was enabled. 279- `CURL_USE_PKGCONFIG`: Enable `pkg-config` to detect dependencies. Default: `ON` for Unix, vcpkg, MinGW if not cross-compiling. 280- `CURL_USE_RUSTLS`: Enable Rustls for SSL/TLS. Default: `OFF` 281- `CURL_USE_SCHANNEL`: Enable Windows native SSL/TLS (Schannel). Default: `OFF` 282- `CURL_USE_SECTRANSP`: Enable Apple OS native SSL/TLS (Secure Transport). Default: `OFF` 283- `CURL_USE_WOLFSSH`: Use wolfSSH. Default: `OFF` 284- `CURL_USE_WOLFSSL`: Enable wolfSSL for SSL/TLS. Default: `OFF` 285- `CURL_ZLIB`: Use zlib (`ON`, `OFF` or `AUTO`). Default: `AUTO` 286- `CURL_ZSTD`: Use zstd. Default: `OFF` 287- `ENABLE_ARES`: Enable c-ares support. Default: `OFF` 288- `USE_APPLE_IDN`: Use Apple built-in IDN support. Default: `OFF` 289- `USE_LIBIDN2`: Use libidn2 for IDN support. Default: `ON` 290- `USE_LIBRTMP`: Enable librtmp from rtmpdump. Default: `OFF` 291- `USE_MSH3`: Use msh3/msquic library for HTTP/3 support. Default: `OFF` 292- `USE_NGHTTP2`: Use nghttp2 library. Default: `ON` 293- `USE_NGTCP2`: Use ngtcp2 and nghttp3 libraries for HTTP/3 support. Default: `OFF` 294- `USE_QUICHE`: Use quiche library for HTTP/3 support. Default: `OFF` 295- `USE_WIN32_IDN`: Use WinIDN for IDN support. Default: `OFF` 296- `USE_WIN32_LDAP`: Use Windows LDAP implementation. Default: `ON` 297 298## Dependency options (via CMake) 299 300- `OPENSSL_ROOT_DIR`: Set this variable to the root installation of OpenSSL (and forks). 301- `ZLIB_INCLUDE_DIR`: The zlib include directory. 302- `ZLIB_LIBRARY`: Path to `zlib` library. 303 304## Dependency options 305 306- `PERL_EXECUTABLE` Perl binary used throughout the build and tests. 307- `BEARSSL_INCLUDE_DIR`: The BearSSL include directory. 308- `BEARSSL_LIBRARY`: Path to `bearssl` library. 309- `BROTLI_INCLUDE_DIR`: The brotli include directory. 310- `BROTLICOMMON_LIBRARY`: Path to `brotlicommon` library. 311- `BROTLIDEC_LIBRARY`: Path to `brotlidec` library. 312- `CARES_INCLUDE_DIR`: The c-ares include directory. 313- `CARES_LIBRARY`: Path to `cares` library. 314- `GSS_ROOT_DIR`: Set this variable to the root installation of GSS. (also supported as environment) 315- `LDAP_LIBRARY`: Name or full path to `ldap` library. Default: `ldap` 316- `LDAP_LBER_LIBRARY`: Name or full path to `lber` library. Default: `lber` 317- `LDAP_INCLUDE_DIR`: Path to LDAP include directory. 318- `LIBGSASL_INCLUDE_DIR`: The libgsasl include directory. 319- `LIBGSASL_LIBRARY`: Path to `libgsasl` library. 320- `LIBIDN2_INCLUDE_DIR`: The libidn2 include directory. 321- `LIBIDN2_LIBRARY`: Path to `libidn2` library. 322- `LIBPSL_INCLUDE_DIR`: The libpsl include directory. 323- `LIBPSL_LIBRARY`: Path to `libpsl` library. 324- `LIBSSH_INCLUDE_DIR`: The libssh include directory. 325- `LIBSSH_LIBRARY`: Path to `libssh` library. 326- `LIBSSH2_INCLUDE_DIR`: The libssh2 include directory. 327- `LIBSSH2_LIBRARY`: Path to `libssh2` library. 328- `LIBUV_INCLUDE_DIR`: The libuv include directory. 329- `LIBUV_LIBRARY`: Path to `libuv` library. 330- `MSH3_INCLUDE_DIR`: The msh3 include directory. 331- `MSH3_LIBRARY`: Path to `msh3` library. 332- `MBEDTLS_INCLUDE_DIR`: The mbedTLS include directory. 333- `MBEDTLS_LIBRARY`: Path to `mbedtls` library. 334- `MBEDX509_LIBRARY`: Path to `mbedx509` library. 335- `MBEDCRYPTO_LIBRARY`: Path to `mbedcrypto` library. 336- `NGHTTP2_INCLUDE_DIR`: The nghttp2 include directory. 337- `NGHTTP2_LIBRARY`: Path to `nghttp2` library. 338- `NGHTTP3_INCLUDE_DIR`: The nghttp3 include directory. 339- `NGHTTP3_LIBRARY`: Path to `nghttp3` library. 340- `NGTCP2_INCLUDE_DIR`: The ngtcp2 include directory. 341- `NGTCP2_LIBRARY`: Path to `ngtcp2` library. 342- `NETTLE_INCLUDE_DIR`: The nettle include directory. 343- `NETTLE_LIBRARY`: Path to `nettle` library. 344- `QUICHE_INCLUDE_DIR`: The quiche include directory. 345- `QUICHE_LIBRARY`: Path to `quiche` library. 346- `RUSTLS_INCLUDE_DIR`: The Rustls include directory. 347- `RUSTLS_LIBRARY`: Path to `rustls` library. 348- `WOLFSSH_INCLUDE_DIR`: The wolfSSH include directory. 349- `WOLFSSH_LIBRARY`: Path to `wolfssh` library. 350- `WOLFSSL_INCLUDE_DIR`: The wolfSSL include directory. 351- `WOLFSSL_LIBRARY`: Path to `wolfssl` library. 352- `ZSTD_INCLUDE_DIR`: The zstd include directory. 353- `ZSTD_LIBRARY`: Path to `zstd` library. 354 355## Test tools 356 357- `APACHECTL`: Default: `apache2ctl` 358- `APXS`: Default: `apxs` 359- `CADDY`: Default: `caddy` 360- `HTTPD_NGHTTPX`: Default: `nghttpx` 361- `HTTPD`: Default: `apache2` 362- `TEST_NGHTTPX`: Default: `nghttpx` 363- `VSFTPD`: Default: `vsftps` 364
