[or-cvs] Document remaining configuration options; add a ccheck for ...

[Nick Mathewson]

Update of /home/or/cvsroot/doc
In directory moria.mit.edu:/tmp/cvs-serv1657/doc

Modified Files:
	TODO tor.1.in 
Log Message:
Document remaining configuration options; add a ccheck for redundant authentication mechanisms in options_validate; add TODO items for post-009 hibernation features

Index: TODO
===================================================================
RCS file: /home/or/cvsroot/doc/TODO,v
retrieving revision 1.209
retrieving revision 1.210
diff -u -d -r1.209 -r1.210
--- TODO	13 Nov 2004 16:53:48 -0000	1.209
+++ TODO	13 Nov 2004 17:17:03 -0000	1.210
@@ -26,10 +26,11 @@
 R  - fix print_usage()
    - Download and use running-routers
 R  - document signals in man page
-N  - Document all undocumented configuration options.
-     - Accounting
-     - Control interface authentication
-     - ... ?
+N  - Check for hibernation on startup, hup, etc.
+     - Test hibernation a lot.
+   o Document all undocumented configuration options.
+     o Accounting
+     o Control interface authentication
 N  - RPMs
      o Merge changes from jbash
      - Figure out versioning
@@ -43,6 +44,9 @@
    - controller should have 'getinfo' command to query about rephist,
      about rendezvous status, etc.
    - weasel wants to say 50GB rather than 50000000 in config ints.
+   - Better hibernation flexibility
+     - Add hibernation intervals for weeks, days.
+     - Start at a time other than 0:00 GMT.
    - allow transition from ORPort to !ORPort, and back
 R  . bandwidth buckets for write as well as read.
    - Limit to 2 dir, 2 OR, N SOCKS connections per IP.

Index: tor.1.in
===================================================================
RCS file: /home/or/cvsroot/doc/tor.1.in,v
retrieving revision 1.36
retrieving revision 1.37
diff -u -d -r1.36 -r1.37
--- tor.1.in	12 Nov 2004 03:30:11 -0000	1.36
+++ tor.1.in	13 Nov 2004 17:17:03 -0000	1.37
@@ -85,6 +85,27 @@
 .TP
 \fBUser \fR\fIUID\fP
 On startup, setuid to this user.
+.TP
+\fBControlPort \fR\fIPort\fP
+If set, Tor will accept connections from the same machine (localhost only) on
+this port, and allow those connections to control the Tor process using the
+Tor Control Protocol (described in control-spec.txt).  Note: unless you also
+specify one of \fBHashedControlPassword\fP or \fBCookieAuthentication\fP,
+setting this option will cause Tor to allow any process on the local host to
+control it.
+.TP
+\fBHashedControlPassword \fR\fIhashed_password\fP
+Don't allow any connections on the control port except when the other process
+knows the password whose one-way hash is \fIhashed_password\fP.  You can
+compute the hash of a password by running "tor --hash-password
+\fIpassword\fP".
+.TP
+\fBCookieAuthentication \fR\fB0\fR|\fB1\fP
+If this option is set to 1, don't allow any connections on the control port
+except when the connecting process knows the contents of a file named
+"control_auth_cookie", which Tor will create in its data directory.  This
+authentication methods should only be used on systems with good filesystem
+security.
 
 .SH CLIENT OPTIONS
 .PP
@@ -223,7 +244,8 @@
 Declare that this Tor server is controlled or administered by a group
 or organization identical or similar to that of the other named servers.
 When two servers both declare that they are in the same 'family', Tor clients
-will not use them in the same circuit.
+will not use them in the same circuit.  (Each server only need to list the
+other servers in its family; it doesn't need to list itself.)
 .TP
 \fBNickname \fR\fIname\fP
 Set the server's nickname to 'name'.