]> git.ipfire.org Git - thirdparty/tor.git/commitdiff
Improve documentation for RelayBandwdith* options
authorSebastian Hahn <sebastian@torproject.org>
Fri, 22 Oct 2010 21:37:54 +0000 (23:37 +0200)
committerSebastian Hahn <sebastian@torproject.org>
Wed, 10 Nov 2010 14:48:26 +0000 (15:48 +0100)
Jesse Adelman noticed that we don't currently describe what
happens very well.

doc/tor.1.txt

index b827fbe8e3c38dbc4fa2144ea84fa5b98f70b21f..1511eb894b4c02403389ff1ec8dfe295c4ab176f 100644 (file)
@@ -89,14 +89,14 @@ Other options can be specified either on the command-line (--option
     without impacting network performance.
 
 **RelayBandwidthRate** __N__ **bytes**|**KB**|**MB**|**GB**::
-    If defined, a separate token bucket limits the average incoming bandwidth
+    If not 0, a separate token bucket limits the average incoming bandwidth
     usage for \_relayed traffic_ on this node to the specified number of bytes
     per second, and the average outgoing bandwidth usage to that same value.
     Relayed traffic currently is calculated to include answers to directory
     requests, but that may change in future versions. (Default: 0)
 
 **RelayBandwidthBurst** __N__ **bytes**|**KB**|**MB**|**GB**::
-    Limit the maximum token bucket size (also known as the burst) for
+    If not 0, limit the maximum token bucket size (also known as the burst) for
     \_relayed traffic_ to the given number of bytes in each direction.
     (Default: 0)