aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGeorge Kadianakis <desnacked@riseup.net>2012-01-21 16:28:48 +0200
committerGeorge Kadianakis <desnacked@riseup.net>2012-01-21 16:28:48 +0200
commit8265a9e5b12572de890f922e14dae43b051feaae (patch)
tree298f8b16242c3914ee6acb7f461f36614b687c9a
parenta812e8b6a875241839e2fd367c31b9e446977dff (diff)
downloadtor-8265a9e5b12572de890f922e14dae43b051feaae.tar
tor-8265a9e5b12572de890f922e14dae43b051feaae.tar.gz
Better documentation of transport-related torrc options.
Document ServerTransportPlugin and the managed proxy version of ClientTransportPlugin.
-rw-r--r--doc/tor.1.txt19
1 files changed, 15 insertions, 4 deletions
diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index 37151712f..16faa857f 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -111,10 +111,21 @@ Other options can be specified either on the command-line (--option
published in the consensus and your relay will use that value. (Default: 0)
**ClientTransportPlugin** __transport__ socks4|socks5 __IP__:__PORT__::
- When set along with a corresponding Bridge line, the Tor client
- forwards its traffic to a SOCKS-speaking proxy on "IP:PORT". It's
- the duty of that proxy to properly forward the traffic to the
- bridge.
+**ClientTransportPlugin** __transport__ exec __path-to-binary__ [options]::
+ In its first form, when set along with a corresponding Bridge line, the Tor
+ client forwards its traffic to a SOCKS-speaking proxy on "IP:PORT". It's the
+ duty of that proxy to properly forward the traffic to the bridge. +
+ +
+ In its second form, when set along with a corresponding Bridge line, the Tor
+ client launches the pluggable transport proxy exacutable in
+ __path-to-binary__ using __options__ as its command-line options, and
+ forwards its traffic to it. It's the duty of that proxy to properly forward
+ the traffic to the bridge.
+
+**ServerTransportPlugin** __transport__ exec __path-to-binary__ [options]::
+ The Tor relay launches the pluggable transport proxy in __path-to-binary__
+ using __options__ as its command-line options, and expects to receive
+ proxied client traffic from it.
**ConnLimit** __NUM__::
The minimum number of file descriptors that must be available to the Tor