share/man/man9/VFS_STATFS.9

   1 .\" Copyright (c) 1996 Doug Rabson
   2 .\"
   3 .\" All rights reserved.
   4 .\"
   5 .\" This program is free software.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  20 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD: src/share/man/man9/VFS_STATFS.9,v 1.5.2.1 2001/12/17 11:30:18 ru Exp $
  28 .\"
  29 .Dd September 1, 2011
  30 .Dt VFS_STATFS 9
  31 .Os
  32 .Sh NAME
  33 .Nm VFS_STATFS
  34 .Nd return filesystem status
  35 .Sh SYNOPSIS
  36 .In sys/param.h
  37 .In sys/mount.h
  38 .In sys/vnode.h
  39 .Ft int
  40 .Fn VFS_STATFS "struct mount *mp" "struct statfs *sbp" "struct ucred *cred"
  41 .Sh DESCRIPTION
  42 This call returns various pieces of information about the filesystem,
  43 including recommended I/O sizes, free space, free inodes, etc.
  44 .Pp
  45 Its arguments are:
  46 .Bl -tag -width sbp
  47 .It Ar mp
  48 The filesystem.
  49 .It Ar sbp
  50 Return parameter for the filesystem's status.
  51 .It Ar cred
  52 Credentials for the process which is querying the filesystem.
  53 .El
  54 .Sh SEE ALSO
  55 .Xr VFS 9 ,
  56 .Xr vnode 9
  57 .Sh AUTHORS
  58 This man page was written by
  59 .An Doug Rabson .