xref: /dragonfly/share/man/man9/VFS_STATFS.9 (revision c9f721c2)
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.\" $DragonFly: src/share/man/man9/VFS_STATFS.9,v 1.3 2004/06/01 11:36:53 hmp Exp $
29.\"
30.Dd July 24, 1996
31.Os
32.Dt VFS_STATFS 9
33.Sh NAME
34.Nm VFS_STATFS
35.Nd return filesystem status
36.Sh SYNOPSIS
37.In sys/param.h
38.In sys/mount.h
39.In sys/vnode.h
40.Ft int
41.Fn VFS_STATFS "struct mount *mp" "struct statfs *sbp" "struct proc *p"
42.Sh DESCRIPTION
43This call returns various pieces of information about the filesystem,
44including recommended I/O sizes, free space, free inodes, etc.
45.Pp
46Its arguments are:
47.Bl -tag -width sbp
48.It Ar mp
49The filesystem.
50.It Ar sbp
51Return parameter for the filesystem's status.
52.It Ar p
53The process which is querying the filesystem.
54.El
55.Sh SEE ALSO
56.Xr VFS 9 ,
57.Xr vnode 9
58.Sh AUTHORS
59This man page was written by
60.An Doug Rabson .
61