[tor-commits] [tor/master] Add some more documentation

[nickm at torproject.org]

commit db648fe886fd8ae4f42bb13d0219ca7fa690bdc1
Author: Arturo Filastò <art at torproject.org>
Date:   Thu Nov 24 10:28:38 2011 +0100

    Add some more documentation
---
 doc/tor.1.txt   |    5 ++++-
 src/or/config.c |    3 ++-
 2 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index 22c8e88..c73b8d3 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -960,7 +960,10 @@ The following options are useful only for clients (that is, if
 **Tor2webMode** **0**|**1**::
     When this option is set, Tor connects to hidden services
     **non-anonymously**.  This option also disables client connections to
-    non-hidden-service hostnames through Tor.  (Default: 0)
+    non-hidden-service hostnames through Tor. It **must only** be used when
+    running a tor2web Hidden Service web proxy.
+    To enable this option the compile time flag --enable-tor2webmode must be
+    specified. (Default: 0)
 
 SERVER OPTIONS
 --------------
diff --git a/src/or/config.c b/src/or/config.c
index 1dd5ed7..adfde81 100644
--- a/src/or/config.c
+++ b/src/or/config.c
@@ -1310,7 +1310,8 @@ options_act(const or_options_t *old_options)
   if (options->Tor2webMode) {
     log_err(LD_CONFIG, "This copy of Tor was not compiled to run in "
             "'tor2web mode'. It cannot be run with the Tor2webMode torrc "
-            "option enabled.");
+            "option enabled. To enable Tor2webMode recompile with the "
+            "--enable-tor2webmode option.");
     return -1;
   }
 #endif