Man page - getopt(1)

Packages contains this manual

Package:  util-linux
apt-get install util-linux

Manuals in package:
• getopt(1)
• x86_64(8)
• zramctl(8)
• findfs(8)
• blockdev(8)
• ipcmk(1)
• linux64(8)
• ldattach(8)
• findmnt(8)
• unshare(1)
• uclampset(1)
• partx(8)
• lscpu(1)
• flock(1)
• fallocate(1)
• setterm(1)
• terminal-colors.d(5)
• setsid(1)
• setarch(8)
• lsns(8)
• adjtime_config(5)
• chcpu(8)
• runuser(1)
• rtcwake(8)
• rev(1)
• lsipc(1)
• blkdiscard(8)
• nsenter(1)
• whereis(1)
• dmesg(1)
• fsck(8)
• blkid(8)
• ipcs(1)
• mcookie(1)
• lsblk(8)
• readprofile(8)
• switch_root(8)
• wdctl(8)
• mountpoint(1)
• lsmem(1)
• fsfreeze(8)
• i386(8)
• pivot_root(8)
• swaplabel(8)
• scols-filter(5)
• getty(8)
• chmem(8)
• chrt(1)
• agetty(8)
• blkzone(8)
• more(1)
• choom(1)
• mkswap(8)
• wipefs(8)
• taskset(1)
• lslocks(8)
• linux32(8)
• ionice(1)
• isosize(8)
• su(1)
• rename.ul(1)
• prlimit(1)
• namei(1)
• lslogins(1)
• ipcrm(1)
• fstrim(8)
• mkfs(8)
• hardlink(1)
• sulogin(8)
• setpriv(1)
Documentations in package:
• util-linux

Available languages:

en fr es pl ja uk ro sr de

Manual

GETOPT

名 前
書 式
説 明
オ プ シ ョ ン
構 文 解 析
出 力
ク ォ ー ト
ス キ ャ ニ ン グ モ ー ド
互 換 性
返 り 値
用 例
環 境 変 数
バ グ
作 者
関 連 項 目
入 手 方 法

---

名 前

getopt - コ マ ン ド の オ プ シ ョ ン を 解 析 す る (強 化 版 )

書 式

getopt optstring parameters
getopt [options] [ -- ] optstring parameters
getopt [options] -o | --options optstring [options] [ -- ] parameters

説 明

getopt は 、 コ マ ン ド ラ イ ン の オ プ シ ョ ン を 分 解 ( 構 文 解 析 ) し て 、 シ ェ ル 上 の 手 続 き に よ る 解 析 作 業 を 容 易 に し た り 、 オ プ シ ョ ン が 有 効 か ど う か を チ ェ ッ ク し た り す る た め に 使 用 す る 。 getopt は 、 そ う し た こ と を 行 う の に GNU getopt (3) の ル ー テ ィ ン を 使 っ て い る 。

getopt を 呼 び 出 す と き に 使 用 す る パ ラ メ ー タ は 、 2 つ の 部 分 に 分 け る こ と が で き る 。 す な わ ち 、 getopt が 解 析 を 行 う と き の 動 作 を 変 更 す る オ プ シ ョ ン 部 分 (上 記 「 書 式 」 の options と opstring ) と 、 解 析 の 対 象 に な る パ ラ メ ー タ 部 分 (上 記 「 書 式 」 の parameters ) の 2 つ で あ る 。 2 番 目 の 部 分 は 、 オ プ シ ョ ン で は な い 最 初 の パ ラ メ ー タ で 、 オ プ シ ョ ン の 引 き 数 で も な い も の か ら 始 ま る か 、 あ る い は 、 ’ -- ’ が 最 初 に 現 れ た 位 置 の 直 後 か ら 始 ま る 。 な お 、 1 番 目 の 部 分 に ’ -o ’ や ’ --options ’ オ プ シ ョ ン が 存 在 し な い 場 合 は (訳 注 : そ し て 、 他 の オ プ シ ョ ン や -- が 存 在 す る な ら ば 、 そ れ は 「 書 式 」 セ ク シ ョ ン の 第 2 の 書 式 に 当 た る )、 2 番 目 の 部 分 の 最 初 の パ ラ メ ー タ が 、 解 析 の 対 象 と な る シ ョ ー ト オ プ シ ョ ン を 1 つ に ま と め た シ ョ ー ト オ プ シ ョ ン ズ 文 字 列 (す な わ ち optsting ) と し て 使 用 さ れ る 。

[ 訳 注 ]

「 書 式 」 セ ク シ ョ ン の 第 3 の 書 式 で 、 解 析 の 対 象 に な る パ ラ メ ー タ を オ プ シ ョ ン か ら 始 め る と き は 、 そ の 前 に ’ -- ’ を 置 く 必 要 が あ る 。 そ う し な い と 、 getopt 自 体 の オ プ シ ョ ン と 誤 解 さ れ る こ と に な る 。 解 析 の 対 象 を フ ァ イ ル 名 な ど か ら 始 め る と き は 、 ’ -- ’ を 置 か な く て も よ い 。

