OSDN Git Service

(split) LDP: Update releases based on LDP 3.52 release
[linuxjm/LDP_man-pages.git] / release / man3 / getutent.3
index ec1a1aa..20a8c3b 100644 (file)
@@ -1,5 +1,6 @@
 .\" Copyright 1995 Mark D. Roth (roth@uiuc.edu)
 .\"
+.\" %%%LICENSE_START(GPLv2+_DOC_FULL)
 .\" This is free documentation; you can redistribute it and/or
 .\" modify it under the terms of the GNU General Public License as
 .\" published by the Free Software Foundation; either version 2 of
@@ -16,9 +17,9 @@
 .\" GNU General Public License for more details.
 .\"
 .\" You should have received a copy of the GNU General Public
-.\" License along with this manual; if not, write to the Free
-.\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
-.\" USA.
+.\" License along with this manual; if not, see
+.\" <http://www.gnu.org/licenses/>.
+.\" %%%LICENSE_END
 .\"
 .\" References consulted:
 .\"     Linux libc source code
 .\" Modified Thu Jul 25 14:43:46 MET DST 1996 by Michael Haardt
 .\"     <michael@cantor.informatik.rwth-aachen.de>
 .\"
-.\" Japanese Version Copyright (c) 1998 NAKANO Takeo all rights reserved.
-.\" Translated 1998-03-15, NAKANO Takeo <nakano@apm.seikei.ac.jp>
-.\" Updated 2001-10-16, Kentaro Shirakata <argrath@ub32.org>
-.\" Updated 2002-01-03, Kentaro Shirakata <argrath@ub32.org>
-.\" Updated 2005-03-18, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
-.\" Updated 2008-08-11, Akihiro MOTOKI, LDP v3.05
+.\"*******************************************************************
 .\"
-.TH GETUTENT 3 2008-06-29 "" "Linux Programmer's Manual"
+.\" This file was generated with po4a. Translate the source file.
+.\"
+.\"*******************************************************************
+.TH GETUTENT 3 2013\-04\-19 "" "Linux Programmer's Manual"
 .SH 名前
-getutent, getutid, getutline, pututline, setutent, endutent, utmpname \-
-utmp ファイルのエントリにアクセスする
+getutent, getutid, getutline, pututline, setutent, endutent, utmpname \- utmp
+ファイルのエントリにアクセスする
 .SH 書式
-.B #include <utmp.h>
+\fB#include <utmp.h>\fP
 .sp
-.B struct utmp *getutent(void);
+\fBstruct utmp *getutent(void);\fP
 .br
-.BI "struct utmp *getutid(struct utmp *" ut );
+\fBstruct utmp *getutid(struct utmp *\fP\fIut\fP\fB);\fP
 .br
-.BI "struct utmp *getutline(struct utmp *" ut );
+\fBstruct utmp *getutline(struct utmp *\fP\fIut\fP\fB);\fP
 .sp
-.BI "struct utmp *pututline(struct utmp *" ut );
+\fBstruct utmp *pututline(struct utmp *\fP\fIut\fP\fB);\fP
 .sp
-.B void setutent(void);
+\fBvoid setutent(void);\fP
 .br
-.B void endutent(void);
+\fBvoid endutent(void);\fP
 .sp
-.BI "int utmpname(const char *" file );
+\fBint utmpname(const char *\fP\fIfile\fP\fB);\fP
 .SH 説明
-新しいアプリケーションでは、これらの関数の "utmpx" 版を使用すべきである。
-これらは POSIX.1 で規定されている。「準拠」の節を参照。
+新しいアプリケーションでは、これらの関数の "utmpx" 版を使用すべきである。 これらは POSIX.1 で規定されている。「準拠」の節を参照。
 
-.BR utmpname ()
-は、他の utmp 関数がアクセスする (utmp フォーマットの)
-ファイルの名前を指定する。他の関数を使う前に
-.BR utmpname ()
-を使って
-ファイル名の指定を行わなかった場合は、 \fI<path.h>\fP で
-定義されている \fB_PATH_UTMP\fP がファイル名とみなされる。
+\fButmpname\fP()  は、他の utmp 関数がアクセスする (utmp フォーマットの)  ファイルの名前を指定する。他の関数を使う前に
+\fButmpname\fP()  を使って ファイル名の指定を行わなかった場合は、 \fI<path.h>\fP で 定義されている
+\fB_PATH_UTMP\fP がファイル名とみなされる。
 .PP
-.BR setutent ()
-は、ファイルポインタを utmp ファイルの先頭に移動する。
+\fBsetutent\fP()  は、ファイルポインタを utmp ファイルの先頭に移動する。
 一般的には、他の関数を使う前にこの関数を呼び出しておくと良いだろう。
 .PP
