xf.li | 6c8fc1e | 2023-08-12 00:11:09 -0700 | [diff] [blame] | 1 | c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al. |
| 2 | SPDX-License-Identifier: curl |
| 3 | Long: proxy |
| 4 | Short: x |
| 5 | Arg: [protocol://]host[:port] |
| 6 | Help: Use this proxy |
| 7 | Category: proxy |
| 8 | Example: --proxy http://proxy.example $URL |
| 9 | Added: 4.0 |
| 10 | See-also: socks5 proxy-basic |
| 11 | Multi: single |
| 12 | --- |
| 13 | Use the specified proxy. |
| 14 | |
| 15 | The proxy string can be specified with a protocol:// prefix. No protocol |
| 16 | specified or http:// will be treated as HTTP proxy. Use socks4://, socks4a://, |
| 17 | socks5:// or socks5h:// to request a specific SOCKS version to be used. |
| 18 | (Added in 7.21.7) |
| 19 | |
| 20 | Unix domain sockets are supported for socks proxy. Set localhost for the host |
| 21 | part. e.g. socks5h://localhost/path/to/socket.sock |
| 22 | |
| 23 | HTTPS proxy support via https:// protocol prefix was added in 7.52.0 for |
| 24 | OpenSSL, GnuTLS and NSS. |
| 25 | |
| 26 | Unrecognized and unsupported proxy protocols cause an error since 7.52.0. |
| 27 | Prior versions may ignore the protocol and use http:// instead. |
| 28 | |
| 29 | If the port number is not specified in the proxy string, it is assumed to be |
| 30 | 1080. |
| 31 | |
| 32 | This option overrides existing environment variables that set the proxy to |
| 33 | use. If there's an environment variable setting a proxy, you can set proxy to |
| 34 | "" to override it. |
| 35 | |
| 36 | All operations that are performed over an HTTP proxy will transparently be |
| 37 | converted to HTTP. It means that certain protocol specific operations might |
| 38 | not be available. This is not the case if you can tunnel through the proxy, as |
| 39 | one with the --proxytunnel option. |
| 40 | |
| 41 | User and password that might be provided in the proxy string are URL decoded |
| 42 | by curl. This allows you to pass in special characters such as @ by using %40 |
| 43 | or pass in a colon with %3a. |
| 44 | |
| 45 | The proxy host can be specified the same way as the proxy environment |
| 46 | variables, including the protocol prefix (http://) and the embedded user + |
| 47 | password. |