環 境 変 数 GETOPT_COMPATIBLE が 設 定 さ れ て い る 場 合 や 、 最 初 の パ ラ メ ー タ が オ プ シ ョ ン で は な い 場 合 (す な わ ち 、 ’ - ’ で 始 ま っ て い な い 場 合 で 、 こ れ は 「 書 式 」 セ ク シ ョ ン の 第 1 の 書 式 で あ る )、 こ の getopt は 他 の バ ー ジ ョ ン の getopt (1) と 互 換 性 の あ る 出 力 を 生 成 す る 。 な お 、 そ の 場 合 で も や は り パ ラ メ ー タ の 並 べ 替 え は 行 う し 、 指 定 が 任 意 の 引 き 数 の 認 識 も す る (詳 細 に つ い て は 、 「 互 換 性 」 セ ク シ ョ ン を 参 照 し て い た だ き た い )。

従 来 の getopt (1) の 実 装 で は 、 引 き 数 な ど の オ プ シ ョ ン で は な い パ ラ メ ー タ の 中 に 、 ホ ワ イ ト ス ペ ー ス (訳 注 : 空 白 、 タ ブ 、 改 行 な ど ) や (シ ェ ル 固 有 の ) 特 殊 文 字 な ど が あ る と 、 そ れ に 対 処 す る こ と が で き な か っ た 。 こ の 問 題 を 解 決 す る た め に 、 こ の 実 装 で は 、 ク ォ ー ト し た 出 力 を 生 成 で き る よ う に な っ て い る が 、 そ う し た 出 力 は 、 シ ェ ル に よ っ て も う 一 度 解 釈 さ れ る 必 要 が あ る (た い て い は 、 そ の た め に eval コ マ ン ド を 使 用 す る 。 [訳 注 : も っ と 詳 し く 言 う と 、 PARAM=$(getopt -o ’a:b::c’ -- "$@"); eval set -- "$PARAM" と い っ た 方 法 を 用 い て 、 位 置 パ ラ メ ー タ を 再 構 成 す る ])。 こ の 出 力 形 式 を 使 え ば 、 ホ ワ イ ト ス ペ ー ス や 特 殊 文 字 を 保 護 す る こ と に は な る が 、 そ れ に は getopt を 他 の バ ー ジ ョ ン と も は や 互 換 性 の な い 形 で 呼 び 出 さ な け れ ば な ら な い (す な わ ち 、 「 書 式 」 セ ク シ ョ ン の 第 2 や 第 3 の 書 式 だ )。 御 使 用 の シ ス テ ム に getopt (1) の こ の 強 化 版 が イ ン ス ト ー ル さ れ て い る か ど う か を 知 る に は 、 専 用 の テ ス ト オ プ シ ョ ン ( -T ) を 使 用 す れ ば よ い 。

オ プ シ ョ ン

-a , --alternative

ロ ン グ オ プ シ ョ ン を 1 個 の ’ - ’ で 始 め る こ と が で き る よ う に す る 。

-h , --help

ヘ ル プ を 表 示 し て 、 終 了 す る 。 そ れ 以 上 何 も 出 力 し な い 。

-l , --longoptions longopts

認 識 す べ き ロ ン グ (複 数 の 文 字 か ら な る ) オ プ シ ョ ン 群 を 指 定 す る 。 2 個 以 上 の オ プ シ ョ ン 名 を 、 コ ン マ で 区 切 っ て 一 度 に 指 定 す る こ と が で き る 。 こ の オ プ シ ョ ン は 複 数 回 指 定 す る こ と も で き 、 そ の 場 合 も longopts が 追 加 さ れ て い く 。 longouts 中 の 各 ロ ン グ オ プ シ ョ ン 名 の 後 ろ に は 、 コ ロ ン を 続 け る こ と が で き る 。 コ ロ ン が 1 個 の と き は 、 引 き 数 が 必 須 だ と い う こ と で あ り 、 2 個 の と き は 、 引 き 数 は 任 意 、 す な わ ち 、 あ っ て も な く て も よ い と い う こ と で あ る 。

[ 訳 注 ]

ロ ン グ オ プ シ ョ ン の み を 使 い 、 シ ョ ー ト オ プ シ ョ ン を 全 く 使 わ な い 場 合 は 、 -o オ プ シ ョ ン に 空 文 字 列 を 渡 す こ と で ( -o ’’ ) そ れ を 明 示 的 に 宣 言 し な け れ ば な ら な い 。 「 バ グ 」 セ ク シ ョ ン を 参 照 。

-n , --name progname

getopt (3) ル ー テ ィ ン が 、 エ ラ ー を 通 知 す る 際 に 使 用 す る プ ロ グ ラ ム 名 を 指 定 す る 。 getopt (1) 自 体 に 関 す る エ ラ ー は (訳 注 : た と え ば 、 getopt コ マ ン ド の オ プ シ ョ ン が 間 違 っ て い る 場 合 な ど は )、 や は り getopt コ マ ン ド が エ ラ ー の 発 生 元 と し て 報 告 さ れ る こ と に 注 意 し て い た だ き た い 。

