curl/docs/cmdline-opts/proxy-header.d

c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Long: proxy-header
Arg: <header/@file>
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
See-also: proxy
Multi: append
---
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
but is for proxy communication only like in CONNECT requests when you want a
separate header sent to the proxy to what is sent to the actual remote host.

curl will make sure that each header you add/replace is sent with the proper
end-of-line marker, you should thus **not** add that as a part of the header
content: do not add newlines or carriage returns, they will only mess things
up for you.

Headers specified with this option will not be included in requests that curl
knows will not be sent to a proxy.

Starting in 7.55.0, this option can take an argument in @filename style, which
then adds a header for each line in the input file. Using @- will make curl
read the header file from stdin.

This option can be used multiple times to add/replace/remove multiple headers.
copyright: update all copyright lines and remove year ranges - they are mostly pointless in all major jurisdictions - many big corporations and projects already don't use them - saves us from pointless churn - git keeps history for us - the year range is kept in COPYING checksrc is updated to allow non-year using copyright statements Closes #10205 2023-01-02 20:51:48 +08:00			`c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.`
docs/cmdline-opts: add copyright and license identifier to each file gen.pl now insists on C: and SPDX-License-Identifier: fields to be present in all files. Closes #9002 2022-06-14 06:12:03 +08:00			`SPDX-License-Identifier: curl`
cmdline-docs: more conversion 2016-11-16 21:20:36 +08:00			`Long: proxy-header`
curl: allow --header and --proxy-header read from file So many headers can be provided as @filename. Suggested-by: Timothe Litt Closes #1486 2017-06-15 17:08:31 +08:00			`Arg: <header/@file>`
			`Help: Pass custom header(s) to proxy`
cmdline-docs: more conversion 2016-11-16 21:20:36 +08:00			`Protocols: HTTP`
			`Added: 7.37.0`
docs: add categories to all cmdline opts Adapted gen.pl with 'listcats' This commit is a part of "--help me if you can" Closes #5680 2020-07-13 20:15:04 +08:00			`Category: proxy`
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 2021-08-31 22:37:14 +08:00			`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`
curl.1: require "see also" for every documented option gen.pl now generates a warning if the "See Also" field is not filled in for a command line option All command line options now provide one or more related options. 167 "See alsos" added! Closes #8019 2021-11-15 22:58:20 +08:00			`See-also: proxy`
cmdline/docs: add a required 'multi' keyword for each option The keyword specifies how option works when specified multiple times: - single: the last provided value replaces the earlier ones - append: it supports being provided multiple times - boolean: on/off values - mutex: flag-like option that disable anoter flag The 'gen.pl' script then outputs the proper and unified language for each option's multi-use behavior in the generated man page. The multi: header is requires in each .d file and will cause build error if missing or set to an unknown value. Closes #9759 2022-10-18 16:39:43 +08:00			`Multi: append`
cmdline-docs: more conversion 2016-11-16 21:20:36 +08:00			`---`
			`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`
			`but is for proxy communication only like in CONNECT requests when you want a`
			`separate header sent to the proxy to what is sent to the actual remote host.`

			`curl will make sure that each header you add/replace is sent with the proper`
docs: make gen.pl support italic and bold Remove some nroffisms from the cmdline doc files to simplify editing, and instead support this markdown style. Closes #6771 2021-03-22 23:50:57 +08:00			`end-of-line marker, you should thus not add that as a part of the header`
cmdline-docs: more conversion 2016-11-16 21:20:36 +08:00			`content: do not add newlines or carriage returns, they will only mess things`
			`up for you.`

			`Headers specified with this option will not be included in requests that curl`
			`knows will not be sent to a proxy.`

curl: allow --header and --proxy-header read from file So many headers can be provided as @filename. Suggested-by: Timothe Litt Closes #1486 2017-06-15 17:08:31 +08:00			`Starting in 7.55.0, this option can take an argument in @filename style, which`
			`then adds a header for each line in the input file. Using @- will make curl`
			`read the header file from stdin.`

cmdline-docs: more conversion 2016-11-16 21:20:36 +08:00			`This option can be used multiple times to add/replace/remove multiple headers.`