1 .\" $NetBSD: humanize_number.3,v 1.4 2003/04/16 13:34:37 wiz Exp $
4 .\" Copyright (c) 1999, 2002 The NetBSD Foundation, Inc.
5 .\" All rights reserved.
7 .\" This code is derived from software contributed to The NetBSD Foundation
8 .\" by Luke Mewburn and by Tomas Svensson.
10 .\" Redistribution and use in source and binary forms, with or without
11 .\" modification, are permitted provided that the following conditions
13 .\" 1. Redistributions of source code must retain the above copyright
14 .\" notice, this list of conditions and the following disclaimer.
15 .\" 2. Redistributions in binary form must reproduce the above copyright
16 .\" notice, this list of conditions and the following disclaimer in the
17 .\" documentation and/or other materials provided with the distribution.
19 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22 .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 .\" POSSIBILITY OF SUCH DAMAGE.
36 .Nd format a number into a human readable form
43 .Fa "char *buf" "size_t len" "int64_t number" "const char *suffix"
44 .Fa "int scale" "int flags"
49 function formats the signed 64-bit quantity given in
55 is appended to the end.
56 The buffer pointed to by
62 If the formatted number (including
64 would be too long to fit into
68 by 1024 until it will.
71 with the appropriate SI designator.
75 follows the traditional computer science conventions rather than the proposed
76 SI power of two convention.
79 .Bl -column "Prefix" "Description" "1000000000000000000" -offset indent
80 .It Sy "Prefix" Ta Sy "Description" Ta Sy "Multiplier" Ta Sy "Multiplier 1000x"
81 .It Li k Ta No kilo Ta 1024 Ta 1000
82 .It Li M Ta No mega Ta 1048576 Ta 1000000
83 .It Li G Ta No giga Ta 1073741824 Ta 1000000000
84 .It Li T Ta No tera Ta 1099511627776 Ta 1000000000000
85 .It Li P Ta No peta Ta 1125899906842624 Ta 1000000000000000
86 .It Li E Ta No exa Ta 1152921504606846976 Ta 1000000000000000000
91 argument must be at least 4 plus the length of
93 in order to ensure a useful result is generated into
95 To use a specific prefix, specify this as
97 (multiplier = 1024 ^ scale).
98 This cannot be combined with any of the
102 The following flags may be passed in
104 .Bl -tag -width ".Dv HN_DIVISOR_1000" -offset indent
106 Format the buffer using the lowest multiplier possible.
108 Return the prefix index number (the number of times
110 must be divided to fit) instead of formatting it to the buffer.
113 The following flags may be passed in
115 .Bl -tag -width ".Dv HN_DIVISOR_1000" -offset indent
117 If the final result is less than 10, display it using one digit.
119 Do not put a space between
125 (bytes) as prefix if the original result does not have a prefix.
126 .It Dv HN_DIVISOR_1000
129 with 1000 instead of 1024.
134 function returns the number of characters stored in
136 (excluding the terminating
138 upon success, or \-1 upon failure.
141 is specified, the prefix index number will be returned instead.
147 function first appeared in