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