Commit 59a9908f authored by Sebastian Hahn's avatar Sebastian Hahn
Browse files

Convert the torify manpage to asciidoc

parent 2fc0c303
......@@ -97,6 +97,10 @@
/doc/tor-gencert.1.in
/doc/tor-gencert.html
/doc/tor-gencert.html.in
/doc/torify.1
/doc/torify.1.in
/doc/torify.html
/doc/torify.html.in
# /doc/design-paper/
/doc/design-paper/Makefile
......
asciidoc_files = tor-gencert
asciidoc_files = tor-gencert torify
html_in = $(asciidoc_files:=.html.in)
......@@ -8,9 +8,9 @@ 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 torify.1
tor-win32-mingw-creation.txt
nodist_man_MANS = tor.1 tor-resolve.1 torify.1 $(asciidoc_files:=.1)
nodist_man_MANS = tor.1 tor-resolve.1 $(asciidoc_files:=.1)
doc_DATA = $(asciidoc_files:=.html)
......@@ -25,6 +25,7 @@ DIST_SUBDIRS = design-paper spec
$(html_in) :
$(top_srcdir)/doc/asciidoc-helper.sh html @ASCIIDOC@ @SED@ $@
torify.html.in : torify.1.txt
tor-gencert.html.in : tor-gencert.1.txt
# Generate the manpage from asciidoc, but don't do
......@@ -32,6 +33,7 @@ tor-gencert.html.in : tor-gencert.1.txt
$(man_in) :
$(top_srcdir)/doc/asciidoc-helper.sh man @A2X@ @SED@ $@
torify.1.in : torify.1.txt
tor-gencert.1.in : tor-gencert.1.txt
# use ../config.status to swap all machine-specific magic strings
......@@ -39,5 +41,7 @@ tor-gencert.1.in : tor-gencert.1.txt
$(asciidoc_product) :
../config.status --file=$@;
torify.1 : torify.1.in
tor-gencert.1 : tor-gencert.1.in
torify.html : torify.html.in
tor-gencert.html : tor-gencert.html.in
.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).
// 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).
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment