Implement an option to cap bandwidth-to-advertise. Arma: can you improve the manpage entry by explaining why you would want to do this?

svn:r3813

2 files changed, 5 insertions, 1 deletions

diff --git a/doc/TODO b/doc/TODO
index 4b41c69f73..0f19b860c6 100644
--- a/doc/TODO
+++ b/doc/TODO
@@ -25,7 +25,7 @@ R  o pick the whole path when you start the circuit.
      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:
 
diff --git a/doc/tor.1.in b/doc/tor.1.in
index 24760f9e07..311a7f0e36 100644
--- a/doc/tor.1.in
+++ b/doc/tor.1.in
@@ -48,6 +48,10 @@ the specified number of bytes per second. (Default: 780 KB)
 \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