docs: mention the protocol:// support in proxy strings

This commit is contained in:
Daniel Stenberg
2011-05-02 22:15:14 +02:00
parent f78fa6a57d
commit d4ebf3c6b0
2 changed files with 25 additions and 10 deletions

View File

@@ -1542,22 +1542,27 @@ means the verification was successful. (Added in 7.19.0)
.RE .RE
If this option is used several times, the last one will be used. If this option is used several times, the last one will be used.
.IP "-x/--proxy <proxyhost[:port]>" .IP "-x/--proxy <[protocol://][user@password]proxyhost[:port]>"
Use the specified HTTP proxy. If the port number is not specified, it is assumed Use the specified HTTP proxy. If the port number is not specified, it is
at port 1080. assumed at port 1080.
This option overrides existing environment variables that set the proxy to 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 use. If there's an environment variable setting a proxy, you can set proxy to
\&"" to override it. \&"" to override it.
\fBNote\fP that all operations that are performed over a HTTP proxy will All operations that are performed over a HTTP proxy will transparently be
transparently be converted to HTTP. It means that certain protocol specific converted to HTTP. It means that certain protocol specific operations might
operations might not be available. This is not the case if you can tunnel not be available. This is not the case if you can tunnel through the proxy, as
through the proxy, as done with the \fI-p/--proxytunnel\fP option. done with the \fI-p/--proxytunnel\fP option.
Starting with 7.14.1, the proxy host can be specified the exact same way as The proxy host can be specified the exact same way as the proxy environment
the proxy environment variables, including the protocol prefix (http://) and variables, including the protocol prefix (http://) and the embedded user +
the embedded user + password. password.
From 7.21.7, the proxy string may be specified with a protocol:// prefix to
specify alternative proxy protocols. Use socks4://, socks4a:// or socks5:// to
request the specific SOCKS version to be used. No protocol specified, http://
and all others will be treated as HTTP proxies.
If this option is used several times, the last one will be used. If this option is used several times, the last one will be used.
.IP "-X/--request <command>" .IP "-X/--request <command>"
@@ -1649,6 +1654,11 @@ Sets the proxy server to use if no protocol-specific proxy is set.
.IP "NO_PROXY <comma-separated list of hosts>" .IP "NO_PROXY <comma-separated list of hosts>"
list of host names that shouldn't go through any proxy. If set to a asterisk list of host names that shouldn't go through any proxy. If set to a asterisk
\&'*' only, it matches all hosts. \&'*' only, it matches all hosts.
Since 7.21.7, the proxy string may be specified with a protocol:// prefix to
specify alternative proxy protocols. Use socks4://, socks4a:// or socks5:// to
request the specific SOCKS version to be used. No protocol specified, http://
and all others will be treated as HTTP proxies.
.SH EXIT CODES .SH EXIT CODES
There are a bunch of different error codes and their corresponding error There are a bunch of different error codes and their corresponding error
messages that may appear during bad conditions. At the time of this writing, messages that may appear during bad conditions. At the time of this writing,

View File

@@ -632,6 +632,11 @@ use of a proxy, even if there is an environment variable set for it.
Since 7.14.1, the proxy host string given in environment variables can be Since 7.14.1, the proxy host string given in environment variables can be
specified the exact same way as the proxy can be set with \fICURLOPT_PROXY\fP, specified the exact same way as the proxy can be set with \fICURLOPT_PROXY\fP,
include protocol prefix (http://) and embedded user + password. include protocol prefix (http://) and embedded user + password.
Since 7.21.7, the proxy string may be specified with a protocol:// prefix to
specify alternative proxy protocols. Use socks4://, socks4a:// or socks5:// to
request the specific SOCKS version to be used. No protocol specified, http://
and all others will be treated as HTTP proxies.
.IP CURLOPT_PROXYPORT .IP CURLOPT_PROXYPORT
Pass a long with this option to set the proxy port to connect to unless it is Pass a long with this option to set the proxy port to connect to unless it is
specified in the proxy string \fICURLOPT_PROXY\fP. specified in the proxy string \fICURLOPT_PROXY\fP.