aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2014-03-04 12:10:42 -0500
committerNick Mathewson <nickm@torproject.org>2014-03-04 12:12:36 -0500
commit27d231ca130b48e0963aaab7307109f7eafcc5c9 (patch)
treee687d374e34c33d2ef5f3aec6499eecb9612aecb /doc
parent496fe685fddcf6f914819df053856621c3090c33 (diff)
downloadtor-27d231ca130b48e0963aaab7307109f7eafcc5c9.tar
tor-27d231ca130b48e0963aaab7307109f7eafcc5c9.tar.gz
Document alternate bandwidth/memory unit spellings
Diffstat (limited to 'doc')
-rw-r--r--doc/tor.1.txt12
1 files changed, 11 insertions, 1 deletions
diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index 14d477d01..370d0cbda 100644
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -143,7 +143,17 @@ GENERAL OPTIONS
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
public network, this needs to be _at the very least_ 30 KBytes (that is,
- 30720 bytes). (Default: 1 GByte)
+ 30720 bytes). (Default: 1 GByte) +
+ +
+ With this option, and in other options that take arguments in bytes,
+ KBytes, and so on, other formats are also supported. Notably, "KBytes" can
+ also be written as "kilobytes" or "kb"; "MBytes" can be written as
+ "megabytes" or "MB"; "kbits" can be written as "kilobits"; and so forth.
+ Tor also accepts "byte" and "bit" in the singular.
+ The prefixes "tera" and "T" are also recognized.
+ If no units are given, we default to bytes.
+ To avoid confusion, we recommend writing "bytes" or "bits" explicitly,
+ since it's easy to forget that "B" means bytes, not bits.
[[BandwidthBurst]] **BandwidthBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**KBits**|**MBits**|**GBits**::
Limit the maximum token bucket size (also known as the burst) to the given