lib/libc/gen/getfsent.3

   1 .\" Copyright (c) 1983, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)getfsent.3  8.1 (Berkeley) 6/4/93
  29 .\" $FreeBSD: src/lib/libc/gen/getfsent.3,v 1.17 2007/01/09 00:27:53 imp Exp $
  30 .\" $DragonFly: src/lib/libc/gen/getfsent.3,v 1.3 2006/05/26 19:39:36 swildner Exp $
  31 .\"
  32 .Dd April 7, 2003
  33 .Dt GETFSENT 3
  34 .Os
  35 .Sh NAME
  36 .Nm getfsent ,
  37 .Nm getfsspec ,
  38 .Nm getfsfile ,
  39 .Nm setfsent ,
  40 .Nm endfsent ,
  41 .Nm setfstab ,
  42 .Nm getfstab
  43 .Nd get file system descriptor file entry
  44 .Sh LIBRARY
  45 .Lb libc
  46 .Sh SYNOPSIS
  47 .In fstab.h
  48 .Ft "struct fstab *"
  49 .Fn getfsent void
  50 .Ft "struct fstab *"
  51 .Fn getfsspec "const char *spec"
  52 .Ft "struct fstab *"
  53 .Fn getfsfile "const char *file"
  54 .Ft int
  55 .Fn setfsent void
  56 .Ft void
  57 .Fn endfsent void
  58 .Ft void
  59 .Fn setfstab "const char *file"
  60 .Ft "const char *"
  61 .Fn getfstab void
  62 .Sh DESCRIPTION
  63 The
  64 .Fn getfsent ,
  65 .Fn getfsspec ,
  66 and
  67 .Fn getfsfile
  68 functions
  69 each return a pointer to an object with the following structure
  70 containing the broken-out fields of a line in the file system
  71 description file,
  72 .In fstab.h .
  73 .Bd -literal -offset indent
  74 struct fstab {
  75         char    *fs_spec;       /* block special device name */
  76         char    *fs_file;       /* file system path prefix */
  77         char    *fs_vfstype;    /* File system type, ufs, nfs */
  78         char    *fs_mntops;     /* Mount options ala -o */
  79         char    *fs_type;       /* FSTAB_* from fs_mntops */
  80         int     fs_freq;        /* dump frequency, in days */
  81         int     fs_passno;      /* pass number on parallel fsck */
  82 };
  83 .Ed
  84 .Pp
  85 The fields have meanings described in
  86 .Xr fstab 5 .
  87 .Pp
  88 The
  89 .Fn setfsent
  90 function
  91 opens the file (closing any previously opened file) or rewinds it
  92 if it is already open.
  93 .Pp
  94 The
  95 .Fn endfsent
  96 function
  97 closes the file.
  98 .Pp
  99 The
 100 .Fn setfstab
 101 function sets the file to be used by subsequent operations.
 102 The value set by
 103 .Fn setfstab
 104 does not persist across calls to
 105 .Fn endfsent .
 106 .Pp
 107 The
 108 .Fn getfstab
 109 function returns the name of the file that will be used.
 110 .Pp
 111 The
 112 .Fn getfsspec
 113 and
 114 .Fn getfsfile
 115 functions
 116 search the entire file (opening it if necessary) for a matching special
 117 file name or file system file name.
 118 .Pp
 119 For programs wishing to read the entire database,
 120 .Fn getfsent
 121 reads the next entry (opening the file if necessary).
 122 .Pp
 123 All entries in the file with a type field equivalent to
 124 .Dv FSTAB_XX
 125 are ignored.
 126 .Sh RETURN VALUES
 127 The
 128 .Fn getfsent ,
 129 .Fn getfsspec ,
 130 and
 131 .Fn getfsfile
 132 functions
 133 return a
 134 .Dv NULL
 135 pointer on
 136 .Dv EOF
 137 or error.
 138 The
 139 .Fn setfsent
 140 function
 141 returns 0 on failure, 1 on success.
 142 The
 143 .Fn endfsent
 144 function
 145 returns nothing.
 146 .Sh ENVIRONMENT
 147 .Bl -tag -width ".Ev PATH_FSTAB"
 148 .It Ev PATH_FSTAB
 149 If the environment variable
 150 .Ev PATH_FSTAB
 151 is set, all operations are performed against the specified file.
 152 .Ev PATH_FSTAB
 153 will not be honored if the process environment or memory address space is
 154 considered
 155 .Dq tainted .
 156 (See
 157 .Xr issetugid 2
 158 for more information.)
 159 .El
 160 .Sh FILES
 161 .Bl -tag -width /etc/fstab -compact
 162 .It Pa /etc/fstab
 163 .El
 164 .Sh SEE ALSO
 165 .Xr fstab 5
 166 .Sh HISTORY
 167 The
 168 .Fn getfsent
 169 function appeared in
 170 .Bx 4.0 ;
 171 the
 172 .Fn endfsent ,
 173 .Fn getfsfile ,
 174 .Fn getfsspec ,
 175 and
 176 .Fn setfsent
 177 functions appeared in
 178 .Bx 4.3 ;
 179 the
 180 .Fn setfstab
 181 and
 182 .Fn getfstab
 183 functions appeared in
 184 .Fx 5.1 .
 185 .Sh BUGS
 186 These functions use static data storage;
 187 if the data is needed for future use, it should be
 188 copied before any subsequent calls overwrite it.