-o , --options shortopts

認 識 す べ き シ ョ ー ト (1 文 字 か ら な る ) オ プ シ ョ ン 群 を 指 定 す る 。 こ の オ プ シ ョ ン が 指 定 さ れ て い な い 場 合 は 、 ’ - ’ で 始 ま ら な い (そ し て 、 オ プ シ ョ ン の 引 数 で も な い ) getopt の 最 初 の パ ラ メ ー タ が 、 シ ョ ー ト オ プ シ ョ ン を 一 つ に ま と め た シ ョ ー ト オ プ シ ョ ン ズ 文 字 列 と し て 使 用 さ れ る (訳 注 : 「 書 式 」 セ ク シ ョ ン の 第 2 の 書 式 )。 shortopts 中 の シ ョ ー ト オ プ シ ョ ン 各 文 字 の 後 ろ に は 、 コ ロ ン を 続 け る こ と が で き る 。 コ ロ ン が 1 個 の と き は 、 引 き 数 が 必 須 だ と い う こ と で あ り 、 2 個 の と き は 、 引 き 数 は 任 意 、 す な わ ち 、 あ っ て も な く て も よ い と い う こ と で あ る 。 ま た 、 shortopts の 先 頭 に ’ + ’ や ’ - ’ と い う 文 字 を 付 け れ ば 、 オ プ シ ョ ン の 解 析 の 仕 方 や 、 出 力 の 生 成 の 仕 方 を 変 更 す る こ と が で き る (詳 細 に つ い て は 、 「 ス キ ャ ニ ン グ モ ー ド 」 セ ク シ ョ ン を 参 照 す る こ と )。

-q , --quiet

getopt(3) の 出 す エ ラ ー メ ッ セ ー ジ を 表 示 し な い 。

-Q , --quiet-output

通 常 の 出 力 を 生 成 し な い 。 そ れ で も 、 -q も 同 時 に 指 定 し な い か ぎ り 、 getopt (3) に よ る エ ラ ー 報 告 は 行 わ れ る 。

-s , --shell shell

ク ォ ー ト 方 式 を shell の も の に す る 。 -s オ プ シ ョ ン が 指 定 さ れ て い な い 場 合 は 、 BASH の ク ォ ー ト 方 式 が 使 わ れ る 。 指 定 可 能 な 引 き 数 は 、 現 在 の と こ ろ ’ sh ’, ’ bash ’, ’ csh ’, ’ tcsh ’ で あ る 。

-T , --test

現 在 使 っ て い る getopt (1) が 、 強 化 バ ー ジ ョ ン か 古 い バ ー ジ ョ ン か を テ ス ト す る 。 こ の オ プ シ ョ ン は 何 も 出 力 し な い が 、 エ ラ ー ス テ ー タ ス を 4 に す る 。 getopt(1) の 他 の 実 装 や 、 こ の バ ー ジ ョ ン で も 環 境 変 数 GETOPT_COMPATIBLE が 設 定 さ れ て い る 場 合 は 、 ’ -- ’ を 返 し て 、 エ ラ ー ス テ ー タ ス を 0 に す る 。

-u , --unquoted

出 力 を ク ォ ー ト し な い 。 こ の モ ー ド で は 、 ホ ワ イ ト ス ペ ー ス や (シ ェ ル に よ っ て 様 々 な ) 特 殊 文 字 が 、 ( getopt (1) の 他 の 実 装 に お け る と 同 様 に ) 望 ま し か ら ぬ 混 乱 を 引 き 起 こ し か ね な い こ と に 、 注 意 し て い た だ き た い 。

-V , --version

バ ー ジ ョ ン 情 報 を 表 示 し て 、 終 了 す る 。 そ れ 以 上 何 も 出 力 し な い 。

構 文 解 析

こ の セ ク シ ョ ン は 、 getopt の パ ラ メ ー タ の 2 番 目 の 部 分 (「 書 式 」 セ ク シ ョ ン の parameters ) の 書 式 に つ い て 詳 述 し て い る 。 次 の セ ク シ ョ ン (「 出 力 」 ) で は 、 生 成 さ れ る 出 力 に つ い て 説 明 す る 。 一 般 に getopt は 、 シ ェ ル 関 数 や シ ェ ル ス ク リ プ ト の 中 で 、 そ の 引 き 数 を 解 析 す る た め に 使 う も の な の で 、 こ こ で 取 り 上 げ る パ ラ メ ー タ 群 が 、 元 は と 言 え ば 、 シ ェ ル 関 数 を 呼 ん だ と き に 渡 し た パ ラ メ ー タ だ っ た と い う の は 、 ご く 普 通 の こ と で あ る 。 そ こ で 、 気 を 付 け な け れ ば な ら な い こ と が あ る 。 シ ェ ル 関 数 を 呼 ん だ と き に 渡 す 各 パ ラ メ ー タ は 、 getopt に 渡 さ れ る パ ラ メ ー タ リ ス ト 中 の パ ラ メ ー タ と 1 対 1 で 対 応 し て い な け れ ば な ら な い の だ (「 用 例 」 セ ク シ ョ ン を 参 照 )。 す べ て の 解 析 は 、 GNU getopt (3) の ル ー テ ィ ン に よ っ て 行 わ れ る 。

