From 35b04df4fd2818cc60e38ff584981d13da5649d1 Mon Sep 17 00:00:00 2001
From: Nick Mathewson <nickm@torproject.org>
Date: Fri, 5 Aug 2005 01:40:10 +0000
Subject: [PATCH] Document helper node options

svn:r4715
---
 doc/TODO     |  4 ++--
 doc/tor.1.in | 14 ++++++++++++++
 2 files changed, 16 insertions(+), 2 deletions(-)

diff --git a/doc/TODO b/doc/TODO
index f80be36acf..42f81da008 100644
--- a/doc/TODO
+++ b/doc/TODO
@@ -103,8 +103,8 @@ N . helper nodes (Choose N nodes randomly; if a node dies (goes down for a
     long time), replace it.  Store nodes on disk.
     o Implement (basic case)
     o Implement (persistence)
-    - Document
-    - Test, debug
+    o Document
+    . Test, debug
     - On sighup, if usehelpernodes changed to 1, use new circs.
 N - Make a FirewallIPs to correspond to firewallPorts so I can use Tor at
     MIT when my directory is out of date.
diff --git a/doc/tor.1.in b/doc/tor.1.in
index f3c15ebc7c..403cf6662d 100644
--- a/doc/tor.1.in
+++ b/doc/tor.1.in
@@ -318,6 +318,20 @@ this will observe it through cookies or other protocol-specific means anyhow.
 Since exit servers go up and down, it is desirable to expire the association
 between host and exit server after NUM seconds. The default
 is 1800 seconds (30 minutes).
+.LP
+.TP
+\fBUseHelperNodes \fR\fI0|1\fP
+If this option is set to 1, we pick a few entry servers as our "helpers", and
+try to use only those fixed entry servers.  This is desirable, because
+constantly changing servers increases the odds that an adversary who owns
+some servers will observe a fraction of your paths.
+(Defaults to 0; will eventually default to 1.)
+.LP
+.TP
+\fBNumHelperNodesUseHelperNodes \fR\fINUM\fP
+If UseHelperNodes is set to 1, we will try to pick a total of NUM helper
+nodes as entries for our circuits.
+(Defaults to 3.)
 
 .SH SERVER OPTIONS
 .PP