mirror/curl
2
0
Fork 0
mirror of https://github.com/curl/curl.git synced 2025-03-07 15:27:17 +08:00
Code Issues Packages Projects Releases Wiki Activity
beeeb85a78
curl/docs/CURL-DISABLE.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

192 lines
3.3 KiB
Markdown
Raw Normal View History

reuse: add copyright + license info to individual docs/*.md files Instead of use 'docs/*.md' in dep5. For clarity and avoiding a wide- matching wildcard. + Remove mention of old files from .reuse/dep5 + add info to .github/dependabot.yml + make scripts/copyright.pl warn on non-matching patterns Closes #13245
2024-03-31 17:52:28 +08:00
<!--
Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
-->
CURL-DISABLE: initial docs for the CURL_DISABLE_* defines The disable-scan script used in test 1165 is extended to also verify that the docs cover all used defines and all defines offered by configure. Reported-by: SLDiggie on github Fixes #4545 Closes #4587
2019-11-12 00:16:04 +08:00
# Code defines to disable features and protocols
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
## `CURL_DISABLE_ALTSVC`
alt-svc: enable by default Remove CURLALTSVC_IMMEDIATELY, which was never implemented/supported. alt-svc support in curl is no longer considered experimental Closes #5868
2020-10-26 06:08:54 +08:00
Disable support for Alt-Svc: HTTP headers.
lib: --disable-bindlocal builds curl without local binding support
2023-08-17 20:36:30 +08:00
## `CURL_DISABLE_BINDLOCAL`
Disable support for binding the local end of connections.
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
## `CURL_DISABLE_COOKIES`
CURL-DISABLE: initial docs for the CURL_DISABLE_* defines The disable-scan script used in test 1165 is extended to also verify that the docs cover all used defines and all defines offered by configure. Reported-by: SLDiggie on github Fixes #4545 Closes #4587
2019-11-12 00:16:04 +08:00
Disable support for HTTP cookies.
lib: add ability to disable auths individually Both with configure and cmake Closes #11490
2023-07-20 22:09:04 +08:00
## `CURL_DISABLE_BASIC_AUTH`
CURL-DISABLE: initial docs for the CURL_DISABLE_* defines The disable-scan script used in test 1165 is extended to also verify that the docs cover all used defines and all defines offered by configure. Reported-by: SLDiggie on github Fixes #4545 Closes #4587
2019-11-12 00:16:04 +08:00
lib: add ability to disable auths individually Both with configure and cmake Closes #11490
2023-07-20 22:09:04 +08:00
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-SIG4** support.
CURL-DISABLE: initial docs for the CURL_DISABLE_* defines The disable-scan script used in test 1165 is extended to also verify that the docs cover all used defines and all defines offered by configure. Reported-by: SLDiggie on github Fixes #4545 Closes #4587
2019-11-12 00:16:04 +08:00
curl: add options for safe/no CA bundle search (Windows) Add `CURL_CA_SEARCH_SAFE` build-time option to enable CA bundle search in the `curl` tool directory. The lookup method was already used to find `.curlrc` and `_curlrc` (on Windows). On Windows it overrides the unsafe default `SearchPath()` method. Enable with: - cmake: `-DCURL_CA_SEARCH_SAFE=ON` - autotools: `--enable-ca-search-safe` - raw: `CPPFLAGS=-DCURL_CA_SEARCH_SAFE` On Windows, before this patch the whole `PATH` was searched for a CA bundle. `PATH` may contain unwanted or world-writable locations, including the current directory. Searching them all is convenient to pick up any CA bundle, but not secure. The Muldersoft curl distro implements such CA search via a custom patch for Windows: https://github.com/lordmulder/cURL-build-win32/blob/cd652d4792c177c98b08b4309d3cac2b8dbbf9b0/patch/curl_tool_doswin.diff#L50 MSYS2/mingw-w64 distro has also been rolling a patch solving this: https://github.com/msys2/MINGW-packages/blob/master/mingw-w64-curl/0001-Make-cURL-relocatable.patch https://github.com/msys2/MINGW-packages/blob/master/mingw-w64-curl/pathtools.c Also add option to fully disable Windows CA search: - cmake: `-DCURL_DISABLE_CA_SEARCH=ON` - autotools: `--disable-ca-search` - raw: `CPPFLAGS=-DCURL_DISABLE_CA_SEARCH`. Both options are considered EXPERIMENTAL, with possible incompatible changes or even (partial) removal in the future, depending on feedback. An alternative, secure option is to embed the CA bundle into the binary. Safe search can be extended to other platforms if necessary or useful, by using `_NSGetExecutablePath()` (macOS), `/proc/self/exe` (Linux/Cygwin), or `argv[0]`. Closes #14582
2024-08-18 15:51:49 +08:00
## `CURL_DISABLE_CA_SEARCH`
Disable unsafe CA bundle search in PATH on Windows.
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
## `CURL_DISABLE_DICT`
CURL-DISABLE: initial docs for the CURL_DISABLE_* defines The disable-scan script used in test 1165 is extended to also verify that the docs cover all used defines and all defines offered by configure. Reported-by: SLDiggie on github Fixes #4545 Closes #4587
2019-11-12 00:16:04 +08:00
Disable the DICT protocol
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
## `CURL_DISABLE_DOH`
CURL-DISABLE: initial docs for the CURL_DISABLE_* defines The disable-scan script used in test 1165 is extended to also verify that the docs cover all used defines and all defines offered by configure. Reported-by: SLDiggie on github Fixes #4545 Closes #4587
2019-11-12 00:16:04 +08:00
Disable DNS-over-HTTPS
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
## `CURL_DISABLE_FILE`
CURL-DISABLE: initial docs for the CURL_DISABLE_* defines The disable-scan script used in test 1165 is extended to also verify that the docs cover all used defines and all defines offered by configure. Reported-by: SLDiggie on github Fixes #4545 Closes #4587
2019-11-12 00:16:04 +08:00
Disable the FILE protocol
configure, cmake, lib: more form api deprecation Introduce a --enable-form-api configure option to control its inclusion in builds. The condition name defined for it is CURL_DISABLE_FORM_API. Form api code is dependent of MIME: configure and CMake handle this dependency automatically: CMake by making it a dependent option explicitly, configure by inheriting the MIME value by default and rejecting explicit incompatible values. "form-api" is now a new hidden test feature. Update libcurl modules to respect this option and adjust tests accordingly. Closes #9621
2022-11-16 00:50:22 +08:00
## `CURL_DISABLE_FORM_API`
Disable the form API
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
## `CURL_DISABLE_FTP`
CURL-DISABLE: initial docs for the CURL_DISABLE_* defines The disable-scan script used in test 1165 is extended to also verify that the docs cover all used defines and all defines offered by configure. Reported-by: SLDiggie on github Fixes #4545 Closes #4587
2019-11-12 00:16:04 +08:00
Disable the FTP (and FTPS) protocol
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
## `CURL_DISABLE_GETOPTIONS`
configure: added --disable-get-easy-options To allow disabling of the curl_easy_option APIs in a build. Closes #5365
2020-08-26 14:30:38 +08:00
Disable the `curl_easy_options` API calls that lets users get information
about existing options to `curl_easy_setopt`.
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
## `CURL_DISABLE_GOPHER`
CURL-DISABLE: initial docs for the CURL_DISABLE_* defines The disable-scan script used in test 1165 is extended to also verify that the docs cover all used defines and all defines offered by configure. Reported-by: SLDiggie on github Fixes #4545 Closes #4587
2019-11-12 00:16:04 +08:00
Disable the GOPHER protocol.
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
## `CURL_DISABLE_HEADERS_API`
headers api: remove EXPERIMENTAL tag Closes #8900
2022-05-30 20:13:48 +08:00
Disable the HTTP header API.
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
## `CURL_DISABLE_HSTS`
hsts: enable by default No longer considered experimental. Closes #6700
2021-03-08 15:30:32 +08:00
Disable the HTTP Strict Transport Security support.
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
## `CURL_DISABLE_HTTP`
CURL-DISABLE: initial docs for the CURL_DISABLE_* defines The disable-scan script used in test 1165 is extended to also verify that the docs cover all used defines and all defines offered by configure. Reported-by: SLDiggie on github Fixes #4545 Closes #4587
2019-11-12 00:16:04 +08:00
Disable the HTTP(S) protocols. Note that this then also disable HTTP proxy
support.
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
## `CURL_DISABLE_HTTP_AUTH`
CURL-DISABLE: initial docs for the CURL_DISABLE_* defines The disable-scan script used in test 1165 is extended to also verify that the docs cover all used defines and all defines offered by configure. Reported-by: SLDiggie on github Fixes #4545 Closes #4587
2019-11-12 00:16:04 +08:00
docs: fix some typos Closes #4680
2019-12-06 19:56:14 +08:00
Disable support for all HTTP authentication methods.
CURL-DISABLE: initial docs for the CURL_DISABLE_* defines The disable-scan script used in test 1165 is extended to also verify that the docs cover all used defines and all defines offered by configure. Reported-by: SLDiggie on github Fixes #4545 Closes #4587
2019-11-12 00:16:04 +08:00
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
## `CURL_DISABLE_IMAP`
CURL-DISABLE: initial docs for the CURL_DISABLE_* defines The disable-scan script used in test 1165 is extended to also verify that the docs cover all used defines and all defines offered by configure. Reported-by: SLDiggie on github Fixes #4545 Closes #4587
2019-11-12 00:16:04 +08:00
Disable the IMAP(S) protocols.
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
## `CURL_DISABLE_LDAP`
CURL-DISABLE: initial docs for the CURL_DISABLE_* defines The disable-scan script used in test 1165 is extended to also verify that the docs cover all used defines and all defines offered by configure. Reported-by: SLDiggie on github Fixes #4545 Closes #4587
2019-11-12 00:16:04 +08:00
Disable the LDAP(S) protocols.
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
## `CURL_DISABLE_LDAPS`
CURL-DISABLE: initial docs for the CURL_DISABLE_* defines The disable-scan script used in test 1165 is extended to also verify that the docs cover all used defines and all defines offered by configure. Reported-by: SLDiggie on github Fixes #4545 Closes #4587
2019-11-12 00:16:04 +08:00
Disable the LDAPS protocol.
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
## `CURL_DISABLE_LIBCURL_OPTION`
CURL-DISABLE: initial docs for the CURL_DISABLE_* defines The disable-scan script used in test 1165 is extended to also verify that the docs cover all used defines and all defines offered by configure. Reported-by: SLDiggie on github Fixes #4545 Closes #4587
2019-11-12 00:16:04 +08:00
Disable the --libcurl option from the curl tool.
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
## `CURL_DISABLE_MIME`
CURL-DISABLE: initial docs for the CURL_DISABLE_* defines The disable-scan script used in test 1165 is extended to also verify that the docs cover all used defines and all defines offered by configure. Reported-by: SLDiggie on github Fixes #4545 Closes #4587
2019-11-12 00:16:04 +08:00
Disable MIME support.
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
## `CURL_DISABLE_MQTT`
mqtt: enable by default No longer considered experimental. Closes #5858
2020-08-31 15:45:09 +08:00
Disable MQTT support.
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
## `CURL_DISABLE_NETRC`
CURL-DISABLE: initial docs for the CURL_DISABLE_* defines The disable-scan script used in test 1165 is extended to also verify that the docs cover all used defines and all defines offered by configure. Reported-by: SLDiggie on github Fixes #4545 Closes #4587
2019-11-12 00:16:04 +08:00
Disable the netrc parser.
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
## `CURL_DISABLE_NTLM`
cmake: sync CURL_DISABLE options Adds the full listing of CURL_DISABLE options to the CMake build. Moves all option code, except for CURL_DISABLE_OPENSSL_AUTO_LOA_CONFIG which resides near OpenSSL configuration, to the same block of code. Also sorts the options here and in the cmake config header. Additionally sorted the CURL-DISABLE listing and fixed the CURL_DISABLE_POP3 option. Closes #7624
2021-08-25 02:27:39 +08:00
Disable support for NTLM.
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
## `CURL_DISABLE_OPENSSL_AUTO_LOAD_CONFIG`
CURL-DISABLE: initial docs for the CURL_DISABLE_* defines The disable-scan script used in test 1165 is extended to also verify that the docs cover all used defines and all defines offered by configure. Reported-by: SLDiggie on github Fixes #4545 Closes #4587
2019-11-12 00:16:04 +08:00
Disable the auto load config support in the OpenSSL backend.
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
## `CURL_DISABLE_PARSEDATE`
CURL-DISABLE: initial docs for the CURL_DISABLE_* defines The disable-scan script used in test 1165 is extended to also verify that the docs cover all used defines and all defines offered by configure. Reported-by: SLDiggie on github Fixes #4545 Closes #4587
2019-11-12 00:16:04 +08:00
Disable date parsing
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
## `CURL_DISABLE_POP3`
CURL-DISABLE: initial docs for the CURL_DISABLE_* defines The disable-scan script used in test 1165 is extended to also verify that the docs cover all used defines and all defines offered by configure. Reported-by: SLDiggie on github Fixes #4545 Closes #4587
2019-11-12 00:16:04 +08:00
cmake: sync CURL_DISABLE options Adds the full listing of CURL_DISABLE options to the CMake build. Moves all option code, except for CURL_DISABLE_OPENSSL_AUTO_LOA_CONFIG which resides near OpenSSL configuration, to the same block of code. Also sorts the options here and in the cmake config header. Additionally sorted the CURL-DISABLE listing and fixed the CURL_DISABLE_POP3 option. Closes #7624
2021-08-25 02:27:39 +08:00
Disable the POP3 protocol
CURL-DISABLE: initial docs for the CURL_DISABLE_* defines The disable-scan script used in test 1165 is extended to also verify that the docs cover all used defines and all defines offered by configure. Reported-by: SLDiggie on github Fixes #4545 Closes #4587
2019-11-12 00:16:04 +08:00
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
## `CURL_DISABLE_PROGRESS_METER`
CURL-DISABLE: initial docs for the CURL_DISABLE_* defines The disable-scan script used in test 1165 is extended to also verify that the docs cover all used defines and all defines offered by configure. Reported-by: SLDiggie on github Fixes #4545 Closes #4587
2019-11-12 00:16:04 +08:00
Disable the built-in progress meter
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
## `CURL_DISABLE_PROXY`
CURL-DISABLE: initial docs for the CURL_DISABLE_* defines The disable-scan script used in test 1165 is extended to also verify that the docs cover all used defines and all defines offered by configure. Reported-by: SLDiggie on github Fixes #4545 Closes #4587
2019-11-12 00:16:04 +08:00
Disable support for proxies
ipfs: add options to disable - CPPFLAGS: `-DCURL_DISABLE_IPFS` - configure: `--disable-ipfs` - cmake: `-DCURL_DISABLE_IPFS=ON` Fixes #14824 Closes #14827
2024-09-08 18:26:45 +08:00
## `CURL_DISABLE_IPFS`
Disable the IPFS/IPNS protocols. This affects the curl tool only, where
IPFS/IPNS protocol support is implemented.
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
## `CURL_DISABLE_RTSP`
CURL-DISABLE: initial docs for the CURL_DISABLE_* defines The disable-scan script used in test 1165 is extended to also verify that the docs cover all used defines and all defines offered by configure. Reported-by: SLDiggie on github Fixes #4545 Closes #4587
2019-11-12 00:16:04 +08:00
Disable the RTSP protocol.
build: add options to disable SHA-512/256 hash algo Existing C macro lacked build-level counterparts. Add them in this patch. - cmake: `-DCURL_DISABLE_SHA512_256=ON` - autotools: `--disable-sha512-256` Also drop the checker exception from `test1165.pl`. Follow-up to cbe41d151d6a100c1f045eaf37ff06b2b2a7b382 #12897 Closes #14753
2024-09-01 22:25:49 +08:00
## `CURL_DISABLE_SHA512_256`
Disable the SHA-512/256 hash algorithm.
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
## `CURL_DISABLE_SHUFFLE_DNS`
CURL-DISABLE: initial docs for the CURL_DISABLE_* defines The disable-scan script used in test 1165 is extended to also verify that the docs cover all used defines and all defines offered by configure. Reported-by: SLDiggie on github Fixes #4545 Closes #4587
2019-11-12 00:16:04 +08:00
Disable the shuffle DNS feature
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
## `CURL_DISABLE_SMB`
CURL-DISABLE: initial docs for the CURL_DISABLE_* defines The disable-scan script used in test 1165 is extended to also verify that the docs cover all used defines and all defines offered by configure. Reported-by: SLDiggie on github Fixes #4545 Closes #4587
2019-11-12 00:16:04 +08:00
Disable the SMB(S) protocols
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
## `CURL_DISABLE_SMTP`
CURL-DISABLE: initial docs for the CURL_DISABLE_* defines The disable-scan script used in test 1165 is extended to also verify that the docs cover all used defines and all defines offered by configure. Reported-by: SLDiggie on github Fixes #4545 Closes #4587
2019-11-12 00:16:04 +08:00
Disable the SMTP(S) protocols
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
## `CURL_DISABLE_SOCKETPAIR`
socketpair: allow CURL_DISABLE_SOCKETPAIR ... to completely disable the use of socketpair Closes #5850
2020-08-14 21:45:08 +08:00
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
Disable the use of `socketpair()` internally to allow waking up and canceling
`curl_multi_poll()`.
socketpair: allow CURL_DISABLE_SOCKETPAIR ... to completely disable the use of socketpair Closes #5850
2020-08-14 21:45:08 +08:00
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
## `CURL_DISABLE_TELNET`
CURL-DISABLE: initial docs for the CURL_DISABLE_* defines The disable-scan script used in test 1165 is extended to also verify that the docs cover all used defines and all defines offered by configure. Reported-by: SLDiggie on github Fixes #4545 Closes #4587
2019-11-12 00:16:04 +08:00
Disable the TELNET protocol
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
## `CURL_DISABLE_TFTP`
CURL-DISABLE: initial docs for the CURL_DISABLE_* defines The disable-scan script used in test 1165 is extended to also verify that the docs cover all used defines and all defines offered by configure. Reported-by: SLDiggie on github Fixes #4545 Closes #4587
2019-11-12 00:16:04 +08:00
Disable the TFTP protocol
docs: spellfixes Pointed by the new CI job
2022-09-21 05:30:19 +08:00
## `CURL_DISABLE_VERBOSE_STRINGS`
CURL-DISABLE: initial docs for the CURL_DISABLE_* defines The disable-scan script used in test 1165 is extended to also verify that the docs cover all used defines and all defines offered by configure. Reported-by: SLDiggie on github Fixes #4545 Closes #4587
2019-11-12 00:16:04 +08:00
Disable verbose strings and error messages.
WebSockets: make support official (non-experimental) Inverts the configure/cmake options to instead provide options that disable WebSockets and have them (ws + wss) enabled by default. Closes #14936
2024-09-27 19:19:55 +08:00
## `CURL_DISABLE_WEBSOCKETS`
Disable the WebSocket protocols.
Reference in New Issue Copy Permalink