summaryrefslogtreecommitdiffstats
path: root/man3/getfsent.3
diff options
context:
space:
mode:
Diffstat (limited to 'man3/getfsent.3')
-rw-r--r--man3/getfsent.3152
1 files changed, 0 insertions, 152 deletions
diff --git a/man3/getfsent.3 b/man3/getfsent.3
deleted file mode 100644
index 8d7f84609..000000000
--- a/man3/getfsent.3
+++ /dev/null
@@ -1,152 +0,0 @@
-'\" t
-.\" Copyright (C) 2002 Andries Brouwer (aeb@cwi.nl)
-.\"
-.\" SPDX-License-Identifier: Linux-man-pages-copyleft
-.\"
-.\" Inspired by a page written by Walter Harms.
-.\"
-.TH getfsent 3 (date) "Linux man-pages (unreleased)"
-.SH NAME
-getfsent, getfsspec, getfsfile, setfsent, endfsent \- handle fstab entries
-.SH LIBRARY
-Standard C library
-.RI ( libc ", " \-lc )
-.SH SYNOPSIS
-.nf
-.B #include <fstab.h>
-.PP
-.B "int setfsent(void);"
-.B "struct fstab *getfsent(void);"
-.B "void endfsent(void);"
-.PP
-.BI "struct fstab *getfsfile(const char *" mount_point );
-.BI "struct fstab *getfsspec(const char *" special_file );
-.fi
-.SH DESCRIPTION
-These functions read from the file
-.IR /etc/fstab .
-The
-.I struct fstab
-is defined by:
-.PP
-.in +4n
-.EX
-struct fstab {
- char *fs_spec; /* block device name */
- char *fs_file; /* mount point */
- char *fs_vfstype; /* filesystem type */
- char *fs_mntops; /* mount options */
- const char *fs_type; /* rw/rq/ro/sw/xx option */
- int fs_freq; /* dump frequency, in days */
- int fs_passno; /* pass number on parallel dump */
-};
-.EE
-.in
-.PP
-Here the field
-.I fs_type
-contains (on a *BSD system)
-one of the five strings "rw", "rq", "ro", "sw", "xx"
-(read-write, read-write with quota, read-only, swap, ignore).
-.PP
-The function
-.BR setfsent ()
-opens the file when required and positions it at the first line.
-.PP
-The function
-.BR getfsent ()
-parses the next line from the file.
-(After opening it when required.)
-.PP
-The function
-.BR endfsent ()
-closes the file when required.
-.PP
-The function
-.BR getfsspec ()
-searches the file from the start and returns the first entry found
-for which the
-.I fs_spec
-field matches the
-.I special_file
-argument.
-.PP
-The function
-.BR getfsfile ()
-searches the file from the start and returns the first entry found
-for which the
-.I fs_file
-field matches the
-.I mount_point
-argument.
-.SH RETURN VALUE
-Upon success, the functions
-.BR getfsent (),
-.BR getfsfile (),
-and
-.BR getfsspec ()
-return a pointer to a
-.IR "struct fstab" ,
-while
-.BR setfsent ()
-returns 1.
-Upon failure or end-of-file, these functions return NULL and 0, respectively.
-.SH ATTRIBUTES
-For an explanation of the terms used in this section, see
-.BR attributes (7).
-.ad l
-.nh
-.TS
-allbox;
-lb lb lbx
-l l l.
-Interface Attribute Value
-T{
-.BR endfsent (),
-.BR setfsent ()
-T} Thread safety T{
-MT-Unsafe race:fsent
-T}
-T{
-.BR getfsent (),
-.BR getfsspec (),
-.BR getfsfile ()
-T} Thread safety T{
-MT-Unsafe race:fsent locale
-T}
-.TE
-.hy
-.ad
-.sp 1
-.SH VERSIONS
-Several operating systems have these functions, for example,
-*BSD, SunOS, Digital UNIX, AIX (which also has a
-.BR getfstype ()).
-HP-UX has functions of the same names,
-that however use a
-.I struct checklist
-instead of a
-.IR "struct fstab" ,
-and calls these functions obsolete, superseded by
-.BR getmntent (3).
-.SH STANDARDS
-None.
-.SH HISTORY
-The
-.BR getfsent ()
-function appeared in 4.0BSD; the other four functions appeared in 4.3BSD.
-.SH NOTES
-These functions are not thread-safe.
-.PP
-Since Linux allows mounting a block special device in several places,
-and since several devices can have the same mount point, where the
-last device with a given mount point is the interesting one,
-while
-.BR getfsfile ()
-and
-.BR getfsspec ()
-only return the first occurrence, these two functions are not suitable
-for use under Linux.
-.SH SEE ALSO
-.BR getmntent (3),
-.BR fstab (5)