comparison mupdf-source/thirdparty/curl/docs/libcurl/opts/CURLOPT_HAPROXYPROTOCOL.3 @ 2:b50eed0cc0ef upstream

ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. The directory name has changed: no version number in the expanded directory now.
author Franz Glasner <fzglas.hg@dom66.de>
date Mon, 15 Sep 2025 11:43:07 +0200
parents
children
comparison
equal deleted inserted replaced
1:1d09e1dec1d9 2:b50eed0cc0ef
1 .\" **************************************************************************
2 .\" * _ _ ____ _
3 .\" * Project ___| | | | _ \| |
4 .\" * / __| | | | |_) | |
5 .\" * | (__| |_| | _ <| |___
6 .\" * \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <daniel@haxx.se>, et al.
9 .\" *
10 .\" * This software is licensed as described in the file COPYING, which
11 .\" * you should have received as part of this distribution. The terms
12 .\" * are also available at https://curl.haxx.se/docs/copyright.html.
13 .\" *
14 .\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
15 .\" * copies of the Software, and permit persons to whom the Software is
16 .\" * furnished to do so, under the terms of the COPYING file.
17 .\" *
18 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
19 .\" * KIND, either express or implied.
20 .\" *
21 .\" **************************************************************************
22 .\"
23 .TH CURLOPT_HAPROXYPROTOCOL 3 "5 Feb 2018" "libcurl 7.60.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_HAPROXYPROTOCOL \- send HAProxy PROXY protocol v1 header
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HAPROXYPROTOCOL,
30 long haproxy_protocol);
31 .SH DESCRIPTION
32 A long parameter set to 1 tells the library to send an HAProxy PROXY
33 protocol v1 header at beginning of the connection. The default action is not to
34 send this header.
35
36 This option is primarily useful when sending test requests to a service that
37 expects this header.
38
39 Most applications do not need this option.
40 .SH DEFAULT
41 0, do not send any HAProxy PROXY protocol header
42 .SH PROTOCOLS
43 HTTP
44 .SH EXAMPLE
45 .nf
46 CURL *curl = curl_easy_init();
47 if(curl) {
48 CURLcode ret;
49 curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
50 curl_easy_setopt(curl, CURLOPT_HAPROXYPROTOCOL, 1L);
51 ret = curl_easy_perform(curl);
52 }
53 .fi
54 .SH AVAILABILITY
55 Along with HTTP. Added in 7.60.0.
56 .SH RETURN VALUE
57 Returns CURLE_OK if HTTP is enabled, and CURLE_UNKNOWN_OPTION if not.