aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2010-07-30 18:00:43 -0400
committerNick Mathewson <nickm@torproject.org>2010-07-30 18:00:43 -0400
commit15424bf800a56007d802db3a9d3fe40fbdf2bee5 (patch)
tree762c0b2e0492cbbe0439b9334c0f7fb19ec67773 /doc
parent7409929917a63b04a29e20cce054cf7bb7be4996 (diff)
downloadtor-15424bf800a56007d802db3a9d3fe40fbdf2bee5.tar
tor-15424bf800a56007d802db3a9d3fe40fbdf2bee5.tar.gz
Document 20KB requirement in BandwidthRate documentation
This fixes the last suggestion of bug #1195.
Diffstat (limited to 'doc')
-rw-r--r--doc/tor.1.txt4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index 2ece2af2b..222aaf103 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -69,7 +69,9 @@ Other options can be specified either on the command-line (--option
**BandwidthRate** __N__ **bytes**|**KB**|**MB**|**GB**::
A token bucket limits the average incoming bandwidth usage on this node to
the specified number of bytes per second, and the average outgoing
- bandwidth usage to that same value. (Default: 5 MB)
+ bandwidth usage to that same value. If you want to run a relay in the
+ public network, this needs to be _at the very least_ 20 KB (that is,
+ 20480 bytes). (Default: 5 MB)
**BandwidthBurst** __N__ **bytes**|**KB**|**MB**|**GB**::
Limit the maximum token bucket size (also known as the burst) to the given