Imported Upstream version 7.53.1
[platform/upstream/curl.git] / docs / libcurl / opts / CURLOPT_PROXYTYPE.3
1 .\" **************************************************************************
2 .\" *                                  _   _ ____  _
3 .\" *  Project                     ___| | | |  _ \| |
4 .\" *                             / __| | | | |_) | |
5 .\" *                            | (__| |_| |  _ <| |___
6 .\" *                             \___|\___/|_| \_\_____|
7 .\" *
8 .\" * Copyright (C) 1998 - 2016, 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 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_PROXYTYPE \- proxy protocol type
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXYTYPE, long type);
30 .SH DESCRIPTION
31 Pass one of the values below to set the type of the proxy.
32
33 .RS
34 .IP CURLPROXY_HTTP
35 HTTP Proxy. Default.
36 .IP CURLPROXY_HTTPS
37 HTTPS Proxy. (Added in 7.52.0 for OpenSSL, GnuTLS and NSS)
38 .IP CURLPROXY_HTTP_1_0
39 HTTP 1.0 Proxy. This is very similar to CURLPROXY_HTTP except it uses HTTP/1.0
40 for any CONNECT tunnelling. It does not change the HTTP version of the actual
41 HTTP requests, controlled by \fICURLOPT_HTTP_VERSION(3)\fP.
42 .IP CURLPROXY_SOCKS4
43 SOCKS4 Proxy.
44 .IP CURLPROXY_SOCKS4A
45 SOCKS4a Proxy. Proxy resolves URL hostname.
46 .IP CURLPROXY_SOCKS5
47 SOCKS5 Proxy.
48 .IP CURLPROXY_SOCKS5_HOSTNAME
49 SOCKS5 Proxy. Proxy resolves URL hostname.
50 .RE
51
52 Often it is more convenient to specify the proxy type with the scheme part of
53 the \fICURLOPT_PROXY(3)\fP string.
54 .SH DEFAULT
55 CURLPROXY_HTTP
56 .SH PROTOCOLS
57 Most
58 .SH EXAMPLE
59 TODO
60 .SH AVAILABILITY
61 Always
62 .SH RETURN VALUE
63 Returns CURLE_OK
64 .SH "SEE ALSO"
65 .BR CURLOPT_PROXY "(3), " CURLOPT_PROXYPORT "(3), "