draft/man3/wordexp.3

   1 .\" Copyright (c) 2003 Andries Brouwer (aeb@cwi.nl)
   2 .\"
   3 .\" This is free documentation; you can redistribute it and/or
   4 .\" modify it under the terms of the GNU General Public License as
   5 .\" published by the Free Software Foundation; either version 2 of
   6 .\" the License, or (at your option) any later version.
   7 .\"
   8 .\" The GNU General Public License's references to "object code"
   9 .\" and "executables" are to be interpreted as the output of any
  10 .\" document formatting or typesetting system, including
  11 .\" intermediate and printed output.
  12 .\"
  13 .\" This manual is distributed in the hope that it will be useful,
  14 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 .\" GNU General Public License for more details.
  17 .\"
  18 .\" You should have received a copy of the GNU General Public
  19 .\" License along with this manual; if not, write to the Free
  20 .\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
  21 .\" USA.
  22 .\"
  23 .\"*******************************************************************
  24 .\"
  25 .\" This file was generated with po4a. Translate the source file.
  26 .\"
  27 .\"*******************************************************************
  28 .TH WORDEXP 3 2008\-07\-14 "" "Linux Programmer's Manual"
  29 .SH 名前
  30 wordexp, wordfree \- posix シェルのように単語の展開を行う
  31 .SH 書式
  32 \fB#include <wordexp.h>\fP
  33 .sp
  34 \fBint wordexp(const char *\fP\fIs\fP\fB, wordexp_t *\fP\fIp\fP\fB, int \fP\fIflags\fP\fB);\fP
  35 .sp
  36 \fBvoid wordfree(wordexp_t *\fP\fIp\fP\fB);\fP
  37 .sp
  38 .in -4n
  39 glibc 向けの機能検査マクロの要件 (\fBfeature_test_macros\fP(7)  参照):
  40 .in
  41 .sp
  42 \fBwordexp\fP(), \fBwordfree\fP(): _XOPEN_SOURCE
  43 .SH 説明
  44 関数 \fBwordexp\fP()  はシェルのように文字列 \fIs\fP を展開し、 \fIp\fP で指し示す構造体に結果を返す。 データ型
  45 \fIwordexp_t\fP は少なくともフィールド \fIwe_wordc\fP, \fIwe_wordv\fP, \fIwe_offs\fP を持つ構造体である。
  46 フィールド \fIwe_wordc\fP は \fIsize_t\fP であり、 \fIs\fP を展開した結果に単語がいくつあるかを表す。 フィールド
  47 \fIwe_wordv\fP は \fIchar **\fP であり、見つかった単語の配列を指し示す。 \fIsize_t\fP 型のフィールド \fIwe_offs\fP
  48 は、 \fIwe_wordv\fP 配列にある初期要素のうちいくつが NULL で埋められるべきかを表すのに使われたりする (\fIflags\fP
  49 により決定される。下記を参照。)。
  50 .LP
  51 関数 \fBwordfree\fP()  は割り当てたメモリを再度解放する。 より正確にいうと、この関数はその引き数を解放するのではなく、 配列
  52 \fIwe_wordv\fP とそれが指し示す文字列を解放する。
  53 .SS 文字列引き数
  54 この展開はシェルによるコマンドのパラメータの展開 (\fBsh\fP(1)  を参照) と同じであるので、文字列 \fIs\fP
  55 はシェルコマンドパラメータで不正とされる文字を含んではならない。 特にエスケープされていない改行、|, &, ;, <, >, (,
  56 ), {, } 文字を コマンド置換やパラメータ置換の場面以外に含めてはならない。
  57 .LP
  58 引き数 \fIs\fP にクォートしていないコメント文字 # で始まる単語が含まれている場合には、 その単語とそれ以降の単語が無視されるか、 それとも #
  59 がコメント文字として扱わないかは、規定されていない。
  60 .SS 展開
  61 実行される展開は、以下の段階で構成される: チルダ展開 (~user を user のホームディレクトリに置き換える)、 変数展開 ($FOO
  62 を環境変数 FOO の値に置き換える)、 コマンド展開 ($(command) または \`command\` を command
  63 の出力で置き換える)、 算術展開、フィールド分割、ワイルドカード展開、クォートの除去。
  64 .LP
  65 特殊なパラメータ ($@, $*, $#, $?, $\-, $$, $!, $0) の 展開結果は規定されていない。
  66 .LP
  67 フィールド分割は環境変数 $IFS を用いて行われる。 この環境変数が設定されていない場合、 フィールド区切り文字はスペース・タブ・改行である。
  68 .SS 出力される配列
  69 配列 \fIwe_wordv\fP は見つかった単語をを含み、最後に NULL が続く。
  70 .SS "flags 引き数"
  71 \fIflags\fP 引き数は以下の値のビット包含的 OR である:
  72 .TP
  73 \fBWRDE_APPEND\fP
  74 見つかった単語を前回の呼び出し結果の配列に追加する。
  75 .TP
  76 \fBWRDE_DOOFFS\fP
  77 初期状態である \fIwe_offs\fP 個の NULL を配列 \fIwe_wordv\fP に挿入する (これらは返される \fIwe_wordc\fP
  78 にはカウントされない)。
  79 .TP
  80 \fBWRDE_NOCMD\fP
  81 コマンド置換を行わない。
  82 .TP
  83 \fBWRDE_REUSE\fP
  84 引き数 \fIp\fP は前回の \fBwordexp\fP()  の呼び出し結果であり、 \fBwordfree\fP()  が (まだ) 呼び出されない。
  85 割り当てられた領域を再利用する。
  86 .TP
  87 \fBWRDE_SHOWERR\fP
  88 通常はコマンド置換のときに \fIstderr\fP が \fI/dev/null\fP にリダイレクトされる。 このフラグは \fIstderr\fP
  89 をリダイレクトしないように指定する。
  90 .TP
  91 \fBWRDE_UNDEF\fP
  92 未定義のシェル変数を展開しようとした場合に、エラーとして扱う。
  93 .SH 返り値
  94 成功した場合は 0 が返される。 エラーの場合は以下の 5 つの値のうちの 1 つが返される。
  95 .TP
  96 \fBWRDE_BADCHAR\fP
  97 改行または |, &, ;, <, >, (, ), {, } のうちの 1 つが不正に出現した。
  98 .TP
  99 \fBWRDE_BADVAL\fP
 100 未定義のシェル変数が参照され、かつ \fBWRDE_UNDEF\fP フラグでこれをエラーとして扱うように指示されている。
 101 .TP
 102 \fBWRDE_CMDSUB\fP
 103 コマンド置換が起こり、かつ \fBWRDE_NOCMD\fP フラグでこれをエラーとして扱うように指示されている。
 104 .TP
 105 \fBWRDE_NOSPACE\fP
 106 メモリが足りない。
 107 .TP
 108 \fBWRDE_SYNTAX\fP
 109 対応する括弧がない、クォートが合致しないといった、 シェルの書式エラー。
 110 .SH バージョン
 111 \fBwordexp\fP()  と \fBwordfree\fP()  は、バージョン 2.1 以降の glibc で提供されている。
 112 .SH 準拠
 113 POSIX.1\-2001.
 114 .SH 例
 115 以下のサンプルプログラムの出力はだいたい "ls [a\-c]*.c" と同じになる。
 116 .LP
 117 .nf
 118 #include <stdio.h>
 119 #include <stdlib.h>
 120 #include <wordexp.h>
 121
 122 int
 123 main(int argc, char **argv)
 124 {
 125     wordexp_t p;
 126     char **w;
 127     int i;
 128
 129     wordexp("[a\-c]*.c", &p, 0);
 130     w = p.we_wordv;
 131     for (i = 0; i < p.we_wordc; i++)
 132         printf("%s\en", w[i]);
 133     wordfree(&p);
 134     exit(EXIT_SUCCESS);
 135 }
 136 .fi
 137 .SH 関連項目
 138 \fBfnmatch\fP(3), \fBglob\fP(3)