romenskiy2012/curl
1
0
Fork 0
mirror of https://github.com/curl/curl.git synced 2026-08-26 05:23:33 +03:00
Code Issues Projects Releases Packages Wiki Activity

curl.1: provide examples for each option

Browse source 
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
This commit is contained in:
Daniel Stenberg 2021-08-31 16:37:14 +02:00
parent c905459e87
commit 68784d73c3
No known key found for this signature in database
GPG key ID: 5CC908FDB71E12C2
245 changed files with 348 additions and 53 deletions
Download patch file Download diff file Expand all files Collapse all files

7
docs/cmdline-opts/header.d
View file

@ -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