[or-cvs] Implement an option to cap bandwidth-to-advertise. Arma: ca...

[nickm@xxxxxxxx (Nick Mathewson)]

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

Modified Files:
	TODO tor.1.in 
Log Message:
Implement an option to cap bandwidth-to-advertise. Arma: can you improve the manpage entry by explaining why you would want to do this?

Index: TODO
===================================================================
RCS file: /home/or/cvsroot/tor/doc/TODO,v
retrieving revision 1.289
retrieving revision 1.290
diff -u -d -r1.289 -r1.290
--- TODO	22 Mar 2005 18:43:24 -0000	1.289
+++ TODO	22 Mar 2005 19:01:46 -0000	1.290
@@ -25,7 +25,7 @@
      they're rejected.
    - controller should have an event to learn about new addressmappings?
    - how do ulimits work on win32, anyway?
-   - have a separate config option which caps bandwidth-to-advertise.
+   o have a separate config option which caps bandwidth-to-advertise.
 
 For 0.1.0.x:
 

Index: tor.1.in
===================================================================
RCS file: /home/or/cvsroot/tor/doc/tor.1.in,v
retrieving revision 1.64
retrieving revision 1.65
diff -u -d -r1.64 -r1.65
--- tor.1.in	18 Mar 2005 01:31:56 -0000	1.64
+++ tor.1.in	22 Mar 2005 19:01:46 -0000	1.65
@@ -48,6 +48,10 @@
 \fBBandwidthBurst \fR\fIN\fR \fBbytes\fR|\fBKB\fR|\fBMB\fR|\fBGB\fR|\fBTB\fP
 Limit the maximum token bucket size (also known as the burst) to the given number of bytes. (Default: 48 MB)
 .TP
+\fBMaxAdvertisedBandwidth \fR\fIN\fR \fBbytes\fR|\fBKB\fR|\fBMB\fR|\fBGB\fR|\fBTB\fP
+If set, we will not advertise more than this amount of bandwidth, no
+matter how much we think we actually have.
+.TP
 \fBDataDirectory \fR\fIDIR\fP
 Store working data in DIR (Default: @LOCALSTATEDIR@/lib/tor)
 .TP