From: Daniel Stenberg Date: Mon, 11 Dec 2023 07:52:19 +0000 (+0100) Subject: docs: clean up Protocols: for cmdline options X-Git-Tag: curl-8_6_0~235 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e38a8e0cd0cdab91967ec5c0cb90803097ac0618;p=thirdparty%2Fcurl.git docs: clean up Protocols: for cmdline options ... and some other minor polish. Closes #12496 --- diff --git a/docs/cmdline-opts/aws-sigv4.d b/docs/cmdline-opts/aws-sigv4.d index b771eee6a9..4b480f50ca 100644 --- a/docs/cmdline-opts/aws-sigv4.d +++ b/docs/cmdline-opts/aws-sigv4.d @@ -1,6 +1,7 @@ c: Copyright (C) Daniel Stenberg, , et al. SPDX-License-Identifier: curl Long: aws-sigv4 +Protocols: HTTP Arg: Help: Use AWS V4 signature authentication Category: auth http diff --git a/docs/cmdline-opts/disallow-username-in-url.d b/docs/cmdline-opts/disallow-username-in-url.d index d0537db97a..0e70ba91f6 100644 --- a/docs/cmdline-opts/disallow-username-in-url.d +++ b/docs/cmdline-opts/disallow-username-in-url.d @@ -2,10 +2,9 @@ c: Copyright (C) Daniel Stenberg, , et al. SPDX-License-Identifier: curl Long: disallow-username-in-url Help: Disallow username in URL -Protocols: HTTP Added: 7.61.0 See-also: proto -Category: curl http +Category: curl Example: --disallow-username-in-url $URL Multi: boolean --- diff --git a/docs/cmdline-opts/dns-servers.d b/docs/cmdline-opts/dns-servers.d index bec23a3c35..96be081414 100644 --- a/docs/cmdline-opts/dns-servers.d +++ b/docs/cmdline-opts/dns-servers.d @@ -3,6 +3,7 @@ SPDX-License-Identifier: curl Long: dns-servers Arg: Help: DNS server addrs to use +Protocols: DNS Requires: c-ares Added: 7.33.0 Category: dns diff --git a/docs/cmdline-opts/get.d b/docs/cmdline-opts/get.d index 2e03a255bc..513ea00438 100644 --- a/docs/cmdline-opts/get.d +++ b/docs/cmdline-opts/get.d @@ -3,6 +3,7 @@ SPDX-License-Identifier: curl Long: get Short: G Help: Put the post data in the URL and use GET +Protocols: HTTP Category: http upload Example: --get $URL Example: --get -d "tool=curl" -d "age=old" $URL diff --git a/docs/cmdline-opts/http3-only.d b/docs/cmdline-opts/http3-only.d index c3f0f31aa1..384519b83c 100644 --- a/docs/cmdline-opts/http3-only.d +++ b/docs/cmdline-opts/http3-only.d @@ -11,7 +11,6 @@ See-also: http1.1 http2 http3 Category: http Example: --http3-only $URL Multi: mutex -Experimental: yes --- Instructs curl to use HTTP/3 to the host in the URL, with no fallback to earlier HTTP versions. HTTP/3 can only be used for HTTPS and not for HTTP diff --git a/docs/cmdline-opts/http3.d b/docs/cmdline-opts/http3.d index a8258c4d31..3b05d4a1dc 100644 --- a/docs/cmdline-opts/http3.d +++ b/docs/cmdline-opts/http3.d @@ -11,7 +11,6 @@ See-also: http1.1 http2 Category: http Example: --http3 $URL Multi: mutex -Experimental: yes --- Tells curl to try HTTP/3 to the host in the URL, but fallback to earlier HTTP versions if the HTTP/3 connection establishment fails. HTTP/3 is only diff --git a/docs/cmdline-opts/include.d b/docs/cmdline-opts/include.d index ce7b9d87b4..85df6a55a0 100644 --- a/docs/cmdline-opts/include.d +++ b/docs/cmdline-opts/include.d @@ -4,14 +4,15 @@ Long: include Short: i Help: Include protocol response headers in the output See-also: verbose +Protocols: HTTP FTP Category: important verbose Example: -i $URL Added: 4.8 Multi: boolean --- -Include the HTTP response headers in the output. The HTTP response headers can -include things like server name, cookies, date of the document, HTTP version -and more... +Include response headers in the output. HTTP response headers can include +things like server name, cookies, date of the document, HTTP version and +more... With non-HTTP protocols, the "headers" are other server communication. To view the request headers, consider the --verbose option. diff --git a/docs/cmdline-opts/ipfs-gateway.d b/docs/cmdline-opts/ipfs-gateway.d index e6845b327a..2fd106e017 100644 --- a/docs/cmdline-opts/ipfs-gateway.d +++ b/docs/cmdline-opts/ipfs-gateway.d @@ -3,6 +3,7 @@ SPDX-License-Identifier: curl Long: ipfs-gateway Arg: Help: Gateway for IPFS +Protocols: IPFS Added: 8.4.0 See-also: help manual Category: ipfs diff --git a/docs/cmdline-opts/ssl-allow-beast.d b/docs/cmdline-opts/ssl-allow-beast.d index 2547675d64..b2c5d9399c 100644 --- a/docs/cmdline-opts/ssl-allow-beast.d +++ b/docs/cmdline-opts/ssl-allow-beast.d @@ -2,6 +2,7 @@ c: Copyright (C) Daniel Stenberg, , et al. SPDX-License-Identifier: curl Long: ssl-allow-beast Help: Allow security flaw to improve interop +Protocols: TLS Added: 7.25.0 Category: tls Example: --ssl-allow-beast $URL diff --git a/docs/cmdline-opts/ssl-auto-client-cert.d b/docs/cmdline-opts/ssl-auto-client-cert.d index 5328adea71..549f0afd8b 100644 --- a/docs/cmdline-opts/ssl-auto-client-cert.d +++ b/docs/cmdline-opts/ssl-auto-client-cert.d @@ -5,6 +5,7 @@ Help: Use auto client certificate (Schannel) Added: 7.77.0 See-also: proxy-ssl-auto-client-cert Category: tls +Protocols: TLS Example: --ssl-auto-client-cert $URL Multi: boolean --- diff --git a/docs/cmdline-opts/ssl-no-revoke.d b/docs/cmdline-opts/ssl-no-revoke.d index 37e91d9c20..3983938e6e 100644 --- a/docs/cmdline-opts/ssl-no-revoke.d +++ b/docs/cmdline-opts/ssl-no-revoke.d @@ -3,6 +3,7 @@ SPDX-License-Identifier: curl Long: ssl-no-revoke Help: Disable cert revocation checks (Schannel) Added: 7.44.0 +Protocols: TLS Category: tls Example: --ssl-no-revoke $URL See-also: crlfile diff --git a/docs/cmdline-opts/ssl-revoke-best-effort.d b/docs/cmdline-opts/ssl-revoke-best-effort.d index cb26d0b9a0..33899848dc 100644 --- a/docs/cmdline-opts/ssl-revoke-best-effort.d +++ b/docs/cmdline-opts/ssl-revoke-best-effort.d @@ -3,6 +3,7 @@ SPDX-License-Identifier: curl Long: ssl-revoke-best-effort Help: Ignore missing/offline cert CRL dist points (Schannel) Added: 7.70.0 +Protocols: TLS Category: tls Example: --ssl-revoke-best-effort $URL See-also: crlfile insecure diff --git a/docs/cmdline-opts/tlsauthtype.d b/docs/cmdline-opts/tlsauthtype.d index 7d3f7e5aac..e74385b892 100644 --- a/docs/cmdline-opts/tlsauthtype.d +++ b/docs/cmdline-opts/tlsauthtype.d @@ -3,6 +3,7 @@ SPDX-License-Identifier: curl Long: tlsauthtype Arg: Help: TLS authentication type +Protocols: TLS Added: 7.21.4 Category: tls auth Example: --tlsauthtype SRP $URL diff --git a/docs/cmdline-opts/tlspassword.d b/docs/cmdline-opts/tlspassword.d index 0513191ae9..9335a07bbc 100644 --- a/docs/cmdline-opts/tlspassword.d +++ b/docs/cmdline-opts/tlspassword.d @@ -4,6 +4,7 @@ Long: tlspassword Arg: Help: TLS password Added: 7.21.4 +Protocols: TLS Category: tls auth Example: --tlspassword pwd --tlsuser user $URL See-also: tlsuser diff --git a/docs/cmdline-opts/tlsuser.d b/docs/cmdline-opts/tlsuser.d index f87532a7c0..b884698b45 100644 --- a/docs/cmdline-opts/tlsuser.d +++ b/docs/cmdline-opts/tlsuser.d @@ -4,6 +4,7 @@ Long: tlsuser Arg: Help: TLS user name Added: 7.21.4 +Protocols: TLS Category: tls auth Example: --tlspassword pwd --tlsuser user $URL See-also: tlspassword