BSD 4_3_Net_2 release

[unix-history] / usr / src / lib / libc / gen / getmntinfo.3

diff --git a/usr/src/lib/libc/gen/getmntinfo.3 b/usr/src/lib/libc/gen/getmntinfo.3
index 3e87d33..6119c6a 100644 (file)
--- a/usr/src/lib/libc/gen/getmntinfo.3
+++ b/usr/src/lib/libc/gen/getmntinfo.3
@@ -1,68 +1,108 @@
-.\" 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.
 .\"

-.\" %sccs.include.redist.man%
+.\" 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.

 .\"
 .\"

-.\"    @(#)getmntinfo.3        6.4 (Berkeley) %G%
+.\" 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 GETMNTINFO 3 ""
-.UC 7
-.SH NAME
-getmntinfo - get information about mounted file systems
-.SH SYNOPSIS
-.nf
-.ft B
-#include <sys/types.h>
-#include <sys/mount.h>
-.LP
-.ft B
-int getmntinfo(mntbufp, flags)
-struct statfs **mntbufp;
-int flags
-.fi
-.ft R
-.SH DESCRIPTION
-.I Getmntinfo
+.\"     @(#)getmntinfo.3       6.5 (Berkeley) 4/19/91
+.\"
+.Dd April 19, 1991
+.Dt GETMNTINFO 3
+.Os
+.Sh NAME
+.Nm getmntinfo
+.Nd get information about mounted file systems
+.Sh SYNOPSIS
+.Fd #include <sys/types.h>
+.Fd #include <sys/mount.h>
+.Ft int
+.Fn getmntinfo "int mntbufp" "int flags"
+.Sh DESCRIPTION
+The
+.Fn getmntinfo
+function

 returns an array of
 returns an array of

-.I statfs
+.Xr statfs

 structures describing each currently mounted file system (see
 structures describing each currently mounted file system (see

-.IR statfs (2)).
-.PP
-.I Getmntinfo
+.Xr statfs 2 ) .
+.Pp
+The
+.Fn getmntinfo
+function

 passes its
 passes its

-.I flags
+.Fa flags

 parameter transparently to
 parameter transparently to

-.IR getfsstat (2).
-.SH "RETURN VALUE"
+.Xr getfsstat 2 .
+.Sh RETURN VALUES

 On successful completion,
 On successful completion,

-.I getmntinfo
+.Fn getmntinfo

 returns a count of the number of elements in the array.
 The pointer to the array is stored into
 returns a count of the number of elements in the array.
 The pointer to the array is stored into

-.IR mntbufp .
-.PP
+.Fa mntbufp .
+.Pp

 If an error occurs, zero is returned and the external variable
 If an error occurs, zero is returned and the external variable

-.I errno
+.Va errno

 is set to indicate the error.
 Although the pointer 
 is set to indicate the error.
 Although the pointer 

-.I mntbufp
+.Fa mntbufp

 will be unmodified, any information previously returned by 
 will be unmodified, any information previously returned by 

-.I getmntinfo
+.Fn getmntinfo

 will be lost.
 will be lost.

-.SH BUGS
-All information is contained in a static area,
-so it must be copied if it is to be saved.
-.PP
-The memory allocated by
-.I getmntinfo
-cannot be
-.IR free 'd
-by the application.
-.SH ERRORS
-.I Getmntinfo
+.Sh ERRORS
+The
+.Fn getmntinfo
+function

 may fail and set errno for any of the errors specified for the library 
 routines
 may fail and set errno for any of the errors specified for the library 
 routines

-.IR getfsstat (2)
+.Xr getfsstat 2

 or 
 or 

-.IR malloc (3).
-.SH SEE ALSO
-getfsstat(2), statfs(2), mount(2), mount(8)
+.Xr malloc 3 .
+.Sh SEE ALSO
+.Xr getfsstat 2 ,
+.Xr statfs 2 ,
+.Xr mount 2 ,
+.Xr mount 8
+.Sh HISTORY
+The
+.Fn getmntinfo
+function is
+.Ud .
+.Sh BUGS
+The
+.Fn getmntinfo
+function writes the array of structures to an internal static object
+and returns
+a pointer to that object. Subsequent calls to
+.Fn getmntinfo
+will modify the same object.
+.Pp
+The memory allocated by
+.Fn getmntinfo
+cannot be
+.Xr free 2 Ns 'd
+by the application.