curl/docs/cmdline-opts/haproxy-protocol.d

c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Long: haproxy-protocol
Help: Send HAProxy PROXY protocol v1 header
Protocols: HTTP
Added: 7.60.0
Category: http proxy
Example: --haproxy-protocol $URL
See-also: proxy
Multi: boolean
---
Send a HAProxy PROXY protocol v1 header at the beginning of the
connection. This is used by some load balancers and reverse proxies to
indicate the client's true IP address and port.

This option is primarily useful when sending test requests to a service that
expects this header.
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`
CURLOPT_HAPROXYPROTOCOL: support the HAProxy PROXY protocol Add --haproxy-protocol for the command line tool Closes #2162 2016-12-01 20:05:04 +08:00			`Long: haproxy-protocol`
docs: mention HAproxy protocol "version 1" ...as there's also a version 2. Closes #2579 2018-05-18 23:47:47 +08:00			`Help: Send HAProxy PROXY protocol v1 header`
CURLOPT_HAPROXYPROTOCOL: support the HAProxy PROXY protocol Add --haproxy-protocol for the command line tool Closes #2162 2016-12-01 20:05:04 +08:00			`Protocols: HTTP`
			`Added: 7.60.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: http 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: --haproxy-protocol $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: boolean`
CURLOPT_HAPROXYPROTOCOL: support the HAProxy PROXY protocol Add --haproxy-protocol for the command line tool Closes #2162 2016-12-01 20:05:04 +08:00			`---`
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			`Send a HAProxy PROXY protocol v1 header at the beginning of the`
			`connection. This is used by some load balancers and reverse proxies to`
			`indicate the client's true IP address and port.`
CURLOPT_HAPROXYPROTOCOL: support the HAProxy PROXY protocol Add --haproxy-protocol for the command line tool Closes #2162 2016-12-01 20:05:04 +08:00
			`This option is primarily useful when sending test requests to a service that`
			`expects this header.`