[ 訳 注 ]

getopt の 使 い 方 の 簡 単 な 例 を 挙 げ る 。 た と え ば 、 シ ェ ル 関 数 や シ ェ ル ス ク リ プ ト 中 に 次 の よ う に 書 く 。

PARAM=$(getopt -o ’a:b::c’ -- "$@")
eval set -- "$PARAM"

こ の よ う に し て 、 シ ェ ル 関 数 や ス ク リ プ ト に 渡 さ れ た 引 き 数 群 を 、 位 置 パ ラ メ ー タ を 利 用 し て 、 ど れ が オ プ シ ョ ン で 、 ど れ が そ の オ プ シ ョ ン 引 き 数 、 ど れ が そ れ 以 外 か 、 わ か り や す く 、 処 理 し や す い よ う に 再 構 成 す る わ け で あ る 。 詳 し く は 、 「 出 力 」 セ ク シ ョ ン や 、 「 用 例 」 で 述 べ て い る ス ク リ プ ト の 見 本 を 参 照 し て い た だ き た い 。

「 シ ェ ル 関 数 を 呼 ん だ と き に 渡 す 各 パ ラ メ ー タ は 、 getopt に 渡 さ れ る パ ラ メ ー タ リ ス ト 中 の パ ラ メ ー タ と 1 対 1 で 対 応 し て い な け れ ば な ら な い 」 と い う の は 、 シ ェ ル 関 数 や シ ェ ル ス ク リ プ ト に 渡 す パ ラ メ ー タ で も 、 そ れ が 空 白 な ど を 含 む よ う な ら ク ォ ー ト し な け れ ば な ら な い の は も ち ろ ん 、 以 下 で 説 明 す る よ う な getopt コ マ ン ド の パ ラ メ ー タ の 書 式 に も 従 っ て い な け れ ば な ら な い と い う こ と で あ る 。 た と え ば 、 引 き 数 が 任 意 の シ ョ ー ト オ プ シ ョ ン -b に 引 き 数 を 指 定 す る 場 合 は 、 -bXXX な ど と 、 間 に 空 白 を 置 か ず に 指 定 し な け れ ば な ら な い 。

パ ラ メ ー タ 群 は 左 か ら 右 へ 解 析 さ れ る 。 各 パ ラ メ ー タ は 、 シ ョ ー ト オ プ シ ョ ン 、 ロ ン グ オ プ シ ョ ン 、 オ プ シ ョ ン の 引 き 数 、 オ プ シ ョ ン と は 無 関 係 な パ ラ メ ー タ に 分 割 分 類 さ れ る 。

単 純 な シ ョ ー ト オ プ シ ョ ン は 、 1 個 の ’ - ’ に 1 個 の シ ョ ー ト オ プ シ ョ ン 文 字 が 続 く も の で あ る 。 オ プ シ ョ ン が 引 き 数 を 必 須 に し て い る 場 合 は 、 オ プ シ ョ ン 文 字 の 直 後 に 続 け て も よ く 、 次 の パ ラ メ ー タ と し て (す な わ ち 、 コ マ ン ド ラ イ ン 上 で ホ ワ イ ト ス ペ ー ス を 間 に 置 い て ) 書 い て も よ い 。 オ プ シ ョ ン の 引 き 数 が 任 意 の 場 合 は 、 そ れ が 存 在 す る な ら 、 オ プ シ ョ ン 文 字 の 直 後 に 続 け な け れ ば な ら な い 。

1 個 の ’ - ’ の 後 ろ に 数 個 の シ ョ ー ト オ プ シ ョ ン を ま と め て 指 定 す る こ と も で き る 。 た だ し 、 最 後 の オ プ シ ョ ン 以 外 の す べ て の オ プ シ ョ ン が 、 必 須 や 任 意 の 引 き 数 を 取 ら な い と い う 条 件 が あ る (例 外 と し て 、 最 後 の オ プ シ ョ ン は 引 き 数 を 取 る こ と が で き る )。

