Convert the torify manpage to asciidoc

1 files changed, 50 insertions, 0 deletions

diff --git a/doc/torify.1.txt b/doc/torify.1.txt
new file mode 100644
index 0000000000..ca2c385c94
--- /dev/null
+++ b/doc/torify.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 http://www.methods.co.nz/asciidoc/userguide.html
+torify(1)
+=========
+Peter Palfrader
+Jacob Appelbaum
+
+NAME
+----
+torify - wrapper for torsocks or tsocks and tor
+
+SYNOPSIS
+--------
+**torify** __application__ [__application's__ __arguments__]
+
+DESCRIPTION
+-----------
+**torify** is a simple wrapper that attempts to find the best underlying Tor
+wrapper available on a system. It calls torsocks or tsocks with a tor specific
+configuration file. +
+
+torsocks is an improved wrapper that explictly rejects UDP, safely resolves DNS
+lookups and properly socksifies your TCP connections. +
+
+tsocks itself is a wrapper between the tsocks library and the application that
+you would like to run socksified. +
+
+Please note that since both method use LD_PRELOAD, torify cannot be applied to
+suid binaries.
+
+WARNING
+-------
+You should also be aware that the way tsocks currently works only TCP
+connections are socksified. Be aware that this will in most circumstances not
+include hostname lookups which would still be routed through your normal system
+resolver to your usual resolving nameservers. The **tor-resolve**(1) tool can be
+useful as a workaround in some cases. The Tor FAQ at
+https://wiki.torproject.org/noreply/TheOnionRouter/TorFAQ might have further
+information on this subject. +
+
+When used with torsocks, torify should not leak DNS requests or UDP data. +
+
+Both will leak ICMP data.
+
+SEE ALSO
+--------
+**tor**(1), **tor-resolve**(1), **torsocks**(1), **tsocks**(1),
+**tsocks.conf**(5).