f66af623cf
Extend `INSTALL-CMAKE` document with the list of available options, a short description and default values. The list may not be 100% complete. There are no component boundaries in CMake, so the line is blurry between curl options, CMake options, CMake Find modules options. I included certain CMake options that seemed useful, and/or have dedicated use withing curl's CMake source. But, all CMake built-in options are usable, as documented upstream in CMake. The naming of the options has a heritage and the inconsistencies with it, including a lack of clear namespace. This may be subject to future updates, also after figuring out which name has special meaning within CMake and/or CMake projects out of unwritten convention or something more tangible. CMake allows to initialize any internal variable via `-D`. This may be useful to pre-initialize/override feature check results. The list doesn't contain these, and they remain officially undocumented. Also: - make adjustments to keep the spellchecker happy. - retrofit description changes to the cmake sources. - stop documenting deprecated `Find*` variables. Reported-by: Daniel Stenberg Fixes https://github.com/curl/curl/discussions/14885 Closes #15388
192 lines
3.3 KiB
Markdown
192 lines
3.3 KiB
Markdown
<!--
|
|
Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
|
|
SPDX-License-Identifier: curl
|
|
-->
|
|
|
|
# Code defines to disable features and protocols
|
|
|
|
## `CURL_DISABLE_ALTSVC`
|
|
|
|
Disable support for Alt-Svc: HTTP headers.
|
|
|
|
## `CURL_DISABLE_BINDLOCAL`
|
|
|
|
Disable support for binding the local end of connections.
|
|
|
|
## `CURL_DISABLE_COOKIES`
|
|
|
|
Disable support for HTTP cookies.
|
|
|
|
## `CURL_DISABLE_BASIC_AUTH`
|
|
|
|
Disable support for the Basic authentication methods.
|
|
|
|
## `CURL_DISABLE_BEARER_AUTH`
|
|
|
|
Disable support for the Bearer authentication methods.
|
|
|
|
## `CURL_DISABLE_DIGEST_AUTH`
|
|
|
|
Disable support for the Digest authentication methods.
|
|
|
|
## `CURL_DISABLE_KERBEROS_AUTH`
|
|
|
|
Disable support for the Kerberos authentication methods.
|
|
|
|
## `CURL_DISABLE_NEGOTIATE_AUTH`
|
|
|
|
Disable support for the negotiate authentication methods.
|
|
|
|
## `CURL_DISABLE_AWS`
|
|
|
|
Disable **aws-sigv4** support.
|
|
|
|
## `CURL_DISABLE_CA_SEARCH`
|
|
|
|
Disable unsafe CA bundle search in PATH on Windows.
|
|
|
|
## `CURL_DISABLE_DICT`
|
|
|
|
Disable the DICT protocol
|
|
|
|
## `CURL_DISABLE_DOH`
|
|
|
|
Disable DNS-over-HTTPS
|
|
|
|
## `CURL_DISABLE_FILE`
|
|
|
|
Disable the FILE protocol
|
|
|
|
## `CURL_DISABLE_FORM_API`
|
|
|
|
Disable the form API
|
|
|
|
## `CURL_DISABLE_FTP`
|
|
|
|
Disable the FTP (and FTPS) protocol
|
|
|
|
## `CURL_DISABLE_GETOPTIONS`
|
|
|
|
Disable the `curl_easy_options` API calls that lets users get information
|
|
about existing options to `curl_easy_setopt`.
|
|
|
|
## `CURL_DISABLE_GOPHER`
|
|
|
|
Disable the GOPHER protocol.
|
|
|
|
## `CURL_DISABLE_HEADERS_API`
|
|
|
|
Disable the HTTP header API.
|
|
|
|
## `CURL_DISABLE_HSTS`
|
|
|
|
Disable the HTTP Strict Transport Security support.
|
|
|
|
## `CURL_DISABLE_HTTP`
|
|
|
|
Disable the HTTP(S) protocols. Note that this then also disable HTTP proxy
|
|
support.
|
|
|
|
## `CURL_DISABLE_HTTP_AUTH`
|
|
|
|
Disable support for all HTTP authentication methods.
|
|
|
|
## `CURL_DISABLE_IMAP`
|
|
|
|
Disable the IMAP(S) protocols.
|
|
|
|
## `CURL_DISABLE_LDAP`
|
|
|
|
Disable the LDAP(S) protocols.
|
|
|
|
## `CURL_DISABLE_LDAPS`
|
|
|
|
Disable the LDAPS protocol.
|
|
|
|
## `CURL_DISABLE_LIBCURL_OPTION`
|
|
|
|
Disable the --libcurl option from the curl tool.
|
|
|
|
## `CURL_DISABLE_MIME`
|
|
|
|
Disable MIME support.
|
|
|
|
## `CURL_DISABLE_MQTT`
|
|
|
|
Disable MQTT support.
|
|
|
|
## `CURL_DISABLE_NETRC`
|
|
|
|
Disable the netrc parser.
|
|
|
|
## `CURL_DISABLE_NTLM`
|
|
|
|
Disable support for NTLM.
|
|
|
|
## `CURL_DISABLE_OPENSSL_AUTO_LOAD_CONFIG`
|
|
|
|
Disable the auto load config support in the OpenSSL backend.
|
|
|
|
## `CURL_DISABLE_PARSEDATE`
|
|
|
|
Disable date parsing
|
|
|
|
## `CURL_DISABLE_POP3`
|
|
|
|
Disable the POP3 protocol
|
|
|
|
## `CURL_DISABLE_PROGRESS_METER`
|
|
|
|
Disable the built-in progress meter
|
|
|
|
## `CURL_DISABLE_PROXY`
|
|
|
|
Disable support for proxies
|
|
|
|
## `CURL_DISABLE_IPFS`
|
|
|
|
Disable the IPFS/IPNS protocols. This affects the curl tool only, where
|
|
IPFS/IPNS protocol support is implemented.
|
|
|
|
## `CURL_DISABLE_RTSP`
|
|
|
|
Disable the RTSP protocol.
|
|
|
|
## `CURL_DISABLE_SHA512_256`
|
|
|
|
Disable the SHA-512/256 hash algorithm.
|
|
|
|
## `CURL_DISABLE_SHUFFLE_DNS`
|
|
|
|
Disable the shuffle DNS feature
|
|
|
|
## `CURL_DISABLE_SMB`
|
|
|
|
Disable the SMB(S) protocols
|
|
|
|
## `CURL_DISABLE_SMTP`
|
|
|
|
Disable the SMTP(S) protocols
|
|
|
|
## `CURL_DISABLE_SOCKETPAIR`
|
|
|
|
Disable the use of `socketpair()` internally to allow waking up and canceling
|
|
`curl_multi_poll()`.
|
|
|
|
## `CURL_DISABLE_TELNET`
|
|
|
|
Disable the TELNET protocol
|
|
|
|
## `CURL_DISABLE_TFTP`
|
|
|
|
Disable the TFTP protocol
|
|
|
|
## `CURL_DISABLE_VERBOSE_STRINGS`
|
|
|
|
Disable verbose strings and error messages.
|
|
|
|
## `CURL_DISABLE_WEBSOCKETS`
|
|
|
|
Disable the WebSocket protocols.
|