1 .\" Copyright (C) 2002 Andries Brouwer (aeb@cwi.nl)
3 .\" %%%LICENSE_START(VERBATIM)
4 .\" Permission is granted to make and distribute verbatim copies of this
5 .\" manual provided the copyright notice and this permission notice are
6 .\" preserved on all copies.
8 .\" Permission is granted to copy and distribute modified versions of this
9 .\" manual under the conditions for verbatim copying, provided that the
10 .\" entire resulting derived work is distributed under the terms of a
11 .\" permission notice identical to this one.
13 .\" Since the Linux kernel and libraries are constantly changing, this
14 .\" manual page may be incorrect or out-of-date. The author(s) assume no
15 .\" responsibility for errors or omissions, or for damages resulting from
16 .\" the use of the information contained herein. The author(s) may not
17 .\" have taken the same level of care in the production of this manual,
18 .\" which is licensed free of charge, as they might when working
21 .\" Formatted or processed versions of this manual, if unaccompanied by
22 .\" the source, must acknowledge the copyright and authors of this work.
25 .\" Inspired by a page written by Walter Harms.
27 .TH GETFSENT 3 2017-09-15 "GNU" "Linux Programmer's Manual"
29 getfsent, getfsspec, getfsfile, setfsent, endfsent \- handle fstab entries
33 .B "void endfsent(void);"
35 .B "struct fstab *getfsent(void);"
37 .BI "struct fstab *getfsfile(const char *" mount_point );
39 .BI "struct fstab *getfsspec(const char *" special_file );
41 .B "int setfsent(void);"
43 These functions read from the file
52 char *fs_spec; /* block device name */
53 char *fs_file; /* mount point */
54 char *fs_vfstype; /* file-system type */
55 char *fs_mntops; /* mount options */
56 const char *fs_type; /* rw/rq/ro/sw/xx option */
57 int fs_freq; /* dump frequency, in days */
58 int fs_passno; /* pass number on parallel dump */
65 contains (on a *BSD system)
66 one of the five strings "rw", "rq", "ro", "sw", "xx"
67 (read-write, read-write with quota, read-only, swap, ignore).
71 opens the file when required and positions it at the first line.
75 parses the next line from the file.
76 (After opening it when required.)
80 closes the file when required.
84 searches the file from the start and returns the first entry found
93 searches the file from the start and returns the first entry found
100 Upon success, the functions
105 return a pointer to a
110 Upon failure or end-of-file, these functions return NULL and 0, respectively.
114 .\" function appeared in 4.0BSD; the other four functions appeared in 4.3BSD.
116 For an explanation of the terms used in this section, see
122 Interface Attribute Value
127 T} Thread safety MT-Unsafe race:fsent
134 T} Thread safety MT-Unsafe race:fsent locale
137 These functions are not in POSIX.1.
138 Several operating systems have them, for example,
139 *BSD, SunOS, Digital UNIX, AIX (which also has a
141 HP-UX has functions of the same names,
143 .IR "struct checklist"
146 and calls these functions obsolete, superseded by
149 These functions are not thread-safe.
151 Since Linux allows mounting a block special device in several places,
152 and since several devices can have the same mount point, where the
153 last device with a given mount point is the interesting one,
158 only return the first occurrence, these two functions are not suitable