Mercurial > hgrepos > Python2 > PyMuPDF

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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 - 2018, 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_PROXY 3 "17 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt options"
24 .SH NAME
25 CURLOPT_PROXY \- set proxy to use
26 .SH SYNOPSIS
27 #include <curl/curl.h>
28
29 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY, char *proxy);
30 .SH DESCRIPTION
31 Set the \fIproxy\fP to use for the upcoming request. The parameter should be a
32 char * to a zero terminated string holding the host name or dotted numerical
33 IP address. A numerical IPv6 address must be written within [brackets].
34
35 To specify port number in this string, append :[port] to the end of the host
36 name. The proxy's port number may optionally be specified with the separate
37 option \fICURLOPT_PROXYPORT(3)\fP. If not specified, libcurl will default to
38 using port 1080 for proxies.
39
40 The proxy string may be prefixed with [scheme]:// to specify which kind of
41 proxy is used.
42
43 .RS
44 .IP http://
45 HTTP Proxy. Default when no scheme or proxy type is specified.
46 .IP https://
47 HTTPS Proxy. (Added in 7.52.0 for OpenSSL, GnuTLS and NSS)
48 .IP socks4://
49 SOCKS4 Proxy.
50 .IP socks4a://
51 SOCKS4a Proxy. Proxy resolves URL hostname.
52 .IP socks5://
53 SOCKS5 Proxy.
54 .IP socks5h://
55 SOCKS5 Proxy. Proxy resolves URL hostname.
56 .RE
57
58 Without a scheme prefix, \fICURLOPT_PROXYTYPE(3)\fP can be used to specify
59 which kind of proxy the string identifies.
60
61 When you tell the library to use an HTTP proxy, libcurl will transparently
62 convert operations to HTTP even if you specify an FTP URL etc. This may have
63 an impact on what other features of the library you can use, such as
64 \fICURLOPT_QUOTE(3)\fP and similar FTP specifics that don't work unless you
65 tunnel through the HTTP proxy. Such tunneling is activated with
66 \fICURLOPT_HTTPPROXYTUNNEL(3)\fP.
67
68 Setting the proxy string to "" (an empty string) will explicitly disable the
69 use of a proxy, even if there is an environment variable set for it.
70
71 A proxy host string can also include protocol scheme (http://) and embedded
72 user + password.
73
74 The application does not have to keep the string around after setting this
75 option.
76 .SH "Environment variables"
77 libcurl respects the proxy environment variables named \fBhttp_proxy\fP,
78 \fBftp_proxy\fP, \fBsftp_proxy\fP etc. If set, libcurl will use the specified
79 proxy for that URL scheme. So for a "FTP://" URL, the \fBftp_proxy\fP is
80 considered. \fBall_proxy\fP is used if no protocol specific proxy was set.
81
82 If \fBno_proxy\fP (or \fBNO_PROXY\fP) is set, it is the exact equivalent of
83 setting the \fICURLOPT_NOPROXY(3)\fP option.
84
85 The \fICURLOPT_PROXY(3)\fP and \fICURLOPT_NOPROXY(3)\fP options override
86 environment variables.
87 .SH DEFAULT
88 Default is NULL, meaning no proxy is used.
89
90 When you set a host name to use, do not assume that there's any particular
91 single port number used widely for proxies. Specify it!
92 .SH PROTOCOLS
93 All except file://. Note that some protocols don't do very well over proxy.
94 .SH EXAMPLE
95 .nf
96 CURL *curl = curl_easy_init();
97 if(curl) {
98 curl_easy_setopt(curl, CURLOPT_URL, "http://example.com/file.txt");
99 curl_easy_setopt(curl, CURLOPT_PROXY, "http://proxy:80");
100 curl_easy_perform(curl);
101 }
102 .fi
103 .SH AVAILABILITY
104 Since 7.14.1 the proxy environment variable names can include the protocol
105 scheme.
106
107 Since 7.21.7 the proxy string supports the socks protocols as "schemes".
108
109 Since 7.50.2, unsupported schemes in proxy strings cause libcurl to return
110 error.
111 .SH RETURN VALUE
112 Returns CURLE_OK if proxies are supported, CURLE_UNKNOWN_OPTION if not, or
113 CURLE_OUT_OF_MEMORY if there was insufficient heap space.
114 .SH "SEE ALSO"
115 .BR CURLOPT_PROXYPORT "(3), " CURLOPT_HTTPPROXYTUNNEL "(3), "
116 .BR CURLOPT_PROXYTYPE "(3)"