summaryrefslogtreecommitdiff
path: root/docs/cmdline-opts/http2.d
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2021-08-31 16:37:14 +0200
committerDaniel Stenberg <daniel@haxx.se>2021-09-01 14:02:43 +0200
commit68784d73c3f8bc0d14502b4e1e930b1741c41699 (patch)
treeb1d7a129e2d43da0bfac6bba56a0b53912a9b026 /docs/cmdline-opts/http2.d
parentc905459e878690942e9a0a8cd7f9ad57b6898efb (diff)
downloadcurl-68784d73c3f8bc0d14502b4e1e930b1741c41699.tar.gz
curl.1: provide examples for each option
The file format for each option now features a "Example:" header that can provide one or more examples that get rendered appropriately in the output. All options MUST have at least one example or gen.pl complains at build-time. This fix also does a few other minor format and consistency cleanups. Closes #7654
Diffstat (limited to 'docs/cmdline-opts/http2.d')
-rw-r--r--docs/cmdline-opts/http2.d7
1 files changed, 7 insertions, 0 deletions
diff --git a/docs/cmdline-opts/http2.d b/docs/cmdline-opts/http2.d
index 197515ee8..2a85db600 100644
--- a/docs/cmdline-opts/http2.d
+++ b/docs/cmdline-opts/http2.d
@@ -8,5 +8,12 @@ See-also: no-alpn
Help: Use HTTP 2
See-also: http1.1 http3
Category: http
+Example: --http2 $URL
---
Tells curl to use HTTP version 2.
+
+For HTTPS, this means curl will attempt to negotiate HTTP/2 in the TLS
+handshake. curl does this by default.
+
+For HTTP, this means curl will attempt to upgrade the request to HTTP/2 using
+the Upgrade: request header.