[or-cvs] Document helper node options

[Nick Mathewson]

Update of /home/or/cvsroot/tor/doc
In directory moria:/tmp/cvs-serv25679/doc

Modified Files:
	TODO tor.1.in 
Log Message:
Document helper node options

Index: TODO
===================================================================
RCS file: /home/or/cvsroot/tor/doc/TODO,v
retrieving revision 1.337
retrieving revision 1.338
diff -u -d -r1.337 -r1.338
--- TODO	4 Aug 2005 19:56:41 -0000	1.337
+++ TODO	5 Aug 2005 01:40:10 -0000	1.338
@@ -103,8 +103,8 @@
     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.

Index: tor.1.in
===================================================================
RCS file: /home/or/cvsroot/tor/doc/tor.1.in,v
retrieving revision 1.93
retrieving revision 1.94
diff -u -d -r1.93 -r1.94
--- tor.1.in	12 Jul 2005 21:06:31 -0000	1.93
+++ tor.1.in	5 Aug 2005 01:40:10 -0000	1.94
@@ -318,6 +318,20 @@
 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