1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
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 .\" References consulted:
26 .\" Linux libc source code
27 .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
29 .\" Modified Sat Jul 24 21:46:57 1993 by Rik Faith (faith@cs.unc.edu)
30 .\" Modified 961109, 031115, aeb
32 .TH GETMNTENT 3 2017-09-15 "" "Linux Programmer's Manual"
34 getmntent, setmntent, addmntent, endmntent, hasmntopt,
35 getmntent_r \- get filesystem descriptor file entry
39 .B #include <mntent.h>
41 .BI "FILE *setmntent(const char *" filename ", const char *" type );
43 .BI "struct mntent *getmntent(FILE *" stream );
45 .BI "int addmntent(FILE *" stream ", const struct mntent *" mnt );
47 .BI "int endmntent(FILE *" streamp );
49 .BI "char *hasmntopt(const struct mntent *" mnt ", const char *" opt );
52 .B #include <mntent.h>
54 .BI "struct mntent *getmntent_r(FILE *" streamp ", struct mntent *" mntbuf ,
55 .BI " char *" buf ", int " buflen );
59 Feature Test Macro Requirements for glibc (see
60 .BR feature_test_macros (7)):
66 Glibc 2.19 and earlier:
67 _BSD_SOURCE || _SVID_SOURCE
69 These routines are used to access the filesystem description file
71 and the mounted filesystem description file
76 function opens the filesystem description file
78 and returns a file pointer which can be used by
83 required and can take the same values as the
90 function reads the next line of the filesystem
93 and returns a pointer to a structure
94 containing the broken out fields from a line in the file.
96 points to a static area of memory which is overwritten by subsequent
114 associated with the filesystem description file.
125 for a substring that matches
131 for valid mount options.
135 function is similar to
141 and stores the strings pointed to by the entries in that struct
142 in the provided array
149 structure is defined in
156 char *mnt_fsname; /* name of mounted filesystem */
157 char *mnt_dir; /* filesystem path prefix */
158 char *mnt_type; /* mount type (see mntent.h) */
159 char *mnt_opts; /* mount options (see mntent.h) */
160 int mnt_freq; /* dump frequency in days */
161 int mnt_passno; /* pass number on parallel fsck */
166 Since fields in the mtab and fstab files are separated by whitespace,
167 octal escapes are used to represent the characters space (\e040),
168 tab (\e011), newline (\e012), and backslash (\e\e) in those files
169 when they occur in one of the four strings in a
177 from string representation to escaped representation and back.
178 When converting from escaped representation, the sequence \e134 is
179 also converted to a backslash.
188 structure or NULL on failure.
192 function returns 0 on success and 1 on failure.
196 function always returns 1.
200 function returns the address of the substring if
201 a match is found and NULL otherwise.
205 filesystem description file
208 mounted filesystem description file
210 For an explanation of the terms used in this section, see
217 Interface Attribute Value
222 T} Thread safety MT-Safe
225 T} Thread safety MT-Unsafe race:mntentbuf locale
228 T} Thread safety MT-Safe race:stream locale
231 T} Thread safety MT-Safe locale
235 The nonreentrant functions are from SunOS 4.1.3.
238 was introduced in HP-UX 10, but it returns an int.
239 The prototype shown above is glibc-only.
243 function but the calling sequence
244 differs, and the returned structure is different.
248 4.4BSD and Digital UNIX have a routine
250 a wrapper around the system call