ロ ン グ オ プ シ ョ ン は 、 通 常 ’ -- ’ で 始 ま り 、 ロ ン グ オ プ シ ョ ン 名 が そ れ に 続 く 。 オ プ シ ョ ン が 引 き 数 を 必 須 に し て い る 場 合 は 、 ロ ン グ オ プ シ ョ ン 名 の 直 後 に ’ = ’ で 区 切 っ て 続 け て も よ く 、 次 の 引 き 数 と し て (す な わ ち 、 コ マ ン ド ラ イ ン 上 で ホ ワ イ ト ス ペ ー ス を 間 に 置 い て ) 書 い て も よ い 。 オ プ シ ョ ン の 引 き 数 が 任 意 の 場 合 は 、 そ れ が 存 在 す る な ら 、 ロ ン グ オ プ シ ョ ン 名 の 直 後 に ’ = ’ で 区 切 っ て 続 け な け れ ば な ら な い (’ = ’ を 続 け た も の の 、 そ の 後 に 何 も 指 定 し な い 場 合 は 、 引 き 数 が 存 在 し な い か の よ う に 解 釈 さ れ る 。 こ れ は ち ょ っ と し た バ グ で あ る 。 「 バ グ 」 セ ク シ ョ ン を 参 照 )。 ロ ン グ オ プ シ ョ ン は 、 短 縮 し て も 他 の オ プ シ ョ ン と 区 別 が 付 く か ぎ り 、 短 縮 で き る 。

’ - ’ で 始 ま っ て い な い パ ラ メ ー タ で 、 直 前 の オ プ シ ョ ン の 必 須 の 引 き 数 で も な い も の は 、 い ず れ も オ プ シ ョ ン と は 無 関 係 な パ ラ メ ー タ で あ る 。 ま た 、 ’ -- ’ と い う パ ラ メ ー タ の 後 に あ る パ ラ メ ー タ は 、 常 に オ プ シ ョ ン と は 無 関 係 な パ ラ メ ー タ と 解 釈 さ れ る 。 環 境 変 数 POSIXLY_CORRECT が 設 定 さ れ て い る 場 合 や 、 シ ョ ー ト オ プ シ ョ ン ズ 文 字 列 (訳 注 : 「 書 式 」 の optstring ) が ’ + ’ で 始 ま っ て い る 場 合 は 、 オ プ シ ョ ン と は 無 関 係 な 最 初 の パ ラ メ ー タ が 見 つ か っ た 時 点 で 、 残 り の す べ て の パ ラ メ ー タ は 、 オ プ シ ョ ン と は 無 関 係 な パ ラ メ ー タ と 解 釈 さ れ る 。

出 力

出 力 は 、 前 の セ ク シ ョ ン で 述 べ た 要 素 の (訳 注 : す な わ ち 、 オ プ シ ョ ン 、 オ プ シ ョ ン の 引 き 数 、 オ プ シ ョ ン と は 無 関 係 な パ ラ メ ー タ ) ひ と つ ひ と つ に 対 し て 生 成 さ れ る 。 出 力 さ れ る 順 番 は 、 オ プ シ ョ ン と は 無 関 係 な パ ラ メ ー タ 以 外 は 、 各 要 素 が 入 力 で 指 定 さ れ た 順 番 と 同 じ で あ る 。 出 力 は 、 互 換 (ク ォ ー ト し な い ) モ ー ド で 行 う こ と も で き る し 、 ホ ワ イ ト ス ペ ー ス な ど の 特 殊 文 字 が 、 オ プ シ ョ ン 引 き 数 や オ プ シ ョ ン と は 無 関 係 な パ ラ メ ー タ 中 に あ る 場 合 に 、 そ う し た も の を 保 護 す る 形 で 行 う こ と も で き る (「 ク ォ ー ト 」 セ ク シ ョ ン を 参 照 )。 出 力 は シ ェ ル ス ク リ プ ト 中 で 処 理 さ れ る 際 に 、 出 力 を 構 成 す る 各 要 素 が 、 そ れ ぞ れ 他 と 区 別 さ れ る も の と し て 見 え る こ と に な る の で 、 (ほ と ん ど の シ ェ ル 言 語 で shift コ マ ン ド を 使 っ て ) ひ と つ ひ と つ 処 理 す る こ と が 可 能 に な る 。 た だ し 、 ク ォ ー ト な し の モ ー ド で の こ の 処 理 は 、 完 全 で は な い 。 要 素 に ホ ワ イ ト ス ペ ー ス や 特 殊 文 字 が 含 ま れ て い る と 、 思 い が け な い と こ ろ で 要 素 が 分 割 さ れ て し ま う か も し れ な い の で あ る 。

た と え ば 、 引 き 数 が 必 須 な の に 存 在 し な い と か 、 未 知 の オ プ シ ョ ン が あ る と か い う 理 由 で 、 パ ラ メ ー タ の 解 析 中 に 問 題 が 起 き た と き は 、 エ ラ ー メ ッ セ ー ジ が 標 準 エ ラ ー に 表 示 さ れ 、 問 題 を 起 こ し た 要 素 に つ い て は 、 何 も 出 力 さ れ な い 。 そ し て 、 ゼ ロ 以 外 の エ ラ ー ス テ ー タ ス が 返 さ れ る 。

