aboutsummaryrefslogtreecommitdiff
path: root/docs/cmdline-opts/proxy.d
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2016-11-28 01:01:13 +0100
committerDaniel Stenberg <daniel@haxx.se>2016-11-28 09:53:15 +0100
commita387d881ecf1cfe8def1460fdf2faa3fdef66302 (patch)
tree58148de3354cb8522e90e42a95e6243a7543c8e9 /docs/cmdline-opts/proxy.d
parentac85f332f13f2e105e69d5f4b97c1787a824f637 (diff)
cmdline-docs: more options converted and fixed
Now all options are in the new system.
Diffstat (limited to 'docs/cmdline-opts/proxy.d')
-rw-r--r--docs/cmdline-opts/proxy.d34
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/cmdline-opts/proxy.d b/docs/cmdline-opts/proxy.d
new file mode 100644
index 000000000..377a51aab
--- /dev/null
+++ b/docs/cmdline-opts/proxy.d
@@ -0,0 +1,34 @@
+Long: proxy
+Short: x
+Arg: [protocol://]host[:port]
+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)
+
+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.