This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

For more information about the manual page format, see the manual page for manpages(5).

GETFSENT(3)              BSD Library Functions Manual              GETFSENT(3)

NAME
     getfsent, getfsspec, getfsfile, setfsent, endfsent -- get file system descriptor file entry

LIBRARY
     Standard C Library (libc, -lc)

SYNOPSIS
     #include <fstab.h>

     struct fstab *
     getfsent(void);

     struct fstab *
     getfsspec(const char *spec);

     struct fstab *
     getfsfile(const char *file);

     int
     setfsent(void);

     void
     endfsent(void);

DESCRIPTION
     The getfsent(), getfsspec(), and getfsfile() functions each return a pointer to an object with the fol-lowing following
     lowing structure containing the broken-out fields of a line in the file system description file,
     <fstab.h>.

           struct fstab {
                   char    *fs_spec;       /* block special device name */
                   char    *fs_file;       /* file system path prefix */
                   char    *fs_vfstype;    /* File system type, ufs, nfs */
                   char    *fs_mntops;     /* Mount options ala -o */
                   char    *fs_type;       /* FSTAB_* from fs_mntops */
                   int     fs_freq;        /* dump frequency, in days */
                   int     fs_passno;      /* pass number on parallel fsck */
           };

     The fields have meanings described in fstab(5).

     The setfsent() function opens the file (closing any previously opened file) or rewinds it if it is
     already open.

     The endfsent() function closes the file.

     The getfsspec() and getfsfile() functions search the entire file (opening it if necessary) for a match-ing matching
     ing special file name or file system file name.

     For programs wishing to read the entire database, getfsent() reads the next entry (opening the file if
     necessary).

     All entries in the file with a type field equivalent to FSTAB_XX are ignored.

RETURN VALUES
     The getfsent(), getfsspec(), and getfsfile() functions return a NULL pointer on EOF or error.  The
     setfsent() function returns 0 on failure, 1 on success.  The endfsent() function returns nothing.

FILES
     /etc/fstab

SEE ALSO
     fstab(5)

HISTORY
     The getfsent() function appeared in 4.0BSD; the endfsent(), getfsfile(), getfsspec(), and setfsent()
     functions appeared in 4.3BSD.

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.

BSD                              June 4, 1993                              BSD