-.BR endutent ()
-は utmp ファイルをクローズする。ユーザーコードで
-他の関数を使ってこのファイルにアクセスを行った時は、最後にこの関数を
-呼び出すべきである。
+\fBendutent\fP()  は utmp ファイルをクローズする。ユーザーコードで
+他の関数を使ってこのファイルにアクセスを行った時は、最後にこの関数を 呼び出すべきである。
 .PP
-.BR getutent ()
-は utmp ファイルの現在のファイル位置から一行読み込み、
-行の各フィールドの内容を収めた構造体へのポインタを返す。
-この構造体の定義は
-.BR utmp (5)
-に書かれている。
+\fBgetutent\fP()  は utmp ファイルの現在のファイル位置から一行読み込み、 行の各フィールドの内容を収めた構造体へのポインタを返す。
+この構造体の定義は \fButmp\fP(5)  に書かれている。
 .PP
-.BR getutid ()
-は、 utmp ファイル中の現在の位置から順方向
-(末尾に向かう方向) へ \fIut\fP に基く検索を行う。 \fIut\fP\->ut_type が
-\fBRUN_LVL\fP, \fBBOOT_TIME\fP, \fBNEW_TIME\fP, \fBOLD_TIME\fP の
-いずれかなら、
-.BR getutid ()
-は \fBut_type\fP フィールドが
-\fIut\fP\->ut_type に一致する最初のエントリを探す。
-\fIut\fP\->ut_type が \fBINIT_PROCESS\fP, \fBLOGIN_PROCESS\fP,
-\fBUSER_PROCESS\fP, \fBDEAD_PROCESS\fP のいずれかなら、
-.BR getutid ()
-は
-.I ut_id
-フィールドが \fIut\fP\->ut_id に
-一致する最初のエントリを探す。
+\fBgetutid\fP()  は、 utmp ファイル中の現在の位置から順方向 (末尾に向かう方向) へ \fIut\fP に基く検索を行う。
+\fIut\fP\->ut_type が \fBRUN_LVL\fP, \fBBOOT_TIME\fP, \fBNEW_TIME\fP, \fBOLD_TIME\fP の
+いずれかなら、 \fBgetutid\fP()  は \fBut_type\fP フィールドが \fIut\fP\->ut_type
+に一致する最初のエントリを探す。 \fIut\fP\->ut_type が \fBINIT_PROCESS\fP, \fBLOGIN_PROCESS\fP,
+\fBUSER_PROCESS\fP, \fBDEAD_PROCESS\fP のいずれかなら、 \fBgetutid\fP()  は \fIut_id\fP フィールドが
+\fIut\fP\->ut_id に 一致する最初のエントリを探す。
 .PP
-.BR getutline ()
-は、 utmp ファイルの現在の位置から末尾に向かって検索を行う。
-.I ut_type
-が \fBUSER_PROCESS\fP または \fBLOGIN_PROCESS\fP で、
-.I ut_line
-フィールドが \fIut\fP->ut_line にマッチする最初の行を返す。
+\fBgetutline\fP()  は、 utmp ファイルの現在の位置から末尾に向かって検索を行う。 \fIut_type\fP が
+\fBUSER_PROCESS\fP または \fBLOGIN_PROCESS\fP で、 \fIut_line\fP フィールドが \fIut\fP\->ut_line
+にマッチする最初の行を返す。
 .PP
-.BR pututline ()
-は
-.I utmp
-構造体 \fIut\fP の内容を utmp ファイルに書き出す。
-.BR pututline ()
-は
-.BR getutid ()
-を用いて、新たなエントリを
-挿入するのにふさわしい場所を探す。 \fIut\fP を挿入するふさわしい場所が
+\fBpututline\fP()  は \fIutmp\fP 構造体 \fIut\fP の内容を utmp ファイルに書き出す。 \fBpututline\fP()  は
+\fBgetutid\fP()  を用いて、新たなエントリを 挿入するのにふさわしい場所を探す。 \fIut\fP を挿入するふさわしい場所が
 見つからない場合は、新たなエントリをファイルの末尾に追加する。
 .SH 返り値
-.BR getutent (),
-.BR getutid (),
-.BR getutline ()
-は、成功すると \fIstruct utmp\fP へのポインタを返す。
-失敗すると NULL を返す (レコードが見つからなかった場合も失敗となる)。
-この \fIstruct utmp\fP は静的な記憶領域に確保され、次にこれらの関数を
-呼び出した際に上書きされるかもしれない。
+\fBgetutent\fP(), \fBgetutid\fP(), \fBgetutline\fP()  は、成功すると \fIstruct utmp\fP
+へのポインタを返す。 失敗すると NULL を返す (レコードが見つからなかった場合も失敗となる)。 この \fIstruct utmp\fP
+は静的な記憶領域に確保され、次にこれらの関数を 呼び出した際に上書きされるかもしれない。
+
+\fBpututline\fP()  は成功すると \fIut\fP を返す。失敗すると NULL を返す。
 
