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 | |
| 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
| -rw-r--r-- | doc/tor.1.in | 7 | ||||
| -rw-r--r-- | src/or/config.c | 4 |
2 files changed, 7 insertions, 4 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 diff --git a/src/or/config.c b/src/or/config.c index 79c6ba9be..a78dd248f 100644 --- a/src/or/config.c +++ b/src/or/config.c @@ -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), |