[or-cvs] [tor/master 06/11] Convert the tor-resolve manpage to asciidoc

[nickm at torproject.org]

Author: Sebastian Hahn <sebastian at torproject.org>
Date: Tue, 19 Jan 2010 14:51:10 +0100
Subject: Convert the tor-resolve manpage to asciidoc
Commit: ce860d8efd73526469ba1de3e8e3665312594940

---
 .gitignore            |    4 ++++
 doc/Makefile.am       |    9 ++++++---
 doc/tor-resolve.1     |   38 --------------------------------------
 doc/tor-resolve.1.txt |   45 +++++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 55 insertions(+), 41 deletions(-)
 delete mode 100644 doc/tor-resolve.1
 create mode 100644 doc/tor-resolve.1.txt

diff --git a/.gitignore b/.gitignore
index ae9cf0a..38f7d54 100644
--- a/.gitignore
+++ b/.gitignore
@@ -97,6 +97,10 @@
 /doc/tor-gencert.1.in
 /doc/tor-gencert.html
 /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.in
 /doc/torify.html
diff --git a/doc/Makefile.am b/doc/Makefile.am
index e7e7896..2a6bba9 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,16 +1,15 @@
-asciidoc_files = tor-gencert torify
+asciidoc_files = tor-gencert tor-resolve torify
 
 html_in = $(asciidoc_files:=.html.in)
 
 man_in = $(asciidoc_files:=.1.in)
 
 EXTRA_DIST = HACKING                                         \
-             tor-resolve.1                                   \
              $(html_in) $(man_in) $(asciidoc_files:=.1.txt)  \
              tor-osx-dmg-creation.txt tor-rpm-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)
 
@@ -27,6 +26,7 @@ $(html_in) :
 
 torify.html.in : torify.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
 # machine-specific replacements yet
@@ -35,6 +35,7 @@ $(man_in) :
 
 torify.1.in : torify.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
 # in the asciidoc with their replacements.
@@ -43,5 +44,7 @@ $(asciidoc_product) :
 
 torify.1 : torify.1.in
 tor-gencert.1 : tor-gencert.1.in
+tor-resolve.1 : tor-resolve.1.in
 torify.html : torify.html.in
 tor-gencert.html : tor-gencert.html.in
+tor-resolve.html : tor-resolve.html.in
diff --git a/doc/tor-resolve.1 b/doc/tor-resolve.1
deleted file mode 100644
index 3987095..0000000
--- a/doc/tor-resolve.1
+++ /dev/null
@@ -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 at mit.edu>, Nick Mathewson <nickm at alum.mit.edu>.
diff --git a/doc/tor-resolve.1.txt b/doc/tor-resolve.1.txt
new file mode 100644
index 0000000..eb51966
--- /dev/null
+++ b/doc/tor-resolve.1.txt
@@ -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 at mit.edu>, Nick Mathewson <nickm at alum.mit.edu>.
\ No newline at end of file
-- 
1.6.5