summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFernando Fernandez Mancera <ffernandezmancera@gmail.com>2017-11-20 17:13:16 +0100
committerNick Mathewson <nickm@torproject.org>2017-11-21 13:54:16 -0500
commit5f4e9d50799ff5bd01408a439405671db28598ce (patch)
treeb68d7612f70c971f5a65c72dca9cc8a8bbe8a173 /doc
parentedc3fe0eb5e590801d2b6d6c390e01bb98b4183e (diff)
downloadtor-5f4e9d50799ff5bd01408a439405671db28598ce.tar.gz
tor-5f4e9d50799ff5bd01408a439405671db28598ce.zip
Clarify the RelayBandwidth* options in man file
Added clarifying information in man file about RelayBandwidthRate and RelayBandwidthBurst options that exclude directory fetches by relays. Fixes #24318 Signed-off-by: Fernando Fernandez Mancera <ffernandezmancera@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/tor.1.txt7
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index e1c3cdaf98..6d0b809186 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -231,12 +231,15 @@ GENERAL OPTIONS
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)
+ requests, but that may change in future versions. They do not include directory
+ fetches by the relay (from authority or other relays), because that is considered
+ "client" activity. (Default: 0)
[[RelayBandwidthBurst]] **RelayBandwidthBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
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)
+ They do not include directory fetches by the relay (from authority
+ or other relays), because that is considered "client" activity. (Default: 0)
[[PerConnBWRate]] **PerConnBWRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**|**KBits**|**MBits**|**GBits**|**TBits**::
If set, do separate rate limiting for each connection from a non-relay.