curl/docs/cmdline-opts/proxy.d

Long: proxy
Short: x
Arg: [protocol://]host[:port]
Help: Use this proxy
Category: proxy
Example: --proxy http://proxy.example $URL
---
Use the specified proxy.

The proxy string can be specified with a protocol:// prefix. No protocol
specified or http:// will be treated as HTTP proxy. Use socks4://, socks4a://,
socks5:// or socks5h:// to request a specific SOCKS version to be used.
(Added in 7.21.7)

HTTPS proxy support via https:// protocol prefix was added in 7.52.0 for
OpenSSL, GnuTLS and NSS.

Unrecognized and unsupported proxy protocols cause an error since 7.52.0.
Prior versions may ignore the protocol and use http:// instead.

If the port number is not specified in the proxy string, it is assumed to be
1080.

This option overrides existing environment variables that set the proxy to
use. If there's an environment variable setting a proxy, you can set proxy to
\&"" to override it.

All operations that are performed over an HTTP proxy will transparently be
converted to HTTP. It means that certain protocol specific operations might
not be available. This is not the case if you can tunnel through the proxy, as
one with the --proxytunnel option.

User and password that might be provided in the proxy string are URL decoded
by curl. This allows you to pass in special characters such as @ by using %40
or pass in a colon with %3a.

The proxy host can be specified the exact same way as the proxy environment
variables, including the protocol prefix (http://) and the embedded user +
password.

If this option is used several times, the last one will be used.
cmdline-docs: more options converted and fixed Now all options are in the new system. 2016-11-28 08:01:13 +08:00			`Long: proxy`
			`Short: x`
			`Arg: [protocol://]host[:port]`
			`Help: Use this proxy`
docs: add categories to all cmdline opts Adapted gen.pl with 'listcats' This commit is a part of "--help me if you can" Closes #5680 2020-07-13 20:15:04 +08:00			`Category: proxy`
curl.1: provide examples for each option The file format for each option now features a "Example:" header that can provide one or more examples that get rendered appropriately in the output. All options MUST have at least one example or gen.pl complains at build-time. This fix also does a few other minor format and consistency cleanups. Closes #7654 2021-08-31 22:37:14 +08:00			`Example: --proxy http://proxy.example $URL`
cmdline-docs: more options converted and fixed Now all options are in the new system. 2016-11-28 08:01:13 +08:00			`---`
			`Use the specified proxy.`

docs: Add more HTTPS proxy documentation - Document HTTPS proxy type. - Document --write-out %{proxy_ssl_verify_result}. - Document SOCKS proxy + HTTP/HTTPS proxy combination. HTTPS proxy support was added in 7.52.0 for OpenSSL, GnuTLS and NSS. Ref: https://github.com/curl/curl/commit/cb4e2be 2017-02-06 16:13:42 +08:00			`The proxy string can be specified with a protocol:// prefix. No protocol`
			`specified or http:// will be treated as HTTP proxy. Use socks4://, socks4a://,`
			`socks5:// or socks5h:// to request a specific SOCKS version to be used.`
curl.1: remove mentions of really old version changes To make the man page more readable, this change removes all references to changes in support/versions etc that happened before 7.30.0 from the curl.1 output file. 7.30.0 was released on Apr 12 2013. This particular limit is a bit arbitrary but was fairly easy to grep for. It is handled like this: the 'Added' keyword is only used in output if it refers to 7.30.0 or later. All occurances of "(Added in $VERSION)" in description will be stripped out if the mentioned $VERSION is from before 7.30.0. It is therefore important that the "Added in..." references are always written exactly like that - and on a single line, not split over two. This change removes about 80 version number references from curl.1, down to 138 from 218. Closes #7786 2021-09-28 16:30:59 +08:00			`(Added in 7.21.7)`
docs: Add more HTTPS proxy documentation - Document HTTPS proxy type. - Document --write-out %{proxy_ssl_verify_result}. - Document SOCKS proxy + HTTP/HTTPS proxy combination. HTTPS proxy support was added in 7.52.0 for OpenSSL, GnuTLS and NSS. Ref: https://github.com/curl/curl/commit/cb4e2be 2017-02-06 16:13:42 +08:00
			`HTTPS proxy support via https:// protocol prefix was added in 7.52.0 for`
			`OpenSSL, GnuTLS and NSS.`

			`Unrecognized and unsupported proxy protocols cause an error since 7.52.0.`
			`Prior versions may ignore the protocol and use http:// instead.`
cmdline-docs: more options converted and fixed Now all options are in the new system. 2016-11-28 08:01:13 +08:00
			`If the port number is not specified in the proxy string, it is assumed to be`
			`1080.`

			`This option overrides existing environment variables that set the proxy to`
			`use. If there's an environment variable setting a proxy, you can set proxy to`
			`\&"" to override it.`

			`All operations that are performed over an HTTP proxy will transparently be`
			`converted to HTTP. It means that certain protocol specific operations might`
			`not be available. This is not the case if you can tunnel through the proxy, as`
			`one with the --proxytunnel option.`

			`User and password that might be provided in the proxy string are URL decoded`
			`by curl. This allows you to pass in special characters such as @ by using %40`
			`or pass in a colon with %3a.`

			`The proxy host can be specified the exact same way as the proxy environment`
			`variables, including the protocol prefix (http://) and the embedded user +`
			`password.`

			`If this option is used several times, the last one will be used.`