Merge branch 'maint-0.4.3' into release-0.4.3
[tor.git] / doc / tor-resolve.1.txt
blobf1f8f77a42069e7b6fba3cb171241239c661f216
1 // Copyright (c) The Tor Project, Inc.
2 // See LICENSE for licensing information
3 // This is an asciidoc file used to generate the manpage/html reference.
4 // Learn asciidoc on http://www.methods.co.nz/asciidoc/userguide.html
5 :man source:   Tor
6 :man manual:   Tor Manual
7 tor-resolve(1)
8 ==============
9 Peter Palfrader
11 NAME
12 ----
13 tor-resolve - resolve a hostname to an IP address via tor
15 SYNOPSIS
16 --------
17 **tor-resolve** [-4|-5] [-v] [-x] [-p __socksport__] __hostname__ [__sockshost__[:__socksport__]]
19 DESCRIPTION
20 -----------
21 **tor-resolve** is a simple script to connect to a SOCKS proxy that knows about
22 the SOCKS RESOLVE command, hand it a hostname, and return an IP address.
24 By default, **tor-resolve** uses the Tor server running on 127.0.0.1 on SOCKS
25 port 9050.  If this isn't what you want, you should specify an explicit
26 __sockshost__ and/or __socksport__ on the command line.
28 OPTIONS
29 -------
30 **-v**::
31     Display verbose output.
33 **-x**::
34     Perform a reverse lookup: get the PTR record for an IPv4 address.
36 **-5**::
37     Use the SOCKS5 protocol. (Default)
39 **-4**::
40     Use the SOCKS4a protocol rather than the default SOCKS5 protocol. Doesn't
41     support reverse DNS.
43 **-p** __socksport__::
44     Override the default SOCKS port without setting the hostname.
46 SEE ALSO
47 --------
48 **tor**(1), **torify**(1). +
50 For protocol details, see: https://spec.torproject.org/socks-extensions
52 AUTHORS
53 -------
54 Roger Dingledine <arma@mit.edu>, Nick Mathewson <nickm@alum.mit.edu>.