docs/libcurl/opts/CURLOPT_HTTPPROXYTUNNEL.3

   1 .\" **************************************************************************
   2 .\" *                                  _   _ ____  _
   3 .\" *  Project                     ___| | | |  _ \| |
   4 .\" *                             / __| | | | |_) | |
   5 .\" *                            | (__| |_| |  _ <| |___
   6 .\" *                             \___|\___/|_| \_\_____|
   7 .\" *
   8 .\" * Copyright (C) 1998 - 2015, 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 http://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_HTTPPROXYTUNNEL 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
  24 .SH NAME
  25 CURLOPT_HTTPPROXYTUNNEL \- tunnel through HTTP proxy
  26 .SH SYNOPSIS
  27 #include <curl/curl.h>
  28
  29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HTTPPROXYTUNNEL, long tunnel);
  30 .SH DESCRIPTION
  31 Set the parameter to 1 to make libcurl tunnel all operations through the HTTP
  32 proxy. There is a big difference between using a proxy and to tunnel through
  33 it. If you don't know what this means, you probably don't want this tunneling
  34 option.
  35
  36 Tunneling essentially means that a CONNECT is sent to the proxy, asking it to
  37 connect to a remote host on a specific port number and then the traffic is
  38 just passed through the proxy. Proxies tend to whitelist specific port numbers
  39 it allows CONNECT requests to and often only port 80 and 443 are allowed.
  40
  41 When using this, it only makes sense to use \fICURLOPT_PROXYTYPE(3)\fP set to
  42 a HTTP proxy.
  43 .SH DEFAULT
  44 0
  45 .SH PROTOCOLS
  46 All network protocols
  47 .SH EXAMPLE
  48 TODO
  49 .SH AVAILABILITY
  50 Always
  51 .SH RETURN VALUE
  52 Returns CURLE_OK
  53 .SH "SEE ALSO"
  54 .BR CURLOPT_PROXY "(3), " CURLOPT_PROXYTYPE "(3), " CURLOPT_PROXYPORT "(3), "