[tor-commits] [tor/master] Document alternate bandwidth/memory unit spellings

[nickm at torproject.org]

commit 27d231ca130b48e0963aaab7307109f7eafcc5c9
Author: Nick Mathewson <nickm at torproject.org>
Date:   Tue Mar 4 12:10:42 2014 -0500

    Document alternate bandwidth/memory unit spellings
---
 changes/bug9222 |    5 +++++
 doc/tor.1.txt   |   12 +++++++++++-
 2 files changed, 16 insertions(+), 1 deletion(-)

diff --git a/changes/bug9222 b/changes/bug9222
new file mode 100644
index 0000000..bd66277
--- /dev/null
+++ b/changes/bug9222
@@ -0,0 +1,5 @@
+  o Documentation:
+
+    - Document in the manpage that "KBytes" may also be written as
+      "kilobytes" or "KB", that "Kbits" may also be written as
+      "kilobits", and so forth. Closes ticket #9222.
diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index 14d477d..370d0cb 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