aboutsummaryrefslogtreecommitdiff
path: root/doc/man/tor-resolve.1.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/man/tor-resolve.1.txt')
-rw-r--r--doc/man/tor-resolve.1.txt50
1 files changed, 50 insertions, 0 deletions
diff --git a/doc/man/tor-resolve.1.txt b/doc/man/tor-resolve.1.txt
new file mode 100644
index 0000000000..c944d75650
--- /dev/null
+++ b/doc/man/tor-resolve.1.txt
@@ -0,0 +1,50 @@
+// Copyright (c) The Tor Project, Inc.
+// See LICENSE for licensing information
+// This is an asciidoc file used to generate the manpage/html reference.
+// Learn asciidoc on https://www.methods.co.nz/asciidoc/userguide.html
+:man source: Tor
+:man manual: Tor Manual
+tor-resolve(1)
+==============
+Peter Palfrader
+
+NAME
+----
+tor-resolve - resolve a hostname to an IP address via tor
+
+SYNOPSIS
+--------
+**tor-resolve** [-4|-5] [-v] [-x] [-p __socksport__] __hostname__ [__sockshost__[:__socksport__]]
+
+DESCRIPTION
+-----------
+**tor-resolve** is a simple script to connect to a SOCKS proxy that knows about
+the SOCKS RESOLVE command, hand it a hostname, and return an IP address.
+
+By default, **tor-resolve** uses the Tor server running on 127.0.0.1 on SOCKS
+port 9050. If this isn't what you want, you should specify an explicit
+__sockshost__ and/or __socksport__ on the command line.
+
+OPTIONS
+-------
+**-v**::
+ Display verbose output.
+
+**-x**::
+ Perform a reverse lookup: get the PTR record for an IPv4 address.
+
+**-5**::
+ Use the SOCKS5 protocol. (Default)
+
+**-4**::
+ Use the SOCKS4a protocol rather than the default SOCKS5 protocol. Doesn't
+ support reverse DNS.
+
+**-p** __socksport__::
+ Override the default SOCKS port without setting the hostname.
+
+SEE ALSO
+--------
+**tor**(1), **torify**(1). +
+
+For protocol details, see: https://spec.torproject.org/socks-extensions