[tor-commits] [tor/master] Document Bridge line transport arguments

[nickm@xxxxxxxxxxxxxx]

commit 224259a929e0503137ebd191d77a4783e8c1a81b
Author: Taylor Yu <catalyst@xxxxxxxxxxxxxx>
Date:   Wed Apr 26 15:00:15 2017 -0400

    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.
---
 changes/bug20341 | 3 +++
 doc/tor.1.txt    | 9 +++++++--
 2 files changed, 10 insertions(+), 2 deletions(-)

diff --git a/changes/bug20341 b/changes/bug20341
new file mode 100644
index 0000000..399ee50
--- /dev/null
+++ b/changes/bug20341
@@ -0,0 +1,3 @@
+  o Documentation:
+    - Document key=value pluggable transport arguments for Bridge lines in
+      torrc.  Fixes bug 20341; feature first appeared in 0.2.5.1-alpha.
diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index c769237..276052c 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)

_______________________________________________
tor-commits mailing list
tor-commits@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-commits