lib/libutil/expand_number.3

   1 .\" Copyright (c) 2007 Eric Anderson <anderson@FreeBSD.org>
   2 .\" Copyright (c) 2007 Pawel Jakub Dawidek <pjd@FreeBSD.org>
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd August 15, 2010
  29 .Dt EXPAND_NUMBER 3
  30 .Os
  31 .Sh NAME
  32 .Nm expand_number
  33 .Nd format a number from human readable form
  34 .Sh LIBRARY
  35 .Lb libutil
  36 .Sh SYNOPSIS
  37 .In libutil.h
  38 .Ft int
  39 .Fo expand_number
  40 .Fa "const char *buf" "uint64_t *num"
  41 .Fc
  42 .Sh DESCRIPTION
  43 The
  44 .Fn expand_number
  45 function unformats the
  46 .Fa buf
  47 string and stores a unsigned 64-bit quantity at address pointed out by the
  48 .Fa num
  49 argument.
  50 .Pp
  51 The
  52 .Fn expand_number
  53 function
  54 follows the SI power of two convention.
  55 .Pp
  56 The prefixes are:
  57 .Bl -column "Prefix" "Description" "1000000000000000000" -offset indent
  58 .It Sy "Prefix" Ta Sy "Description" Ta Sy "Multiplier"
  59 .It Li k Ta No kilo Ta 1024
  60 .It Li M Ta No mega Ta 1048576
  61 .It Li G Ta No giga Ta 1073741824
  62 .It Li T Ta No tera Ta 1099511627776
  63 .It Li P Ta No peta Ta 1125899906842624
  64 .It Li E Ta No exa  Ta 1152921504606846976
  65 .El
  66 .Sh RETURN VALUES
  67 .Rv -std
  68 .Sh ERRORS
  69 The
  70 .Fn expand_number
  71 function will fail if:
  72 .Bl -tag -width Er
  73 .It Bq Er EINVAL
  74 The given string contains no digits.
  75 .It Bq Er EINVAL
  76 An unrecognized prefix was given.
  77 .It Bq Er ERANGE
  78 Result doesn't fit into 64 bits.
  79 .El
  80 .Sh SEE ALSO
  81 .Xr humanize_number 3
  82 .Sh HISTORY
  83 The
  84 .Fn expand_number
  85 function first appeared in
  86 .Fx 6.3 .