getmntentのヘルプ・マニュアル
日本語 英語
getmntent --help
man getmntent
GETMNTENT(3) Linux Programmer’s Manual GETMNTENT(3)
名前
getmntent, setmntent, addmntent, endmntent, hasmntopt, getmntent_r - フ
ァイルシステム記述ファイルのエントリを取得する
書式
#include
#include
FILE *setmntent(const char *filename, const char *type);
struct mntent *getmntent(FILE *fp);
int addmntent(FILE *fp, const struct mntent *mnt);
int endmntent(FILE *fp);
char *hasmntopt(const struct mntent *mnt, const char *opt);
/* GNU による拡張 */
#include
struct mntent *getmntent_r(FILE *fp, struct mntent *mntbuf,
char *buf, int buflen);
glibc 向けの機能検査マクロの要件 (feature_test_macros(7) 参照):
getmntent_r(): _BSD_SOURCE || _SVID_SOURCE
説明
これらのルーチンは、ファイルシステムを記述したファイル /etc/fstab と 、
マウントされているファイルシステムを記述したファイル /etc/mtab にアクセ
スするために用いられる。
setmntent() 関数は、ファイルシステムの記述ファイル fp をオープンして 、
そのファイルポインタを返す。このファイルポインタは getmntent() によって
用いられる。引き数 type は要求するアクセス形式で、 fopen(3) の mode 引
き数と同じ値を取ることができる。
getmntent() 関数はファイルシステムの記述ファイル fp から新しい行を読み
込み、行をフィールドに分割した内容を収めた構造体へのポインタを返す。 ポ
インタはメモリの静的な領域を指しており、この領域は getmntent() を次に呼
び出したときに上書きされてしまう。
addmntent() 関数は mntent 構造体 mnt の内容を、オープンされているファイ
ル fp の最後に追加する。
endmntent() 関数はファイルシステムの記述ファイル fp を閉じる。
hasmntopt() 関数は mntent 構造体 mnt の mnt_opts フィールド (下記参照)
をスキャンし、 opt に一致する部分文字列があるかを調べる。有効なマウント
オプションについては と mount(8) を参照のこと。
リ エントラントな関数 getmntent_r() は getmntent() と同じだが、ユーザが
用意した *mntbuf に struct mount を格納し、その構造体の各エントリが指し
示す文字列をユーザが用意した大きさ buflen の配列 buf に書き込む。
mntent 構造体は で以下のように定義されている。
struct mntent {
char *mnt_fsname; /* name of mounted file system */
char *mnt_dir; /* file system path prefix */
char *mnt_type; /* mount type (see mntent.h) */
char *mnt_opts; /* mount options (see mntent.h) */
int mnt_freq; /* dump frequency in days */
int mnt_passno; /* pass number on parallel fsck */
};
mtab や fstab ファイルでは、各フィールドは空白で区切られているので、ス
ペース、タブ、改行、バックスラッシュの 4文字をこれらのファイルで使い た
い 場合で、かつ mntent 構造体の 4つの文字列メンバーのいずれかに対応する
フィールド内で使いたい場合には、8進のエスケープ表記を使って表現する: ス
ペ ー ス (\040), タブ (\011), 改行 (\012), バックスラッシュ (\134)。
addmntent() と getmntent() は、文字列表現からエスケープ表現への変換、お
よびその逆を行う。
返り値
getmntent() と getmntent_r() は mntent 構造体へのポインタを返す。失敗し
た場合は NULL を返す。
endmntent() 関数はつねに 1 を返す。
hasmntopt() 関数は、マッチした場合は部分文字列へのアドレスを返し、マ ッ
チしなければ NULL を返す。
ファイル
/etc/fstab ファイルシステム記述ファイル
/etc/mtab マウントされたファイルシステムの記述ファイル
準拠
リエントラントでない関数は SunOS 4.1.3 由来のものである。 getmntent_r()
関数は HPUX 10 で導入されたが、このバージョンでは int を返す。上記に 示
したプロトタイプは glibc 独自のものである。
注意
System V にも getmntent() 関数はあるが、呼び出し手順が異なり、返される
構造体も異なる。 System V では /etc/mnttab が用いられる 。 4.4BSD と
Digital Unix には getmntinfo() があるが、システムコール getfsstat() の
ラッパー関数である。
関連項目
fopen(3), fstab(5), mount(8)
2008-06-16 GETMNTENT(3)
GETMNTENT(3) Linux Programmer’s Manual GETMNTENT(3)
NAME
getmntent, setmntent, addmntent, endmntent, hasmntopt, getmntent_r -
get file system descriptor file entry
SYNOPSIS
#include
#include
FILE *setmntent(const char *filename, const char *type);
struct mntent *getmntent(FILE *fp);
int addmntent(FILE *fp, const struct mntent *mnt);
int endmntent(FILE *fp);
char *hasmntopt(const struct mntent *mnt, const char *opt);
/* GNU extension */
#include
struct mntent *getmntent_r(FILE *fp, struct mntent *mntbuf,
char *buf, int buflen);
Feature Test Macro Requirements for glibc (see feature_test_macros(7)):
getmntent_r(): _BSD_SOURCE || _SVID_SOURCE
DESCRIPTION
These routines are used to access the file system description file
/etc/fstab and the mounted file system description file /etc/mtab.
The setmntent() function opens the file system description file fp and
returns a file pointer which can be used by getmntent(). The argument
type is the type of access required and can take the same values as the
mode argument of fopen(3).
The getmntent() function reads the next line from the file system
description file fp and returns a pointer to a structure containing the
broken out fields from a line in the file. The pointer points to a
static area of memory which is overwritten by subsequent calls to getm-
ntent().
The addmntent() function adds the mntent structure mnt to the end of
the open file fp.
The endmntent() function closes the file system description file fp.
The hasmntopt() function scans the mnt_opts field (see below) of the
mntent structure mnt for a substring that matches opt. See
and mount(8) for valid mount options.
The reentrant getmntent_r() function is similar to getmntent(), but
stores the struct mount in the provided *mntbuf and stores the strings
pointed to by the entries in that struct in the provided array buf of
size buflen.
The mntent structure is defined in as follows:
struct mntent {
char *mnt_fsname; /* name of mounted file system */
char *mnt_dir; /* file system path prefix */
char *mnt_type; /* mount type (see mntent.h) */
char *mnt_opts; /* mount options (see mntent.h) */
int mnt_freq; /* dump frequency in days */
int mnt_passno; /* pass number on parallel fsck */
};
Since fields in the mtab and fstab files are separated by whitespace,
octal escapes are used to represent the four characters space (\040),
tab (\011), newline (\012) and backslash (\134) in those files when
they occur in one of the four strings in a mntent structure. The rou-
tines addmntent() and getmntent() will convert from string representa-
tion to escaped representation and back.
RETURN VALUE
The getmntent() and getmntent_r() functions return a pointer to the
mntent structure or NULL on failure.
The addmntent() function returns 0 on success and 1 on failure.
The endmntent() function always returns 1.
The hasmntopt() function returns the address of the substring if a
match is found and NULL otherwise.
FILES
/etc/fstab file system description file
/etc/mtab mounted file system description file
CONFORMING TO
The non-reentrant functions are from SunOS 4.1.3. A routine getmn-
tent_r() was introduced in HP-UX 10, but it returns an int. The proto-
type shown above is glibc-only.
NOTES
System V also has a getmntent() function but the calling sequence dif-
fers, and the returned structure is different. Under System V
/etc/mnttab is used. 4.4BSD and Digital Unix have a routine getm-
ntinfo(), a wrapper around the system call getfsstat().
SEE ALSO
fopen(3), fstab(5), mount(8)
COLOPHON
This page is part of release 3.22 of the Linux man-pages project. A
description of the project, and information about reporting bugs, can
be found at http://www.kernel.org/doc/man-pages/.
2008-06-16 GETMNTENT(3)