summaryrefslogtreecommitdiff
path: root/doc/tor.1.txt
diff options
context:
space:
mode:
authorTaylor Yu <catalyst@torproject.org>2017-04-26 15:00:15 -0400
committerTaylor Yu <catalyst@torproject.org>2017-04-26 16:39:36 -0400
commit224259a929e0503137ebd191d77a4783e8c1a81b (patch)
tree16dad24151248adc4e77752f2607ac391860c327 /doc/tor.1.txt
parente5eb260b7a534ab1ad9d3221c047ca13004b7756 (diff)
downloadtor-224259a929e0503137ebd191d77a4783e8c1a81b.tar.gz
tor-224259a929e0503137ebd191d77a4783e8c1a81b.zip
Document Bridge line transport arguments
Bridge lines in torrc can contain key=value settings as per-connection arguments to a pluggable transport. tor.1.txt hadn't been updated to reflect this.
Diffstat (limited to 'doc/tor.1.txt')
-rw-r--r--doc/tor.1.txt9
1 files changed, 7 insertions, 2 deletions
diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index c7692379b1..276052c799 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -788,7 +788,7 @@ The following options are useful only for clients (that is, if
so using these relays might make your client stand out.
(Default: 1)
-[[Bridge]] **Bridge** [__transport__] __IP__:__ORPort__ [__fingerprint__]::
+[[Bridge]] **Bridge** [__transport__] __IP__:__ORPort__ [__fingerprint__] [__key__=__val__...]::
When set along with UseBridges, instructs Tor to use the relay at
"IP:ORPort" as a "bridge" relaying into the Tor network. If "fingerprint"
is provided (using the same format as for DirAuthority), we will verify that
@@ -801,7 +801,12 @@ The following options are useful only for clients (that is, if
rather than connecting to the bridge directly. Some transports use a
transport-specific method to work out the remote address to connect to.
These transports typically ignore the "IP:ORPort" specified in the bridge
- line.
+ line. +
+ +
+ Tor passes any "key=val" settings to the pluggable transport proxy as
+ per-connection arguments when connecting to the bridge. Consult
+ the documentation of the pluggable transport for details of what
+ arguments it supports.
[[LearnCircuitBuildTimeout]] **LearnCircuitBuildTimeout** **0**|**1**::
If 0, CircuitBuildTimeout adaptive learning is disabled. (Default: 1)