1 .\" $NetBSD: humanize_number.3,v 1.5 2005/04/11 12:19:16 wiz Exp $
2 .\" $FreeBSD: src/lib/libutil/humanize_number.3,v 1.12 2007/09/28 15:31:44 obrien Exp $
3 .\" $DragonFly: src/lib/libutil/humanize_number.3,v 1.3 2008/08/04 19:42:39 swildner Exp $
5 .\" Copyright (c) 1999, 2002 The NetBSD Foundation, Inc.
6 .\" All rights reserved.
8 .\" This code is derived from software contributed to The NetBSD Foundation
9 .\" by Luke Mewburn and by Tomas Svensson.
11 .\" Redistribution and use in source and binary forms, with or without
12 .\" modification, are permitted provided that the following conditions
14 .\" 1. Redistributions of source code must retain the above copyright
15 .\" notice, this list of conditions and the following disclaimer.
16 .\" 2. Redistributions in binary form must reproduce the above copyright
17 .\" notice, this list of conditions and the following disclaimer in the
18 .\" documentation and/or other materials provided with the distribution.
20 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 .\" POSSIBILITY OF SUCH DAMAGE.
37 .Nd format a number into a human readable form
44 .Fa "char *buf" "size_t len" "int64_t number" "const char *suffix"
45 .Fa "int scale" "int flags"
50 function formats the signed 64-bit quantity given in
56 is appended to the end.
57 The buffer pointed to by
63 If the formatted number (including
65 would be too long to fit into
69 by 1024 until it will.
72 with the appropriate SI designator.
76 follows the traditional computer science conventions rather than the proposed
77 SI power of two convention.
80 .Bl -column "Prefix" "Description" "1000000000000000000" -offset indent
81 .It Sy "Prefix" Ta Sy "Description" Ta Sy "Multiplier" Ta Sy "Multiplier 1000x"
82 .It Li k Ta No kilo Ta 1024 Ta 1000
83 .It Li M Ta No mega Ta 1048576 Ta 1000000
84 .It Li G Ta No giga Ta 1073741824 Ta 1000000000
85 .It Li T Ta No tera Ta 1099511627776 Ta 1000000000000
86 .It Li P Ta No peta Ta 1125899906842624 Ta 1000000000000000
87 .It Li E Ta No exa Ta 1152921504606846976 Ta 1000000000000000000
92 argument must be at least 4 plus the length of
94 in order to ensure a useful result is generated into
96 To use a specific prefix, specify this as
98 (multiplier = 1024 ^ scale).
99 This cannot be combined with any of the
103 The following flags may be passed in
105 .Bl -tag -width ".Dv HN_DIVISOR_1000" -offset indent
107 Format the buffer using the lowest multiplier possible.
109 Return the prefix index number (the number of times
111 must be divided to fit) instead of formatting it to the buffer.
114 The following flags may be passed in
116 .Bl -tag -width ".Dv HN_DIVISOR_1000" -offset indent
118 If the final result is less than 10, display it using one digit.
120 Do not put a space between
126 (bytes) as prefix if the original result does not have a prefix.
127 .It Dv HN_DIVISOR_1000
130 with 1000 instead of 1024.
135 function returns the number of characters stored in
137 (excluding the terminating
139 upon success, or \-1 upon failure.
142 is specified, the prefix index number will be returned instead.
146 function first appeared in