summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSebastian Hahn <sebastian@torproject.org>2010-10-22 23:37:54 +0200
committerSebastian Hahn <sebastian@torproject.org>2010-11-10 15:48:26 +0100
commit0b05f05bbf83de7d00a8b4586685d2d52e7e2ac9 (patch)
treecb56984ecca03b3773801ff52b767872929ce3a4
parent6de673076f0f26415fcd515864279a16e3d83f1a (diff)
downloadtor-0b05f05bbf83de7d00a8b4586685d2d52e7e2ac9.tar.gz
tor-0b05f05bbf83de7d00a8b4586685d2d52e7e2ac9.zip
Improve documentation for RelayBandwdith* options
Jesse Adelman noticed that we don't currently describe what happens very well.
-rw-r--r--doc/tor.1.txt4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index b827fbe8e3..1511eb894b 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -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)