Return to CURLOPT_PROXYTYPE.3 CVS log

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

Annotation of embedaddon/curl/docs/libcurl/opts/CURLOPT_PROXYTYPE.3, revision 1.1.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_PROXYTYPE 3 "May 30, 2017" "libcurl 7.70.0" "curl_easy_setopt options"
                     24: 
                     25: .SH NAME
                     26: CURLOPT_PROXYTYPE \- proxy protocol type
                     27: .SH SYNOPSIS
                     28: #include <curl/curl.h>
                     29: 
                     30: CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYTYPE, long type);
                     31: .SH DESCRIPTION
                     32: Pass one of the values below to set the type of the proxy.
                     33: 
                     34: .RS
                     35: .IP CURLPROXY_HTTP
                     36: HTTP Proxy. Default.
                     37: .IP CURLPROXY_HTTPS
                     38: HTTPS Proxy. (Added in 7.52.0 for OpenSSL, GnuTLS and NSS)
                     39: .IP CURLPROXY_HTTP_1_0
                     40: HTTP 1.0 Proxy. This is very similar to CURLPROXY_HTTP except it uses HTTP/1.0
                     41: for any CONNECT tunnelling. It does not change the HTTP version of the actual
                     42: HTTP requests, controlled by \fICURLOPT_HTTP_VERSION(3)\fP.
                     43: .IP CURLPROXY_SOCKS4
                     44: SOCKS4 Proxy.
                     45: .IP CURLPROXY_SOCKS4A
                     46: SOCKS4a Proxy. Proxy resolves URL hostname.
                     47: .IP CURLPROXY_SOCKS5
                     48: SOCKS5 Proxy.
                     49: .IP CURLPROXY_SOCKS5_HOSTNAME
                     50: SOCKS5 Proxy. Proxy resolves URL hostname.
                     51: .RE
                     52: 
                     53: Often it is more convenient to specify the proxy type with the scheme part of
                     54: the \fICURLOPT_PROXY(3)\fP string.
                     55: .SH DEFAULT
                     56: CURLPROXY_HTTP
                     57: .SH PROTOCOLS
                     58: Most
                     59: .SH EXAMPLE
                     60: .nf
                     61: CURL *curl = curl_easy_init();
                     62: if(curl) {
                     63:   CURLcode ret;
                     64:   curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
                     65:   curl_easy_setopt(curl, CURLOPT_PROXY, "local.example.com:1080");
                     66:   /* set the proxy type */
                     67:   curl_easy_setopt(curl, CURLOPT_PROXYTYPE, CURLPROXY_SOCKS5);
                     68:   ret = curl_easy_perform(curl);
                     69:   curl_easy_cleanup(curl);
                     70: }
                     71: .fi
                     72: .SH AVAILABILITY
                     73: Always
                     74: .SH RETURN VALUE
                     75: Returns CURLE_OK
                     76: .SH "SEE ALSO"
                     77: .BR CURLOPT_PROXY "(3), " CURLOPT_PROXYPORT "(3), "