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
This commit is contained in:
Nick Mathewson
2007-01-29 18:13:34 +00:00
parent f58678730c
commit 21f5e06862
2 changed files with 7 additions and 4 deletions
+4 -3
View File
@@ -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
+3 -1
View File
@@ -206,6 +206,7 @@ static config_var_t _option_vars[] = {
VAR("ORListenAddress", LINELIST, ORListenAddress, NULL),
VAR("ORPort", UINT, ORPort, "0"),
VAR("OutboundBindAddress", STRING, OutboundBindAddress, NULL),
/* XXXX012 mark this obsolete? Warn if it's set? */
VAR("PathlenCoinWeight", DOUBLE, PathlenCoinWeight, "0.3"),
VAR("PidFile", STRING, PidFile, NULL),
VAR("PreferTunneledDirConns", BOOL, PreferTunneledDirConns, "0"),
@@ -218,7 +219,8 @@ static config_var_t _option_vars[] = {
VAR("RecommendedVersions", LINELIST, RecommendedVersions, NULL),
VAR("RecommendedClientVersions", LINELIST, RecommendedClientVersions, NULL),
VAR("RecommendedServerVersions", LINELIST, RecommendedServerVersions, NULL),
VAR("RedirectExit", LINELIST, RedirectExit, NULL),
VAR("RedirectExit", LINELIST, RedirectExit, NULL)
/* XXXX012 These aren't implemented. Take them out for now? */
VAR("RelayBandwidthBurst", MEMUNIT, RelayBandwidthBurst, "0"),
VAR("RelayBandwidthRate", MEMUNIT, RelayBandwidthRate, "0"),
VAR("RendExcludeNodes", STRING, RendExcludeNodes, NULL),