Convert the tor-resolve manpage to asciidoc

This commit is contained in:
Sebastian Hahn 2010-01-19 14:51:10 +01:00
parent 59a9908f66
commit ce860d8efd
4 changed files with 55 additions and 41 deletions

4
.gitignore vendored
View File

@ -97,6 +97,10 @@
/doc/tor-gencert.1.in /doc/tor-gencert.1.in
/doc/tor-gencert.html /doc/tor-gencert.html
/doc/tor-gencert.html.in /doc/tor-gencert.html.in
/doc/tor-resolve.1
/doc/tor-resolve.1.in
/doc/tor-resolve.html
/doc/tor-resolve.html.in
/doc/torify.1 /doc/torify.1
/doc/torify.1.in /doc/torify.1.in
/doc/torify.html /doc/torify.html

View File

@ -1,16 +1,15 @@
asciidoc_files = tor-gencert torify asciidoc_files = tor-gencert tor-resolve torify
html_in = $(asciidoc_files:=.html.in) html_in = $(asciidoc_files:=.html.in)
man_in = $(asciidoc_files:=.1.in) man_in = $(asciidoc_files:=.1.in)
EXTRA_DIST = HACKING \ EXTRA_DIST = HACKING \
tor-resolve.1 \
$(html_in) $(man_in) $(asciidoc_files:=.1.txt) \ $(html_in) $(man_in) $(asciidoc_files:=.1.txt) \
tor-osx-dmg-creation.txt tor-rpm-creation.txt \ tor-osx-dmg-creation.txt tor-rpm-creation.txt \
tor-win32-mingw-creation.txt tor-win32-mingw-creation.txt
nodist_man_MANS = tor.1 tor-resolve.1 $(asciidoc_files:=.1) nodist_man_MANS = tor.1 $(asciidoc_files:=.1)
doc_DATA = $(asciidoc_files:=.html) doc_DATA = $(asciidoc_files:=.html)
@ -27,6 +26,7 @@ $(html_in) :
torify.html.in : torify.1.txt torify.html.in : torify.1.txt
tor-gencert.html.in : tor-gencert.1.txt tor-gencert.html.in : tor-gencert.1.txt
tor-resolve.html.in : tor-resolve.1.txt
# Generate the manpage from asciidoc, but don't do # Generate the manpage from asciidoc, but don't do
# machine-specific replacements yet # machine-specific replacements yet
@ -35,6 +35,7 @@ $(man_in) :
torify.1.in : torify.1.txt torify.1.in : torify.1.txt
tor-gencert.1.in : tor-gencert.1.txt tor-gencert.1.in : tor-gencert.1.txt
tor-resolve.1.in : tor-resolve.1.txt
# use ../config.status to swap all machine-specific magic strings # use ../config.status to swap all machine-specific magic strings
# in the asciidoc with their replacements. # in the asciidoc with their replacements.
@ -43,5 +44,7 @@ $(asciidoc_product) :
torify.1 : torify.1.in torify.1 : torify.1.in
tor-gencert.1 : tor-gencert.1.in tor-gencert.1 : tor-gencert.1.in
tor-resolve.1 : tor-resolve.1.in
torify.html : torify.html.in torify.html : torify.html.in
tor-gencert.html : tor-gencert.html.in tor-gencert.html : tor-gencert.html.in
tor-resolve.html : tor-resolve.html.in

View File

@ -1,38 +0,0 @@
.TH tor-resolve 1 "" Aug-2004 ""
.\" manual page by Peter Palfrader
.SH NAME
.LP
tor-resolve \- resolve a hostname to an IP address via tor
.SH SYNOPSIS
\fBtor-resolve\fP\ [-4|-5] [-v] [-x] \fIhostname\fP\ [\fIsockshost\fP[:\fIsocksport]\fP]
.SH DESCRIPTION
\fBtor-resolve\fR 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.
.SH OPTIONS
\fB-v \fP
Display verbose output.
.LP
.TP
\fB-x\fP
Perform a reverse lookup: get the PTR record for an IPv4 address.
.LP
.TP
\fB-5\fP
Use the SOCKS5 protocol. (Default)
.LP
.TP
\fB-4\fP
Use the SOCKS4a protocol rather than the default SOCKS5 protocol. Doesn't
support reverse DNS.
.SH SEE ALSO
.BR tor (1),
.BR torify (1).
.PP
See doc/socks-extensions.txt in the Tor package for protocol details.
.SH AUTHORS
Roger Dingledine <arma@mit.edu>, Nick Mathewson <nickm@alum.mit.edu>.

45
doc/tor-resolve.1.txt Normal file
View File

@ -0,0 +1,45 @@
// 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 http://www.methods.co.nz/asciidoc/userguide.html
tor-resolve(1)
==============
Peter Palfrader
NAME
----
tor-resolve - resolve a hostname to an IP address via tor
SYNOPSIS
--------
**tor-resolve** [-4|-5] [-v] [-x] __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.
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.
SEE ALSO
--------
**tor**(1), **torify**(1). +
See doc/socks-extensions.txt in the Tor package for protocol details.
AUTHORS
-------
Roger Dingledine <arma@mit.edu>, Nick Mathewson <nickm@alum.mit.edu>.