xref: /curl/docs/cmdline-opts/socks5.md (revision 6e494a23)
1---
2c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
3SPDX-License-Identifier: curl
4Long: socks5
5Arg: <host[:port]>
6Help: SOCKS5 proxy on given host + port
7Added: 7.18.0
8Category: proxy
9Multi: single
10See-also:
11  - socks5-hostname
12  - socks4a
13Example:
14  - --socks5 proxy.example:7000 $URL
15---
16
17# `--socks5`
18
19Use the specified SOCKS5 proxy - but resolve the hostname locally. If the
20port number is not specified, it is assumed at port 1080.
21
22To specify proxy on a unix domain socket, use localhost for host, e.g.
23`socks5://localhost/path/to/socket.sock`
24
25This option overrides any previous use of --proxy, as they are mutually
26exclusive.
27
28This option is superfluous since you can specify a socks5 proxy with --proxy
29using a socks5:// protocol prefix. (Added in 7.21.7)
30
31--preproxy can be used to specify a SOCKS proxy at the same time --proxy is
32used with an HTTP/HTTPS proxy (added in 7.52.0). In such a case, curl first
33connects to the SOCKS proxy and then connects (through SOCKS) to the HTTP or
34HTTPS proxy.
35
36This option (as well as --socks4) does not work with IPV6, FTPS or LDAP.
37