Move the torify manpage into the doc dir

2 files changed, 44 insertions, 2 deletions

diff --git a/doc/Makefile.am b/doc/Makefile.am
index 79123d81d5..f8e17ecd3e 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -2,9 +2,9 @@
 EXTRA_DIST = HACKING                                         \
              tor-resolve.1 tor-gencert.1                     \
              tor-osx-dmg-creation.txt tor-rpm-creation.txt   \
-             tor-win32-mingw-creation.txt
+             tor-win32-mingw-creation.txt torify.1
 
-man_MANS = tor.1 tor-resolve.1 tor-gencert.1
+man_MANS = tor.1 tor-resolve.1 tor-gencert.1 torify.1
 
 SUBDIRS = design-paper spec
 
diff --git a/doc/torify.1 b/doc/torify.1
new file mode 100644
index 0000000000..9ae4e40d9d
--- /dev/null
+++ b/doc/torify.1
@@ -0,0 +1,42 @@
+.TH torify 1 "" Jan-2009 ""
+.\" manual page by Peter Palfrader and Jacob Appelbaum
+.SH NAME
+.LP
+torify \- wrapper for torsocks or tsocks and tor
+
+.SH SYNOPSIS
+\fBtorify\fP\ \fIapplication\fP\ [\fIapplication's\ arguments\fP]
+
+.SH DESCRIPTION
+\fBtorify\fR 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.
+
+.SH 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
+\fBtor-resolve\fR(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.
+
+.SH SEE ALSO
+.BR tor (1),
+.BR tor-resolve (1),
+.BR torsocks (1),
+.BR tsocks (1),
+.BR tsocks.conf (5).