getfsentのヘルプ・マニュアル
日本語 英語
getfsent --help
man getfsent
GETFSENT(3) Linux Programmer’s Manual GETFSENT(3)
名前
getfsent, getfsspec, getfsfile, setfsent, endfsent - fstab エントリの処
理
書式
#include
void endfsent(void);
struct fstab *getfsent(void);
struct fstab *getfsfile(const char *mount_point);
struct fstab *getfsspec(const char *special_file);
int setfsent(void);
説明
これらの関数は /etc/fstab ファイルから情報を読み込む。fstab 構造体は 次
のように定義されている。
struct fstab {
char *fs_spec; /* block device name */
char *fs_file; /* mount point */
char *fs_vfstype; /* file-system 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 */
};
*BSD システムの場合、 fs_type フィールドには、5 つの文字列 "rw", "rq",
"ro", "sw", "xx" のいずれかが入る (それぞれ read-write, quota 付 き
read-write, read-only, swap, ignore)。
関数 setfsent() は呼び出されると fstab ファイルをオープンし、最初の行に
移動する。
関数 getfsent() は fstab ファイルから次の行をパースする (必要な場合はフ
ァイルをオープンする)。
関数 endfsent() は呼び出されると fstab ファイルをクローズする。
関数 getfsspec() は fstab ファイルを先頭から検索し、 fs_spec フィールド
が special_file 引数にマッチするエントリが見つかったら、その最初のも の
を返す。
関数 getfsfile() は fstab ファイルを先頭から検索し、 fs_file フィールド
が mount_point 引数にマッチするエントリが見つかったら、その最初のものを
返す。
返り値
成功すると、 getfsent(), getfsfile(), getfsspec() の各関数は fstab 構造
体へのポインタを返し、 setfsent() 関数は 1 を返す。失敗するとこれらの関
数は NULL を返し、 end-of-file になったら 0 を返す。
準拠
POSIX.1-2001 にはこれらの関数は存在しない。これらの関数をもつ OS はいく
つかあり、 *BSD, SunOS, Digital Unix, AIX 等である (AIX に は getf-
stype() もある)。 HP-UX にも同名の関数群があるが、 HP-UX のものは fstab
構造体ではなく checklist 構造体を用いる。またこれらの関数の呼び出 し は
obsolete で、 getmntent(3) に取って代わられている。
注意
これらの関数はスレッドセーフではない。
Linux ではブロックスペシャルデバイスを複数の場所にマウントでき、また複
数のデバイスが同じマウントポイントを共有できる (この場合はそのマウン ト
ポイントに最後にマウントされたデバイスが意味を持つ) が、 getfsfile() と
getfsspec() はマッチした最初のエントリしか返さないので、これらの 2 つの
関数は Linux での利用には適していない。
関連項目
getmntent(3), fstab(5)
Linux 2002-02-28 GETFSENT(3)
GETFSENT(3) Linux Programmer’s Manual GETFSENT(3)
NAME
getfsent, getfsspec, getfsfile, setfsent, endfsent - handle fstab
entries
SYNOPSIS
#include
void endfsent(void);
struct fstab *getfsent(void);
struct fstab *getfsfile(const char *mount_point);
struct fstab *getfsspec(const char *special_file);
int setfsent(void);
DESCRIPTION
These functions read from the file /etc/fstab. The struct fstab is
defined by:
struct fstab {
char *fs_spec; /* block device name */
char *fs_file; /* mount point */
char *fs_vfstype; /* file-sysem 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 */
};
Here the field 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 setfsent() opens the file when required and positions it
at the first line.
The function getfsent() parses the next line from the file. (After
opening it when required.)
The function endfsent() closes the file when required.
The function getfsspec() searches the file from the start and returns
the first entry found for which the fs_spec field matches the spe-
cial_file argument.
The function getfsfile() searches the file from the start and returns
the first entry found for which the fs_file field matches the
mount_point argument.
RETURN VALUE
Upon success, the functions getfsent(), getfsfile(), and getfsspec()
return a pointer to a struct fstab, while setfsent() returns 1. Upon
failure or end-of-file, these functions return NULL and 0, respec-
tively.
CONFORMING TO
These functions are not in POSIX.1-2001. Several operating systems
have them, e.g., *BSD, SunOS, Digital Unix, AIX (which also has a getf-
stype()). HP-UX has functions of the same names, that however use a
struct checklist instead of a struct fstab, and calls these functions
obsolete, superseded by getmntent(3).
NOTES
These functions are not thread-safe.
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 getfs-
file() and getfsspec() only return the first occurrence, these two
functions are not suitable for use under Linux.
SEE ALSO
getmntent(3), fstab(5)
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/.
GNU 2002-02-28 GETFSENT(3)