xref: /csrg-svn/lib/libc/gen/getbsize.3 (revision 61111)
1*61111Sbostic.\" Copyright (c) 1993
2*61111Sbostic.\"	The Regents of the University of California.  All rights reserved.
361054Smckusick.\"
461054Smckusick.\" %sccs.include.redist.man%
561054Smckusick.\"
6*61111Sbostic.\"     @(#)getbsize.3	8.1 (Berkeley) 06/04/93
761054Smckusick.\"
861054Smckusick.Dd
961054Smckusick.Dt GETBSIZE 3
1061054Smckusick.Os BSD 4.4
1161054Smckusick.Sh NAME
1261054Smckusick.Nm getbsize
1361054Smckusick.Nd get user block size
1461054Smckusick.Sh SYNOPSIS
1561054Smckusick.Fd #include <stdlib.h>
1661054Smckusick.Ft char *
1761054Smckusick.Fn getbsize "int *headerlenp" "long *blocksizep"
1861054Smckusick.Sh DESCRIPTION
1961054SmckusickThe
2061054Smckusick.Nm getbsize
2161054Smckusickfunction determines the user's preferred block size based on the value of the
2261054Smckusick.Dq BLOCKSIZE
2361054Smckusickenvironment variable; see
2461054Smckusick.Xr environ 7
2561054Smckusickfor details on its use and format.
2661054Smckusick.Pp
2761054SmckusickThe
2861054Smckusick.Nm getbsize
2961054Smckusickfunction returns a pointer to a null-terminated string describing
3061054Smckusickthe block size, something like
3161054Smckusick.Dq 1K-blocks .
3261054SmckusickThe memory referenced by
3361054Smckusick.Fa headerlenp
3461054Smckusickis filled in with the length of the string (not including the
3561054Smckusickterminating null).
3661054SmckusickThe memory referenced by
3761054Smckusick.Fa blocksizep
3861054Smckusickis filled in with block size, in bytes.
3961054Smckusick.Pp
4061054SmckusickIf the user's block size is unreasonable, a warning message is
4161054Smckusickwritten to standard error and the returned information reflects
4261054Smckusicka block size of 512 bytes.
4361054Smckusick.Sh SEE ALSO
4461054Smckusick.Xr df 1 ,
4561054Smckusick.Xr du 1 ,
4661054Smckusick.Xr ls 1 ,
4761054Smckusick.Xr systat 1 ,
4861054Smckusick.Xr environ 7
4961054Smckusick.Sh HISTORY
5061054SmckusickThe
5161054Smckusick.Nm getbsize
5261054Smckusickfunction call appeared in
5361054Smckusick.Bx 4.4 .
54