summaryrefslogtreecommitdiff
path: root/docs/cmdline-opts/proxy-header.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/proxy-header.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/proxy-header.d')
-rw-r--r--docs/cmdline-opts/proxy-header.d3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/cmdline-opts/proxy-header.d b/docs/cmdline-opts/proxy-header.d
index c2b0928f9..273a773d9 100644
--- a/docs/cmdline-opts/proxy-header.d
+++ b/docs/cmdline-opts/proxy-header.d
@@ -4,6 +4,9 @@ Help: Pass custom header(s) to proxy
Protocols: HTTP
Added: 7.37.0
Category: proxy
+Example: --proxy-header "X-First-Name: Joe" -x http://proxy $URL
+Example: --proxy-header "User-Agent: surprise" -x http://proxy $URL
+Example: --proxy-header "Host:" -x http://proxy $URL
---
Extra header to include in the request when sending HTTP to a proxy. You may
specify any number of extra headers. This is the equivalent option to --header