comparison mupdf-source/thirdparty/curl/docs/libcurl/opts/CURLOPT_HTTPPROXYTUNNEL.3 @ 2:b50eed0cc0ef upstream

ADD: MuPDF v1.26.7: the MuPDF source as downloaded by a default build of PyMuPDF 1.26.4. The directory name has changed: no version number in the expanded directory now.
author Franz Glasner <fzglas.hg@dom66.de>
date Mon, 15 Sep 2025 11:43:07 +0200
parents
children
comparison
equal deleted inserted replaced
1:1d09e1dec1d9 2:b50eed0cc0ef
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_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 \fBtunnel\fP parameter to 1L to make libcurl tunnel all operations
32 through the HTTP proxy (set with \fICURLOPT_PROXY(3)\fP). There is a big
33 difference between using a proxy and to tunnel through it.
34
35 Tunneling means that an HTTP CONNECT request is sent to the proxy, asking it
36 to connect to a remote host on a specific port number and then the traffic is
37 just passed through the proxy. Proxies tend to white-list specific port numbers
38 it allows CONNECT requests to and often only port 80 and 443 are allowed.
39
40 To suppress proxy CONNECT response headers from user callbacks use
41 \fICURLOPT_SUPPRESS_CONNECT_HEADERS(3)\fP.
42
43 HTTP proxies can generally only speak HTTP (for obvious reasons), which makes
44 libcurl convert non-HTTP requests to HTTP when using an HTTP proxy without
45 this tunnel option set. For example, asking for an FTP URL and specifying an
46 HTTP proxy will make libcurl send an FTP URL in an HTTP GET request to the
47 proxy. By instead tunneling through the proxy, you avoid that conversion (that
48 rarely works through the proxy anyway).
49 .SH DEFAULT
50 0
51 .SH PROTOCOLS
52 All network protocols
53 .SH EXAMPLE
54 .nf
55 CURL *curl = curl_easy_init();
56 if(curl) {
57 curl_easy_setopt(curl, CURLOPT_URL, "ftp://example.com/file.txt");
58 curl_easy_setopt(curl, CURLOPT_PROXY, "http://127.0.0.1:80");
59 curl_easy_setopt(curl, CURLOPT_HTTPPROXYTUNNEL, 1L);
60 curl_easy_perform(curl);
61 }
62 .fi
63 .SH AVAILABILITY
64 Always
65 .SH RETURN VALUE
66 Returns CURLE_OK
67 .SH "SEE ALSO"
68 .BR CURLOPT_PROXY "(3), " CURLOPT_PROXYTYPE "(3), " CURLOPT_PROXYPORT "(3), "