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/haproxy-protocol.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/haproxy-protocol.d')
| -rw-r--r-- | docs/cmdline-opts/haproxy-protocol.d | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/docs/cmdline-opts/haproxy-protocol.d b/docs/cmdline-opts/haproxy-protocol.d index 835820465..446dc6572 100644 --- a/docs/cmdline-opts/haproxy-protocol.d +++ b/docs/cmdline-opts/haproxy-protocol.d @@ -3,10 +3,11 @@ Help: Send HAProxy PROXY protocol v1 header Protocols: HTTP Added: 7.60.0 Category: http proxy +Example: --haproxy-protocol $URL --- -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. +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. |