comparison mupdf-source/thirdparty/curl/docs/libcurl/opts/CURLOPT_HEADEROPT.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 - 2017, 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_HEADEROPT 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_HEADEROPT \- set how to send HTTP headers
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HEADEROPT, long bitmask);
30 .SH DESCRIPTION
31 Pass a long that is a bitmask of options of how to deal with headers. The two
32 mutually exclusive options are:
33
34 \fBCURLHEADER_UNIFIED\fP - the headers specified in
35 \fICURLOPT_HTTPHEADER(3)\fP will be used in requests both to servers and
36 proxies. With this option enabled, \fICURLOPT_PROXYHEADER(3)\fP will not have
37 any effect.
38
39 \fBCURLHEADER_SEPARATE\fP - makes \fICURLOPT_HTTPHEADER(3)\fP headers only get
40 sent to a server and not to a proxy. Proxy headers must be set with
41 \fICURLOPT_PROXYHEADER(3)\fP to get used. Note that if a non-CONNECT request
42 is sent to a proxy, libcurl will send both server headers and proxy
43 headers. When doing CONNECT, libcurl will send \fICURLOPT_PROXYHEADER(3)\fP
44 headers only to the proxy and then \fICURLOPT_HTTPHEADER(3)\fP headers only to
45 the server.
46 .SH DEFAULT
47 CURLHEADER_SEPARATE (changed in 7.42.1, used CURLHEADER_UNIFIED before then)
48 .SH PROTOCOLS
49 HTTP
50 .SH EXAMPLE
51 .nf
52 CURL *curl = curl_easy_init();
53 if(curl) {
54 CURLcode ret;
55 struct curl_slist *list;
56 list = curl_slist_append(NULL, "Shoesize: 10");
57 list = curl_slist_append(list, "Accept:");
58 curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
59 curl_easy_setopt(curl, CURLOPT_PROXY, "http://localhost:8080");
60 curl_easy_setopt(curl, CURLOPT_HTTPHEADER, list);
61
62 /* HTTPS over a proxy makes a separate CONNECT to the proxy, so tell
63 libcurl to not send the custom headers to the proxy. Keep them
64 separate! */
65 curl_easy_setopt(curl, CURLOPT_HEADEROPT, CURLHEADER_SEPARATE);
66 ret = curl_easy_perform(curl);
67 curl_slist_free_all(list);
68 curl_easy_cleanup(curl);
69 }
70 .fi
71 .SH AVAILABILITY
72 Added in 7.37.0
73 .SH RETURN VALUE
74 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
75 .SH "SEE ALSO"
76 .BR CURLOPT_HTTPHEADER "(3), " CURLOPT_PROXYHEADER "(3), "