From 21f5e0686201ec2a00a90b7a976b18ffd8436f7c Mon Sep 17 00:00:00 2001 From: Nick Mathewson Date: Mon, 29 Jan 2007 18:13:34 +0000 Subject: 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 --- doc/tor.1.in | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) (limited to 'doc') 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 -- cgit v1.2.3