man/man5/statvfs.5

   1 .\"     $NetBSD: statvfs.5,v 1.10 2008/06/23 04:22:36 dholland Exp $
   2 .\"
   3 .\" Copyright (c) 1989, 1991, 1993
   4 .\"     The Regents of the University of California.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. Neither the name of the University nor the names of its contributors
  15 .\"    may be used to endorse or promote products derived from this software
  16 .\"    without specific prior written permission.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  19 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  22 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  23 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  24 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  25 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  28 .\" SUCH DAMAGE.
  29 .\"
  30 .\"     @(#)statfs.2    8.5 (Berkeley) 5/24/95
  31 .\"
  32 .Dd June 23, 2008
  33 .Dt STATVFS 5
  34 .Os
  35 .Sh NAME
  36 .Nm statvfs
  37 .Nd file system statistics
  38 .Sh SYNOPSIS
  39 .In sys/types.h
  40 .In sys/statvfs.h
  41 .Sh DESCRIPTION
  42 The
  43 .Aq Pa sys/statvfs.h
  44 header defines the structures and functions that
  45 return information about a mounted file system.
  46 The
  47 .Nm statvfs
  48 structure is defined as follows:
  49 .Bd -literal
  50
  51 struct statvfs {
  52         unsigned long   f_bsize;  /* system block size */
  53         unsigned long   f_frsize; /* system fragment size */
  54
  55         fsblkcnt_t      f_blocks; /* number of blocks in file system */
  56         fsblkcnt_t      f_bfree;  /* free blocks avail in file system */
  57         fsblkcnt_t      f_bavail; /* free blocks avail to non-root */
  58
  59         fsfilcnt_t      f_files;  /* total file nodes in file system */
  60         fsfilcnt_t      f_ffree;  /* free file nodes in file system */
  61         fsfilcnt_t      f_favail; /* free file nodes avail to non-root */
  62
  63         unsigned long   f_fsid;   /* File system ID */
  64
  65         unsigned long   f_flag;   /* flags */
  66
  67         unsigned long   f_namemax;/* maximum filename length */
  68 };
  69 .Ed
  70 .Pp
  71 The
  72 .Fa f_flag
  73 argument can have the following bits set:
  74 .Bl -tag -width ST_SYNCHRONOUS
  75 .It Dv ST_RDONLY
  76 The filesystem is mounted read-only;
  77 Even the super-user may not write on it.
  78 .It Dv ST_NOSUID
  79 Setuid and setgid bits on files are not honored when they are executed.
  80 .It Dv ST_NOTRUNC
  81 File names longer than NAME_MAX are not truncated.
  82 .El
  83 .Sh SEE ALSO
  84 .Xr statvfs 2
  85 .Sh HISTORY
  86 The
  87 .Aq Pa sys/statvfs.h
  88 header first appeared in
  89 .Nx 3.0 .