Copyright (c) 2007 Pawel Jakub Dawidek <pjd@FreeBSD.org>
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
$FreeBSD: stable/11/lib/libutil/expand_number.3 354034 2019-10-24 19:14:37Z jhb $
.Dd July 20, 2019 .Dt EXPAND_NUMBER 3 .Os .Sh NAME .Nm expand_number .Nd format a number from human readable form .Sh LIBRARY .Lb libutil .Sh SYNOPSIS n libutil.h .Ft int .Fo expand_number .Fa "const char *buf" "uint64_t *num" .Fc .Sh DESCRIPTION The .Fn expand_number function parses the .Fa buf string and stores a unsigned 64-bit quantity at .Fa *num .
p The .Fn expand_number function is case-insensitive and follows the SI power of two convention.
p The suffixes are: l -column "Suffix" "Description" "1000000000000000000" -offset indent t Sy "Suffix" Ta Sy "Description" Ta Sy "Multiplier" t Li K Ta No kilo Ta 1024 t Li M Ta No mega Ta 1048576 t Li G Ta No giga Ta 1073741824 t Li T Ta No tera Ta 1099511627776 t Li P Ta No peta Ta 1125899906842624 t Li E Ta No exa Ta 1152921504606846976 .El .Sh RETURN VALUES .Rv -std .Sh ERRORS The .Fn expand_number function will fail if: l -tag -width Er t Bq Er EINVAL The given string contains no digits. t Bq Er EINVAL An unrecognized suffix was given. t Bq Er ERANGE Result doesn't fit into 64 bits. .El .Sh SEE ALSO .Xr humanize_number 3 .Sh HISTORY The .Fn expand_number function first appeared in .Fx 6.3 .