[tor-commits] [tor/master] Clarify that hidden services are TCP only

[nickm at torproject.org]

commit b9c86948e4f4f0af15e88f74a7297f424ed37f6b
Author: Nick Mathewson <nickm at torproject.org>
Date:   Wed Sep 19 08:18:19 2012 -0400

    Clarify that hidden services are TCP only
    
    Also remove some trailing whitespace.
    
    Patch from maker; fixes bug 6024.
---
 changes/bug6024 |    2 ++
 doc/tor.1.txt   |   19 ++++++++++---------
 2 files changed, 12 insertions(+), 9 deletions(-)

diff --git a/changes/bug6024 b/changes/bug6024
new file mode 100644
index 0000000..743e6ef
--- /dev/null
+++ b/changes/bug6024
@@ -0,0 +1,2 @@
+  o Documentation fixes:
+    - Clarify that hidden services are TCP only. Fixes bug 6024.
diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index 5aac054..773fccf 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -237,7 +237,7 @@ GENERAL OPTIONS
     recommend that you leave this alone unless you know what you're doing,
     since giving attackers access to your control listener is really
     dangerous. This directive can be specified multiple
-    times to bind to multiple addresses/ports.  (Default: 127.0.0.1) 
+    times to bind to multiple addresses/ports.  (Default: 127.0.0.1)
 
 **ControlSocket** __Path__::
     Like ControlPort, but listens on a Unix domain socket, rather than a TCP
@@ -762,7 +762,7 @@ The following options are useful only for clients (that is, if
     purposes, e.g., for Tor controllers. This option may be used multiple times
     for different hidden services. If a hidden service uses authorization and
     this option is not set, the hidden service is not accessible. Hidden
-    services can be configured to require authorization using the 
+    services can be configured to require authorization using the
     **HiddenServiceAuthorizeClient** option.
 
 **CloseHSClientCircuitsImmediatelyOnTimeout** **0**|**1**::
@@ -1017,7 +1017,7 @@ The following options are useful only for clients (that is, if
     Open this port to listen for transparent proxy connections.  Set this to
     0 if you don't want to allow transparent proxy connections.  Set the port
     to "auto" to have Tor pick a port for you. This directive can be
-    specified multiple times to bind to multiple addresses/ports.  See 
+    specified multiple times to bind to multiple addresses/ports.  See
     SOCKSPort for an explanation of isolation flags. +
  +
     TransPort requires OS support for transparent proxies, such as BSDs' pf or
@@ -1055,7 +1055,7 @@ The following options are useful only for clients (that is, if
 **AutomapHostsOnResolve** **0**|**1**::
     When this option is enabled, and we get a request to resolve an address
     that ends with one of the suffixes in **AutomapHostsSuffixes**, we map an
-    unused virtual address to that address, and return the new virtual address. 
+    unused virtual address to that address, and return the new virtual address.
     This is handy for making ".onion" addresses work with applications that
     resolve an address and then connect to it. (Default: 0)
 
@@ -1747,10 +1747,11 @@ The following options are used to configure a hidden service.
     Configure a virtual port VIRTPORT for a hidden service. You may use this
     option multiple times; each time applies to the service using the most
     recent hiddenservicedir. By default, this option maps the virtual port to
-    the same port on 127.0.0.1. You may override the target port, address, or
-    both by specifying a target of addr, port, or addr:port. You may also have
-    multiple lines with  the same VIRTPORT: when a user connects to that
-    VIRTPORT, one of the TARGETs from those lines will be chosen at random.
+    the same port on 127.0.0.1 over TCP. You may override the target port,
+    address, or both by specifying a target of addr, port, or addr:port.
+    You may also have multiple lines with  the same VIRTPORT: when a user
+    connects to that VIRTPORT, one of the TARGETs from those lines will be
+    chosen at random.
 
 **PublishHidServDescriptors** **0**|**1**::
     If set to 0, Tor will run any hidden services you configure, but it won't
@@ -1775,7 +1776,7 @@ The following options are used to configure a hidden service.
     their configuration file using **HidServAuth**.
 
 **RendPostPeriod** __N__ **seconds**|**minutes**|**hours**|**days**|**weeks**::
-    Every time the specified period elapses, Tor uploads any rendezvous 
+    Every time the specified period elapses, Tor uploads any rendezvous
     service descriptors to the directory servers. This information  is also
     uploaded whenever it changes. (Default: 1 hour)