lib/libc/gen/getbsize.3

   1 .\" Copyright (c) 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)getbsize.3  8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd June 11, 2017
  32 .Dt GETBSIZE 3
  33 .Os
  34 .Sh NAME
  35 .Nm getbsize
  36 .Nd get preferred block size
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In stdlib.h
  41 .Ft char *
  42 .Fn getbsize "int *headerlenp" "long *blocksizep"
  43 .Sh DESCRIPTION
  44 The
  45 .Fn getbsize
  46 function returns a preferred block size for reporting by system utilities
  47 .Xr df 1 ,
  48 .Xr du 1
  49 and
  50 .Xr ls 1 ,
  51 based on the value of the
  52 .Ev BLOCKSIZE
  53 environment variable.
  54 .Ev BLOCKSIZE
  55 may be specified directly in bytes, or in multiples of a kilobyte by
  56 specifying a number followed by ``K'' or ``k'', in multiples of a
  57 megabyte by specifying a number followed by ``M'' or ``m'' or in
  58 multiples of a gigabyte by specifying a number followed by ``G'' or
  59 ``g''.
  60 Multiples must be integers.
  61 .Pp
  62 Valid values of
  63 .Ev BLOCKSIZE
  64 are 512 bytes to 1 gigabyte.
  65 Sizes less than 512 bytes are rounded up to 512 bytes, and sizes
  66 greater than 1 GB are rounded down to 1 GB.
  67 In each case
  68 .Fn getbsize
  69 produces a warning message via
  70 .Xr warnx 3 .
  71 .Pp
  72 The
  73 .Fn getbsize
  74 function returns a pointer to a null-terminated string describing
  75 the block size, something like
  76 .Dq 1K-blocks .
  77 The memory referenced by
  78 .Fa headerlenp
  79 is filled in with the length of the string (not including the
  80 terminating null).
  81 The memory referenced by
  82 .Fa blocksizep
  83 is filled in with block size, in bytes.
  84 .Sh SEE ALSO
  85 .Xr df 1 ,
  86 .Xr du 1 ,
  87 .Xr ls 1 ,
  88 .Xr systat 1 ,
  89 .Xr environ 7
  90 .Sh HISTORY
  91 The
  92 .Fn getbsize
  93 function first appeared in
  94 .Bx 4.4 .