...as there's also a version 2.
Closes #2579
Long: haproxy-protocol
-Help: Send HAProxy PROXY protocol header
+Help: Send HAProxy PROXY protocol v1 header
Protocols: HTTP
Added: 7.60.0
---
-Send a HAProxy PROXY protocol header at the beginning of the connection. This
+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.
.IP CURLOPT_PROXY_SERVICE_NAME
Proxy authentication service name. \fICURLOPT_PROXY_SERVICE_NAME(3)\fP
.IP CURLOPT_HAPROXYPROTOCOL
-Send an HAProxy PROXY protocol header. See \fICURLOPT_HAPROXYPROTOCOL(3)\fP
+Send an HAProxy PROXY protocol v1 header. See \fICURLOPT_HAPROXYPROTOCOL(3)\fP
.IP CURLOPT_SERVICE_NAME
Authentication service name. \fICURLOPT_SERVICE_NAME(3)\fP
.IP CURLOPT_INTERFACE
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
-.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <daniel@haxx.se>, et al.
+.\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
.\"
.TH CURLOPT_HAPROXYPROTOCOL 3 "5 Feb 2018" "libcurl 7.60.0" "curl_easy_setopt options"
.SH NAME
-CURLOPT_HAPROXYPROTOCOL \- send HAProxy PROXY protocol header
+CURLOPT_HAPROXYPROTOCOL \- send HAProxy PROXY protocol v1 header
.SH SYNOPSIS
#include <curl/curl.h>
long haproxy_protocol);
.SH DESCRIPTION
A long parameter set to 1 tells the library to send an HAProxy PROXY
-protocol header at beginning of the connection. The default action is not to
+protocol v1 header at beginning of the connection. The default action is not to
send this header.
This option is primarily useful when sending test requests to a service that
Most applications do not need this option.
.SH DEFAULT
-0, do not send HAProxy PROXY protocol header
+0, do not send any HAProxy PROXY protocol header
.SH PROTOCOLS
HTTP
.SH EXAMPLE
bool stream_depends_e; /* set or don't set the Exclusive bit */
int stream_weight;
- bool haproxyprotocol; /* whether to send HAProxy PROXY protocol header */
+ bool haproxyprotocol; /* whether to send HAProxy PROXY protocol v1 header */
struct Curl_http2_dep *stream_dependents;
bool ssh_compression; /* enable/disable SSH compression */
long happy_eyeballs_timeout_ms; /* happy eyeballs timeout in milliseconds.
0 is valid. default: CURL_HET_DEFAULT. */
- bool haproxy_protocol; /* whether to send HAProxy PROXY protocol */
+ bool haproxy_protocol; /* whether to send HAProxy PROXY protocol v1 */
struct GlobalConfig *global;
struct OperationConfig *prev;
struct OperationConfig *next; /* Always last in the struct */
{"-I, --head",
"Show document info only"},
{" --haproxy-protocol",
- "Send HAProxy PROXY protocol header"},
+ "Send HAProxy PROXY protocol v1 header"},
{"-H, --header <header/@file>",
"Pass custom header(s) to server"},
{"-h, --help",