diff options
| author | Nick Mathewson <nickm@torproject.org> | 2007-01-29 18:13:34 +0000 |
|---|---|---|
| committer | Nick Mathewson <nickm@torproject.org> | 2007-01-29 18:13:34 +0000 |
| commit | 21f5e0686201ec2a00a90b7a976b18ffd8436f7c (patch) | |
| tree | 14dd615210a59c4a44718d93785fa4e8e01e5454 /doc | |
| parent | f58678730cb099e0db6c535b8258cadbc10bc5f7 (diff) | |
| download | tor-21f5e0686201ec2a00a90b7a976b18ffd8436f7c.tar tor-21f5e0686201ec2a00a90b7a976b18ffd8436f7c.tar.gz | |
r11583@catbus: nickm | 2007-01-29 11:19:48 -0500
Make man page stop saying that BandwidthRate is for incoming bandwidth only; Add some XXX012s for config options that should maybe die.
svn:r9455
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/tor.1.in | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/tor.1.in b/doc/tor.1.in index 24375da77..4a2fec85a 100644 --- a/doc/tor.1.in +++ b/doc/tor.1.in @@ -58,13 +58,14 @@ Options are case-insensitive. .LP .TP \fBBandwidthRate \fR\fIN\fR \fBbytes\fR|\fBKB\fR|\fBMB\fR|\fBGB\fR|\fBTB\fP -A token bucket limits the average incoming bandwidth on this node to -the specified number of bytes per second. (Default: 3 MB) +A token bucket limits the average bandwidth usage on this node to the +specified number of bytes per second. (Default: 3 MB) .LP .TP \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: 6 MB) +given number of bytes. This value should be at least twice your +BandwidthRate. (Default: 6 MB) .LP .TP \fBMaxAdvertisedBandwidth \fR\fIN\fR \fBbytes\fR|\fBKB\fR|\fBMB\fR|\fBGB\fR|\fBTB\fP |