mirror of
https://github.com/moparisthebest/curl
synced 2024-11-18 07:25:14 -05:00
55 lines
2.2 KiB
Groff
55 lines
2.2 KiB
Groff
.\" **************************************************************************
|
|
.\" * _ _ ____ _
|
|
.\" * Project ___| | | | _ \| |
|
|
.\" * / __| | | | |_) | |
|
|
.\" * | (__| |_| | _ <| |___
|
|
.\" * \___|\___/|_| \_\_____|
|
|
.\" *
|
|
.\" * Copyright (C) 1998 - 2015, Daniel Stenberg, <daniel@haxx.se>, et al.
|
|
.\" *
|
|
.\" * This software is licensed as described in the file COPYING, which
|
|
.\" * you should have received as part of this distribution. The terms
|
|
.\" * are also available at http://curl.haxx.se/docs/copyright.html.
|
|
.\" *
|
|
.\" * You may opt to use, copy, modify, merge, publish, distribute and/or sell
|
|
.\" * copies of the Software, and permit persons to whom the Software is
|
|
.\" * furnished to do so, under the terms of the COPYING file.
|
|
.\" *
|
|
.\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
|
|
.\" * KIND, either express or implied.
|
|
.\" *
|
|
.\" **************************************************************************
|
|
.\"
|
|
.TH CURLOPT_HTTPPROXYTUNNEL 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
|
|
.SH NAME
|
|
CURLOPT_HTTPPROXYTUNNEL \- tunnel through HTTP proxy
|
|
.SH SYNOPSIS
|
|
#include <curl/curl.h>
|
|
|
|
CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTPPROXYTUNNEL, long tunnel);
|
|
.SH DESCRIPTION
|
|
Set the parameter to 1 to make libcurl tunnel all operations through the HTTP
|
|
proxy. There is a big difference between using a proxy and to tunnel through
|
|
it. If you don't know what this means, you probably don't want this tunneling
|
|
option.
|
|
|
|
Tunneling essentially means that a CONNECT is sent to the proxy, asking it to
|
|
connect to a remote host on a specific port number and then the traffic is
|
|
just passed through the proxy. Proxies tend to whitelist specific port numbers
|
|
it allows CONNECT requests to and often only port 80 and 443 are allowed.
|
|
|
|
When using this, it only makes sense to use \fICURLOPT_PROXYTYPE(3)\fP set to
|
|
a HTTP proxy.
|
|
.SH DEFAULT
|
|
0
|
|
.SH PROTOCOLS
|
|
All network protocols
|
|
.SH EXAMPLE
|
|
TODO
|
|
.SH AVAILABILITY
|
|
Always
|
|
.SH RETURN VALUE
|
|
Returns CURLE_OK
|
|
.SH "SEE ALSO"
|
|
.BR CURLOPT_PROXY "(3), " CURLOPT_PROXYTYPE "(3), " CURLOPT_PROXYPORT "(3), "
|