docs: clean up Protocols: for cmdline options

... and some other minor polish. Closes #12496
2025-02-23 15:10:03 +08:00 · 2023-12-11 08:52:19 +01:00 · 2023-12-11 08:52:19 +01:00 · e38a8e0cd0
commit e38a8e0cd0
parent 9fa8652fd5
15 changed files with 16 additions and 7 deletions
--- a/docs/cmdline-opts/aws-sigv4.d
+++ b/docs/cmdline-opts/aws-sigv4.d
@ -1,6 +1,7 @@
 c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
 SPDX-License-Identifier: curl
 Long: aws-sigv4
+Protocols: HTTP
 Arg: <provider1[:provider2[:region[:service]]]>
 Help: Use AWS V4 signature authentication
 Category: auth http
--- 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, <daniel@haxx.se>, 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
 ---
--- 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: <addresses>
 Help: DNS server addrs to use
+Protocols: DNS
 Requires: c-ares
 Added: 7.33.0
 Category: dns
--- 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
--- 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
--- 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
--- 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.

--- 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: <URL>
 Help: Gateway for IPFS
+Protocols: IPFS
 Added: 8.4.0
 See-also: help manual
 Category: ipfs
--- 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, <daniel@haxx.se>, 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
--- 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
 ---
--- 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
--- 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
--- a/docs/cmdline-opts/tlsauthtype.d
+++ b/docs/cmdline-opts/tlsauthtype.d
@ -3,6 +3,7 @@ SPDX-License-Identifier: curl
 Long: tlsauthtype
 Arg: <type>
 Help: TLS authentication type
+Protocols: TLS
 Added: 7.21.4
 Category: tls auth
 Example: --tlsauthtype SRP $URL
--- a/docs/cmdline-opts/tlspassword.d
+++ b/docs/cmdline-opts/tlspassword.d
@ -4,6 +4,7 @@ Long: tlspassword
 Arg: <string>
 Help: TLS password
 Added: 7.21.4
+Protocols: TLS
 Category: tls auth
 Example: --tlspassword pwd --tlsuser user $URL
 See-also: tlsuser
--- a/docs/cmdline-opts/tlsuser.d
+++ b/docs/cmdline-opts/tlsuser.d
@ -4,6 +4,7 @@ Long: tlsuser
 Arg: <name>
 Help: TLS user name
 Added: 7.21.4
+Protocols: TLS
 Category: tls auth
 Example: --tlspassword pwd --tlsuser user $URL
 See-also: tlspassword