2004-11-03 13:51:07 +00:00
|
|
|
.\" Copyright (C) 2002 Andries Brouwer (aeb@cwi.nl)
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to make and distribute verbatim copies of this
|
|
|
|
.\" manual provided the copyright notice and this permission notice are
|
|
|
|
.\" preserved on all copies.
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to copy and distribute modified versions of this
|
|
|
|
.\" manual under the conditions for verbatim copying, provided that the
|
|
|
|
.\" entire resulting derived work is distributed under the terms of a
|
|
|
|
.\" permission notice identical to this one.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" Since the Linux kernel and libraries are constantly changing, this
|
|
|
|
.\" manual page may be incorrect or out-of-date. The author(s) assume no
|
|
|
|
.\" responsibility for errors or omissions, or for damages resulting from
|
|
|
|
.\" the use of the information contained herein. The author(s) may not
|
|
|
|
.\" have taken the same level of care in the production of this manual,
|
|
|
|
.\" which is licensed free of charge, as they might when working
|
|
|
|
.\" professionally.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
|
|
|
.\"
|
|
|
|
.\" Inspired by a page written by Walter Harms.
|
|
|
|
.\"
|
2007-05-30 05:36:26 +00:00
|
|
|
.TH GETFSENT 3 2002-02-28 "GNU" "Linux Programmer's Manual"
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NAME
|
|
|
|
getfsent, getfsspec, getfsfile, setfsent, endfsent \- handle fstab entries
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.B #include <fstab.h>
|
|
|
|
.sp
|
2007-09-20 16:26:31 +00:00
|
|
|
.B "void endfsent(void);"
|
2004-11-03 13:51:07 +00:00
|
|
|
.sp
|
2007-09-20 16:26:31 +00:00
|
|
|
.B "struct fstab *getfsent(void);"
|
2004-11-03 13:51:07 +00:00
|
|
|
.sp
|
|
|
|
.BI "struct fstab *getfsfile(const char *" mount_point );
|
|
|
|
.sp
|
|
|
|
.BI "struct fstab *getfsspec(const char *" special_file );
|
|
|
|
.sp
|
2007-09-20 16:26:31 +00:00
|
|
|
.B "int setfsent(void);"
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH DESCRIPTION
|
|
|
|
These functions read from the file
|
|
|
|
.IR /etc/fstab .
|
2007-07-09 21:07:06 +00:00
|
|
|
The \fIstruct fstab\fP is defined by:
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
2007-12-19 06:57:44 +00:00
|
|
|
.in +4n
|
2004-11-03 13:51:07 +00:00
|
|
|
.nf
|
|
|
|
struct fstab {
|
2007-07-09 21:07:06 +00:00
|
|
|
char *fs_spec; /* block device name */
|
|
|
|
char *fs_file; /* mount point */
|
2008-03-19 07:26:08 +00:00
|
|
|
char *fs_vfstype; /* file-sysem type */
|
2007-07-09 21:07:06 +00:00
|
|
|
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 */
|
2004-11-03 13:51:07 +00:00
|
|
|
};
|
|
|
|
.fi
|
2007-07-09 21:07:06 +00:00
|
|
|
.in
|
|
|
|
.PP
|
2004-11-03 13:51:07 +00:00
|
|
|
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).
|
|
|
|
|
|
|
|
The function
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR setfsent ()
|
2004-11-03 13:51:07 +00:00
|
|
|
opens the file when required and positions it at the first line.
|
|
|
|
.LP
|
|
|
|
The function
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR getfsent ()
|
2004-11-03 13:51:07 +00:00
|
|
|
parses the next line from the file.
|
|
|
|
(After opening it when required.)
|
|
|
|
.LP
|
|
|
|
The function
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR endfsent ()
|
2004-11-03 13:51:07 +00:00
|
|
|
closes the file when required.
|
|
|
|
.LP
|
|
|
|
The function
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR getfsspec ()
|
2004-11-03 13:51:07 +00:00
|
|
|
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.
|
|
|
|
.LP
|
|
|
|
The function
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR getfsfile ()
|
2004-11-03 13:51:07 +00:00
|
|
|
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
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR getfsent (),
|
|
|
|
.BR getfsfile (),
|
2004-11-03 13:51:07 +00:00
|
|
|
and
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR getfsspec ()
|
2007-06-13 22:13:46 +00:00
|
|
|
return a pointer to a \fIstruct fstab\fP, while
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR setfsent ()
|
2004-11-03 13:51:07 +00:00
|
|
|
returns 1.
|
|
|
|
Upon failure or end-of-file, these functions return NULL and 0, respectively.
|
2007-05-18 11:59:14 +00:00
|
|
|
.\" .SH HISTORY
|
|
|
|
.\" The
|
|
|
|
.\" .BR getfsent ()
|
|
|
|
.\" function appeared in 4.0BSD; the other four functions appeared in 4.3BSD.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "CONFORMING TO"
|
2007-04-12 22:42:49 +00:00
|
|
|
These functions are not in POSIX.1-2001.
|
2006-08-03 13:57:30 +00:00
|
|
|
Several operating systems have them,
|
intro.1, time.1, accept.2, bind.2, connect.2, execve.2, flock.2, getdents.2, getpriority.2, getuid.2, intro.2, ioctl.2, mincore.2, mknod.2, personality.2, ptrace.2, read.2, recv.2, select_tut.2, send.2, sendfile.2, shmctl.2, sigaction.2, signal.2, stat.2, times.2, truncate.2, umask.2, wait.2, MB_CUR_MAX.3, MB_LEN_MAX.3, argz_add.3, btowc.3, clearenv.3, clock.3, cmsg.3, end.3, endian.3, errno.3, exit.3, fgetwc.3, fgetws.3, fopen.3, fputwc.3, fputws.3, fseek.3, fwide.3, getfsent.3, getgrnam.3, gethostid.3, getipnodebyname.3, getmntent.3, getpwnam.3, getwchar.3, grantpt.3, iconv.3, iconv_close.3, iconv_open.3, insque.3, intro.3, iswalnum.3, iswalpha.3, iswblank.3, iswcntrl.3, iswctype.3, iswdigit.3, iswgraph.3, iswlower.3, iswprint.3, iswpunct.3, iswspace.3, iswupper.3, iswxdigit.3, malloc.3, mblen.3, mbrlen.3, mbrtowc.3, mbsinit.3, mbsnrtowcs.3, mbsrtowcs.3, mbstowcs.3, mbtowc.3, mkstemp.3, mktemp.3, nl_langinfo.3, openpty.3, posix_openpt.3, printf.3, ptsname.3, putwchar.3, qecvt.3, rcmd.3, readdir.3, rexec.3, rpc.3, setnetgrent.3, shm_open.3, sigpause.3, stdin.3, stpcpy.3, strftime.3, strptime.3, syslog.3, towctrans.3, towlower.3, towupper.3, ttyslot.3, ungetwc.3, unlocked_stdio.3, wcpcpy.3, wcpncpy.3, wcrtomb.3, wcscasecmp.3, wcscat.3, wcschr.3, wcscmp.3, wcscpy.3, wcscspn.3, wcsdup.3, wcslen.3, wcsncasecmp.3, wcsncat.3, wcsncmp.3, wcsncpy.3, wcsnlen.3, wcsnrtombs.3, wcspbrk.3, wcsrchr.3, wcsrtombs.3, wcsspn.3, wcsstr.3, wcstok.3, wcstombs.3, wcswidth.3, wctob.3, wctomb.3, wctrans.3, wctype.3, wcwidth.3, wmemchr.3, wmemcmp.3, wmemcpy.3, wmemmove.3, wmemset.3, wprintf.3, console_ioctl.4, pts.4, elf.5, filesystems.5, hosts.5, proc.5, ttytype.5, boot.7, capabilities.7, credentials.7, epoll.7, glob.7, koi8-r.7, path_resolution.7, pty.7, signal.7, suffixes.7, time.7, unicode.7, unix.7, uri.7, utf-8.7: global fix: s/Unix/UNIX/
The man pages were rather inconsistent in the use of "Unix"
versus "UNIX". Let's go with the trademark usage.
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-10-12 04:45:38 +00:00
|
|
|
e.g., *BSD, SunOS, Digital UNIX, AIX (which also has a
|
2005-11-02 11:34:24 +00:00
|
|
|
.BR getfstype ()).
|
2007-06-13 22:13:46 +00:00
|
|
|
HP-UX has functions of the same names,
|
|
|
|
that however use a \fIstruct checklist\fP
|
|
|
|
instead of a \fIstruct fstab\fP,
|
|
|
|
and calls these functions obsolete, superseded by
|
2004-11-03 13:51:07 +00:00
|
|
|
.BR getmntent (3).
|
|
|
|
.SH NOTES
|
|
|
|
These functions are not thread-safe.
|
|
|
|
.LP
|
|
|
|
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
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR getfsfile ()
|
2004-11-03 13:51:07 +00:00
|
|
|
and
|
2005-10-19 07:07:02 +00:00
|
|
|
.BR getfsspec ()
|
2004-11-03 13:51:07 +00:00
|
|
|
only return the first occurrence, these two functions are not suitable
|
|
|
|
for use under Linux.
|
|
|
|
.SH "SEE ALSO"
|
|
|
|
.BR getmntent (3),
|
|
|
|
.BR fstab (5)
|