Browse Source

Refer to the actual minima and the preferred minimum

Nick Mathewson 9 years ago
parent
commit
c1c1c4d057
2 changed files with 9 additions and 4 deletions
  1. 3 0
      changes/bug16382
  2. 6 4
      doc/tor.1.txt

+ 3 - 0
changes/bug16382

@@ -0,0 +1,3 @@
+  o Documentation:
+    - Explain actual minima for BandwidthRate. Closes ticket 16382.
+

+ 6 - 4
doc/tor.1.txt

@@ -140,11 +140,13 @@ GENERAL OPTIONS
 ---------------
 ---------------
 
 
 [[BandwidthRate]] **BandwidthRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
 [[BandwidthRate]] **BandwidthRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
-    A token bucket limits the average incoming bandwidth usage on this node to
-    the specified number of bytes per second, and the average outgoing
+    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.  If you want to run a relay in the
     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_ 250 KBytes (that is,
-    2 mbit). (Default: 1 GByte) +
+    public network, this needs to be _at the very least_ 75 KBytes for a
+    relay (that is, 600 kbits) or 50 KBytes for a bridge (400 kbits) -- but of
+    course, more is better; we recommend at least 250 KBytes (2 mbits) if
+    possible.  (Default: 1 GByte) +
  +
  +
     With this option, and in other options that take arguments in bytes,
     With this option, and in other options that take arguments in bytes,
     KBytes, and so on, other formats are also supported. Notably, "KBytes" can
     KBytes, and so on, other formats are also supported. Notably, "KBytes" can