From: Nick Mathewson <nickm@torproject.org>
Date: Fri, 30 Jul 2010 22:00:43 +0000 (-0400)
Subject: Document 20KB requirement in BandwidthRate documentation
X-Git-Tag: tor-0.2.2.15-alpha~60
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=15424bf800a56007d802db3a9d3fe40fbdf2bee5;p=thirdparty%2Ftor.git

Document 20KB requirement in BandwidthRate documentation

This fixes the last suggestion of bug #1195.
---

diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index 2ece2af2b8..222aaf103c 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