From 2dfa19a871d8f54a91881475820e82246ed66132 Mon Sep 17 00:00:00 2001 From: Nick Mathewson Date: Fri, 19 Mar 2021 13:23:29 -0400 Subject: Move ServerTransport* options to 'Server Options' section. Patch from 'cypherpunks'. Closes #40331. --- changes/ticket-40331 | 3 +++ doc/man/tor.1.txt | 33 ++++++++++++++++----------------- 2 files changed, 19 insertions(+), 17 deletions(-) create mode 100644 changes/ticket-40331 diff --git a/changes/ticket-40331 b/changes/ticket-40331 new file mode 100644 index 0000000000..c99d704c33 --- /dev/null +++ b/changes/ticket-40331 @@ -0,0 +1,3 @@ + o Documentation (doc/man/tor.1.txt) : + - Move the ServerTransport* options options to the SERVER OPTIONS` section . + Closes issue 40331. diff --git a/doc/man/tor.1.txt b/doc/man/tor.1.txt index b43f61d054..a1552ef1aa 100644 --- a/doc/man/tor.1.txt +++ b/doc/man/tor.1.txt @@ -966,23 +966,6 @@ forward slash (/) in the configuration file and on the command line. If KIST is used in Schedulers, this is a multiplier of the per-socket limit calculation of the KIST algorithm. (Default: 1.0) - -[[ServerTransportListenAddr]] **ServerTransportListenAddr** __transport__ __IP__:__PORT__:: - When this option is set, Tor will suggest __IP__:__PORT__ as the - listening address of any pluggable transport proxy that tries to - launch __transport__. (IPv4 addresses should written as-is; IPv6 - addresses should be wrapped in square brackets.) (Default: none) - -[[ServerTransportOptions]] **ServerTransportOptions** __transport__ __k=v__ __k=v__ ...:: - When this option is set, Tor will pass the __k=v__ parameters to - any pluggable transport proxy that tries to launch __transport__. + - (Example: ServerTransportOptions obfs45 shared-secret=bridgepasswd cache=/var/lib/tor/cache) (Default: none) - -[[ServerTransportPlugin]] **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. (Default: none) - [[Socks4Proxy]] **Socks4Proxy** __host__[:__port__]:: Tor will make all OR connections through the SOCKS 4 proxy at host:port (or host:1080 if port is not specified). @@ -2676,6 +2659,22 @@ is non-zero): name lookups that your server does on behalf of clients. (Default: "www.google.com, www.mit.edu, www.yahoo.com, www.slashdot.org") +[[ServerTransportListenAddr]] **ServerTransportListenAddr** __transport__ __IP__:__PORT__:: + When this option is set, Tor will suggest __IP__:__PORT__ as the + listening address of any pluggable transport proxy that tries to + launch __transport__. (IPv4 addresses should written as-is; IPv6 + addresses should be wrapped in square brackets.) (Default: none) + +[[ServerTransportOptions]] **ServerTransportOptions** __transport__ __k=v__ __k=v__ ...:: + When this option is set, Tor will pass the __k=v__ parameters to + any pluggable transport proxy that tries to launch __transport__. + + (Example: ServerTransportOptions obfs45 shared-secret=bridgepasswd cache=/var/lib/tor/cache) (Default: none) + +[[ServerTransportPlugin]] **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. (Default: none) + [[ShutdownWaitLength]] **ShutdownWaitLength** __NUM__:: When we get a SIGINT and we're a server, we begin shutting down: we close listeners and start refusing new circuits. After **NUM** -- cgit v1.2.3-54-g00ecf