[tor-commits] [tor/master] Revise MapAddress manpage

[nickm at torproject.org]

commit 00ecc2212660e3d31c1c5098e5bbef618ece5ef8
Author: Nick Mathewson <nickm at torproject.org>
Date:   Thu Sep 8 12:19:27 2011 -0400

    Revise MapAddress manpage
    
    make the asciidoc work; make the example more generic; tighten the
    prose a little; be more specific that *.example.com matches
    example.com; simplify an example.
---
 doc/tor.1.txt |   27 +++++++++++++--------------
 1 files changed, 13 insertions(+), 14 deletions(-)

diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index eb79452..7679126 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -655,18 +655,19 @@ The following options are useful only for clients (that is, if
     5050, 5190, 5222, 5223, 6523, 6667, 6697, 8300)
 
 **MapAddress** __address__ __newaddress__::
-    When a request for address arrives to Tor, it will rewrite it to newaddress
+    When a request for address arrives to Tor, it will transform to newaddress
     before processing it. For example, if you always want connections to
-    www.indymedia.org to exit via __torserver__ (where __torserver__ is the
-    nickname of the server), use MapAddress www.indymedia.org
-    www.indymedia.org.torserver.exit. If the value is prepended with a
-    '*.', it is treated as matching an entire domain. For example, if you
-    always want connections to  any sub-domain of indymedia.org to exit via
+    www.example.com to exit via __torserver__ (where __torserver__ is the
+    nickname of the server), use "MapAddress www.example.com
+    www.example.com.torserver.exit". If the value is prefixed with a
+    "\*.", matches an entire domain. For example, if you
+    always want connections to example.com and any if its subdomains
+    to exit via
     __torserver__ (where __torserver__ is the nickname of the server), use
-    MapAddress *.indymedia.org *.indymedia.org.torserver.exit. (Note the
-    leading '*.' in each part of the directive.) You can also redirect all
-    subdomains of a domain to a single address. For example, MapAddress
-    *.indymedia.org www.indymedia.org. +
+    "MapAddress \*.example.com \*.example.com.torserver.exit". (Note the
+    leading "*." in each part of the directive.) You can also redirect all
+    subdomains of a domain to a single address. For example, "MapAddress
+    *.example.com www.example.com". +
  +
     NOTES:
 
@@ -681,18 +682,16 @@ The following options are useful only for clients (that is, if
     if you have the following in your torrc, www.torproject.org will map to
     2.2.2.2:
 
-      MapAddress www.torproject.org 3.3.3.3
-      MapAddress 1.1.1.1 4.4.4.4
       MapAddress 1.1.1.1 2.2.2.2
       MapAddress www.torproject.org 1.1.1.1
 
     3. The following MapAddress expression is invalid (and will be
-    ignored) because you cannot map from a specific address to a wildcarded
+    ignored) because you cannot map from a specific address to a wildcard
     address:
 
       MapAddress www.torproject.org *.torproject.org.torserver.exit
 
-    4. Using a wildcard as a regular expression (e.g. *ample.com) is
+    4. Using a wildcard to match only part of a string (as in *ample.com) is
     also invalid.
 
 **NewCircuitPeriod** __NUM__::