シ ョ ー ト オ プ シ ョ ン に 対 し て は 、 1 個 の ’ - ’ と オ プ シ ョ ン 文 字 が 、 ひ と つ の パ ラ メ ー タ と し て 生 成 さ れ る 。 オ プ シ ョ ン に 引 き 数 が あ る 場 合 は 、 次 の パ ラ メ ー タ は そ の 引 き 数 で あ る 。 オ プ シ ョ ン の 引 き 数 が 任 意 な と き 、 そ の 引 き 数 が 見 つ か ら な か っ た 場 合 は 、 ク ォ ー テ ィ ン グ モ ー ド で は 、 次 の パ ラ メ ー タ が 生 成 さ れ る が 、 空 の パ ラ メ ー タ に な る 。 ク ォ ー ト な し の モ ー ド (互 換 モ ー ド ) で は 、 2 番 目 の パ ラ メ ー タ は 生 成 さ れ な い 。 な お 、 getopt (1) の 他 の 実 装 で は 、 任 意 の 引 数 を サ ポ ー ト し て い な い こ と が 多 い 。

1 個 の ’ - ’ の 後 ろ に 複 数 の シ ョ ー ト オ プ シ ョ ン が 指 定 さ れ て い る 場 合 は 、 各 オ プ シ ョ ン が そ れ ぞ れ 独 立 し た パ ラ メ ー タ と し て 出 力 さ れ る こ と に な る 。

ロ ン グ オ プ シ ョ ン に 対 し て は 、 ’ -- ’ と 省 略 な し の オ プ シ ョ ン 名 が ひ と つ の パ ラ メ ー タ と し て 生 成 さ れ る 。 こ の 動 作 は 、 入 力 中 で オ プ シ ョ ン が 短 縮 さ れ て い る か ど う か や 、 1 個 の ’ - ’ と と も に 指 定 さ れ て い る か ど う か (訳 注 : -a オ プ シ ョ ン を 使 っ た 場 合 ) と は 、 関 係 が な い 。 引 き 数 の 処 理 は 、 シ ョ ー ト オ プ シ ョ ン の 場 合 と 同 じ で あ る 。

通 常 、 オ プ シ ョ ン と は 無 関 係 な パ ラ メ ー タ の 出 力 が 生 成 さ れ る の は 、 す べ て の オ プ シ ョ ン と そ の 引 き 数 が 生 成 さ れ て か ら で あ る 。 そ れ か ら 、 ’ -- ’ が 1 個 の パ ラ メ ー タ と し て 生 成 さ れ 、 そ の 後 で 、 オ プ シ ョ ン と は 無 関 係 な パ ラ メ ー タ が 、 見 つ か っ た 順 序 で 、 そ れ ぞ れ 独 立 し た パ ラ メ ー タ と し て 生 成 さ れ る 。 た だ し 、 シ ョ ー ト オ プ シ ョ ン ズ 文 字 列 の 最 初 の 文 字 が ’ - ’ の と き だ け は 別 で 、 そ の 場 合 は 、 オ プ シ ョ ン と は 無 関 係 な パ ラ メ ー タ の 出 力 は 、 入 力 中 の そ れ が 見 つ か っ た 位 置 で 生 成 さ れ る (こ の 動 作 は 、 「 書 式 」 セ ク シ ョ ン の 第 1 の 書 式 が 使 用 さ れ て い る 場 合 に は 、 サ ポ ー ト さ れ な い 。 そ の 場 合 は 、 シ ョ ー ト オ プ シ ョ ン ズ 文 字 列 の 前 に あ る ’ - ’ や ’ + ’ は 、 す べ て 無 視 さ れ る )。

ク ォ ー ト

互 換 モ ー ド で は 、 オ プ シ ョ ン の 引 き 数 や オ プ シ ョ ン と は 無 関 係 な パ ラ メ ー タ 中 に 、 ホ ワ イ ト ス ペ ー ス や 特 殊 文 字 が あ る と 、 そ れ を 適 切 に 処 理 で き な い 。 そ の た め 、 互 換 モ ー ド の 出 力 を 渡 さ れ た シ ェ ル ス ク リ プ ト は 、 そ の 出 力 を ど の よ う に 個 々 の パ ラ メ ー タ に 分 割 す る こ と が 期 待 さ れ て い る の か 、 わ か ら な い こ と に な る 。 こ の 問 題 を 回 避 す る た め に 、 getopt の こ の 実 装 で は 、 ク ォ ー ト に よ る 保 護 を 提 供 し て い る 。 要 す る に 、 出 力 を 生 成 す る と き 、 パ ラ メ ー タ を ひ と つ ひ と つ 引 用 符 で 囲 ん で や る の で あ る 。 こ の 出 力 を (た い て い は 、 シ ェ ル の eval コ マ ン ド を 使 っ て ) も う 一 度 シ ェ ル に 渡 し て や れ ば 、 別 々 の パ ラ メ ー タ に 適 切 に 分 割 さ れ る こ と に な る 。

次 の 場 合 に は 、 引 用 符 に よ る 保 護 が 行 わ れ な い 。 環 境 変 数 GETOPT_COMPATIBLE が 設 定 さ れ て い る 場 合 、 「 書 式 」 セ ク シ ョ ン の 第 1 の 書 式 が 使 わ れ て い る 場 合 、 ’ -u ’ オ プ シ ョ ン が 指 定 さ れ て い る 場 合 。

