diff --git a/changes/doc28805 b/changes/doc28805 new file mode 100644 index 0000000000..6c9fea44fa --- /dev/null +++ b/changes/doc28805 @@ -0,0 +1,4 @@ + o Documentation (manpage): + - Improve ControlPort description in tor manpage to mention that it + accepts address/port pair, and can be used multiple times. Closes ticket + 28805. diff --git a/doc/tor.1.txt b/doc/tor.1.txt index 4ff789a931..b058bebcb3 100644 --- a/doc/tor.1.txt +++ b/doc/tor.1.txt @@ -350,7 +350,7 @@ GENERAL OPTIONS all sockets will be set to this limit. Must be a value between 2048 and 262144, in 1024 byte increments. Default of 8192 is recommended. -[[ControlPort]] **ControlPort** __PORT__|**unix:**__path__|**auto** [__flags__]:: +[[ControlPort]] **ControlPort** \['address':]__port__|**unix:**__path__|**auto** [__flags__]:: If set, Tor will accept connections on this port and allow those connections to control the Tor process using the Tor Control Protocol (described in control-spec.txt in @@ -361,7 +361,8 @@ GENERAL OPTIONS methods means either method is sufficient to authenticate to Tor.) This option is required for many Tor controllers; most use the value of 9051. If a unix domain socket is used, you may quote the path using standard - C escape sequences. + C escape sequences. You can specify this directive multiple times, to + bind to multiple address/port pairs. Set it to "auto" to have Tor pick a port for you. (Default: 0) + + Recognized flags are...