Clarify that Address is an IPv4 option only.

diff --git a/changes/ticket18891 b/changes/ticket18891
new file mode 100644 (file)
index 0000000..34fd1cb
--- /dev/null
+++ b/changes/ticket18891
@@ -0,0 +1,3 @@
+  o Documentation:
+    - Clarify that the Address option is entirely about setting an
+      advertised IPv4 address. Closes ticket 18891.

diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index f669a055c050e91ded52883e7279c587d1d3b1b1..52501631560d278dd51799f6b027969e310456b6 100644 (file)
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -1642,12 +1642,13 @@ The following options are useful only for servers (that is, if ORPort
 is non-zero):
 
 [[Address]] **Address** __address__::
-    The IP address or fully qualified domain name of this server (e.g.
-    moria.mit.edu). You can leave this unset, and Tor will guess your IP
-    address.  This IP address is the one used to tell clients and other
-    servers where to find your Tor server; it doesn't affect the IP that your
-    Tor client binds to.  To bind to a different address, use the
-    *ListenAddress and OutboundBindAddress options.
+    The IPv4 address of this server, or a fully qualified domain name of
+    this server that resolves to an IPv4 address.  You can leave this
+    unset, and Tor will try to guess your IPv4 address.  This IPv4
+    address is the one used to tell clients and other servers where to
+    find your Tor server; it doesn't affect the address that your server
+    binds to.  To bind to a different address, use the ORPort and
+    OutboundBindAddress options.
 
 [[AssumeReachable]] **AssumeReachable** **0**|**1**::
     This option is used when bootstrapping a new Tor network. If set to 1,