[tor-commits] [tor/master] doc: Improve port flags in man page

dgoulet at torproject.org dgoulet at torproject.org
Mon Jan 20 16:00:25 UTC 2020


commit 6898131b41fe7c2ddf90a74c1793a15c41337940
Author: teor <teor at torproject.org>
Date:   Mon Jan 20 16:38:02 2020 +1000

    doc: Improve port flags in man page
    
    Explain that:
    * most flags default to off
    * flags that default to on are specified
    
    Document PreferIPv6Automap in its "No" form, because it's on by
    default.
    
    Cleanup after 32637.
---
 doc/tor.1.txt | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index c84eba56e..5f8435195 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -1703,7 +1703,9 @@ The following options are useful only for clients (that is, if
     connections via SOCKS. Set it to "auto" to have Tor pick a port for
     you. This directive can be specified multiple times to bind
     to multiple addresses/ports. If a unix domain socket is used, you may
-    quote the path using standard C escape sequences.
+    quote the path using standard C escape sequences. Most flags are off by
+    default, except where specified. Flags that are on by default can be
+    disabled by putting "No" before the flag name.
     (Default: 9050) +
      +
         NOTE: Although this option allows you to specify an IP address
@@ -1802,11 +1804,11 @@ The following options are useful only for clients (that is, if
     **UseDNSCache**;;
         Tells the client to use any cached DNS answers we have when making
         requests via this connection.
-    **PreferIPv6Automap**;;
+    **NoPreferIPv6Automap**;;
         When serving a hostname lookup request on this port that
         should get automapped (according to AutomapHostsOnResolve),
         if we could return either an IPv4 or an IPv6 answer, prefer
-        an IPv6 answer. (On by default.)
+        an IPv4 answer. (Tor prefers IPv6 by default.)
     **PreferSOCKSNoAuth**;;
         Ordinarily, when an application offers both "username/password
         authentication" and "no authentication" to Tor via SOCKS5, Tor





More information about the tor-commits mailing list