BSD 4_4 release

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

diff --git a/usr/src/lib/libc/gen/getfsent.3 b/usr/src/lib/libc/gen/getfsent.3
index e83bb37..1051837 100644 (file)
--- a/usr/src/lib/libc/gen/getfsent.3
+++ b/usr/src/lib/libc/gen/getfsent.3
@@ -1,81 +1,148 @@
-.\" Copyright (c) 1980 Regents of the University of California.
-.\" All rights reserved.  The Berkeley software License Agreement
-.\" specifies the terms and conditions for redistribution.
+.\" Copyright (c) 1983, 1991, 1993
+.\"    The Regents of the University of California.  All rights reserved.

 .\"
 .\"

-.\"    @(#)getfsent.3  6.4 (Berkeley) %G%
+.\" 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.

 .\"
 .\"

-.TH GETFSENT 3  ""
-.UC 4
-.SH NAME
-getfsent, getfsspec, getfsfile, setfsent, endfsent \- get file system descriptor file entry
-.SH SYNOPSIS
-.nf
-.B #include <fstab.h>
-.PP
-.B struct fstab *getfsent()
-.PP
-.B struct fstab *getfsspec(spec)
-.B char *spec;
-.PP
-.B struct fstab *getfsfile(file)
-.B char *file;
-.PP
-.B int setfsent()
-.PP
-.B int endfsent()
-.fi
-.SH DESCRIPTION
-.IR Getfsent ,
-.IR getfsspec ,
+.\" 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.
+.\"
+.\"     @(#)getfsent.3 8.1 (Berkeley) 6/4/93
+.\"
+.Dd June 4, 1993
+.Dt GETFSENT 3
+.Os BSD 4
+.Sh NAME
+.Nm getfsent ,
+.Nm getfsspec ,
+.Nm getfsfile ,
+.Nm setfsent ,
+.Nm endfsent
+.Nd get file system descriptor file entry
+.Sh SYNOPSIS
+.Fd #include <fstab.h>
+.Ft fstab *
+.Fn getfsent void
+.Ft struct fstab *
+.Fn getfsspec "const char *spec"
+.Ft struct fstab *
+.Fn getfsfile "const char *file"
+.Ft int
+.Fn setfsent void
+.Ft void
+.Fn endfsent void
+.Sh DESCRIPTION
+The
+.Fn getfsent ,
+.Fn getfsspec ,

 and
 and

-.I getfsfile
+.Fn getfsfile
+functions

 each return a pointer to an object with the following structure
 containing the broken-out fields of a line in the file system
 description file,
 each return a pointer to an object with the following structure
 containing the broken-out fields of a line in the file system
 description file,

-.IR < fstab.h >.
-.RS
-.PP
-.nf
+.Aq Pa fstab.h .
+.Bd -literal -offset indent

 struct fstab {
 struct fstab {

-       char    *fs_spec;
-       char    *fs_file;
-       char    *fs_type;
-       int     fs_freq;
-       int     fs_passno;
+       char    *fs_spec;       /* block special device name */
+       char    *fs_file;       /* file system path prefix */
+       char    *fs_vfstype;    /* type of file system */
+       char    *fs_mntops;     /* comma separated mount options */
+       char    *fs_type;       /* rw, ro, sw, or xx */
+       int     fs_freq;        /* dump frequency, in days */
+       int     fs_passno;      /* pass number on parallel dump */

 };
 };

-.ft R
-.ad
-.fi
-.RE
-.PP
+.Ed
+.Pp

 The fields have meanings described in
 The fields have meanings described in

-.IR fstab (5).
-.PP
-.I Getfsent
-reads the next line of the file, opening the file if necessary.
-.PP
-.I Setfsent
-opens and rewinds the file.
-.PP
-.I Endfsent
+.Xr fstab 5 .
+.Pp
+The
+.Fn setfsent
+function
+opens the file (closing any previously opened file) or rewinds it
+if it is already open.
+.Pp
+The
+.Fn endfsent
+function

 closes the file.
 closes the file.

-.PP
-.I Getfsspec
+.Pp
+The
+.Fn getfsspec

 and
 and

-.I getfsfile
-sequentially search from the beginning of the file until a matching
-special file name or file system file name is found, or until EOF is
-encountered.
-.PP
-Entries in the file with a type field equivalent to \fIFSTAB_XX\fP
+.Fn getfsfile
+functions
+search the entire file (opening it if necessary) for a matching special
+file name or file system file name.
+.Pp
+For programs wishing to read the entire database,
+.Fn getfsent
+reads the next entry (opening the file if necessary).
+.Pp
+All entries in the file with a type field equivalent to
+.Dv FSTAB_XX

 are ignored.
 are ignored.

-.SH FILES
-/etc/fstab
-.SH "SEE ALSO"
-fstab(5)
-.SH DIAGNOSTICS
-Null pointer
-(0) returned on EOF or error.
-.SH BUGS
-All information is contained in a static area so it must be copied if it is
-to be saved.
+.Sh RETURN VALUES
+The
+.Fn getfsent ,
+.Fn getfsspec ,
+and
+.Fn getfsfile
+functions
+return a null pointer (0) on
+.Dv EOF
+or error.
+The
+.Fn setfsent
+function
+returns 0 on failure, 1 on success.
+The
+.Fn endfsent
+function
+returns nothing.
+.Sh FILES
+.Bl -tag -width /etc/fstab -compact
+.It Pa /etc/fstab
+.El
+.Sh SEE ALSO
+.Xr fstab 5
+.Sh HISTORY
+The
+.Fn getfsent
+function appeared in 
+.Bx 4.0 ;
+the
+.Fn endfsent ,
+.Fn getfsfile ,
+.Fn getfsspec ,
+and 
+.Fn setfsent
+functions appeared in
+.Bx 4.3 .
+.Sh BUGS
+These functions use static data storage;
+if the data is needed for future use, it should be
+copied before any subsequent calls overwrite it.