[or-cvs] [tor/master] Document 20KB requirement in BandwidthRate documentation

[nickm at torproject.org]

Author: Nick Mathewson <nickm at torproject.org>
Date: Fri, 30 Jul 2010 18:00:43 -0400
Subject: Document 20KB requirement in BandwidthRate documentation
Commit: 15424bf800a56007d802db3a9d3fe40fbdf2bee5

This fixes the last suggestion of bug #1195.
---
 doc/tor.1.txt |    4 +++-
 1 files changed, 3 insertions(+), 1 deletions(-)

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