ク ォ ー ト 方 式 は シ ェ ル ご と に 異 な る 。 自 分 が 使 用 し て い る シ ェ ル の 方 式 を 選 ぶ に は 、 ’ -s ’ オ プ シ ョ ン を 使 え ば よ い 。 現 在 サ ポ ー ト し て い る シ ェ ル は 、 ’ sh ’, ’ bash ’, ’ csh ’, ’ tcsh ’ で あ る 。 実 の と こ ろ 、 sh 風 の ク ォ ー ト 方 式 と csh 風 の ク ォ ー ト 方 式 と い う 、 2 つ の 系 統 し か 区 別 し て い な い 。 別 の シ ェ ル ス ク リ プ ト 言 語 を 使 用 し て い る 場 合 で も 、 こ の 2 つ の 系 統 の ど ち ら か が 多 分 使 え る だ ろ う 。

ス キ ャ ニ ン グ モ ー ド

シ ョ ー ト オ プ シ ョ ン ズ 文 字 列 (訳 注 : 「 書 式 」 の optstring ) の 先 頭 に は 、 1 個 の ’ - ’ ま た は ’ + ’ を 付 け て 、 特 別 な ス キ ャ ニ ン グ モ ー ド を 指 示 す る こ と が で き る 。 「 書 式 」 セ ク シ ョ ン の 第 1 の 呼 び 出 し 形 式 が 使 用 さ れ て い る 場 合 に は 、 こ う し た プ ラ ス や マ イ ナ ス 記 号 は 無 視 さ れ る が 、 そ の と き で も 、 環 境 変 数 POSIXLY_CORRECT が 設 定 さ れ て い る か ど う か は 、 や は り 調 べ ら れ る (訳 注 : 実 際 に は 、 第 1 の 書 式 で optstring の 先 頭 に ’ - ’ を 付 け る と 、 2, 3 番 目 の 書 式 と 混 同 さ れ て 、 多 分 エ ラ ー に な る )。

先 頭 文 字 が ’ + ’ の 場 合 や 、 環 境 変 数 POSIXLY_CORRECT が 設 定 さ れ て い る 場 合 は 、 オ プ シ ョ ン で は な い パ ラ メ ー タ で (す な わ ち 、 ’ -’ で 始 ま っ て い な い パ ラ メ ー タ で )、 か つ オ プ シ ョ ン の 引 き 数 で も な い も の が 最 初 に 見 つ か っ た 時 点 で 、 解 析 は ス ト ッ プ す る 。 残 り の パ ラ メ ー タ は す べ て 、 オ プ シ ョ ン と は 無 関 係 な パ ラ メ ー タ と 見 な さ れ る 。

先 頭 文 字 が ’ - ’ の 場 合 、 オ プ シ ョ ン と は 無 関 係 な パ ラ メ ー タ は 、 そ れ が 見 つ か っ た 位 置 に 出 力 さ れ る 。 そ れ に 対 し て 、 通 常 の 動 作 で は 、 そ う し た パ ラ メ ー タ は 、 1 個 の ’ -- ’ と い う パ ラ メ ー タ が 生 成 さ れ た 後 で 、 出 力 の 末 尾 に 全 部 ま と め て 置 か れ る の で あ る 。 な お 、 こ の モ ー ド で も 、 ’ -- ’ と い う パ ラ メ ー タ は や は り 生 成 さ れ る が 、 必 ず 最 後 の パ ラ メ ー タ に な る 。

互 換 性

こ の バ ー ジ ョ ン の getopt (1) は 、 で き る だ け 他 の バ ー ジ ョ ン と 互 換 性 が あ る よ う に 書 か れ て い る 。 た い て い の 場 合 、 他 の バ ー ジ ョ ン の getopt を こ の バ ー ジ ョ ン で 置 き 換 え る だ け で よ く 、 既 存 の シ ェ ル ス ク リ プ ト な ど に 手 を 入 れ る 必 要 は な い 。 さ ら に 、 い く つ か の 利 点 も あ る 。

getopt の 最 初 の パ ラ メ ー タ の 最 初 の 文 字 が ’ - ’ で な い 場 合 、 getopt は 互 換 モ ー ド に な る 。 最 初 の パ ラ メ ー タ は 、 シ ョ ー ト オ プ シ ョ ン を ひ と つ に ま と め た 文 字 列 と 見 な さ れ 、 他 の す べ て の 引 き 数 は 、 解 析 の 対 象 に な る 。 こ の 場 合 で も 、 環 境 変 数 POSIXLY_CORRECT が 設 定 さ れ て い な い か ぎ り 、 パ ラ メ ー タ の 並 べ 替 え は 行 う 。 (す な わ ち 、 オ プ シ ョ ン と は 無 関 係 な す べ て の パ ラ メ ー タ は 、 最 後 に 出 力 さ れ る )。

