curl/docs/cmdline-opts/socks5.md

---
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Long: socks5
Arg: <host[:port]>
Help: SOCKS5 proxy on given host + port
Added: 7.18.0
Category: proxy
Multi: single
See-also:
  - socks5-hostname
  - socks4a
Example:
  - --socks5 proxy.example:7000 $URL
---

# `--socks5`

Use the specified SOCKS5 proxy - but resolve the hostname locally. If the
port number is not specified, it is assumed at port 1080.

To specify proxy on a unix domain socket, use localhost for host, e.g.
`socks5://localhost/path/to/socket.sock`

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

This option is superfluous since you can specify a socks5 proxy with --proxy
using a socks5:// protocol prefix. (Added in 7.21.7)

--preproxy can be used to specify a SOCKS proxy at the same time --proxy is
used with an HTTP/HTTPS proxy (added in 7.52.0). In such a case, curl first
connects to the SOCKS proxy and then connects (through SOCKS) to the HTTP or
HTTPS proxy.

This option (as well as --socks4) does not work with IPV6, FTPS or LDAP.
docs/cmdline: change to .md for cmdline docs - switch all invidual files documenting command line options into .md, as the documentation is now markdown-looking. - made the parser treat 4-space indents as quotes - switch to building the curl.1 manpage using the "mainpage.idx" file, which lists the files to include to generate it, instead of using the previous page-footer/headers. Also, those files are now also .md ones, using the same format. I gave them underscore prefixes to make them sort separately: _NAME.md, _SYNOPSIS.md, _DESCRIPTION.md, _URL.md, _GLOBBING.md, _VARIABLES.md, _OUTPUT.md, _PROTOCOLS.md, _PROGRESS.md, _VERSION.md, _OPTIONS.md, _FILES.md, _ENVIRONMENT.md, _PROXYPREFIX.md, _EXITCODES.md, _BUGS.md, _AUTHORS.md, _WWW.md, _SEEALSO.md - updated test cases accordingly Closes #12751 2024-01-21 06:18:43 +08:00			`---`
copyright: update all copyright lines and remove year ranges - they are mostly pointless in all major jurisdictions - many big corporations and projects already don't use them - saves us from pointless churn - git keeps history for us - the year range is kept in COPYING checksrc is updated to allow non-year using copyright statements Closes #10205 2023-01-02 20:51:48 +08:00			`c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.`
docs/cmdline-opts: add copyright and license identifier to each file gen.pl now insists on C: and SPDX-License-Identifier: fields to be present in all files. Closes #9002 2022-06-14 06:12:03 +08:00			`SPDX-License-Identifier: curl`
cmdline-opts: more command line options documented Moved over to the new format 2016-11-28 07:50:25 +08:00			`Long: socks5`
			`Arg: <host[:port]>`
			`Help: SOCKS5 proxy on given host + port`
			`Added: 7.18.0`
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`
cmdline/docs: add a required 'multi' keyword for each option The keyword specifies how option works when specified multiple times: - single: the last provided value replaces the earlier ones - append: it supports being provided multiple times - boolean: on/off values - mutex: flag-like option that disable anoter flag The 'gen.pl' script then outputs the proper and unified language for each option's multi-use behavior in the generated man page. The multi: header is requires in each .d file and will cause build error if missing or set to an unknown value. Closes #9759 2022-10-18 16:39:43 +08:00			`Multi: single`
docs/cmdline: change to .md for cmdline docs - switch all invidual files documenting command line options into .md, as the documentation is now markdown-looking. - made the parser treat 4-space indents as quotes - switch to building the curl.1 manpage using the "mainpage.idx" file, which lists the files to include to generate it, instead of using the previous page-footer/headers. Also, those files are now also .md ones, using the same format. I gave them underscore prefixes to make them sort separately: _NAME.md, _SYNOPSIS.md, _DESCRIPTION.md, _URL.md, _GLOBBING.md, _VARIABLES.md, _OUTPUT.md, _PROTOCOLS.md, _PROGRESS.md, _VERSION.md, _OPTIONS.md, _FILES.md, _ENVIRONMENT.md, _PROXYPREFIX.md, _EXITCODES.md, _BUGS.md, _AUTHORS.md, _WWW.md, _SEEALSO.md - updated test cases accordingly Closes #12751 2024-01-21 06:18:43 +08:00			`See-also:`
			`- socks5-hostname`
			`- socks4a`
			`Example:`
			`- --socks5 proxy.example:7000 $URL`
cmdline-opts: more command line options documented Moved over to the new format 2016-11-28 07:50:25 +08:00			`---`
docs/cmdline: change to .md for cmdline docs - switch all invidual files documenting command line options into .md, as the documentation is now markdown-looking. - made the parser treat 4-space indents as quotes - switch to building the curl.1 manpage using the "mainpage.idx" file, which lists the files to include to generate it, instead of using the previous page-footer/headers. Also, those files are now also .md ones, using the same format. I gave them underscore prefixes to make them sort separately: _NAME.md, _SYNOPSIS.md, _DESCRIPTION.md, _URL.md, _GLOBBING.md, _VARIABLES.md, _OUTPUT.md, _PROTOCOLS.md, _PROGRESS.md, _VERSION.md, _OPTIONS.md, _FILES.md, _ENVIRONMENT.md, _PROXYPREFIX.md, _EXITCODES.md, _BUGS.md, _AUTHORS.md, _WWW.md, _SEEALSO.md - updated test cases accordingly Closes #12751 2024-01-21 06:18:43 +08:00
			# `--socks5`

docs: more language cleanups - present tense - avoid bad words Closes #13003 2024-02-27 17:35:28 +08:00			`Use the specified SOCKS5 proxy - but resolve the hostname locally. If the`
cmdline-opts: more command line options documented Moved over to the new format 2016-11-28 07:50:25 +08:00			`port number is not specified, it is assumed at port 1080.`

socks: support unix sockets for socks proxy Usage: curl -x "socks5h://localhost/run/tor/socks" "https://example.com" Updated runtests.pl to run a socksd server listening on unix socket Added tests test1467 test1468 Added documentation for proxy command line option and socks proxy options Closes #8668 2022-05-19 21:33:22 +08:00			`To specify proxy on a unix domain socket, use localhost for host, e.g.`
docs/cmdline: change to .md for cmdline docs - switch all invidual files documenting command line options into .md, as the documentation is now markdown-looking. - made the parser treat 4-space indents as quotes - switch to building the curl.1 manpage using the "mainpage.idx" file, which lists the files to include to generate it, instead of using the previous page-footer/headers. Also, those files are now also .md ones, using the same format. I gave them underscore prefixes to make them sort separately: _NAME.md, _SYNOPSIS.md, _DESCRIPTION.md, _URL.md, _GLOBBING.md, _VARIABLES.md, _OUTPUT.md, _PROTOCOLS.md, _PROGRESS.md, _VERSION.md, _OPTIONS.md, _FILES.md, _ENVIRONMENT.md, _PROXYPREFIX.md, _EXITCODES.md, _BUGS.md, _AUTHORS.md, _WWW.md, _SEEALSO.md - updated test cases accordingly Closes #12751 2024-01-21 06:18:43 +08:00			`socks5://localhost/path/to/socket.sock`
socks: support unix sockets for socks proxy Usage: curl -x "socks5h://localhost/run/tor/socks" "https://example.com" Updated runtests.pl to run a socksd server listening on unix socket Added tests test1467 test1468 Added documentation for proxy command line option and socks proxy options Closes #8668 2022-05-19 21:33:22 +08:00
cmdline-opts/socks: Mention --preproxy in --socks opts - Document in --socks* opts they're still mutually exclusive of --proxy. Partial revert of 423a93c; I had misinterpreted the SOCKS proxy + HTTP/HTTPS proxy combination. - Document in --socks* opts that --preproxy can be used to specify a SOCKS proxy at the same time --proxy is used with an HTTP/HTTPS proxy. 2017-02-10 07:26:16 +08:00			`This option overrides any previous use of --proxy, as they are mutually`
			`exclusive.`

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			`This option is superfluous since you can specify a socks5 proxy with --proxy`
			`using a socks5:// protocol prefix. (Added in 7.21.7)`
cmdline-opts: more command line options documented Moved over to the new format 2016-11-28 07:50:25 +08:00
cmdline-docs: make sure to phrase it as "added in ...." References to things that were added or changed in a specific version should be specified as "(added in [version]) for two reasons: 1 - consistency 2 - to allow gen.pl to strip them out if deemed referring to too old versions Closes #11821 2023-09-08 20:03:59 +08:00			`--preproxy can be used to specify a SOCKS proxy at the same time --proxy is`
			`used with an HTTP/HTTPS proxy (added in 7.52.0). In such a case, curl first`
			`connects to the SOCKS proxy and then connects (through SOCKS) to the HTTP or`
			`HTTPS 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
cmdline-opts: more command line options documented Moved over to the new format 2016-11-28 07:50:25 +08:00			`This option (as well as --socks4) does not work with IPV6, FTPS or LDAP.`