draft/man3/glob.3

   1 .\" Copyright (c) 1993 by Thomas Koenig (ig25@rz.uni-karlsruhe.de)
   2 .\"
   3 .\" Permission is granted to make and distribute verbatim copies of this
   4 .\" manual provided the copyright notice and this permission notice are
   5 .\" preserved on all copies.
   6 .\"
   7 .\" Permission is granted to copy and distribute modified versions of this
   8 .\" manual under the conditions for verbatim copying, provided that the
   9 .\" entire resulting derived work is distributed under the terms of a
  10 .\" permission notice identical to this one.
  11 .\"
  12 .\" Since the Linux kernel and libraries are constantly changing, this
  13 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  14 .\" responsibility for errors or omissions, or for damages resulting from
  15 .\" the use of the information contained herein.  The author(s) may not
  16 .\" have taken the same level of care in the production of this manual,
  17 .\" which is licensed free of charge, as they might when working
  18 .\" professionally.
  19 .\"
  20 .\" Formatted or processed versions of this manual, if unaccompanied by
  21 .\" the source, must acknowledge the copyright and authors of this work.
  22 .\" License.
  23 .\" Modified Wed Jul 28 11:12:17 1993 by Rik Faith (faith@cs.unc.edu)
  24 .\" Modified Mon May 13 23:08:50 1996 by Martin Schulze (joey@linux.de)
  25 .\" Modified 11 May 1998 by Joseph S. Myers (jsm28@cam.ac.uk)
  26 .\" Modified 990912 by aeb
  27 .\" 2007-10-10 mtk
  28 .\"     Added description of GLOB_TILDE_NOMATCH
  29 .\"     Expanded the description of various flags
  30 .\"     Various wording fixes.
  31 .\"
  32 .\"*******************************************************************
  33 .\"
  34 .\" This file was generated with po4a. Translate the source file.
  35 .\"
  36 .\"*******************************************************************
  37 .TH GLOB 3 2007\-10\-10 GNU "Linux Programmer's Manual"
  38 .SH 名前
  39 glob, globfree \- パターンにマッチするパス名を見付ける。glob() によっ て確保されたメモリ領域を解放する。
  40 .SH 書式
  41 .nf
  42 \fB#include <glob.h>\fP
  43 .sp
  44 \fBint glob(const char *\fP\fIpattern\fP\fB, int \fP\fIflags\fP\fB,\fP
  45 .br
  46 \fB         int (*\fP\fIerrfunc\fP\fB) (const char *\fP\fIepath\fP\fB, int \fP\fIeerrno\fP\fB),\fP
  47 .br
  48 \fB         glob_t *\fP\fIpglob\fP\fB);\fP
  49 .br
  50 \fBvoid globfree(glob_t *\fP\fIpglob\fP\fB);\fP
  51 .fi
  52 .SH 説明
  53 \fBglob\fP()  関数はシェルが用いているルール (\fBglob\fP(7)  参照) に基づいてパターン \fIpattern\fP
  54 にマッチするすべてのパス名を検索する。 チルダ (~) の展開やパラメータ置換は行われない。それらを行いたい場合は \fBwordexp\fP(3)
  55 を使うとよい。
  56 .PP
  57 \fBglobfree\fP()  関数は前に呼ばれた \fBglob\fP()  により動的に確保された記憶領域を解放する。
  58 .PP
  59 \fBglob\fP()  の結果は \fIpglob\fP がポイントする構造体に返される。 \fIpglob\fP は \fIglob_t\fP 型の構造体である。
  60 \fIglob_t\fP 型は \fI<glob.h>\fP 内で宣言されており、以下の要素を含んでいる。これらの要素は POSIX.2 で定義
  61 されている (さらに多くの要素が拡張として入っているかもしれない)。
  62 .PP
  63 .br
  64 .in +4n
  65 .nf
  66 typedef struct {
  67     size_t   gl_pathc;    /* 今までにマッチしたパスの数 */
  68     char   **gl_pathv;    /* マッチしたパス名のリスト */
  69     size_t   gl_offs;     /* \fIgl_pathv\fP 内に確保するスロット数 */
  70 } glob_t;
  71 .fi
  72 .in
  73 .PP
  74 結果は動的に確保された記憶領域に入れられる。
  75 .PP
  76 パラメータ \fIflags\fP には以下の示す定数のうち、指定したいものをビットごとの OR で与える (一つも 指定しなくてもよい)。これによって
  77 \fBglob\fP()  の動作を変更できる。
  78 .TP
  79 \fBGLOB_ERR\fP
  80 (例えば、ディレクトリに読み取り許可属性が無い場合などで)  読み取りエラーが発生した際に関数から戻る。 デフォルトでは、エラーに関わらず
  81 読み取り可能なディレクトリを全てについて読み取りを実行しようとする。
  82 .TP
  83 \fBGLOB_MARK\fP
  84 ディレクトリに対応する各々のパスにスラッシュを付加する。
  85 .TP
  86 \fBGLOB_NOSORT\fP
  87 返されるパス名のソートを行わない。 ソートを行わない理由は、処理時間を節約するためだけである。 デフォルトでは、返されるパス名はソートされる。
  88 .TP
  89 \fBGLOB_DOOFFS\fP
  90 \fIpglob\->pathv\fP の文字列リストの先頭に \fIpglob\->gl_offs\fP スロット分の領域を予約する。
  91 予約されたスロットには NULL ポインタが入る。
  92 .TP
  93 \fBGLOB_NOCHECK\fP
  94 マッチするパターンがなければ、元のパターンを返す。 デフォルトでは、 \fBglob\fP()  はマッチするパターンがなければ
  95 \fBGLOB_NOMATCH\fP を返す。
  96 .TP
  97 \fBGLOB_APPEND\fP
  98 この呼び出しでの結果を直前の \fBglob\fP()  の呼び出しで返された結果のベクトルに追加する。最初の \fBglob\fP()
  99 の呼び出しの際にはこのフラグを設定してはいけない。
 100 .TP
 101 \fBGLOB_NOESCAPE\fP
 102 バックスラッシュ (\(aq\e\(aq) をエスケープ用文字として使用できない。 通常は、バックスラッシュを使って、次に続く文字をクォートすることで、
 103 特別な意味を持つメタキャラクタを無効することができる。
 104 .PP
 105 \fIflags\fP には以下に示すものも指定できる。 これらは GNU で拡張されたもので、POSIX.2 では定義されていない。
 106 .TP
 107 \fBGLOB_PERIOD\fP
 108 先頭のピリオドがメタキャラクタにマッチできるようにする。 デフォルトでは、メタキャラクタは先頭のピリオドにはマッチできない。
 109 .TP
 110 \fBGLOB_ALTDIRFUNC\fP
 111 ファイルシステムにアクセスする際に、通常のライブラリ関数の代わりに 代替関数 \fIpglob\->gl_closedir\fP,
 112 \fIpglob\->gl_readdir\fP, \fIpglob\->gl_opendir\fP, \fIpglob\->gl_lstat\fP,
 113 \fIpglob\->gl_stat\fP が用いられる。
 114 .TP
 115 \fBGLOB_BRACE\fP
 116 \fB{a,b}\fP という形式の \fBcsh\fP(1)  スタイルの括弧表現を展開する。 括弧表現は入れ子にすることができる。
 117 したがって、例えば、"{foo/{,cat,dog},bar}" というパターンを 指定した場合に得られる結果は、 4つの文字列 "foo/",
 118 "foo/cat", "foo/dog", "bar" のそれぞれについて \fBglob\fP()  を呼び出した場合と同じになる。
 119 .TP
 120 \fBGLOB_NOMAGIC\fP
 121 パターンにメタキャラクタが含まれていない場合、 マッチ結果として指定されたパターンだけを返す。
 122 パターンで指定された名前のファイルが存在しない場合であっても、 そのパターンが返される。
 123 .TP
 124 \fBGLOB_TILDE\fP
 125 チルダの展開を行う。 チルダ (\(aq~\(aq) がパターン内の唯一の文字の場合か、先頭のチルダの直後の文字が スラッシュ (\(aq/\(aq)
 126 の場合、チルダを呼び出し者のホームディレクトリで置換する。 先頭のチルダにユーザ名が続く場合 (例えば "~andrea/bin")、
 127 チルダとユーザ名をそのユーザのホームディレクトリで置換する。 ユーザ名が無効な場合やホームディレクトリが決定できない場合は、 置換は実行されない。
 128 .TP
 129 \fBGLOB_TILDE_CHECK\fP
 130 このフラグを指定すると \fBGLOB_TILDE\fP と同様の振舞いをする。 \fBGLOB_TILDE\fP との違いは、ユーザ名が無効だった場合や
 131 ホームディレクトリが決定できなかった場合に、 パターン自身を使用するのではなく、 \fBglob\fP()  がエラーを示す \fBGLOB_NOMATCH\fP
 132 を返すことである。
 133 .TP
 134 \fBGLOB_ONLYDIR\fP
 135 このフラグは、 \fBglob\fP()  に対する「ヒント」であり、 呼び出し側がパターンにマッチするディレクトリにしか興味がないことを知らせる。
 136 実装においてファイルの種別情報を簡単に決定できる場合は、ディレクトリでない ファイルは呼び出し側に返されない。しかしながら、呼び出し側では、返された
 137 ファイルリストがディレクトリかどうかを確認しなければならない。 (このフラグが存在するのは、呼び出し側がディレクトリにしか興味がない際に
 138 性能を最適化する目的のためだけである。)
 139 .PP
 140 \fIerrfunc\fP が NULL でなければ、 エラーが起こった場合には関数 \fIerrfunc\fP が呼び出される。関数の引数には、失敗したパス名
 141 \fIepath\fP と \fIerrno\fP (\fBopendir\fP(3), \fBreaddir\fP(3), \fBstat\fP(2).
 142 のいずれかによってセットされた値) が与えられる。 \fIerrfunc\fP が 0 以外の値を返すかもしくは \fBGLOB_ERR\fP がセットされた場合
 143 \fBglob\fP()  は \fIerrfunc\fP の呼び出し後に終了する。
 144 .PP
 145 呼び出しが成功して戻った場合 \fIpglob\->gl_pathc\fP にはマッチしたパス名が含まれ、 \fIpglob\->gl_pathv\fP
 146 はマッチしたパス名へのポインタのリストへのポインタとなる。 ポインタのリストは NULL ポインタで終端される。
 147 .PP
 148 \fBglob\fP()  を何度か続けて呼び出すことができる。その際2回目以降の呼び出しでは \fBGLOB_APPEND\fP フラグが \fIflags\fP
 149 に設定されていなければならない。
 150 .PP
 151 GNU の拡張として、 \fIpglob\->gl_flags\fP には指定したフラグがセットされる。もし一つでもメタキャラクタが見付かれば
 152 このフラグと \fBGLOB_MAGCHAR\fP との \fBOR\fP を取った結果がセットされる。
 153 .SH 返り値
 154 呼び出しが成功して完了すると \fBglob\fP()  は 0 を返す。 それ以外の返り値は以下の通り:
 155 .TP
 156 \fBGLOB_NOSPACE\fP
 157 メモリを使い果たした
 158 .TP
 159 \fBGLOB_ABORTED\fP
 160 読み取りエラー
 161 .TP
 162 \fBGLOB_NOMATCH\fP
 163 一つもマッチしなかった
 164 .SH 準拠
 165 POSIX.2, POSIX.1\-2001.
 166 .SH 注意
 167 glibc 2.1 では、 \fIgl_pathc\fP と \fIgl_offs\fP は POSIX.2 で指定されているように \fIsize_t\fP
 168 として宣言されている。 libc4, libc5, glibc 2.0 では、 \fIint\fP として宣言されている。
 169 .SH バグ
 170 \fBglob\fP()  関数はその中で呼び出している \fBmalloc\fP(3)  や \fBopendir\fP(3)
 171 などの関数の呼び出しで失敗が起こると失敗する。 これにより \fIerrno\fP にそのエラーコードが入る。
 172 .SH 例
 173 使用法の一例を以下に示す。以下はシェルで
 174 .sp
 175 .in +4n
 176 ls \-l *.c ../*.c
 177 .in
 178 .sp
 179 をタイプした場合をシミュレートしている。
 180 .nf
 181 .in +4n
 182
 183 glob_t globbuf;
 184
 185 globbuf.gl_offs = 2;
 186 glob("*.c", GLOB_DOOFFS, NULL, &globbuf);
 187 glob("../*.c", GLOB_DOOFFS | GLOB_APPEND, NULL, &globbuf);
 188 globbuf.gl_pathv[0] = "ls";
 189 globbuf.gl_pathv[1] = "\-l";
 190 execvp("ls", &globbuf.gl_pathv[0]);
 191 .in
 192 .fi
 193 .SH 関連項目
 194 \fBls\fP(1), \fBsh\fP(1), \fBstat\fP(2), \fBexec\fP(3), \fBfnmatch\fP(3), \fBmalloc\fP(3),
 195 \fBopendir\fP(3), \fBreaddir\fP(3), \fBwordexp\fP(3), \fBglob\fP(7)