Opened 9 years ago

Closed 9 years ago

Last modified 7 years ago

#1195 closed defect (fixed)

manpage doesn't talk about mbytes and friends

Reported by: Sebastian Owned by: phobos
Priority: Low Milestone: Tor: 0.2.2.x-final
Component: Core Tor/Tor Version: 0.2.1.21
Severity: Keywords: easy
Cc: Sebastian, nickm, arma Actual Points:
Parent ID: Points:
Reviewer: Sponsor:

Description (last modified by phobos)

Making this bug report so I don't forget

waltman| In setting a value like AccountingMax in torrc, is there a difference

between "500 MB" and "500 MBytes"?

waltman| It's a bit confusing because the manpage says "KB", "MB", etc., but

the examples values all are "KBytes", e.g. "RelayBandwidthRate 100 KBytes"

Sebastian| you can use either one
waltman| cool, thanks
Sebastian| we should fix that in the manpage.
Sebastian| we're thinking about how we can make the manpage easier to

understand for the average use. Hopefully we'll find something.

In our efforts to make the manpage less confusing and more usable for people
with less *nix experience, we might want to explore explaining what we mean
when we allow the user to specify some amount of bandwidth in one section,
and the refer to that section from all the options.

[Automatically added by flyspray2trac: Operating System: All]

Child Tickets

Change History (7)

comment:1 Changed 9 years ago by keb

Also when we say KB|MB|GB|TB, we mean
2^10, 2^20, 2^30, 2^40
rather than thousand, million, etc.
It is well known legacy terminology within the computer field
but not to new/end-users who may be used to SI Metric.

The distinction is important in at least the case of
minimum required relay bandwidth of 20480 bytes/s.
https://blog.torproject.org/blog/tor-02114rc-released

comment:2 Changed 9 years ago by phobos

Description: modified (diff)
Milestone: Tor: 0.2.2.x-final
Owner: set to phobos
Status: newaccepted

average users don't read man pages.

comment:3 Changed 9 years ago by phobos

Sent a patch for the sample torrcs to be included in master.

comment:4 Changed 9 years ago by nickm

Merged phobos's patch. NAK on changing KB to KiB, though i'd be okay with taking a patch to accept "kib" and "kibibytes". If you want to submit a patch to clarify anything about the 20KiB issue, that would be fine too.

comment:5 Changed 9 years ago by nickm

Keywords: easy added

comment:6 Changed 9 years ago by nickm

Resolution: Nonefixed
Status: acceptedclosed

Added a sentence on the 20 kb issue as 15424bf. Closing.

comment:7 Changed 7 years ago by nickm

Component: Tor ClientTor
Note: See TracTickets for help on using tickets.