blob: 6506692be8844b614559836d150571be907c877a [file] [log] [blame]
lh9ed821d2023-04-07 01:36:19 -07001Long: proxy
2Short: x
3Arg: [protocol://]host[:port]
4Help: Use this proxy
5---
6Use the specified proxy.
7
8The proxy string can be specified with a protocol:// prefix. No protocol
9specified or http:// will be treated as HTTP proxy. Use socks4://, socks4a://,
10socks5:// or socks5h:// to request a specific SOCKS version to be used.
11(The protocol support was added in curl 7.21.7)
12
13HTTPS proxy support via https:// protocol prefix was added in 7.52.0 for
14OpenSSL, GnuTLS and NSS.
15
16Unrecognized and unsupported proxy protocols cause an error since 7.52.0.
17Prior versions may ignore the protocol and use http:// instead.
18
19If the port number is not specified in the proxy string, it is assumed to be
201080.
21
22This option overrides existing environment variables that set the proxy to
23use. If there's an environment variable setting a proxy, you can set proxy to
24\&"" to override it.
25
26All operations that are performed over an HTTP proxy will transparently be
27converted to HTTP. It means that certain protocol specific operations might
28not be available. This is not the case if you can tunnel through the proxy, as
29one with the --proxytunnel option.
30
31User and password that might be provided in the proxy string are URL decoded
32by curl. This allows you to pass in special characters such as @ by using %40
33or pass in a colon with %3a.
34
35The proxy host can be specified the exact same way as the proxy environment
36variables, including the protocol prefix (http://) and the embedded user +
37password.
38
39If this option is used several times, the last one will be used.