xref: /csrg-svn/lib/libc/gen/getbsize.3 (revision 61054)
1*61054Smckusick.\" Copyright (c) 1993 The Regents of the University of California.
2*61054Smckusick.\" All rights reserved.
3*61054Smckusick.\"
4*61054Smckusick.\" %sccs.include.redist.man%
5*61054Smckusick.\"
6*61054Smckusick.\"     @(#)getbsize.3	6.1 (Berkeley) 06/02/93
7*61054Smckusick.\"
8*61054Smckusick.Dd
9*61054Smckusick.Dt GETBSIZE 3
10*61054Smckusick.Os BSD 4.4
11*61054Smckusick.Sh NAME
12*61054Smckusick.Nm getbsize
13*61054Smckusick.Nd get user block size
14*61054Smckusick.Sh SYNOPSIS
15*61054Smckusick.Fd #include <stdlib.h>
16*61054Smckusick.Ft char *
17*61054Smckusick.Fn getbsize "int *headerlenp" "long *blocksizep"
18*61054Smckusick.Sh DESCRIPTION
19*61054SmckusickThe
20*61054Smckusick.Nm getbsize
21*61054Smckusickfunction determines the user's preferred block size based on the value of the
22*61054Smckusick.Dq BLOCKSIZE
23*61054Smckusickenvironment variable; see
24*61054Smckusick.Xr environ 7
25*61054Smckusickfor details on its use and format.
26*61054Smckusick.Pp
27*61054SmckusickThe
28*61054Smckusick.Nm getbsize
29*61054Smckusickfunction returns a pointer to a null-terminated string describing
30*61054Smckusickthe block size, something like
31*61054Smckusick.Dq 1K-blocks .
32*61054SmckusickThe memory referenced by
33*61054Smckusick.Fa headerlenp
34*61054Smckusickis filled in with the length of the string (not including the
35*61054Smckusickterminating null).
36*61054SmckusickThe memory referenced by
37*61054Smckusick.Fa blocksizep
38*61054Smckusickis filled in with block size, in bytes.
39*61054Smckusick.Pp
40*61054SmckusickIf the user's block size is unreasonable, a warning message is
41*61054Smckusickwritten to standard error and the returned information reflects
42*61054Smckusicka block size of 512 bytes.
43*61054Smckusick.Sh SEE ALSO
44*61054Smckusick.Xr df 1 ,
45*61054Smckusick.Xr du 1 ,
46*61054Smckusick.Xr ls 1 ,
47*61054Smckusick.Xr systat 1 ,
48*61054Smckusick.Xr environ 7
49*61054Smckusick.Sh HISTORY
50*61054SmckusickThe
51*61054Smckusick.Nm getbsize
52*61054Smckusickfunction call appeared in
53*61054Smckusick.Bx 4.4 .
54