[tor-commits] [tor/master] Tweak ControlPort description in manpage

[nickm at torproject.org]

commit 8eadfad71daaad985ac1262436bc232d4b184d71
Author: rl1987 <rl1987 at sdf.lonestar.org>
Date:   Sun Dec 23 19:58:25 2018 +0200

    Tweak ControlPort description in manpage
---
 changes/doc28805 | 4 ++++
 doc/tor.1.txt    | 5 +++--
 2 files changed, 7 insertions(+), 2 deletions(-)

diff --git a/changes/doc28805 b/changes/doc28805
new file mode 100644
index 000000000..6c9fea44f
--- /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 4ff789a93..b058bebcb 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...