-.BR pututline ()
-は成功すると
-.I ut
-を返す。失敗すると NULL を返す。
+\fButmpname\fP()  は、新しい名前の格納に成功すると 0 を返し、失敗すると \-1 を返す。
 
-.BR utmpname ()
-は、新しい名前の格納に成功すると 0 を返し、失敗すると \-1 を返す。
+In the event of an error, these functions \fIerrno\fP set to indicate the
+cause.
 .SH エラー
-.TP
-.B ENOMEM
+.TP 
+\fBENOMEM\fP
 メモリ不足。
-.TP
-.B ESRCH
+.TP 
+\fBESRCH\fP
 レコードが見つからなかった。
 .PP
-関数
-.BR setutent (),
-.BR pututline (),
-.BR getut* ()
-は
-.BR open (2)
+関数 \fBsetutent\fP(), \fBpututline\fP(), \fBgetut*\fP()  は \fBopen\fP(2)
 に書かれている理由でも失敗することがある。
 .SH ファイル
-/var/run/utmp     現在ログイン中のユーザーのデータベース
+/var/run/utmp 現在ログイン中のユーザーのデータベース
 .br
-/var/log/wtmp     過去のユーザーログインのデータベース
+/var/log/wtmp 過去のユーザーログインのデータベース
 .SH 準拠
 XPG2, SVr4.
 .LP
-XPG2 と SVID 2 では、
-.BR pututline ()
-関数は値を返さないとされており、
-(AIX, HP-UX, Linux libc5 などの) 多くのシステムではそうなっている。
-HP-UX では、上述の
-.BR pututline ()
-と同じプロトタイプを持つ
-新しい関数
-.BR _pututline ()
-が導入されている
-(この関数は Linux libc5 にもある)。
+XPG2 と SVID 2 では、 \fBpututline\fP()  関数は値を返さないとされており、 (AIX, HP\-UX, Linux libc5
+などの) 多くのシステムではそうなっている。 HP\-UX では、上述の \fBpututline\fP()  と同じプロトタイプを持つ 新しい関数
+\fB_pututline\fP()  が導入されている (この関数は Linux libc5 にもある)。
 .LP
-現在では、Linux 以外のシステムでは、これらの関数は全て廃止されている。
-SUSv1 の後に出てきた POSIX.1-2001 では、もはやこれらの関数はなく、
-代わりに以下のものを使う。
+現在では、Linux 以外のシステムでは、これらの関数は全て廃止されている。 SUSv1 の後に出てきた POSIX.1\-2001
+では、もはやこれらの関数はなく、 代わりに以下のものを使う。
 .sp
-.B #include <utmpx.h>
+\fB#include <utmpx.h>\fP
 .sp
-.B struct utmpx *getutxent(void);
+\fBstruct utmpx *getutxent(void);\fP
 .br
-.B struct utmpx *getutxid(const struct utmpx *);
+\fBstruct utmpx *getutxid(const struct utmpx *);\fP
 .br
-.B struct utmpx *getutxline(const struct utmpx *);
+\fBstruct utmpx *getutxline(const struct utmpx *);\fP
 .br
-.B struct utmpx *pututxline(const struct utmpx *);
+\fBstruct utmpx *pututxline(const struct utmpx *);\fP
 .br
-.B void setutxent(void);
+\fBvoid setutxent(void);\fP
 .br
-.B void endutxent(void);
+\fBvoid endutxent(void);\fP
 .PP
-これらの関数は glibc により提供されており、
-"x" がない関数と同じ処理を行うが、
-.I "struct utmpx"
-を使用する。
-Linux では、この構造体の定義は
-.I "struct utmp"
-と同じになっている。
-完全を期すために、glibc では
-.BR utmpxname ()
+これらの関数は glibc により提供されており、 "x" がない関数と同じ処理を行うが、 \fIstruct utmpx\fP を使用する。 Linux
+では、この構造体の定義は \fIstruct utmp\fP と同じになっている。 完全を期すために、glibc では \fButmpxname\fP()
 も提供している。この関数は POSIX.1 では規定されていない。
 .PP
