Return to CURLOPT_PROXYHEADER.3 CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / curl / docs / libcurl / opts

Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_PROXYHEADER.3, revision 1.1

1.1     ! misho       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_PROXYHEADER 3 "May 30, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
        !            24: 
        !            25: .SH NAME
        !            26: CURLOPT_PROXYHEADER \- custom HTTP headers to pass to proxy
        !            27: .SH SYNOPSIS
        !            28: .nf
        !            29: #include <curl/curl.h>
        !            30: 
        !            31: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYHEADER,
        !            32:                           struct curl_slist *headers);
        !            33: .SH DESCRIPTION
        !            34: Pass a pointer to a linked list of HTTP headers to pass in your HTTP request
        !            35: sent to a proxy. The rules for this list is identical to the
        !            36: \fICURLOPT_HTTPHEADER(3)\fP option's.
        !            37: 
        !            38: The headers set with this option is only ever used in requests sent to a proxy
        !            39: - when there's also a request sent to a host.
        !            40: 
        !            41: The first line in a request (containing the method, usually a GET or POST) is
        !            42: NOT a header and cannot be replaced using this option. Only the lines
        !            43: following the request-line are headers. Adding this method line in this list
        !            44: of headers will only cause your request to send an invalid header.
        !            45: 
        !            46: Pass a NULL to this to reset back to no custom headers.
        !            47: .SH DEFAULT
        !            48: NULL
        !            49: .SH PROTOCOLS
        !            50: HTTP
        !            51: .SH EXAMPLE
        !            52: .nf
        !            53: CURL *curl = curl_easy_init();
        !            54: 
        !            55: struct curl_slist *list;
        !            56: 
        !            57: if(curl) {
        !            58:   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com");
        !            59:   curl_easy_setopt(curl, CURLOPT_PROXY, "http://proxy.example.com:80");
        !            60: 
        !            61:   list = curl_slist_append(NULL, "Shoesize: 10");
        !            62:   list = curl_slist_append(list, "Accept:");
        !            63: 
        !            64:   curl_easy_setopt(curl, CURLOPT_PROXYHEADER, list);
        !            65: 
        !            66:   curl_easy_perform(curl);
        !            67: 
        !            68:   curl_slist_free_all(list); /* free the list again */
        !            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_HEADEROPT "(3), " CURLOPT_HTTPHEADER "(3), "