aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2018-04-23 09:47:05 -0400
committerNick Mathewson <nickm@torproject.org>2018-04-23 09:47:05 -0400
commit3527f4b8a4f002e7b910eacd4ead6e9044cb4003 (patch)
tree11661e8c3b97c649d80001d76fdd60d6a7ad58bc /doc
parent1b40e9986bba3667b8dd22af22c2e2f495c1eb6b (diff)
parentbd3f8260a342b9eefc6fc164dc945605cf1ab0d1 (diff)
downloadtor-3527f4b8a4f002e7b910eacd4ead6e9044cb4003.tar.gz
tor-3527f4b8a4f002e7b910eacd4ead6e9044cb4003.zip
Merge remote-tracking branch 'github/lazy_bucket_refill'
Diffstat (limited to 'doc')
-rw-r--r--doc/tor.1.txt8
1 files changed, 5 insertions, 3 deletions
diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index 594dedf397..cf666e9142 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -1286,9 +1286,11 @@ The following options are useful only for clients (that is, if
2 minutes)
[[TokenBucketRefillInterval]] **TokenBucketRefillInterval** __NUM__ [**msec**|**second**]::
- Set the refill interval of Tor's token bucket to NUM milliseconds.
- NUM must be between 1 and 1000, inclusive. Note that the configured
- bandwidth limits are still expressed in bytes per second: this
+ Set the refill delay interval of Tor's token bucket to NUM milliseconds.
+ NUM must be between 1 and 1000, inclusive. When Tor is out of bandwidth,
+ on a connection or globally, it will wait up to this long before it tries
+ to use that connection again.
+ Note that bandwidth limits are still expressed in bytes per second: this
option only affects the frequency with which Tor checks to see whether
previously exhausted connections may read again.
Can not be changed while tor is running. (Default: 100 msec)