]> git.ipfire.org Git - thirdparty/tor.git/commitdiff
Make documentation for TokenBucketRefillInterval match its behavior
authorNick Mathewson <nickm@torproject.org>
Thu, 8 Sep 2011 01:03:08 +0000 (21:03 -0400)
committerNick Mathewson <nickm@torproject.org>
Thu, 22 Sep 2011 19:07:34 +0000 (15:07 -0400)
doc/tor.1.txt

index 05f52f81cdbc79fcccd6e57e5082f67116b68d79..15f5a211a3fe12f576b82d58dfd2203cfc3fc5f2 100644 (file)
@@ -737,13 +737,13 @@ The following options are useful only for clients (that is, if
     unattached waiting for an appropriate circuit, before we fail it. (Default:
     2 minutes.)
 
-**TokenBucketRefillInterval** __NUM__::
+**TokenBucketRefillInterval** __NUM__ [**msec**|**second**]::
     Set the refill interval of Tor's token bucket to NUM milliseconds.
-    NUM must be positive and either a divisor or a multiple of 1 second.
-    Note that this option retains the configured bandwidth limits and refills
-    token buckets only in ratio to the interval. This option will be ignored
-    when Tor was built with Libevent's bufferevents enabled. (Default: 1 second)
-
+    NUM must be between 1 and 1000, inclusive.  Note that the configured
+    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. This option is
+    if Tor was built with Libevent's bufferevents enabled. (Default: 10 msec.)
 
 **TrackHostExits** __host__,__.domain__,__...__::
     For each value in the comma separated list, Tor will track recent