usr/src/man/man3head/statvfs.h.3head

   1 '\" te
   2 .\" Copyright (c) 2001, The IEEE and The Open Group. All Rights Reserved. Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
   4 .\" http://www.opengroup.org/bookstore/.
   5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
   6 .\"  This notice shall appear on any product containing this material.
   7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
  10 .TH STATVFS.H 3HEAD "Sep 10, 2004"
  11 .SH NAME
  12 statvfs.h, statvfs \- VFS File System information structure
  13 .SH SYNOPSIS
  14 .LP
  15 .nf
  16 #include <\fBsys/statvfs.h\fR>
  17 .fi
  18
  19 .SH DESCRIPTION
  20 .sp
  21 .LP
  22 The <\fBsys/statvfs.h\fR> header defines the \fBstatvfs\fR structure, which
  23 includes the following members:
  24 .sp
  25 .in +2
  26 .nf
  27 unsigned long f_bsize     /* file system block
  28                              size */
  29 unsigned long f_frsize    /* fundamental file system block
  30                              size */
  31 fsblkcnt_t    f_blocks    /* total number of blocks on file
  32                              system in units of \fBf_frsize\fR */
  33 fsblkcnt_t    f_bfree     /* total number of free blocks */
  34 fsblkcnt_t    f_bavail    /* number of free blocks available
  35                              to non-privileged process */
  36 fsfilcnt_t    f_files     /* total number of file serial
  37                              numbers */
  38 fsfilcnt_t    f_ffree     /* total number of free file serial
  39                              numbers */
  40 fsfilcnt_t    f_favail    /* number of file serial numbers
  41                              available to non-privileged
  42 unsigned long f_fsid      /* process file system ID */
  43 unsigned long f_flag      /* bit mask of \fBf_flag\fR values */
  44 unsigned long f_namemax   /* maximum filename length */
  45 .fi
  46 .in -2
  47
  48 .sp
  49 .LP
  50 The \fBfsblkcnt_t\fR and \fBfsfilcnt_t\fR types are defined as described in
  51 <\fBsys/types.h\fR>. See \fBtypes.h\fR(3HEAD).
  52 .sp
  53 .LP
  54 The following flags for the \fBf_flag\fR member are defined:
  55 .sp
  56 .ne 2
  57 .na
  58 \fB\fBST_RDONLY\fR\fR
  59 .ad
  60 .RS 13n
  61 read-only file system
  62 .RE
  63
  64 .sp
  65 .ne 2
  66 .na
  67 \fB\fBST_NOSUID\fR\fR
  68 .ad
  69 .RS 13n
  70 does not support \fBsetuid()\fR/\fBsetgid()\fR semantics
  71 .RE
  72
  73 .SH ATTRIBUTES
  74 .sp
  75 .LP
  76 See \fBattributes\fR(5) for descriptions of the following attributes:
  77 .sp
  78
  79 .sp
  80 .TS
  81 box;
  82 c | c
  83 l | l .
  84 ATTRIBUTE TYPE  ATTRIBUTE VALUE
  85 _
  86 Interface Stability     Standard
  87 .TE
  88
  89 .SH SEE ALSO
  90 .sp
  91 .LP
  92 \fBstatvfs\fR(2), \fBtypes.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5)