]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
docs: clean up Protocols: for cmdline options
authorDaniel Stenberg <daniel@haxx.se>
Mon, 11 Dec 2023 07:52:19 +0000 (08:52 +0100)
committerDaniel Stenberg <daniel@haxx.se>
Mon, 11 Dec 2023 09:40:16 +0000 (10:40 +0100)
... and some other minor polish.

Closes #12496

15 files changed:
docs/cmdline-opts/aws-sigv4.d
docs/cmdline-opts/disallow-username-in-url.d
docs/cmdline-opts/dns-servers.d
docs/cmdline-opts/get.d
docs/cmdline-opts/http3-only.d
docs/cmdline-opts/http3.d
docs/cmdline-opts/include.d
docs/cmdline-opts/ipfs-gateway.d
docs/cmdline-opts/ssl-allow-beast.d
docs/cmdline-opts/ssl-auto-client-cert.d
docs/cmdline-opts/ssl-no-revoke.d
docs/cmdline-opts/ssl-revoke-best-effort.d
docs/cmdline-opts/tlsauthtype.d
docs/cmdline-opts/tlspassword.d
docs/cmdline-opts/tlsuser.d

index b771eee6a94a8c8c35e50424f35d569cecd4839a..4b480f50cab4737e850200c78cfa1f63f7f05b77 100644 (file)
@@ -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
index d0537db97ac44f4a80eb8a7a5d6c4762ce9cc190..0e70ba91f6463cf70e20fa80053ff3ef3312d1a9 100644 (file)
@@ -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
 ---
index bec23a3c35245f3d806d18bd29861a325516b8e4..96be0814143be79a920ae1baea2891829c941c08 100644 (file)
@@ -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
index 2e03a255bc83d8abdfec73974f1a10d971f5acb6..513ea00438d424fb0c9dbbe3593d6fe24956586b 100644 (file)
@@ -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
index c3f0f31aa1bba29bcaaef613bdaeb10a25a3c92a..384519b83c5916c9686ad26cbdbe41d14210226c 100644 (file)
@@ -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
index a8258c4d313c2ab2a59842f4ea0d741d4b1af7a0..3b05d4a1dcbcb33ed5c81dbf901f6a693a981c1f 100644 (file)
@@ -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
index ce7b9d87b472b02c652977c063a3b01450ea84ea..85df6a55a0d66d910a29f1b0b4c69e841ca13f5d 100644 (file)
@@ -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.
 
index e6845b327a6b730dbbfd946c10a20305a1b98aa3..2fd106e0170157aa1aef8760ce67ded17cf51866 100644 (file)
@@ -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
index 2547675d64052ba1619647464e60ecc73ff576ce..b2c5d9399c8e2074d0c01e12c1d42e384c52c0dc 100644 (file)
@@ -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
index 5328adea7107e619775c79a8931516cabbb9c889..549f0afd8b368fee7accf78fd04ea39bb89f829f 100644 (file)
@@ -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
 ---
index 37e91d9c2042838388ee911f0cc3c3473dc9ce0c..3983938e6ef29aec4a1ae64c5350087205e07e1f 100644 (file)
@@ -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
index cb26d0b9a09315c4461db00f7503c6f31735c622..33899848dce416c10a80b4a9ef9065c600ec5339 100644 (file)
@@ -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
index 7d3f7e5aac48d0152080d73fc54cbddd8113d49f..e74385b8920899f90858a1bfbb4b37429f6659a7 100644 (file)
@@ -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
index 0513191ae936f3fe4b1596fda39e3450ec418b9a..9335a07bbc341c6abc9bbea5d6e5dee93d4b857a 100644 (file)
@@ -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
index f87532a7c03fccb25387b0c36522856891a3f23d..b884698b45239a5465aa2c696931b4a4da75ae86 100644 (file)
@@ -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