release/man3/getopt.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 Sat Jul 24 19:27:50 1993 by Rik Faith (faith@cs.unc.edu)
  24 .\" Modified Mon Aug 30 22:02:34 1995 by Jim Van Zandt <jrv@vanzandt.mv.com>
  25 .\"  longindex is a pointer, has_arg can take 3 values, using consistent
  26 .\"  names for optstring and longindex, "\n" in formats fixed.  Documenting
  27 .\"  opterr and getopt_long_only.  Clarified explanations (borrowing heavily
  28 .\"  from the source code).
  29 .\" Modified 8 May 1998 by Joseph S. Myers (jsm28@cam.ac.uk)
  30 .\" Modified 990715, aeb: changed `EOF' into `-1' since that is what POSIX
  31 .\"  says; moreover, EOF is not defined in <unistd.h>.
  32 .\" Modified 2002-02-16, joey: added information about nonexistent
  33 .\"  option character and colon as first option character
  34 .\" Modified 2004-07-28, Michael Kerrisk <mtk.manpages@gmail.com>
  35 .\"     Added text to explain how to order both '[-+]' and ':' at
  36 .\"             the start of optstring
  37 .\" Modified 2006-12-15, mtk, Added getopt() example program.
  38 .\"
  39 .\"*******************************************************************
  40 .\"
  41 .\" This file was generated with po4a. Translate the source file.
  42 .\"
  43 .\"*******************************************************************
  44 .TH GETOPT 3 2010\-11\-01 GNU "Linux Programmer's Manual"
  45 .SH 名前
  46 getopt, getopt_long, getopt_long_only, optarg, optind, opterr, optopt \-
  47 コマンドラインオプションを解釈する
  48 .SH 書式
  49 .nf
  50 \fB#include <unistd.h>\fP
  51 .sp
  52 \fBint getopt(int \fP\fIargc\fP\fB, char * const \fP\fIargv[]\fP\fB,\fP
  53 \fB           const char *\fP\fIoptstring\fP\fB);\fP
  54 .sp
  55 \fBextern char *\fP\fIoptarg\fP\fB;\fP
  56 \fBextern int \fP\fIoptind\fP\fB, \fP\fIopterr\fP\fB, \fP\fIoptopt\fP\fB;\fP
  57 .sp
  58 \fB#include <getopt.h>\fP
  59 .sp
  60 \fBint getopt_long(int \fP\fIargc\fP\fB, char * const \fP\fIargv[]\fP\fB,\fP
  61 \fB           const char *\fP\fIoptstring\fP\fB,\fP
  62 \fB           const struct option *\fP\fIlongopts\fP\fB, int *\fP\fIlongindex\fP\fB);\fP
  63 .sp
  64 \fBint getopt_long_only(int \fP\fIargc\fP\fB, char * const \fP\fIargv[]\fP\fB,\fP
  65 \fB           const char *\fP\fIoptstring\fP\fB,\fP
  66 \fB           const struct option *\fP\fIlongopts\fP\fB, int *\fP\fIlongindex\fP\fB);\fP
  67 .fi
  68 .sp
  69 .in -4n
  70 glibc 向けの機能検査マクロの要件 (\fBfeature_test_macros\fP(7)  参照):
  71 .ad l
  72 .in
  73 .sp
  74 \fBgetopt\fP(): _POSIX_C_SOURCE\ >=\ 2 || _XOPEN_SOURCE
  75 .br
  76 \fBgetopt_long\fP(), \fBgetopt_long_only\fP(): _GNU_SOURCE
  77 .ad b
  78 .SH 説明
  79 \fBgetopt\fP()  関数はコマンドライン引き数を解釈する。 \fBgetopt\fP()  がとる引き数 \fIargc\fP と \fIargv\fP
  80 は、それぞれプログラムの起動時に \fImain\fP()  関数に渡された引き数の個数と配列である。 \fIargv\fP の要素のうち \(aq\-\(aq
  81 で始まるもの (かつ "\-" 単独や "\-\-" 単独ではないもの) は オプション要素 (option element) とみなされる。
  82 この要素から先頭の \(aq\-\(aq を除いた文字は オプション文字 (option character) とされる。 \fBgetopt\fP()
  83 は、繰り返し呼び出されるごとに、次のオプション文字を返す。
  84 .PP
  85 変数 \fIoptind\fP は、 \fIargv\fP の次に処理される要素のインデックスである。 システムによりこの変数の値は 1 に初期化される。
  86 呼び出し側でこの値を 1 にリセットすることで、同じ \fIargv\fP のスキャンをやり直したり、新しい引き数ベクトルをスキャンすることができる。
  87 .PP
  88 新たなオプション文字を見つけると、 \fBgetopt\fP()  はその文字を返し、 外部変数 \fIoptind\fP とスタティックな変数
  89 \fInextchar\fP を更新する。 これらによって、 \fBgetopt\fP()  は次回の呼び出しの際に、 以降のオプション文字や \fIargv\fP
  90 要素のスキャンを継続できる。
  91 .PP
  92 オプション文字がそれ以上見つからなくなると、 \fBgetopt\fP()  は \-1 を返す。そして \fIoptind\fP は、\fIargv\fP の要素のうち、
  93 オプションでない最初の要素を示すようになる。
  94 .PP
  95 \fIoptstring\fP は受け付けるオプション文字からなる文字列である。 文字のあとにコロン (:) が置かれている場合は、
  96 オプションには引き数が必要であることを示す。 このとき \fBgetopt\fP()  は、現在注目している \fIargv\fP
  97 要素で、オプション文字に引き続くテキストへのポインタか、 あるいは次の \fIargv\fP 要素のテキストへのポインタを \fIoptarg\fP に代入する。
  98 2 個連続してコロンが置かれている場合は、 そのオプションは引き数をとってもとらなくてもよい。 現在の \fIargv\fP 要素にテキストがあれば
  99 (つまり、"\-oarg" のように、オプション名自身と同じワード内に テキストがある場合)、それが \fIoptarg\fP に返される。 なければ
 100 \fIoptarg\fP は 0 に設定される。 これは GNU による拡張である。 \fIoptstring\fP に \fBW\fP
 101 とそれに続くセミコロンが入っていると、 \fB\-W foo\fP は長いオプション \fB\-\-foo\fP と同じように扱われる (POSIX.2 は \fB\-W\fP
 102 オプションを実装依存の拡張として予約している)。 この動作は GNU による拡張であり、glibc 2 以前のライブラリでは 利用できない。
 103 .PP
 104 デフォルトでは \fBgetopt\fP()  は \fIargv\fP をスキャンする際に順序を変更し、 オプション以外の要素を最後に移動する。 他にも 2
 105 つのモードが実装されている。 \fIoptstring\fP の先頭文字が \(aq+\(aq であるか、環境変数 \fBPOSIXLY_CORRECT\fP
 106 が設定されている場合には、オプションを対象とする動作は、 非オプションの引き数が現れた段階で終了する。 \fIoptstring\fP の先頭文字が
 107 \(aq\-\(aq である場合には、 オプションでない \fIargv\fP 要素は、 文字コード 1 のオプションであるかのように扱われる
 108 (これを用いるプログラムは、 オプションや \fIargv\fP 要素を任意の順序で受け入れ、かつそれらの順序が 意味を持つように書かれている必要がある)。
 109 "\-\-" は特殊な引き数で、スキャンのモードによらず、 オプションのスキャンを強制的に終了させる。
 110 .PP
 111 認識できないオプション文字があると、 \fBgetopt\fP()  はエラーメッセージを標準エラー出力 \fIstderr\fP に表示し、 その文字を
 112 \fIoptopt\fP に保存して \(aq?\(aq を返す。 呼び出したプログラムで \fIopterr\fP を 0 にしておけば、
 113 エラーメッセージの表示を抑制できる。
 114 .PP
 115 \fBgetopt\fP()  は \fIargv\fP の中に \fIoptstring\fP にないオプション文字を見つけた場合、
 116 またはオプション引き数が足りないことが分かった場合、 \&\(aq?\(aq を返して外部変数 \fIoptopt\fP をそのオプション文字に設定する。
 117 \fIoptstring\fP の (上で説明したオプションで指定できる \&\(aq+\(aq または \(aq\-\(aq 後に続く) 最初の文字が コロン
 118 (\(aq:\(aq) のとき、 \fBgetopt\fP()  はオプション引き数が足りない場合に \(aq?\(aq ではなく \(aq:\(aq
 119 を返す。 エラーを見つけた場合で、かつ \fIoptstring\fP の最初の文字がコロンでなく、 かつ外部変数 \fIopterr\fP が 0 でない場合
 120 (これがデフォルト)、 \fBgetopt\fP()  はエラーメッセージを表示する。
 121 .SS "getopt_long() と getopt_long_only()"
 122 \fBgetopt_long\fP()  関数は、長いオプション (2 つのダッシュ "\-\-" で始まるオプション) を 受け入れることを除いて
 123 \fBgetopt\fP()  と同じように動作する (プログラムに長いオプションだけが渡された場合、 \fIoptstring\fP は NULL
 124 ではなく空文字列 ("") となる)。 長いオプションの名前は、他と重ならない範囲において短縮できる。
 125 あるいは定義されたオプションに正確にマッチするものでも (当然) かまわない。 長いオプションは引き数を取ることができ、 \fB\-\-arg=param\fP
 126 または \fB\-\-arg param\fP と言う形式で指定する。
 127 .PP
 128 \fIlongopts\fP は \fIstruct option\fP の要素からなる配列の、先頭要素へのポインタである。 \fIstruct option\fP は
 129 \fI<getopt.h>\fP で以下のように定義されている。
 130 .in +4n
 131 .nf
 132 .sp
 133 struct option {
 134     const char *name;
 135     int         has_arg;
 136     int        *flag;
 137     int         val;
 138 };
 139 .fi
 140 .in
 141 .PP
 142 それぞれのフィールドの意味は以下の通り。
 143 .TP
 144 \fIname\fP
 145 長いオプションの名前。
 146 .TP
 147 \fIhas_arg\fP
 148 \fBno_argument\fP (または 0) なら、オプションは引き数をとらない。 \fBrequired_argument\fP (または 1)
 149 なら、オプションは引き数を必要とする。 \fBoptional_argument\fP (または 2) なら、オプションは引き数をとっても とらなくても良い。
 150 .TP
 151 \fIflag\fP
 152 長いオプションに対する結果の返し方を指定する。\fIflag\fP が NULL なら \fBgetopt_long\fP()  は \fIval\fP を返す
 153 (例えば呼び出し元のプログラムは、 \fIval\fP に等価なオプション文字を代入することができる)。 NULL 以外の場合には、
 154 \fBgetopt_long\fP()  は 0 を返す。 このときオプションが見つかると \fIflag\fP がポイントする変数に \fIval\fP
 155 が代入される。見つからないとこの変数は変更されない。
 156 .TP
 157 \fIval\fP
 158 返り値、または \fIflag\fP がポイントする変数へロードされる値。
 159 .PP
 160 配列の最後の要素は、全て 0 で埋められていなければならない。
 161 .PP
 162 \fIlongindex\fP は、NULL でなければ、 長いオプションのインデックスを \fIlongopts\fP
 163 からの相対位置として保持している変数へのポインタとなる。
 164 .PP
 165 \fBgetopt_long_only\fP()  は \fBgetopt_long\fP()  と同様の動作をするが、 \(aq\-\(aq も "\-\-"
 166 と同様に、 長いオプションとして扱われる。\(aq\-\(aq で始まる ("\-\-" 以外の) オプションが、長いものにはマッチしないが短いものに
 167 マッチする場合においては、それは短いオプションとして解釈される。
 168 .SH 返り値
 169 オプションが正常に見つかれば \fBgetopt\fP()  はそのオプション文字を返す。 すべてのコマンドラインオプションの解析が終わったら、
 170 \fBgetopt\fP()  は \-1 を返す。 \fIoptstring\fP に含まれないオプション文字が見つかると、\(aq?\(aq を返す。
 171 引き数が足りないオプションが見つかった場合、 返り値は \fIoptstring\fP の最初の文字による異なる: 最初の文字が \(aq:\(aq であれば
 172 \(aq:\(aq を返し、 それ以外の場合は \(aq?\(aq を返す。
 173 .PP
 174 \fBgetopt_long\fP()  と \fBgetopt_long_only\fP()  も、 短いオプション文字を認識した場合にはその文字を返す。
 175 長いオプションに対しては、 \fIflag\fP が NULL なら \fIval\fP を返し、 \fIflag\fP が NULL 以外なら 0 を返す。 エラーと
 176 \-1 の返り値は \fBgetopt\fP()  と同じである。 さらに \(aq?\(aq
 177 は、マッチが確定できない場合や余分なパラメーターがある場合にも返る。
 178 .SH 環境
 179 .TP
 180 \fBPOSIXLY_CORRECT\fP
 181 これが設定されていると、非オプションの引き数に到達した時点でオプション に対する操作が停止される。
 182 .TP
 183 \fB_<PID>_GNU_nonoption_argv_flags_\fP
 184 この変数は \fBbash\fP(1)  2.0 が glibc と通信するために用いられた。 どの引き数がワイルドカードを展開した結果で、
 185 したがってオプションとみなすべきでないかを知らせるものである。 この機能は \fBbash\fP(1)  のバージョン 2.01 で削除されたが、glibc
 186 にはまだ残っている。
 187 .SH 準拠
 188 .TP
 189 \fBgetopt\fP():
 190 環境変数 \fBPOSIXLY_CORRECT\fP が設定されている場合は POSIX.2 と POSIX.1\-2001 に準拠する。 他の場合は
 191 \fIargv\fP の要素は本当の意味での定数にはならない。 なぜなら順序が変更されてしまうからである。
 192 ただしそれらは、プロトタイプでは定数であるかのようにしてある。 これは他のシステムとの互換性のためである。
 193
 194 \fIoptstring\fP で \(aq+\(aq や \(aq\-\(aq を使うのは GNU による拡張である.
 195
 196 古い実装のいくつかでは、 \fBgetopt\fP()  は \fI<stdio.h>\fP で宣言されていた。 SUSv1 では、
 197 \fI<unistd.h>\fP か \fI<stdio.h>\fP のどちらかで 宣言してもよかった。 POSIX.1\-2001
 198 では、 \fBgetopt\fP の宣言を \fI<stdio.h>\fP で行うのは「過去の名残」であるとされた。 POSIX.1\-2001 では
 199 \fI<stdio.h>\fP で宣言を行うことを認めていない。
 200 .TP
 201 \fBgetopt_long\fP(), \fBgetopt_long_only\fP():
 202 これらの関数は GNU による拡張である。
 203 .SH 注意
 204 複数の引き数ベクトルをスキャンしたり、同じ引き数ベクトルを二回以上 スキャンするようなプログラムで、 \fIoptstring\fP の先頭で
 205 \(aq+\(aq や \(aq\-\(aq といった GNU による拡張機能を使用したり、 引き数ベクトルの切り替え時に
 206 \fBPOSIXLY_CORRECT\fP の値を変更したりする場合には、 \fIoptind\fP を伝統的な 1 ではなく 0 にリセットすることで
 207 \fBgetopt\fP()  を再初期化しなければならない (0 にリセットすることで、 \fBPOSIXLY_CORRECT\fP や \fIoptstring\fP
 208 の GNU 拡張機能のチェックを行う内部初期化ルーチンが起動される)。
 209 .SH バグ
 210 POSIX.2 における \fBgetopt\fP()  の仕様には技術的な問題があり、 その内容は POSIX.2 Interpretation 150
 211 に記されている。 GNU による実装では (おそらく他のすべての実装でも)、 仕様と異なる正しい動作をするように実装されている。
 212 .SH 例
 213 以下に示す簡単なサンプルプログラムでは、 二種類のプログラムオプションを扱うのに \fBgetopt\fP()  を使用している。一つは値を伴わない
 214 \fI\-n\fP で、もう一つは対応する値が必要な \fI\-t val\fP である。
 215 .nf
 216 .sp
 217 #include <unistd.h>
 218 #include <stdlib.h>
 219 #include <stdio.h>
 220
 221 int
 222 main(int argc, char *argv[])
 223 {
 224     int flags, opt;
 225     int nsecs, tfnd;
 226
 227     nsecs = 0;
 228     tfnd = 0;
 229     flags = 0;
 230     while ((opt = getopt(argc, argv, "nt:")) != \-1) {
 231         switch (opt) {
 232         case \(aqn\(aq:
 233             flags = 1;
 234             break;
 235         case \(aqt\(aq:
 236             nsecs = atoi(optarg);
 237             tfnd = 1;
 238             break;
 239         default: /* \(aq?\(aq */
 240             fprintf(stderr, "Usage: %s [\-t nsecs] [\-n] name\en",
 241                     argv[0]);
 242             exit(EXIT_FAILURE);
 243         }
 244     }
 245
 246     printf("flags=%d; tfnd=%d; optind=%d\en", flags, tfnd, optind);
 247
 248     if (optind >= argc) {
 249         fprintf(stderr, "Expected argument after options\en");
 250         exit(EXIT_FAILURE);
 251     }
 252
 253     printf("name argument = %s\en", argv[optind]);
 254
 255     /* Other code omitted */
 256
 257     exit(EXIT_SUCCESS);
 258 }
 259 .fi
 260 .PP
 261 以下は、 \fBgetopt_long\fP()  の使用法を、ほぼすべての機能について示したプログラムの例である。
 262 .nf
 263 .sp
 264 #include <stdio.h>     /* for printf */
 265 #include <stdlib.h>    /* for exit */
 266 #include <getopt.h>
 267
 268 int
 269 main(int argc, char **argv) {
 270     int c;
 271     int digit_optind = 0;
 272
 273     while (1) {
 274         int this_option_optind = optind ? optind : 1;
 275         int option_index = 0;
 276         static struct option long_options[] = {
 277             {"add",     required_argument, 0,  0 },
 278             {"append",  no_argument,       0,  0 },
 279             {"delete",  required_argument, 0,  0 },
 280             {"verbose", no_argument,       0,  0 },
 281             {"create",  required_argument, 0, \(aqc\(aq},
 282             {"file",    required_argument, 0,  0 },
 283             {0,         0,                 0,  0 }
 284         };
 285
 286         c = getopt_long(argc, argv, "abc:d:012",
 287                  long_options, &option_index);
 288         if (c == \-1)
 289             break;
 290
 291         switch (c) {
 292         case 0:
 293             printf("option %s", long_options[option_index].name);
 294             if (optarg)
 295                 printf(" with arg %s", optarg);
 296             printf("\en");
 297             break;
 298
 299         case \(aq0\(aq:
 300         case \(aq1\(aq:
 301         case \(aq2\(aq:
 302             if (digit_optind != 0 && digit_optind != this_option_optind)
 303               printf("digits occur in two different argv\-elements.\en");
 304             digit_optind = this_option_optind;
 305             printf("option %c\en", c);
 306             break;
 307
 308         case \(aqa\(aq:
 309             printf("option a\en");
 310             break;
 311
 312         case \(aqb\(aq:
 313             printf("option b\en");
 314             break;
 315
 316         case \(aqc\(aq:
 317             printf("option c with value \(aq%s\(aq\en", optarg);
 318             break;
 319
 320         case \(aqd\(aq:
 321             printf("option d with value \(aq%s\(aq\en", optarg);
 322             break;
 323
 324         case \(aq?\(aq:
 325             break;
 326
 327         default:
 328             printf("?? getopt returned character code 0%o ??\en", c);
 329         }
 330     }
 331
 332     if (optind < argc) {
 333         printf("non\-option ARGV\-elements: ");
 334         while (optind < argc)
 335             printf("%s ", argv[optind++]);
 336         printf("\en");
 337     }
 338
 339     exit(EXIT_SUCCESS);
 340 }
 341 .fi
 342 .SH 関連項目
 343 \fBgetsubopt\fP(3)