Mercurial > hgrepos > Python2 > PyMuPDF

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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_HTTPHEADER 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_HTTPHEADER \- set custom HTTP headers
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTPHEADER, struct curl_slist *headers);
30 .SH DESCRIPTION
31 Pass a pointer to a linked list of HTTP headers to pass to the server and/or
32 proxy in your HTTP request. The same list can be used for both host and proxy
33 requests!
34
35 The linked list should be a fully valid list of \fBstruct curl_slist\fP
36 structs properly filled in. Use \fIcurl_slist_append(3)\fP to create the list
37 and \fIcurl_slist_free_all(3)\fP to clean up an entire list. If you add a
38 header that is otherwise generated and used by libcurl internally, your added
39 one will be used instead. If you add a header with no content as in 'Accept:'
40 (no data on the right side of the colon), the internally used header will get
41 disabled. With this option you can add new headers, replace internal headers
42 and remove internal headers. To add a header with no content (nothing to the
43 right side of the colon), use the form 'MyHeader;' (note the ending
44 semicolon).
45
46 The headers included in the linked list \fBmust not\fP be CRLF-terminated,
47 because libcurl adds CRLF after each header item. Failure to comply with this
48 will result in strange bugs because the server will most likely ignore part of
49 the headers you specified.
50
51 The first line in a request (containing the method, usually a GET or POST) is
52 not a header and cannot be replaced using this option. Only the lines
53 following the request-line are headers. Adding this method line in this list
54 of headers will only cause your request to send an invalid header. Use
55 \fICURLOPT_CUSTOMREQUEST(3)\fP to change the method.
56
57 When this option is passed to \fIcurl_easy_setopt(3)\fP, libcurl will not copy
58 the entire list so you \fBmust\fP keep it around until you no longer use this
59 \fIhandle\fP for a transfer before you call \fIcurl_slist_free_all(3)\fP on
60 the list.
61
62 Pass a NULL to this option to reset back to no custom headers.
63
64 The most commonly replaced headers have "shortcuts" in the options
65 \fICURLOPT_COOKIE(3)\fP, \fICURLOPT_USERAGENT(3)\fP and
66 \fICURLOPT_REFERER(3)\fP. We recommend using those.
67
68 There's an alternative option that sets or replaces headers only for requests
69 that are sent with CONNECT to a proxy: \fICURLOPT_PROXYHEADER(3)\fP. Use
70 \fICURLOPT_HEADEROPT(3)\fP to control the behavior.
71 .SH SECURITY CONCERNS
72 By default, this option makes libcurl send the given headers in all HTTP
73 requests done by this handle. You should therefore use this option with
74 caution if you for example connect to the remote site using a proxy and a
75 CONNECT request, you should to consider if that proxy is supposed to also get
76 the headers. They may be private or otherwise sensitive to leak.
77
78 Use \fICURLOPT_HEADEROPT(3)\fP to make the headers only get sent to where you
79 intend them to get sent.
80
81 Custom headers are sent in all requests done by the easy handles, which
82 implies that if you tell libcurl to follow redirects
83 (\fICURLOPT_FOLLOWLOCATION(3)\fP), the same set of custom headers will be sent
84 in the subsequent request. Redirects can of course go to other hosts and thus
85 those servers will get all the contents of your custom headers too.
86
87 Starting in 7.58.0, libcurl will specifically prevent "Authorization:" headers
88 from being sent to other hosts than the first used one, unless specifically
89 permitted with the \fICURLOPT_UNRESTRICTED_AUTH(3)\fP option.
90
91 Starting in 7.64.0, libcurl will specifically prevent "Cookie:" headers
92 from being sent to other hosts than the first used one, unless specifically
93 permitted with the \fICURLOPT_UNRESTRICTED_AUTH(3)\fP option.
94 .SH DEFAULT
95 NULL
96 .SH PROTOCOLS
97 HTTP
98 .SH EXAMPLE
99 .nf
100 CURL *curl = curl_easy_init();
101
102 struct curl_slist *list = NULL;
103
104 if(curl) {
105 curl_easy_setopt(curl, CURLOPT_URL, "http://example.com");
106
107 list = curl_slist_append(list, "Shoesize: 10");
108 list = curl_slist_append(list, "Accept:");
109
110 curl_easy_setopt(curl, CURLOPT_HTTPHEADER, list);
111
112 curl_easy_perform(curl);
113
114 curl_slist_free_all(list); /* free the list again */
115 }
116 .fi
117
118 .SH AVAILABILITY
119 As long as HTTP is enabled
120 .SH RETURN VALUE
121 Returns CURLE_OK if HTTP is supported, and CURLE_UNKNOWN_OPTION if not.
122 .SH "SEE ALSO"
123 .BR CURLOPT_CUSTOMREQUEST "(3), " CURLOPT_HEADEROPT "(3), "
124 .BR CURLOPT_PROXYHEADER "(3), " CURLOPT_HEADER "(3)"