summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorRoger Dingledine <arma@torproject.org>2005-03-22 20:32:48 +0000
committerRoger Dingledine <arma@torproject.org>2005-03-22 20:32:48 +0000
commitf5c930bb0ea2139170a0e128066b7e8c71f9016b (patch)
tree6e6e70a1eadcaca498a02070f19c69cd72e7b206 /doc
parentab1d0049a22d22f31a76c988f3277c11685c0b14 (diff)
downloadtor-f5c930bb0ea2139170a0e128066b7e8c71f9016b.tar.gz
tor-f5c930bb0ea2139170a0e128066b7e8c71f9016b.zip
clean up man page entry for MaxAdvertisedBandwidth
svn:r3817
Diffstat (limited to 'doc')
-rw-r--r--doc/tor.1.in7
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/tor.1.in b/doc/tor.1.in
index 311a7f0e36..5b77d4d37e 100644
--- a/doc/tor.1.in
+++ b/doc/tor.1.in
@@ -49,8 +49,11 @@ the specified number of bytes per second. (Default: 780 KB)
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.
+If set, we will not advertise more than this amount of bandwidth for our
+BandwidthRate. Server operators who want to reduce the number of clients
+who ask to build circuits through them (since this is proportional to
+advertised bandwidth rate) can thus reduce the CPU demands on their
+server without impacting network performance.
.TP
\fBDataDirectory \fR\fIDIR\fP
Store working data in DIR (Default: @LOCALSTATEDIR@/lib/tor)