diff options
author | pjd <pjd@FreeBSD.org> | 2004-09-25 14:11:34 +0000 |
---|---|---|
committer | pjd <pjd@FreeBSD.org> | 2004-09-25 14:11:34 +0000 |
commit | afbc779ed060e27981f69dae175dd65e3a84af7c (patch) | |
tree | 2c89645db72188f54f80d8baa0b23d6a6367274d /lib/libutil/humanize_number.3 | |
parent | 9f5e8e56329a2fee389d296bcc060797773f6cdf (diff) | |
download | FreeBSD-src-afbc779ed060e27981f69dae175dd65e3a84af7c.zip FreeBSD-src-afbc779ed060e27981f69dae175dd65e3a84af7c.tar.gz |
Take the lastest fixes from NetBSD.
Obtained from: NetBSD
Diffstat (limited to 'lib/libutil/humanize_number.3')
-rw-r--r-- | lib/libutil/humanize_number.3 | 46 |
1 files changed, 19 insertions, 27 deletions
diff --git a/lib/libutil/humanize_number.3 b/lib/libutil/humanize_number.3 index 09ed619..5e1f9ae 100644 --- a/lib/libutil/humanize_number.3 +++ b/lib/libutil/humanize_number.3 @@ -35,7 +35,7 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE .\" POSSIBILITY OF SUCH DAMAGE. .\" -.Dd May 25, 2004 +.Dd Sep 25, 2004 .Dt HUMANIZE_NUMBER 3 .Os .Sh NAME @@ -53,14 +53,13 @@ .Sh DESCRIPTION The .Fn humanize_number -function formats the signed 64-bit quantity given in +function formats the signed 64 bit quantity given in .Fa number into .Fa buffer . A space and then .Fa suffix is appended to the end. -The buffer pointed to by .Fa buffer must be at least .Fa len @@ -80,30 +79,29 @@ with the appropriate SI designator. The prefixes are: .Bl -column "Prefix" "Description" "Multiplier" -offset indent .It Sy "Prefix" Ta Sy "Description" Ta Sy "Multiplier" -.It Li k Ta No kilo Ta 1024 -.It Li M Ta No mega Ta 1048576 -.It Li G Ta No giga Ta 1073741824 -.It Li T Ta No tera Ta 1099511627776 -.It Li P Ta No peta Ta 1125899906842624 -.It Li E Ta No exa Ta 1152921504606846976 +.It k kilo 1024 +.It M mega 1048576 +.It G giga 1073741824 +.It T tera 1099511627776 +.It P peta 1125899906842624 +.It E exa 1152921504606846976 .El .Pp -The .Fa len -argument must be at least 4 plus the length of +must be at least 4 plus the length of .Fa suffix , in order to ensure a useful result is generated into .Fa buffer . To use a specific prefix, specify this as .Fa scale -(multiplier = 1024 ^ scale). -This cannot be combined with any of the +(Multiplier = 1024 ^ scale). +This can not be combined with any of the .Fa scale flags below. .Pp The following flags may be passed in -.Fa scale : -.Bl -tag -width ".Dv HN_DIVISOR_1000" -offset indent +.Pa scale : +.Bl -tag -width Dv -offset indent .It Dv HN_AUTOSCALE Format the buffer using the lowest multiplier possible. .It Dv HN_GETSCALE @@ -113,8 +111,8 @@ must be divided to fit) instead of formatting it to the buffer. .El .Pp The following flags may be passed in -.Fa flags : -.Bl -tag -width ".Dv HN_DIVISOR_1000" -offset indent +.Pa flags : +.Bl -tag -width Dv -offset indent .It Dv HN_DECIMAL If the final result is less than 10, display it using one digit. .It Dv HN_NOSPACE @@ -122,27 +120,21 @@ Do not put a space between .Fa number and the prefix. .It Dv HN_B -Use -.Ql B -(bytes) as prefix if the original result does not have a prefix. +Use 'B' (bytes) as prefix if the original result does not have a prefix. .It Dv HN_DIVISOR_1000 Divide .Fa number with 1000 instead of 1024. .El .Sh RETURN VALUES -The .Fn humanize_number -function returns the number of characters stored in +returns the number of characters stored in .Fa buffer -(excluding the terminating -.Dv NUL ) -upon success, or \-1 upon failure. +(excluding the terminating NUL) upon success, or \-1 upon failure. If .Dv HN_GETSCALE is specified, the prefix index number will be returned instead. .Sh HISTORY -The .Fn humanize_number -function first appeared in +first appeared in .Nx 2.0 . |