1.\" $NetBSD: getfsent.3,v 1.8 2002/02/07 07:00:12 ross Exp $ 2.\" 3.\" Copyright (c) 1983, 1991, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by the University of 17.\" California, Berkeley and its contributors. 18.\" 4. Neither the name of the University nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.\" @(#)getfsent.3 8.1 (Berkeley) 6/4/93 35.\" 36.Dd June 4, 1993 37.Dt GETFSENT 3 38.Os 39.Sh NAME 40.Nm getfsent , 41.Nm getfsspec , 42.Nm getfsfile , 43.Nm setfsent , 44.Nm endfsent 45.Nd get file system descriptor file entry 46.Sh LIBRARY 47.Lb libc 48.Sh SYNOPSIS 49.Fd #include \*[Lt]fstab.h\*[Gt] 50.Ft struct fstab * 51.Fn getfsent void 52.Ft struct fstab * 53.Fn getfsspec "const char *spec" 54.Ft struct fstab * 55.Fn getfsfile "const char *file" 56.Ft int 57.Fn setfsent void 58.Ft void 59.Fn endfsent void 60.Sh DESCRIPTION 61The 62.Fn getfsent , 63.Fn getfsspec , 64and 65.Fn getfsfile 66functions 67each return a pointer to an object with the following structure 68containing the broken-out fields of a line in the file system 69description file, 70.Aq Pa fstab.h . 71.Bd -literal -offset indent 72struct fstab { 73 char *fs_spec; /* block special device name */ 74 char *fs_file; /* file system path prefix */ 75 char *fs_vfstype; /* type of file system */ 76 char *fs_mntops; /* comma separated mount options */ 77 char *fs_type; /* rw, ro, sw, or xx */ 78 int fs_freq; /* dump frequency, in days */ 79 int fs_passno; /* pass number on parallel dump */ 80}; 81.Ed 82.Pp 83The fields have meanings described in 84.Xr fstab 5 . 85.Pp 86The 87.Fn setfsent 88function 89opens the file (closing any previously opened file) or rewinds it 90if it is already open. 91.Pp 92The 93.Fn endfsent 94function 95closes the file. 96.Pp 97The 98.Fn getfsspec 99and 100.Fn getfsfile 101functions 102search the entire file (opening it if necessary) for a matching special 103file name or file system file name. 104.Pp 105For programs wishing to read the entire database, 106.Fn getfsent 107reads the next entry (opening the file if necessary). 108.Pp 109All entries in the file with a type field equivalent to 110.Dv FSTAB_XX 111are ignored. 112.Sh RETURN VALUES 113The 114.Fn getfsent , 115.Fn getfsspec , 116and 117.Fn getfsfile 118functions 119return a null pointer (0) on 120.Dv EOF 121or error. 122The 123.Fn setfsent 124function 125returns 0 on failure, 1 on success. 126The 127.Fn endfsent 128function 129returns nothing. 130.Sh FILES 131.Bl -tag -width /etc/fstab -compact 132.It Pa /etc/fstab 133.El 134.Sh SEE ALSO 135.Xr fstab 5 136.Sh HISTORY 137The 138.Fn getfsent 139function appeared in 140.Bx 4.0 ; 141the 142.Fn endfsent , 143.Fn getfsfile , 144.Fn getfsspec , 145and 146.Fn setfsent 147functions appeared in 148.Bx 4.3 . 149.Sh BUGS 150These functions use static data storage; 151if the data is needed for future use, it should be 152copied before any subsequent calls overwrite it. 153