-Linux 以外のシステムでは、
-\fIutmpx\fP 構造体は \fIutmp\fP 構造体の上位集合 (superset) になっていて、
-追加のフィールドがあったり、既存のフィールドのサイズが大きくなっていたり
-するものもある。複数のファイルが使用されている場合もあり、多くの場合
-.I /var/*/utmpx
-と
-.I /var/*/wtmpx
-というファイルが使われる。
+Linux 以外のシステムでは、 \fIutmpx\fP 構造体は \fIutmp\fP 構造体の上位集合 (superset) になっていて、
+追加のフィールドがあったり、既存のフィールドのサイズが大きくなっていたり するものもある。複数のファイルが使用されている場合もあり、多くの場合
+\fI/var/*/utmpx\fP と \fI/var/*/wtmpx\fP というファイルが使われる。
 .LP
 一方、 Linux glibc では複数の \fIutmpx\fP ファイル は使われていない。
 \fIutmp\fP 構造体が十分に大きいからである。
-\fIgetutxent\fP() などの関数は \fIgetutent\fP() などの別名となっている。
+上記の名前に "x" が付いた関数は "x" が付いていない対応する関数の別名と
+なっている (例えば \fIgetutxent\fP() は \fIgetutent\fP() の別名である)。
 .SH 注意
-.SS glibc での注意
-上記の関数群はスレッド・セーフではない。
-glibc にはリエントラント版 (reentrant) が追加されている。
+.SS "glibc での注意"
+上記の関数群はスレッド・セーフではない。 glibc にはリエントラント版 (reentrant) が追加されている。
 .sp
 .nf
-.BR "#define _GNU_SOURCE" "    /* or _SVID_SOURCE or _BSD_SOURCE;
-.RB "\&                          " feature_test_macros(7) " 参照 */"
-.B #include <utmp.h>
+\fB#define _GNU_SOURCE\fP    /* or _SVID_SOURCE or _BSD_SOURCE;
+\&                          \fBfeature_test_macros\fP(7) 参照 */
+\fB#include <utmp.h>\fP
 .sp
-.BI "int getutent_r(struct utmp *" ubuf ", struct utmp **" ubufp );
+\fBint getutent_r(struct utmp *\fP\fIubuf\fP\fB, struct utmp **\fP\fIubufp\fP\fB);\fP
 .sp
-.BI "int getutid_r(struct utmp *" ut ,
-.BI "              struct utmp *" ubuf ", struct utmp **" ubufp );
+\fBint getutid_r(struct utmp *\fP\fIut\fP\fB,\fP
+\fB              struct utmp *\fP\fIubuf\fP\fB, struct utmp **\fP\fIubufp\fP\fB);\fP
 .sp
-.BI "int getutline_r(struct utmp *" ut ,
-.BI "                struct utmp *" ubuf ", struct utmp **" ubufp );
+\fBint getutline_r(struct utmp *\fP\fIut\fP\fB,\fP
+\fB                struct utmp *\fP\fIubuf\fP\fB, struct utmp **\fP\fIubufp\fP\fB);\fP
 .fi
 .sp
-これらの関数は GNU での拡張であり、末尾の _r をとった名前の関数と
-同様の機能を持つ。
-.I ubuf
-パラメータは結果を格納する場所を指定する。
-成功すると 0 を返し、結果へのポインタを
-.I *ubufp
-に書き込む。エラーの場合 \-1 を返す。
-上記の関数に対応する utmpx 版は存在しない
-(POSIX.1 ではこれらの関数を規定されていない)。
+これらの関数は GNU での拡張であり、末尾の _r をとった名前の関数と 同様の機能を持つ。 \fIubuf\fP
+パラメータは結果を格納する場所を指定する。 成功すると 0 を返し、結果へのポインタを \fI*ubufp\fP に書き込む。エラーの場合 \-1 を返す。
+上記の関数に対応する utmpx 版は存在しない (POSIX.1 ではこれらの関数を規定されていない)。
 .SH 例
-以下の例では、 utmp のレコードの追加・削除を行っている。このコードは、
-擬似端末 (pseudo terminal) から実行されることを想定している。
-実際のアプリケーションでは
-.BR getpwuid (3)
-と
-.BR ttyname (3)
+以下の例では、 utmp のレコードの追加・削除を行っている。このコードは、 擬似端末 (pseudo terminal)
+から実行されることを想定している。 実際のアプリケーションでは \fBgetpwuid\fP(3)  と \fBttyname\fP(3)
 の戻り値を検査するべきである。
 .PP
 .nf
@@ -285,5 +212,8 @@ main(int argc, char *argv[])
 }
 .fi
 .SH 関連項目
-.BR getutmp (3),
-.BR utmp (5)
+\fBgetutmp\fP(3), \fButmp\fP(5)
+.SH この文書について
+この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.52 の一部
+である。プロジェクトの説明とバグ報告に関する情報は
+http://www.kernel.org/doc/man\-pages/ に書かれている。