Commit 423a93ce authored by Jay Satiro's avatar Jay Satiro
Browse files

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
parent a49d2d0e

docs/cmdline-opts/proxy.d

+10 −5
Original line number Diff line number Diff line
@@ -5,11 +5,16 @@ Help: Use this proxy 
---

Use the specified proxy.



The proxy string can be specified with a protocol:// prefix to specify

alternative proxy protocols. Use socks4://, socks4a://, socks5:// or

socks5h:// to request the specific SOCKS version to be used. No protocol

specified, http:// and all others will be treated as HTTP proxies. (The

protocol support was added in curl 7.21.7)

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.

(The protocol support was added in curl 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.

docs/cmdline-opts/socks4.d

+5 −3
Original line number Diff line number Diff line
@@ -6,10 +6,12 @@ Added: 7.15.2 
Use the specified SOCKS4 proxy. If the port number is not specified, it is

assumed at port 1080.



This option overrides any previous use of --proxy, as they are mutually

exclusive.



Since 7.21.7, this option is superfluous since you can specify a socks4 proxy

with --proxy using a socks4:// protocol prefix.



This option typically overrides any previous use of --proxy; however since

7.52.0 if --proxy is used to specify an HTTP or HTTPS proxy then curl will

attempt to use it with the SOCKS proxy. In such a case curl first connects to

the SOCKS proxy and then connects (through SOCKS) to the HTTP or HTTPS proxy.



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

docs/cmdline-opts/socks4a.d

+5 −3
Original line number Diff line number Diff line
@@ -6,10 +6,12 @@ Added: 7.18.0 
Use the specified SOCKS4a proxy. If the port number is not specified, it is

assumed at port 1080.



This option overrides any previous use of --proxy, as they are mutually

exclusive.



Since 7.21.7, this option is superfluous since you can specify a socks4a proxy

with --proxy using a socks4a:// protocol prefix.



This option typically overrides any previous use of --proxy; however since

7.52.0 if --proxy is used to specify an HTTP or HTTPS proxy then curl will

attempt to use it with the SOCKS proxy. In such a case curl first connects to

the SOCKS proxy and then connects (through SOCKS) to the HTTP or HTTPS proxy.



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

docs/cmdline-opts/socks5-hostname.d

+5 −3
Original line number Diff line number Diff line
@@ -6,10 +6,12 @@ Added: 7.18.0 
Use the specified SOCKS5 proxy (and let the proxy resolve the host name). If

the port number is not specified, it is assumed at port 1080.



This option overrides any previous use of --proxy, as they are mutually

exclusive.



Since 7.21.7, this option is superfluous since you can specify a socks5

hostname proxy with --proxy using a socks5h:// protocol prefix.



This option typically overrides any previous use of --proxy; however since

7.52.0 if --proxy is used to specify an HTTP or HTTPS proxy then curl will

attempt to use it with the SOCKS proxy. In such a case curl first connects to

the SOCKS proxy and then connects (through SOCKS) to the HTTP or HTTPS proxy.



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

docs/cmdline-opts/socks5.d

+5 −3
Original line number Diff line number Diff line
@@ -6,12 +6,14 @@ Added: 7.18.0 
Use the specified SOCKS5 proxy - but resolve the host name locally. If the

port number is not specified, it is assumed at port 1080.



This option overrides any previous use of --proxy, as they are mutually

exclusive.



Since 7.21.7, this option is superfluous since you can specify a socks5 proxy

with --proxy using a socks5:// protocol prefix.



This option typically overrides any previous use of --proxy; however since

7.52.0 if --proxy is used to specify an HTTP or HTTPS proxy then curl will

attempt to use it with the SOCKS proxy. In such a case curl first connects to

the SOCKS proxy and then connects (through SOCKS) to the HTTP or HTTPS proxy.



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



This option (as well as --socks4) does not work with IPV6, FTPS or LDAP.