diff options
| author | Daniel Stenberg <daniel@haxx.se> | 2021-08-31 16:37:14 +0200 |
|---|---|---|
| committer | Daniel Stenberg <daniel@haxx.se> | 2021-09-01 14:02:43 +0200 |
| commit | 68784d73c3f8bc0d14502b4e1e930b1741c41699 (patch) | |
| tree | b1d7a129e2d43da0bfac6bba56a0b53912a9b026 /docs/cmdline-opts/header.d | |
| parent | c905459e878690942e9a0a8cd7f9ad57b6898efb (diff) | |
| download | curl-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/header.d')
| -rw-r--r-- | docs/cmdline-opts/header.d | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/docs/cmdline-opts/header.d b/docs/cmdline-opts/header.d index 121285ae3..11c96d5ea 100644 --- a/docs/cmdline-opts/header.d +++ b/docs/cmdline-opts/header.d @@ -5,6 +5,9 @@ Help: Pass custom header(s) to server Protocols: HTTP Category: http See-also: user-agent referer +Example: -H "X-First-Name: Joe" $URL +Example: -H "User-Agent: yes-please/2000" $URL +Example: -H "Host:" $URL --- Extra header to include in the request when sending HTTP to a server. You may specify any number of extra headers. Note that if you should add a custom @@ -32,10 +35,6 @@ proxy. Added in 7.37.0. Passing on a "Transfer-Encoding: chunked" header when doing a HTTP request with a request body, will make curl send the data using chunked encoding. -Example: - - curl -H "X-First-Name: Joe" http://example.com/ - **WARNING**: headers set with this option will be set in all requests - even after redirects are followed, like when told with --location. This can lead to the header being sent to other hosts than the original host, so sensitive |