projects / unix-history / blobdiff
? search:
summary | tags | clone url | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
BSD 4_3_Net_2 release
[unix-history] / usr / src / lib / libc / sys / getfsstat.2
diff --git a/usr/src/lib/libc/sys/getfsstat.2 b/usr/src/lib/libc/sys/getfsstat.2
index 84deb62..2587e05 100644 (file)
--- a/usr/src/lib/libc/sys/getfsstat.2
+++ b/usr/src/lib/libc/sys/getfsstat.2
@@ -1,67 +1,73 @@
-.\" Copyright (c) 1989 The Regents of the University of California.
+.\" Copyright (c) 1989, 1991 The Regents of the University of California.
 .\" All rights reserved.
 .\"
 .\" All rights reserved.
 .\"
-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" Neither the name of the University nor the names of its contributors may
-.\" be used to endorse or promote products derived from this software without
-.\" specific prior written permission.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.
 .\"
 .\"
-.\"    @(#)getfsstat.2 6.4 (Berkeley) 6/23/90
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
 .\"
 .\"
-.TH GETFSSTAT 2 "June 23, 1990"
-.UC 7
-.SH NAME
-getfsstat \- get list of all mounted filesystems
-.SH SYNOPSIS
-.nf
-.ft B
-#include <sys/types.h>
-#include <sys/mount.h>
-.LP
-.ft B
-getfsstat(buf, bufsize, flags)
-struct statfs *buf[];
-long bufsize;
-int flags;
-.fi
-.ft R
-.SH DESCRIPTION
-.I Getfsstat
+.\"    @(#)getfsstat.2 6.6 (Berkeley) 7/23/91
+.\"
+.Dd July 23, 1991
+.Dt GETFSSTAT 2
+.Os
+.Sh NAME
+.Nm getfsstat
+.Nd get list of all mounted filesystems
+.Sh SYNOPSIS
+.Fd #include <sys/types.h>
+.Fd #include <sys/mount.h>
+.Ft int
+.Fn getfsstat "struct statfs *buf" "long bufsize" "int flags"
+.Sh DESCRIPTION
+.Fn Getfsstat
 returns information about all mounted filesystems.
 returns information about all mounted filesystems.
-.I Buf
-is a pointer to an array of
-.I statfs
+.Fa Buf
+is a pointer to
+.Xr statfs
 structures defined as follows:
 structures defined as follows:
-.IP
-.ta \w'#define\0\0'u +\w'fsid_t\0\0'u +\w'f_mntfromname[MNAMELEN]\0\0'u
-.nf
+.Bd -literal
 typedef quad fsid_t;
 typedef quad fsid_t;
-.sp 1
+
 #define MNAMELEN 32    /* length of buffer for returned name */
 #define MNAMELEN 32    /* length of buffer for returned name */
-.sp 1
+
 struct statfs {
 struct statfs {
-       short   f_type; /* type of filesystem (see below) */
-       short   f_flags;        /* copy of mount flags */
-       long    f_fsize;        /* fundamental filesystem block size */
-       long    f_bsize;        /* optimal transfer block size */
-       long    f_blocks;       /* total data blocks in filesystem */
-       long    f_bfree;        /* free blocks in fs */
-       long    f_bavail;       /* free blocks avail to non-superuser */
-       long    f_files;        /* total file nodes in filesystem */
-       long    f_ffree;        /* free file nodes in fs */
-       fsid_t  f_fsid; /* filesystem id */
-       long    f_spare[6];     /* spare for later */
-       char    f_mntonname[MNAMELEN];  /* directory on which mounted */
-       char    f_mntfromname[MNAMELEN];        /* mounted filesystem */
+    short   f_type;    /* type of filesystem (see below) */
+    short   f_flags;   /* copy of mount flags */
+    long    f_fsize;   /* fundamental filesystem block size */
+    long    f_bsize;   /* optimal transfer block size */
+    long    f_blocks;  /* total data blocks in filesystem */
+    long    f_bfree;   /* free blocks in fs */
+    long    f_bavail;  /* free blocks avail to non-superuser */
+    long    f_files;   /* total file nodes in filesystem */
+    long    f_ffree;   /* free file nodes in fs */
+    fsid_t  f_fsid;    /* filesystem id */
+    long    f_spare[6];        /* spare for later */
+    char    f_mntonname[MNAMELEN]; /* directory on which mounted */
+    char    f_mntfromname[MNAMELEN]; /* mounted filesystem */
 };
 /*
  * File system types.
 };
 /*
  * File system types.
@@ -69,50 +75,61 @@ struct statfs {
 #define        MOUNT_UFS       1
 #define        MOUNT_NFS       2
 #define        MOUNT_PC        3
 #define        MOUNT_UFS       1
 #define        MOUNT_NFS       2
 #define        MOUNT_PC        3
-.fi
-.PP
-Fields that are undefined for a particular filesystem are set to \-1.
+.Ed
+.Pp
+Fields that are undefined for a particular filesystem are set to -1.
 The buffer is filled with an array of
 The buffer is filled with an array of
-.I fsstat
+.Fa fsstat
 structures, one for each mounted filesystem
 up to the size specified by
 structures, one for each mounted filesystem
 up to the size specified by
-.I bufsize .
-.PP
+.Fa bufsize .
+.Pp
 If
 If
-.I buf
-is given as zero,
-.I getfsstat
+.Fa buf
+is given as NULL,
+.Fn getfsstat
 returns just the number of mounted filesystems.
 returns just the number of mounted filesystems.
-.PP
+.Pp
 Normally
 Normally
-.I flags
-should be specified as MNT_WAIT.
+.Fa flags
+should be specified as
+.Dv MNT_WAIT .
 If
 If
-.I flags
-is set to MNT_NOWAIT, then
-.I getfsstat
+.Fa flags
+is set to
+.Dv MNT_NOWAIT ,
+.Fn getfsstat
 will return the information it has available without requesting
 an update from each filesystem.
 Thus, some of the information will be out of date, but
 will return the information it has available without requesting
 an update from each filesystem.
 Thus, some of the information will be out of date, but
-.I getfsstat
+.Fn getfsstat
 will not block waiting for information from a filesystem that is
 unable to respond.
 will not block waiting for information from a filesystem that is
 unable to respond.
-.SH RETURN VALUE
+.Sh RETURN VALUES
 Upon successful completion, the number of 
 Upon successful completion, the number of 
-.I fsstat
+.Fa fsstat
 structures is returned.
 structures is returned.
-Otherwise, \-1 is returned and the global variable
-.I errno
+Otherwise, -1 is returned and the global variable
+.Va errno
 is set to indicate the error.
 is set to indicate the error.
-.SH ERRORS
-.I Getfsstat
+.Sh ERRORS
+.Fn Getfsstat
 fails if one or more of the following are true:
 fails if one or more of the following are true:
-.TP 15
-EFAULT
-.I Buf
+.Bl -tag -width Er
+.It EFAULT
+.Fa Buf
 points to an invalid address.
 points to an invalid address.
-.TP 15
-EIO
-An I/O error occurred while reading from or writing to the filesystem.
-.SH "SEE ALSO"
-statfs(2), fstab(5), mount(8)
+.It EIO
+An
+.Tn I/O
+error occurred while reading from or writing to the filesystem.
+.El
+.Sh SEE ALSO
+.Xr statfs 2 ,
+.Xr fstab 5 ,
+.Xr mount 8
+.Sh HISTORY
+The
+.Nm getfsstat
+function call is
+.Ud .
Continuous source code history from original PDP-7 UNIX to FreeBSD 2, the first fully unencumbered FreeBSD release.