環 境 変 数 GETOPT_COMPATIBLE は getopt を 強 制 的 に 互 換 モ ー ド に す る 。 こ の 環 境 変 数 と POSIXLY_CORRECT の 両 方 を 設 定 す る と 、 「 気 難 し い 」 プ ロ グ ラ ム の た め に 100% の 互 換 性 が 得 ら れ る 。 し か し 、 通 常 は ど ち ら も 設 定 す る 必 要 が な い 。

互 換 モ ー ド で は 、 シ ョ ー ト オ プ シ ョ ン ズ 文 字 列 の 先 頭 に 付 く ’ - ’ や ’ + ’ は 無 視 さ れ る 。

返 り 値

getopt は 、 解 析 に 成 功 し た 場 合 は 、 エ ラ ー コ ー ド 0 を 返 す 。 getopt (3) が エ ラ ー を 返 し た 場 合 は 1 を 返 す 。 自 分 自 身 に 対 し て 与 え ら れ た パ ラ メ ー タ が 理 解 で き な か っ た 場 合 は 2 を 返 す 。 メ モ リ が 足 り な い (out-of-memory) と い っ た 内 部 エ ラ ー が 起 き た 場 合 は 3 を 返 す 。 -T オ プ シ ョ ン を 付 け て 呼 び 出 さ れ た 場 合 は 4 を 返 す 。

用 例

getopt (1) の 配 布 で は 、 (ba)sh と (t)csh 用 の ス ク リ プ ト の 見 本 を 提 供 し て い る 。 イ ン ス ト ー ル 場 所 は /usr/share/doc/util-linux/getopt/ で あ る (訳 注 : /usr/share/doc/util-linux/examples/ な ど か も し れ な い )。

環 境 変 数

POSIXLY_CORRECT

こ の 環 境 変 数 は getopt (3) ル ー テ ィ ン に よ っ て 調 べ ら れ る 。 こ れ が 設 定 さ れ て い る 場 合 、 オ プ シ ョ ン で も オ プ シ ョ ン の 引 き 数 で も な い パ ラ メ ー タ が 見 つ か っ た 時 点 で 、 解 析 は 停 止 す る 。 そ れ 以 降 の す べ て の パ ラ メ ー タ は 、 ’ - ’ で 始 ま っ て い る か ど う か に 関 係 な く 、 オ プ シ ョ ン と は 無 関 係 な パ ラ メ ー タ と し て 解 釈 さ れ る 。

GETOPT_COMPATIBLE

getopt に 対 し て 強 制 的 に 「 書 式 」 セ ク シ ョ ン の 第 1 の 呼 び 出 し 形 式 を 使 わ せ る 。

バ グ

getopt (3) 関 数 は 、 引 き 数 が 任 意 の ロ ン グ オ プ シ ョ ン が 空 の 任 意 引 き 数 を 渡 さ れ た 場 合 、 そ れ を 解 析 で き る (だ が 、 シ ョ ー ト オ プ シ ョ ン に 対 し て は 、 そ れ が で き な い )。 一 方 、 こ の getopt (1) コ マ ン ド は 、 空 の 任 意 引 き 数 を 、 引 き 数 が 存 在 し な い か の よ う に 処 理 し て い る 。

[ 訳 注 ]

バ グ と は 言 っ て も 、 不 具 合 で は な く 、 こ の getopt コ マ ン ド が getopt (3) 関 数 と は 、 仕 様 が 微 妙 に 違 う と い う こ と を 言 っ て い る ら し い 。 す な わ ち 、 getopt (3) ( getopt_long (3)) 関 数 は 、 引 き 数 が 任 意 の ロ ン グ オ プ シ ョ ン に 引 数 が な い 場 合 と 、 空 の 引 き 数 を 渡 さ れ た 場 合 と を 区 別 し て い る 。 そ れ に 対 し て 、 こ の getopt コ マ ン ド の 方 は 、 ロ ン グ オ プ シ ョ ン で あ れ 、 シ ョ ー ト オ プ シ ョ ン で あ れ 、 引 き 数 が 任 意 の オ プ シ ョ ン に 引 数 が な い 場 合 と 、 空 の 引 き 数 を 渡 さ れ た 場 合 と を 区 別 せ ず 、 ど ち ら も 同 じ よ う に 処 理 し て い る 。

シ ョ ー ト オ プ シ ョ ン を 全 く 使 い た く な い 場 合 の getopt コ マ ン ド の 構 文 は 、 あ ま り 直 感 的 で は な い (シ ョ ー ト オ プ シ ョ ン ズ 文 字 列 を 明 示 的 に 空 文 字 列 に し な け れ ば な ら な い の だ )。

[ 訳 注 ]

す な わ ち 、 getopt -o ’’ --longoptions ... の よ う に 使 用 し な け れ ば な ら な い 。

作 者

Frodo Looijaard <frodo@frodo.looijaard.name>

関 連 項 目

bash (1), tcsh (1), getopt (3)

入 手 方 法

こ の getopt コ マ ン ド は 、 util-linux パ ッ ケ ー ジ の 一 部 で あ り 、 Linux Kernel Archive <https://www.kernel.org/pub/linux/utils/util-linux/> か ら 入 手 で き る 。

---