nihilist/tor
1
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/core/tor.git synced 2024-11-24 04:13:28 +01:00
Code Issues Packages Projects Releases Wiki Activity

Say "KBytes" rather than "KB" in the man page

Browse Source 
(for various values of K), to further reduce confusion about whether
Tor counts in units of memory or fractions of units of memory. Fixes
bug 7054.
This commit is contained in:
Roger Dingledine 2012-10-06 01:57:13 -04:00
parent 751b3aabb5
commit 0b598cb2bb
2 changed files with 25 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
changes/bug7054 Normal file
View File

@ -0,0 +1,4 @@
o Minor bugfixes (man page):
- Say "KBytes" rather than "KB" in the man page (for various values
of K), to further reduce confusion about whether Tor counts in
units of memory or fractions of units of memory. Fixes bug 7054.

42
doc/tor.1.txt
View File

@ -124,42 +124,42 @@ option name with a forward slash.
GENERAL OPTIONS GENERAL OPTIONS
--------------- ---------------
**BandwidthRate** __N__ **bytes**|**KB**|**MB**|**GB**:: **BandwidthRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**::
A token bucket limits the average incoming bandwidth usage on this node to A token bucket limits the average incoming bandwidth usage on this node to
the specified number of bytes per second, and the average outgoing 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_ 30 KB (that is, public network, this needs to be _at the very least_ 30 KBytes (that is,
30720 bytes). (Default: 1 GB) 30720 bytes). (Default: 1 GByte)
**BandwidthBurst** __N__ **bytes**|**KB**|**MB**|**GB**:: **BandwidthBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**::
Limit the maximum token bucket size (also known as the burst) to the given Limit the maximum token bucket size (also known as the burst) to the given
number of bytes in each direction. (Default: 1 GB) number of bytes in each direction. (Default: 1 GByte)
**MaxAdvertisedBandwidth** __N__ **bytes**|**KB**|**MB**|**GB**:: **MaxAdvertisedBandwidth** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**::
If set, we will not advertise more than this amount of bandwidth for our If set, we will not advertise more than this amount of bandwidth for our
BandwidthRate. Server operators who want to reduce the number of clients BandwidthRate. Server operators who want to reduce the number of clients
who ask to build circuits through them (since this is proportional to who ask to build circuits through them (since this is proportional to
advertised bandwidth rate) can thus reduce the CPU demands on their server advertised bandwidth rate) can thus reduce the CPU demands on their server
without impacting network performance. without impacting network performance.
**RelayBandwidthRate** __N__ **bytes**|**KB**|**MB**|**GB**:: **RelayBandwidthRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**::
If not 0, a separate token bucket limits the average incoming bandwidth If not 0, a separate token bucket limits the average incoming bandwidth
usage for \_relayed traffic_ on this node to the specified number of bytes 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. per second, and the average outgoing bandwidth usage to that same value.
Relayed traffic currently is calculated to include answers to directory 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. (Default: 0)
**RelayBandwidthBurst** __N__ **bytes**|**KB**|**MB**|**GB**:: **RelayBandwidthBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**::
If not 0, limit the maximum token bucket size (also known as the burst) for 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. \_relayed traffic_ to the given number of bytes in each direction.
(Default: 0) (Default: 0)
**PerConnBWRate** __N__ **bytes**|**KB**|**MB**|**GB**:: **PerConnBWRate** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**::
If set, do separate rate limiting for each connection from a non-relay. If set, do separate rate limiting for each connection from a non-relay.
You should never need to change this value, since a network-wide value is You should never need to change this value, since a network-wide value is
published in the consensus and your relay will use that value. (Default: 0) published in the consensus and your relay will use that value. (Default: 0)
**PerConnBWBurst** __N__ **bytes**|**KB**|**MB**|**GB**:: **PerConnBWBurst** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**::
If set, do separate rate limiting for each connection from a non-relay. If set, do separate rate limiting for each connection from a non-relay.
You should never need to change this value, since a network-wide value is You should never need to change this value, since a network-wide value is
published in the consensus and your relay will use that value. (Default: 0) published in the consensus and your relay will use that value. (Default: 0)
@ -217,7 +217,7 @@ GENERAL OPTIONS
the TCP stream and will reduce throughput in proportion to round trip the TCP stream and will reduce throughput in proportion to round trip
time on long paths. (Default: 0) time on long paths. (Default: 0)
**ConstrainedSockSize** __N__ **bytes**|**KB**:: **ConstrainedSockSize** __N__ **bytes**|**KBytes**::
When **ConstrainedSockets** is enabled the receive and transmit buffers for When **ConstrainedSockets** is enabled the receive and transmit buffers for
all sockets will be set to this limit. Must be a value between 2048 and all sockets will be set to this limit. Must be a value between 2048 and
262144, in 1024 byte increments. Default of 8192 is recommended. 262144, in 1024 byte increments. Default of 8192 is recommended.
@ -1370,14 +1370,14 @@ is non-zero):
server is still alive and doing useful things. Settings this server is still alive and doing useful things. Settings this
to 0 will disable the heartbeat. (Default: 6 hours) to 0 will disable the heartbeat. (Default: 6 hours)
**AccountingMax** __N__ **bytes**|**KB**|**MB**|**GB**|**TB**:: **AccountingMax** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**|**TBytes**::
Never send more than the specified number of bytes in a given accounting Never send more than the specified number of bytes in a given accounting
period, or receive more than that number in the period. For example, with period, or receive more than that number in the period. For example, with
AccountingMax set to 1 GB, a server could send 900 MB and receive 800 MB AccountingMax set to 1 GByte, a server could send 900 MBytes and
and continue running. It will only hibernate once one of the two reaches 1 receive 800 MBytes and continue running. It will only hibernate once
GB. When the number of bytes gets low, Tor will stop accepting new one of the two reaches 1 GByte. When the number of bytes gets low,
connections and circuits. When the number of bytes Tor will stop accepting new connections and circuits. When the
is exhausted, Tor will hibernate until some number of bytes is exhausted, Tor will hibernate until some
time in the next accounting period. To prevent all servers from waking at time in the next accounting period. To prevent all servers from waking at
the same time, Tor will also wait until a random point in each period the same time, Tor will also wait until a random point in each period
before waking up. If you have bandwidth cost issues, enabling hibernation before waking up. If you have bandwidth cost issues, enabling hibernation
@ -1683,15 +1683,15 @@ DIRECTORY AUTHORITY SERVER OPTIONS
Authoritative directories only. Like AuthDirMaxServersPerAddr, but applies Authoritative directories only. Like AuthDirMaxServersPerAddr, but applies
to addresses shared with directory authorities. (Default: 5) to addresses shared with directory authorities. (Default: 5)
**AuthDirFastGuarantee** __N__ **bytes**|**KB**|**MB**|**GB**:: **AuthDirFastGuarantee** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**::
Authoritative directories only. If non-zero, always vote the Authoritative directories only. If non-zero, always vote the
Fast flag for any relay advertising this amount of capacity or Fast flag for any relay advertising this amount of capacity or
more. (Default: 100 KB) more. (Default: 100 KBytes)
**AuthDirGuardBWGuarantee** __N__ **bytes**|**KB**|**MB**|**GB**:: **AuthDirGuardBWGuarantee** __N__ **bytes**|**KBytes**|**MBytes**|**GBytes**::
Authoritative directories only. If non-zero, this advertised capacity Authoritative directories only. If non-zero, this advertised capacity
or more is always sufficient to satisfy the bandwidth requirement or more is always sufficient to satisfy the bandwidth requirement
for the Guard flag. (Default: 250 KB) for the Guard flag. (Default: 250 KBytes)
**BridgePassword** __Password__:: **BridgePassword** __Password__::
If set, contains an HTTP authenticator that tells a bridge authority to If set, contains an HTTP authenticator that tells a bridge authority to