release/man2/inotify_init.2

   1 .\" man2/inotify_init.2 - inotify_init man page
   2 .\"
   3 .\" Copyright (C) 2005 Robert Love
   4 .\"
   5 .\" This is free documentation; you can redistribute it and/or
   6 .\" modify it under the terms of the GNU General Public License as
   7 .\" published by the Free Software Foundation; either version 2 of
   8 .\" the License, or (at your option) any later version.
   9 .\"
  10 .\" The GNU General Public License's references to "object code"
  11 .\" and "executables" are to be interpreted as the output of any
  12 .\" document formatting or typesetting system, including
  13 .\" intermediate and printed output.
  14 .\"
  15 .\" This manual is distributed in the hope that it will be useful,
  16 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 .\" GNU General Public License for more details.
  19 .\"
  20 .\" You should have received a copy of the GNU General Public
  21 .\" License along with this manual; if not, write to the Free
  22 .\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
  23 .\" USA.
  24 .\"
  25 .\" 2005-07-19 Robert Love <rlove@rlove.org> - initial version
  26 .\" 2006-02-07 mtk, minor changes
  27 .\" 2008-10-10 mtk: add description of inotify_init1()
  28 .\"
  29 .\" Japanese Version Copyright (c) 2006 Akihiro MOTOKI
  30 .\"         all rights reserved.
  31 .\" Translated 2006-08-15, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v2.39
  32 .\" Updated 2008-11-10, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>, LDP v3.12
  33 .\"
  34 .TH INOTIFY_INIT 2 2008-10-10 "Linux" "Linux Programmer's Manual"
  35 .SH 名前
  36 inotify_init, inotify_init1 \- inotify インスタンスを初期化する
  37 .SH 書式
  38 .nf
  39 .B #include <sys/inotify.h>
  40 .sp
  41 .B "int inotify_init(void);"
  42 .BI "int inotify_init1(int " flags );
  43 .fi
  44 .SH 説明
  45 .BR inotify_init ()
  46 は、新規の inotify インスタンスを初期化し、作成された inotify イベントキュー
  47 に対応するファイルディスクリプタを返す。
  48
  49 .BR inotify_init1 ()
  50 は、
  51 .I flags
  52 が 0 の場合、
  53 .BR inotify_init ()
  54 と同じである。
  55 .I flags
  56 に以下の値をビット毎の論理和 (OR) で指定することで、
  57 異なる動作をさせることができる。
  58 .TP 12
  59 .B IN_NONBLOCK
  60 新しく生成されるオープンファイル記述 (open file description) の
  61 BR O_NONBLOCK
  62 ファイルステータスフラグをセットする。
  63 このフラグを使うことで、
  64 .B O_NONBLOCK
  65 をセットするために
  66 .BR fcntl (2)
  67 を追加で呼び出す必要がなくなる。
  68 .TP
  69 .B IN_CLOEXEC
  70 新しいファイル・ディスクリプターに対して
  71 close-on-exec
  72 .RB ( FD_CLOEXEC )
  73 フラグをセットする。
  74 このフラグが役に立つ理由については、
  75 .BR open (2)
  76 の
  77 .B O_CLOEXEC
  78 フラグの説明を参照のこと。
  79 .SH 返り値
  80 成功すると、これらのシステムコールは新しいファイルディスクリプタを返す。
  81 エラーの場合、\-1 を返し、
  82 .I errno
  83 をエラーを示す値に設定する。
  84 .SH エラー
  85 .TP
  86 .B EINVAL
  87 .RB ( inotify_init1 ())
  88 無効な値が
  89 .I flags
  90 に指定された。
  91 .TP
  92 .B EMFILE
  93 inotify インスタンスの総数がユーザ単位の上限に達していた。
  94 .TP
  95 .B ENFILE
  96 inotify インスタンスの総数がシステムの上限に達していた。
  97 .TP
  98 .B ENOMEM
  99 カーネルメモリが十分になかった。
 100 .SH バージョン
 101 .BR inotify_init ()
 102 は Linux 2.6.13 で初めて登場した。
 103 .BR inotify_init1 ()
 104 は Linux 2.6.27 で追加された。
 105 .SH 準拠
 106 これらのシステムコールは Linux 独自である。
 107 .SH 関連項目
 108 .BR inotify_add_watch (2),
 109 .BR inotify_rm_watch (2),
 110 .BR inotify (7)