単純なコマンド (Simple Commands)¶

単純なコマンド (simple command) とは、 変数の代入を並べたもの (これは省略可能です) の後に、 ブランク区切りの単語とリダイレクションを記述し、 最後に制御演算子を置いたものです。 最初の単語は実行するコマンドを指定します。 これは 0 番目の引き数となります。 残りの単語は起動されるコマンドに引き数として渡されます。

単純なコマンドの返り値はコマンドの終了コードですが、シグナル n を受けてコマンドが終了した場合には 128+n となります。

パイプライン (Pipeline)¶

パイプライン (pipeline)は、制御演算子 | または |& で区切った 1 つ以上のコマンドの並びです。 パイプラインのフォーマットを以下に示します:

command の標準出力は command2 の標準入力にパイプで接続されます。 この接続は、 コマンドで指定したどのリダイレクションよりも先に実行されます (後述の リダイレクト を参照)。 |& を使うと、command の標準エラー出力もパイプを通して command2 の標準入力に接続されます。 これは 2>&1 | の短縮形です。 この標準エラー出力の暗黙のリダイレクションは、 コマンドに指定された全てのリダイレクションの後に実行されます。

pipefail オプションが有効になっている場合を除き、 パイプラインの返却ステータスは最後のコマンドの終了ステータスになります。 pipefail が有効になっている場合には、 0 以外のステータスを返した最後の (一番右の) コマンドの値が パイプラインの返却ステータスになり、 全てのコマンドが正常終了した場合にのみ 0 になります。 パイプラインの前に、予約語である ! がある場合、 そのパイプラインの終了ステータスは上記の終了ステータスを 論理否定したものになります。 値を返す前に、シェルはパイプライン中の全てのコマンドが終了するのを待ちます。

パイプラインの前に予約語 time がある場合、コマンドの実行にかかった 経過時間・ユーザ時間・システム時間がパイプラインの終了時に報告されます。 -p オプションを指定すると、 出力フォーマットが POSIX 仕様に変わります。 シェルが posix モード のときには、 後に続くのが `-' で始まるトークンであれば time を予約語と認識しません。 変数 TIMEFORMAT には、経過時間情報の表示の仕方を指定するフォーマット文字列を 設定できます (後述の シェル変数 の項の TIMEFORMAT に関する説明を参照)。

シェルが posix モード のときには、time の直後が 改行でもかまいません。 この場合、シェルと子プロセスがそれまでに消費した ユーザ時間とシステム時間を出力します。 このときにも、経過時間情報のフォーマットを変数 TIMEFORMAT で指定できます。

パイプライン中の各コマンドは、それぞれ別のプロセスとして (つまりサブシェル内で) 実行されます。

リスト¶

リスト (list) とは、1つ以上のパイプラインを演算子 ;, &, &&, || のいずれかで区切って並べたものです。パイプラインの最後に ;, &, <newline> のいずれかを置くこともできます。

リスト演算子のうち、 && と || の優先順位は同じです。これらの次に、 ; と & が同じ優先順位で続きます。

リスト 中では、コマンドの区切りとして、 セミコロンの代わりに一つ以上の改行が使われることもあります。

コマンドが制御演算子 & で終わっている場合、シェルはコマンドをサブシェル内で バックグラウンド (background) で実行します。 シェルはコマンドが終了するのを待たずに、返却ステータス 0 を返します。 コマンドを ; で区切った場合には、これらは順番に実行されます。 シェルはそれぞれのコマンドが終了するのを順番に待ちます。 返却ステータスは、最後に実行したコマンドの終了ステータスになります。

AND リストと OR リストは、それぞれ制御演算子 && と || で区切られたパイプラインの並びです。 AND リストと OR リストは左結合で実行されます。 AND リストは

という形式であり、 command1 が終了ステータス 0 を返した場合に限り command2 が実行されます。

OR リストは

という形式であり、 command1 が 0 以外の終了ステータスを返した場合に限り command2 が実行されます。 AND リストと OR リストの返却ステータスは、 リスト中で最後に実行されたコマンドの終了ステータスです。

複合コマンド (Compound Commands)¶

複合コマンド (compound command) を以下に示します:

(list)

list はサブシェル内で実行されます (後述の コマンド実行環境 の項を参照)。 シェルの環境に影響を与えるような変数の代入や組み込みコマンドは、 コマンドの終了後に影響を残しません。 返却ステータスは list の終了ステータスです。

{ list; }

list が単に現在のシェル環境で実行されます。 list の最後は改行文字かセミコロンでなければなりません。これは グループコマンド(group command) と呼ばれます。返却ステータスは list の終了ステータスです。 メタ文字である ( や ) と違い、 { と } は 予約語 であり、予約語として認識される場所に現われる必要があることに注意してください。 これらは単語分割の対象とならないため、 リスト との間が空白またはシェルのメタ文字で分かれている必要があります。

((expression))

expression が後述の 算術式評価 で説明される規則に従って評価されます。 式の値が 0 でない場合、返却ステータスは 0 になります。そうでない場合、 返されるステータスは 1 になります。これは let "expression" と全く同じものです。

[[ expression ]]

条件式 expression の評価値に従って 0 または 1 を返します。 式は後述の 条件式 で説明する、プライマリによって構成されます。 単語分割とパス名展開は [[ と ]] の間の単語に対しては行われません。 チルダ展開、パラメータと変数の展開、算術式展開、コマンド置換、 プロセス置換、クォート除去は実行されます。 -f などの条件演算子がプライマリとして認識されるためには、 クォートされていてはいけません。

[[ においては、< 演算子と > 演算子は、 現在のロケールにおける辞書順で比較します。

== 演算子と != 演算子が使われたとき、 演算子の右の文字列はパターンと解釈され、 後述のパターンマッチングで説明する規則に従ってマッチングが行われます。 シェルオプション nocasematch が有効であれば、 アルファベットの大文字と小文字を考慮せずにマッチングが行われます。 返り値は、== 演算子では文字列がマッチしたときに、 != 演算子では文字列がマッチしなかったときに 0 となり、 そうでない場合に 1 となります。 パターン中のどの部分でも、クォートすることで、 ただの文字列としてマッチングさせることができます。

そのほか、二項演算子 =~ もあります。 優先順位は == や != と同じです。 これを使うと、右辺の文字列は拡張正規表現とみなされ、 それに従って (regex(3) にあるように) マッチングが行われます。 文字列がパターンにマッチすれば返り値は 0 であり、 マッチしなければ返り値は 1 になります。 正規表現が文法的に誤っていれば、条件式の返り値は 2 になります。 シェルオプション nocasematch が有効であれば、 アルファベットの大文字と小文字を考慮せずにマッチングが行われます。 パターン中のどの部分でも、クォートすることで、 ただの文字列としてマッチングさせることができます。 正規表現中の括弧による部分式にマッチした部分文字列は、配列変数 BASH_REMATCH に保存されます。 BASH_REMATCH のインデックス 0 の要素は、文字列のうち正規表現全体にマッチした部分になります。 BASH_REMATCH のインデックス n の要素は、文字列のうち、 正規表現中の n 番目の括弧による部分式にマッチした部分になります。

式は以下の演算子を使って繋げられます。 以下に演算子を優先度の順に示します:

for name [ [ in [ word ... ] ] ; ] do list ; done

in に続く単語のリストが展開され、要素のリストが生成されます。 変数 name には、このリストの各要素が順番にセットされ、そのたびに list が実行されます。「in word」が省略された場合、 for コマンドは、設定されている位置パラメータそれぞれに対して list を一度ずつ実行します(後述の パラメータ を参照)。 返却ステータスは実行された最後のコマンドの終了ステータスになります。 in に続く要素を展開した結果が空となった場合、 コマンドは全く実行されず、返却ステータス 0 が返されます。

for (( expr1 ; expr2 ; expr3 )) ; do list ; done

最初に、算術式 expr1 が、後述の 算術式評価 で説明される規則に従って評価されます。 次に、算術式 expr2 がゼロになるまで繰り返し評価されます。 算術式 expr2 の評価結果がゼロでなければ、そのたびごとにlistが実行され、 算術式 expr3 が評価されます。 どの算術式も、省略された場合は、 評価結果が 1 であったものとして振舞います。 返却ステータスは list 中で実行された 最後のコマンドの終了ステータスとなりますが、 算術式のいずれかが不正である場合には偽となります。

select name [ in word ] ; do list ; done

in に続く単語のリストが展開され、要素のリストが生成されます。 展開された単語の集合が番号付きで標準エラー出力に出力されます。 「in word」が省略された場合、 位置パラメータが出力されます (後述の パラメータ を参照)。続いて PS3 プロンプトが表示され、標準入力から 1 行の読み込みが行われます。 表示された単語のいずれかに対応する数字がこの行に含まれていれば、 name の値としてその単語が設定されます。 行が空であれば、単語とプロンプトが再び表示されます。 EOF を読み込むとコマンドが終了します。 これ以外の値の場合には、 name には空文字列が設定されます。読み込んだ行は変数 REPLY に格納されます。 break コマンドが実行されるまで、選択を行うたびに list が実行されます。 select の終了ステータスは、 list 中で最後に実行したコマンドの終了ステータスですが、 コマンドが全く実行されなかった場合には 0 となります。

case word in [ [(] pattern [ | pattern ] ... ) list ;; ] ... esac

case コマンドは最初に word を展開し、それぞれの pattern に対して順にマッチングを試みます。 マッチングの際にはパス名展開 (後述の パス名展開 を参照) と同じ規則が用いられます。 word には、チルダ展開、パラメータと変数の展開、算術式展開、 コマンド置換、プロセス置換、クォート除去が実行されます。 それぞれの pattern は、チルダ展開、パラメータと変数の展開、 算術式展開、コマンド置換、プロセス置換、クォート除去のうえで比較されます。 シェルオプション nocasematch が有効であれば、 アルファベットの大文字と小文字を考慮せずにマッチングが行われます。 マッチするものが見つかると、これに対応する list が実行されます。 ;; 演算子を使うと、 最初にマッチしたパターン以降のマッチングは試みられません。 ;; の代わりに ;& を使うと、 その次のパターンに対応する list の実行に続きます。 ;; の代わりに ;;& を使うと、 次のパターンがあればそのマッチングを試み、 マッチすれば対応する list を実行します。 マッチするパターンが無ければ、終了ステータスは 0 になります。 マッチするものがあったら、終了ステータスは list 中で最後に実行されたコマンドの終了ステータスになります。

if list; then list; [ elif list; then list; ] ... [ else list; ] fi

最初に if list が実行されます。list の終了ステータスが 0 ならば、then list が実行されます。 そうでなければ elif list がそれぞれ順番に実行され、 list の終了ステータスが 0 ならば、対応する then list が実行され、コマンドが終了します。そうでなければ、else list が (もし存在すれば) 実行されます。終了ステータスは最後に実行されたコマンドの終了ステータスとなります。どの条件も真と評価されず、コマンドが全く実行されなかった場合、終了ステータスは 0 となります。

while list-1; do list-2; done

until list-1; do list-2; done

while コマンドは、list-1 中の最後のコマンドが終了ステータス 0 を返す間、繰り返して list-2 を実行します。until コマンドは while コマンドとほぼ同じですが、 評価の条件が逆となる点が異なります。 list-2 は list-1 中の最後のコマンドが 0 以外の終了ステータスを返す限りずっと実行されます。 while コマンドと until コマンドの終了ステータスは、 do list-2 で実行された最後のコマンドの終了ステータスになりますが、 コマンドが全く実行されなかった場合には 0 になります。

コプロセス (Coprocesses)¶

コプロセス (coprocess) とは、予約語 coproc で始まるシェルのコマンドのことです。 コプロセスは、コマンドが制御演算子 & で終わっているときのように、 サブシェルで非同期に実行されます。 実行したシェルとコプロセスの間には、双方向のパイプが設けられます

コプロセスのフォーマットを以下に示します:

これにより NAME という名前のコプロセスが作られます。 NAME が指定されない場合、デフォルトの名前は COPROC となります。 command が 単純なコマンド (前述) のときには、 NAME は指定できません。 指定すると、単純なコマンドの最初の単語として扱われます。 コプロセスが実行されると、実行したシェルのコンテキストに NAME という名前の配列変数 (後述の 配列 を参照) が作られます。 command の標準出力は、実行しているシェルのファイル・ディスクリプターの一つと パイプによって接続されます。 このファイル・ディスクリプターは NAME[0] に代入されます。 command の標準入力は、実行しているシェルのファイル・ディスクリプターの一つと パイプによって接続されます。 このファイル・ディスクリプターは NAME[1] に代入されます。 このパイプは、コマンドで指定されたほかのリダイレクトより先に設けられます (後述の リダイレクト を参照)。 ファイル・ディスクリプターは、標準的な単語展開により、 シェルのコマンドの引き数やリダイレクションに指定できます。 コプロセスの実行で生成されたシェルのプロセス ID は、変数 NAME_PID の値になります。 コプロセスの終了を待つには、組み込みコマンド wait を使います。

コプロセスの返却ステータスは、command の終了ステータスです。

関数定義¶

シェル関数とは、単純なコマンドとして呼び出されて、 新しい位置パラメーターの一式を持つ複合コマンドを実行するもののことです。 シェル関数は以下の形式で宣言します:

name () compound-command [redirection]

function name [()] compound-command [redirection]

これによって name という名前の関数が定義されます。 予約語 function は省略可能です。 予約語 function が与えられた場合、括弧は省略可能です。 関数の 実体 は複合コマンド compound-command です (前述の 複合コマンド を参照)。 多くの場合、 { と } に挟まれたコマンドの リスト が用いられますが、 前述の 複合コマンド で挙げたどのコマンドを用いてもかまいません。 単純なコマンドの名前として name を指定するといつでも compound-command が実行されます。 関数の定義で指定されたリダイレクション (後述の リダイレクト を参照) は、関数が実行されるときに処理されます。 関数定義の終了ステータスは、文法エラーが起きた場合や、 読み込み専用の関数が同じ名前で定義されていた場合を除き、0 です。 関数を実行したときの終了ステータスは、実体の中で最後に実行されたコマンドの終了ステータスになります (後述の 関数 を参照)。

位置パラメータ(Positional Parameters)¶

位置パラメータ (positional parameter) は、1 桁以上の数値で表されるパラメータです。ただし 0 は含みません。 位置パラメータは、シェルが起動されたときにシェルの引き数が代入されますが、 組み込みコマンドの set を使って代入し直すこともできます。 代入文を使って位置パラメータへの代入を行うことはできません。 シェル関数が実行されると、 位置パラメータは一時的に置き換えられます (後述の 関数 を参照)。

2 桁以上の数値を含む位置パラメータを展開するときには、ブレース ({}) で囲まなければなりません (後述の 展開 を参照)。

特殊パラメータ¶

シェルはいくつかのパラメータを特別扱いします。 このようなパラメータは参照されるだけであり、 値を代入することは許されません。

*

(1 から始まる) 全ての位置パラメータに展開されます。 ダブルクォートの内部で展開が行われたときは、 それぞれのパラメータを特別な変数である IFS の最初の文字で区切って並べた 1 つの単語に展開されます。つまり、 "$*" は "$1c$2c..." と同じです。 ここで c は変数 IFS の値の最初の文字です。 IFS が設定されていなければ、パラメータは空白で区切られます。 IFS が空文字列の場合、パラメータの間には区切り文字は入らず、 全てのパラメータは繋げられます。

@

(1 から始まる) 全ての位置パラメータに展開されます。 ダブルクォートの内部で展開が行われたときは、 それぞれのパラメータは別々の単語に展開されます。 つまり "$@" は "$1" "$2" ... と同じです。 単語の中でダブルクォートの展開が行われるときには、 最初のパラメータの展開結果に元の単語のダブルクォートより前の部分が 結び付き、最後のパラメータの展開結果に元の単語のダブルクォートより 後の部分が結び付きます。 位置パラメータがない場合には、"$@" や $@ を展開しても無かったことになります (つまり取り除かれます)。

#

位置パラメータの個数を示す 10 進値に展開されます。

?

最後に実行されたフォアグラウンドのパイプラインの 終了ステータスに展開されます。

-

現在のオプションフラグに展開されます。 これは起動のときに指定したり、組み込みコマンド set で設定したり、( -i オプション等で) シェル自身が設定したりします。

$

シェルのプロセス ID に展開されます。 () を使ったサブシェルの内部では、$ はサブシェルではなく、 現在のシェルのプロセス ID に展開されます。

!

最後に実行されたバックグラウンド (非同期) コマンドの プロセス ID に展開されます。

0

シェルまたはシェルスクリプトの名前に展開されます。 これはシェルの初期化時に設定されます。 コマンドを記述したファイルを指定して bash を起動した場合、 $0 にはそのファイルの名前が設定されます。 -c オプションを付けて bash を起動した場合、実行する文字列の後に引き数があれば、その最初の値が $0 に設定されます。引き数がなければ、 bash を起動するときに使用した名前が引き数 0 として与えられ $0 に設定されます。

_

シェルの起動時には、環境または引き数リストで渡された、 実行するシェルまたはシェルスクリプトの絶対パス名が設定されます。 その後では、直前のコマンドに対する最後の引き数 (展開後のもの) に展開されます。 また、実行する各コマンドの完全なパス名が設定され、 そのコマンドの環境にエクスポートされます。 メールをチェックするときには、 このパラメータは現在チェックしているメールファイル名を保持します。

シェル変数¶

以下の変数はシェルが設定します:

BASH

現在実行している bash を起動したときに使われた、完全なファイル名に展開されます。

BASHOPTS

コロン区切りのリストで、有効になっているシェルのオプションを示します。 リスト中のそれぞれの単語は、組み込みコマンド shopt の -s オプション (後述の シェルの組み込みコマンド を参照) に対する有効な引き数になっています。 BASHOPTS に現われるオプションは、shopt コマンドで on と表示されるものです。 もし bash を起動したときに、この変数が環境変数に設定されていれば、 起動ファイルを読み込む前に、リストにある全てのシェルオプションが 有効に設定されます。 この変数は読み込み専用です。

BASHPID

現在の bash のプロセス ID に展開されます。 bash を再初期化しないサブシェルのような、いくつかの環境においては、 $$ と値が異なります。

BASH_ALIASES

エイリアスの内部的なリストに対応する連想配列変数です。 エイリアスは通常、組み込みコマンド alias で操作します。 この配列に要素を追加すると、エイリアスのリストにも追加されます。 配列から要素を削除すると、エイリアスがリストから削除されます。

BASH_ARGC

bash の現在の呼び出しスタックについて、フレームごとの引き数の数が並んだ配列変数です。現在のサブルーチン (シェル関数や、. か source で実行されたスクリプト) の引き数の数が、スタックの一番上に置かれます。サブルーチンが実行されると、渡されたパラメータの数が BASH_ARGC に追加されます。シェルが BASH_ARGC を設定するのは、拡張デバッグモードのときだけです (後述の組み込みコマンド shopt の extdebug オプションを参照)。

BASH_ARGV

bash の現在の呼び出しスタックについて、全ての引き数が並んだ配列変数です。一連の呼び出しのうち、最後に呼ばれたサブルーチンの最後の引き数が、スタックの一番上に置かれます。最初に呼ばれたサブルーチンの最初の引き数が、スタックの一番下になります。サブルーチンが実行されると、渡されたパラメータが BASH_ARGV に追加されます。シェルが BASH_ARGV を設定するのは、拡張デバッグモードのときだけです (後述の組み込みコマンド shopt の extdebug オプションを参照)。

BASH_CMDS

bash が内部に持つ、コマンドのハッシュテーブルに対応する 連想配列変数です。 ハッシュテーブルは通常、組み込みコマンド hash で操作します。 この配列に要素を追加すると、ハッシュテーブルにも追加されます。 配列から要素を削除すると、ハッシュテーブルから削除されます。

BASH_COMMAND

現在実行しているか実行しようとしているコマンドです。 ただし、トラップによってシェルが実行しているコマンドは別で、 その場合は、トラップの発動時に実行していたコマンドになります。

BASH_EXECUTION_STRING

起動オプション -c で指定されたコマンドです。

BASH_LINENO

ソースファイル中の行番号からなる配列変数で、 それぞれの要素は FUNCNAME の各要素が呼び出された位置に対応します。 つまり、${BASH_LINENO[$i]} はソースファイル (${BASH_SOURCE[$i+1]}) 中で${FUNCNAME[$i]} が呼び出された行番号です。 別のシェル関数から参照されると ${BASH_LINENO[$i-1]} になります。 現在の行番号は LINENO で取得できます。

BASH_REMATCH

条件コマンド [[ 中の二項演算子 =~ により設定される配列変数です。 インデックス 0 の要素は、正規表現全体にマッチする部分文字列です。 インデックス n の要素は、n 番目の括弧による部分式に マッチした部分文字列です。 この変数は読み込み専用です。

BASH_SOURCE

ソースファイル名からなる配列変数で、それぞれの要素は配列変数 FUNCNAME の要素のシェル関数がそれぞれ定義されたファイル名に対応します。 シェル関数 ${FUNCNAME[$i]} はファイル ${BASH_SOURCE[$i]} で定義され、 ${BASH_SOURCE[$i+1]} から呼ばれています。

BASH_SUBSHELL

サブシェルやサブシェル環境が作成されるたびに 1 ずつ増えます。 初期値は 0 です。

BASH_VERSINFO

読み込み専用の配列変数で、配列の各要素は現在実行されている bash のバージョン情報を持っています。 配列変数の要素に代入される内容を以下に示します:

BASH_VERSION

現在実行している bash のバージョンを示す文字列に展開されます。

COMP_CWORD

現在カーソル位置がある単語の 配列変数 ${COMP_WORDS} におけるインデックスです。 この変数はプログラム補完機能 (後述の プログラム補完 を参照) から呼ばれたシェル関数においてのみ有効です。

COMP_KEY

現在の補完関数を呼び出したキー (またはキーシーケンスの最後のキー) です。

COMP_LINE

現在のコマンドラインです。 この変数はプログラム補完機能 (後述の プログラム補完 を参照) から呼ばれたシェル関数や外部コマンドにおいてのみ有効です。

COMP_POINT

現在のコマンドの先頭からの相対値として与えられた カーソル位置のインデックスです。 現在のカーソル位置が現在の現在のコマンドの最後にある場合、 この変数の値は ${#COMP_LINE} と等しくなります。 この変数はプログラム補完機能 (後述の プログラム補完 を参照) から呼ばれたシェル関数や外部コマンドにおいてのみ有効です。

COMP_TYPE

補完関数を呼び出した補完のタイプに対応する整数値が設定されます。 TAB は通常の補完です。 ? は連続したタブ入力による候補のリスト表示です。 ! は途中まで補完した後の候補のリスト表示です。 @ は、部分的な補完ができないときの候補のリスト表示です。 % はメニュー補完 (menu completion)です。 この変数はプログラム補完機能 (後述の プログラム補完 を参照) から呼ばれたシェル関数と外部コマンドにおいてのみ有効です。

COMP_WORDBREAKS

単語補完のときに readline ライブラリが単語分割の区切り文字として 扱う文字の並びです。 COMP_WORDBREAKS を unset すると、この変数の特殊な性質はなくなります。後で再び set しても元には戻りません。

COMP_WORDS

現在のコマンドラインの各単語からなる配列変数 (後述の 配列 参照) です。 コマンドラインは readline と同じように前述した COMP_WORDBREAKS によって単語に分割されます。 この変数はプログラム補完機能 (後述の プログラム補完 を参照) から呼ばれたシェル関数においてのみ有効です。

COPROC

無名のコプロセス (前述の コプロセス を参照) が入出力するファイル・ディスクリプターを保持する配列変数 (後述の 配列 参照) です。

DIRSTACK

現在のディレクトリスタックの内容を持つ配列変数 (後述の 配列 を参照) です。組み込みコマンド dirs を使うと、スタック中のディレクトリがスタック順に表示されます。 配列変数の要素に代入を行うと、 既にスタックに入っているディレクトリを変更できますが、 ディレクトリの追加と削除を行うためには、組み込みコマンドの pushd と popd を使わなければなりません。 この変数に代入を行っても現在の作業ディレクトリは変わりません。 DIRSTACK を unset すると、この変数の特殊な性質はなくなります。後で再び set しても元には戻りません。

EUID

現在のユーザの実効ユーザ ID に展開されます。 初期化はシェルの起動時に行われます。 この変数は読み込み専用です。

FUNCNAME

現在の呼び出しスタックにある全てのシェル関数名が 入った配列変数です。 インデックス 0 の要素は、実行中のシェル関数の名前です。 最も下の要素 (最大のインデックスの要素) は "main". です。 この変数は、シェル関数を実行している間のみ存在します。 FUNCNAME への代入は効果がなく、エラーステータスを返します。 FUNCNAME を unset すると、この変数の特殊な性質はなくなります。後で再び set しても元には戻りません。

この変数の各要素は、BASH_LINENO や BASH_SOURCE の各要素に 対応します。 これらを参照することで、呼び出しスタックの状態を確認できます。 例えば、${FUNCNAME[$i]} はファイル ${BASH_SOURCE[$i+1]} の行番号 ${BASH_LINENO[$i]} から呼び出されたものです。 組み込みコマンド caller を実行すると、これらの情報から 現在の呼び出しスタックを表示します。

GROUPS

現在のユーザがメンバになっているグループのリストを含んだ配列変数です。 GROUPS への代入は効果がなく、エラーステータスを返します。 GROUPS が unset された場合はこの変数の特殊な性質はなくなります。 その後に再設定されたとしても元に戻りません。

HISTCMD

現在のコマンドの履歴番号 (履歴リストにおけるインデックス) です。 HISTCMD を unset すると、この変数の特殊な性質はなくなります。後で再び set しても元には戻りません。

HOSTNAME

現在のホスト名が自動的に設定されます。

HOSTTYPE

bash を実行するマシンの種類をユニークに記述する文字列が自動的に設定されます。 デフォルト値はシステム依存です。

LINENO

この変数が参照されると、その場所ごとに、 スクリプトや関数における現在の行番号 (1 から始まります) を表す 10 進値に置き換わります。スクリプトや関数の内部でない場合には、 意味のある値が代入されることは保証されません。 LINENO を unset すると、この変数の特殊な性質はなくなります。後で再び set しても元には戻りません。

MACHTYPE

bash を実行するシステムの種類を完全に指定する文字列が、 GNU 標準の cpu-company-system の形式で設定されます。 デフォルト値はシステム依存です。

MAPFILE

組み込みコマンド mapfile に変数名が指定されなかったときに 読み込んだテキストを保持する配列変数 (後述の 配列 を参照) です。

OLDPWD

cd コマンドで設定された、1 つ前の作業ディレクトリ。

OPTARG

組み込みコマンド getopts で処理した最後のオプション引き数の値です (後述の シェルの組み込みコマンド を参照)。

OPTIND

組み込みコマンド getopts で次に処理されるオプション引き数のインデックスです (後述の シェルの組み込みコマンド を参照)。

OSTYPE

bash を実行するオペレーティングシステムを記述する文字列が自動的に設定されます。 デフォルト値はシステム依存です。

PIPESTATUS

フォアグラウンドで最後に実行したパイプラインの各プロセスの 終了ステータスのリストを含む配列変数です (後述の 配列 を参照)。 パイプラインには 1 つのコマンドしかなくてもかまいません。

PPID

そのシェルの親のプロセス ID。この変数は読み込み専用です。

PWD

cd コマンドで設定された現在の作業ディレクトリ。

RANDOM

このパラメータが参照されるたびに、 0 から 32767 までのランダムな整数が生成されます。 RANDOM に値を代入すると、乱数の列を初期化できます。 RANDOM を unset すると、この変数の特殊な性質はなくなります。後で再び set しても元には戻りません。

READLINE_LINE

readline の編集バッファの内容です。 "bind -x" (後述の シェルの組み込みコマンド を参照) で使います。

READLINE_POINT

readline の編集バッファでの挿入ポイントの位置です。 "bind -x" (後述の シェルの組み込みコマンド を参照) で使います。

REPLY

組み込みコマンド read に引き数が与えられなかったときに読み込まれた行が設定されます。

SECONDS

このパラメータを参照すると、シェルが起動されてからの秒数が返されます。 SECONDS に値を代入した場合、それ以降の参照において返される値は、 代入された値と代入以降の秒数を足した値になります。 SECONDS を unset すると、この変数の特殊な性質はなくなります。後で再び set しても元には戻りません。

SHELLOPTS

コロン区切りのリストで、有効になっているシェルのオプションを示します。 リスト中のそれぞれの単語は、組み込みコマンド set の -o オプション (後述の シェルの組み込みコマンド を参照) に対する有効な引き数になっています。 SHELLOPTS に入っているオプションは、set -o を実行した場合にも on であると報告されます。 この変数が bash の起動時に環境変数に入っていた場合、 どの初期化ファイルを読むよりも前にリスト中のシェルオプションが有効になります。 この変数は読み込み専用です。

SHLVL

bash が起動するときに、環境変数で渡された値から 1 増やした値が 設定されます。

UID

現在のユーザのユーザ ID に展開されます。 初期化はシェルの起動時に行われます。 この変数は読み込み専用です。

以下の変数はシェルが使用します。場合によっては、 bash がデフォルト値を変数に代入します。 そのような場合についてはそれぞれ注記します。

BASH_ENV

bash がシェルスクリプトを実行するときにこの値が設定されている場合、 この値は (~/.bashrc のように) シェルを初期化するコマンドが書かれているファイル名と解釈されます。 BASH_ENV の値をファイル名として処理する前には、パラメータ展開、コマンド置換、 算術的展開が行われます。 この結果のファイルを検索する際には PATH は使用されません。

BASH_XTRACEFD

有効なファイル・ディスクリプターに対応する整数をセットすると、 bash は set -x が設定されたときに、生成されたトレース出力を そのファイル・ディスクリプターに出力します。 BASH_XTRACEFD が unset されるか、新しい値が代入されると、 それまで設定されていたファイル・ディスクリプターはクローズされます。 BASH_XTRACEFD を unset するか空文字列を代入すると、 トレース出力は標準エラー出力に送られます。 BASH_XTRACEFD に 2 (標準エラー出力のファイル・ディスクリプター) を設定してしまうと、 unset したときに標準エラー出力がクローズされてしまうことに 注意してください。

CDPATH

cd コマンドの検索パスです。これは、 cd コマンドで指定した対象ディレクトリを探すディレクトリを コロンで区切って並べたリストです。 例えば、 ".:~:/usr" といった値になります。

COLUMNS

組み込みコマンド select によって、選択されたリストを表示する際の端末幅の決定に用いられます。 SIGWINCH を受信すると自動的に設定されます。

COMPREPLY

bash が可能な補完候補を読み込む配列変数です。 この値はプログラム補完機能 (後述の プログラム補完 を参照) によって呼び出されたシェル関数によって生成されます。

EMACS

bash が起動したときにこの環境変数が設定されて値が "t", になっていると、Emacs のシェルバッファで動作しているとみなし、 行編集を無効にします。

ENV

BASH_ENV と類似の変数で、POSIX モードで使われます。

FCEDIT

組み込みコマンド fc が使うデフォルトのエディタです。

FIGNORE

ファイル名補完 (後述の READLINE を参照) を行う際に無視するサフィックスを コロンで区切って並べたリストです。 FIGNORE のエントリのいずれかにサフィックスがマッチするファイル名は、 ファイル名補完にマッチするファイルのリストから除外されます。 例えば値として ".o:~" を設定します。

FUNCNEST

0 より大きい数値を設定すると、関数呼び出しを何重まで許すかの 最大レベルを決めます。 このレベルを超えて関数を呼び出すと、コマンドが異常終了します。

GLOBIGNORE

パス名展開で無視するファイル名の集合を定義するパターンを コロンで区切って並べたリストです。 パス名展開パターンにマッチするファイル名が GLOBIGNORE 内のパターンのどれかにもマッチする場合、 マッチしたもののリストから削除されます。

HISTCONTROL

履歴リストに入れるコマンドを制御する値をコロンで区切って並べたリストです。 ignorespace の値が設定されていると、 空白 文字で始まる行は履歴リストに入りません。 ignoredups の値が設定されていると、 履歴の最後の行にマッチする行は履歴リストに入りません。 ignoreboth を指定すると ignorespace と ignoredups の両方が指定されます。 erasedups の値が設定されていると、行が保存される前に、 現在の行に一致する過去の行が履歴リストから削除されます。 上記以外の値を設定しても無視されます。 HISTCONTROL が設定されていない場合や、不正な値が設定されている場合には、 シェルのパーザが読み込んだ全ての行は HISTIGNORE の値が示す条件の下で履歴リストに保存されます。 複数行にまたがる複合コマンドの場合は 2 番目以降の行が調べられることはありません。よって、これらは HISTCONTROL の値に関わらず履歴に追加されます。

HISTFILE

コマンド履歴が保存されるファイルの名前 (後述の 履歴 を参照)。デフォルト値は ~/.bash_history です。 設定されていない場合、 対話シェルが終了するときに履歴の保存が行われません。

HISTFILESIZE

履歴ファイルに保持する履歴の最大数です。この変数に値が代入された場合、 その行数を越えないように、必要に応じて古いエントリを削除して履歴ファイルを 切り詰めます。 デフォルト値は 500 です。対話シェルが終了するときにも、 履歴ファイルのサイズはファイル書き込みの後にこのサイズに切り詰められます。

HISTIGNORE

どのコマンド行を履歴リストに保存するかを決めるために使うパターンを コロンで区切って並べたリストです。 それぞれのパターンは行の先頭から比較され、 行全体と完全に一致しなければなりません (`*' が暗黙的に追加されるこ とはありません)。行に対する各パターンの評価は HISTCONTROL で指定したチェックが行われた後で実行されます。 通常のシェルのパターンマッチング文字以外に、 `&' が履歴の前の行にマッチします。 バックスラッシュを使って `&' をエスケープできます。 マッチングを試みる前にバックスラッシュは取り除かれます。 複数行にまたがる複合コマンドの場合、2 番目以降の行は調べられません。 よって、これらは HISTIGNORE の値に関わらず履歴に追加されます。

HISTSIZE

コマンド履歴に記憶するコマンドの数 (後述の HISTORY を参照)。 デフォルトは 500 です。

HISTTIMEFORMAT

この変数に空でない値が設定されると、 組み込みコマンド history で履歴エントリを表示するときに タイムスタンプを表示するための strftime(3) の書式文字列 として使われます。 この変数が設定されると、ほかのシェルのセッションでも使えるように タイムスタンプは履歴ファイルに書き込まれます。 タイムスタンプはほかの履歴行と区別するために履歴のコメントとなります。

HOME

現在のユーザのホームディレクトリです。 組み込みコマンド cd のデフォルトの引き数になります。 この変数の値は、チルダ展開を実行するときにも使われます。

HOSTFILE

/etc/hosts と同じフォーマットであり、 シェルがホスト名を補完する必要があるときに読み込むファイルの名前を示します。 シェルの実行中でも補完するホスト名のリストを変更できます。 この変数が変更された次の機会にホスト名の補完を試みるとき、 bash は新しいファイルの内容を既存のデータベースに追加します。 HOSTFILE が設定されているがその値が空文字列の場合や、 読み込めるファイルの名前ではない場合には、 bash は補完可能なホスト名のリストを取得するために /etc/hosts を使用します。 HOSTFILE が unset された場合は、ホスト名のリストはクリアされます。

IFS

内部フィールド区切り文字 (Internal Field Separator) です。展開を行った後に単語を分割する場合や、組み込みコマンドの read を使ったときに行を単語に分割する場合に使われます。 デフォルト値は “<空白><タブ><改行>” です。

IGNOREEOF

単独で入力された EOF 文字を受け取ったときの対話シェルの動作を制御します。 この変数が設定されていれば、指定されている値の数だけの EOF 文字を連続して行頭の文字として入力しなければ bash は終了しません。この変数に数値以外の値が設定されている場合や、 空の値が設定されている場合には、デフォルト値として 10 が使われます。 この変数が存在しなければ、 EOF 文字はシェルへの入力の終わりを示します。

INPUTRC

readline の起動ファイルのファイル名です。これはデフォルト値の ~/.inputrc (後述の READLINE を参照) を上書きします。

LANG

ロケールカテゴリが LC_ で始まる変数によって明示的に指定されて いない場合、そうしたカテゴリのロケールを決定するのに使用されます。

LC_ALL

この変数はロケールカテゴリを指定する LC_ 変数と LANG の値に優先します。

LC_COLLATE

この変数はパス名展開の結果をソートするときに使用される照合順序と、 パス名展開とパターンマッチングにおける 範囲表現、等値クラス、照合順序の動作を決定します。

LC_CTYPE

この変数は、パス名展開とパターンマッチングにおける 文字の解釈と文字クラスに含まれる文字を決めます。

LC_MESSAGES

この変数は、$ の後に続くダブルクォートされた文字列の 翻訳に使うロケールを決めます。

LC_NUMERIC

この変数は数字のフォーマットに使用するロケールカテゴリを決定します。

LINES

組み込みコマンド select によって、選択されたリストを表示する際の行数の決定に用いられます。 SIGWINCH を受信すると自動的に設定されます。

MAIL

このパラメータにファイル名またはディレクトリ名が設定されており、かつ変数 MAILPATH が設定されていなければ、 bash は指定されたファイルまたはMaildier形式のディレクトリへの メールの到着をユーザに通知します。

MAILCHECK

bash がメールをチェックする頻度を (秒数で) 指定します。 デフォルト値は 60 秒です。 メールをチェックする時間になると、 シェルはプライマリのプロンプトを表示する前にチェックを行います。 この変数が unset された場合、 あるいはこの変数に 0 以上の数値以外が代入された場合は、 シェルはメールのチェックを行いません。

MAILPATH

メールのチェックに使うファイル名をコロンで区切って並べたリストです。 特定のファイルにメールが到着したときに出力される メッセージは、`?' を使ってファイル名をメッセージから区切ることによって 指定できます。メッセージのテキスト中で使われたときは、 $_ は現在のメールファイルの名前に展開されます。 設定例:

OPTERR

値として 1 が設定されている場合、 bash は組み込みコマンド getopts (後述の シェルの組み込みコマンド を参照) を使って生成したエラーメッセージを表示します。 シェルが起動されたり、シェルスクリプトが実行されたりするたびに、 OPTERR は 1 に初期化されます。

PATH

コマンドの検索パスです。 シェルがコマンドを検索するディレクトリをコロンで区切って並べたリストです (後述の コマンドの実行 を参照)。 PATH 中の長さ 0 の (空の) ディレクトリ名は、カレントディレクトリを示します。 空のディレクトリ名は、2 つのコロンを並べるか、 先頭や末尾のコロンで表します。 デフォルトのパスはシステム依存で、 bash をインストールしたシステム管理者が設定します。 一般的な値は ``/usr/gnu/bin:/usr/local/bin:/usr/ucb:/bin:/usr/bin'' です。

POSIXLY_CORRECT

bash が起動したときにこの環境変数が設定されていると、 起動オプション --posix を指定したときと同じように、どの初期化ファイルを読むよりも前に シェルが posix モード になります。 シェルの実行中にこの変数が設定されると、 bash は set -o posix コマンドを実行したときと同じように、posix モード が有効になります。

PROMPT_COMMAND

設定されていると、プライマリプロンプトを出す前に毎回、 この値がコマンドとして実行されます。

PROMPT_DIRTRIM

0 より大きい値が設定されると、 プロンプト文字列のエスケープシーケンス \w や \W (後述の プロンプト を参照) を展開するときに、ディレクトリがパス名の最後からこの数だけ残ります。 削られた部分は省略記号に置き換えられます。

PS1

このパラメータの値は展開されてプライマリのプロンプト文字列として使われます。 (後述の プロンプト を参照)、 デフォルト値は “\s-\v\$ ” です。

PS2

このパラメータの値は PS1 と同じように展開され、セカンダリのプロンプト文字列として使われます。 デフォルト値は “> ” です。

PS3

このパラメータの値は select コマンド (前述の シェルの文法 を参照) のプロンプトとして使われます。

PS4

このパラメータは PS1 と同じように展開されます。この値は実行トレース中に bash が表示する各コマンド前に出力されます。 複数段の間接レベル (levels of indirection) を示すときは、 PS4 の最初の文字が必要に応じて複数回表示されます。 デフォルト値は “+ ” です。

SHELL

この環境変数にシェルのフルパス名が保存されています。 シェルを起動したときに設定されていない場合は、 bash が現在のユーザのログインシェルのフルパス名を代入します。

TIMEFORMAT

このパラメータの値は、予約語である time が先頭に付いているパイプラインに対して、 時間情報の表示の仕方を指定するフォーマット文字列として使われます。 % は、時間の値などに展開される エスケープシーケンスを示すための文字です。 エスケープシーケンスとその意味を以下に示します。 ただし、ブレース ([]) は省略可能であることを表しま す。

p 省略可能で、精度 (precision) が何桁であるかを指定します。 つまり小数点以下の桁数を指定します。この値が 0 ならば、 小数点や小数の部分は出力されません。 また、小数点以下で指定できるのは 3 桁までです。 つまり、p の値が 3 より大きければ 3 に変更されます。 p を指定しなければ、この値は 3 となります。

l は省略可能ですが、指定すると、分を含み、 MMmSS.FF という形式の長いフォーマットになります。 小数を含むかどうかは p の値によって決まります。

この変数が設定されていなければ、 bash は $'\nreal\t%3lR\nuser\t%3lU\nsys%3lS' という値が指定されているかのように動作します。 この値が空文字列ならば、時間の情報は表示されません。 フォーマット文字列の表示の際には、末尾に改行文字が追加されます。

TMOUT

0 より大きい値を設定すると、 TMOUT の値が組み込みコマンド read のデフォルトのタイムアウト値となります。 select コマンドは、端末からの入力の際に TMOUT 秒入力がないと終了します。 対話シェルではこの値は、プライマリのプロンプトを出してから 入力を待つ秒数として解釈されます この秒数待って入力が来ないと、 bash は終了します

TMPDIR

設定すると、値を bash がシェル用にテンポラリファイルを作る ディレクトリ名として使います。

auto_resume

この変数は、ユーザがジョブ制御をするときの方法を変更します。 この変数を設定した場合、1 語からなるリダイレクトなしの単純なコマンドを 入力すると、停止中のジョブの実行再開候補として扱われます。 曖昧な指定は許されず、入力された文字列で始まるジョブが複数ある場合には、 最後にアクセスされたものが選ばれます。 停止中のジョブの 名前 とは、コマンドを起動する際に使ったコマンドラインのことです。 この変数の値に exact が設定されている場合、 与えられた文字列は停止中のジョブの名前に 正確にマッチしなければなりません。 substring が設定されている場合は、 与えられた文字列は停止中のジョブの名前の部分文字列に マッチする必要があります。 substring という値は、ジョブ識別子の %? に似た機能を持っています (後述の ジョブ制御 を参照)。 これ以外の値が設定されている場合、 与えられた文字列は停止中のジョブの名前の 先頭部分でなければなりません。これはジョブ識別子の %string と似た機能を持っています。

histchars

2 文字または 3 文字で、 履歴の展開とトークン分割 (後述の 履歴の展開 を参照) を制御します。 最初の文字は 履歴展開 (history expansion) 文字であり、 履歴展開の先頭を示す文字です。通常、これは `!' です。 2 番目の文字は 簡易置換 (quick substitution) 文字であり、直前に入力したコマンドの文字列を 別の文字列に置き換えて再実行するための省略表現として使います。 デフォルト値は `^' です。 3 番目の文字は省略可能です。単語の先頭でこの文字が見つかると、 行の残りの部分がコメントとなるような文字を指定します。 これは通常は `#' です。 履歴コメント文字があると、 その行の残りの単語に対する履歴置換はスキップされます。 この文字があるからといって、 必ずしもシェルのパーザが行の残りの部分をコメントとして扱うわけではありません。

配列¶

bash は 1 次元のインデックスによる配列と連想配列の変数を扱うことができます。 全ての変数は配列として使用できます。 declare 組み込みコマンドを使えば、明示的に配列を宣言できます。 配列のサイズの上限はありませんし、 メンバのインデックス付けや代入を 連続的にしなければならないという条件もありません。 インデックスによる配列は整数 (算術式を含む) で参照します。 インデックスは 0 から始まります。 連想配列は任意の文字列で参照します。

変数の代入の際に name[subscript]=value という記法が使われた場合、配列は自動的に生成されます。 subscript は算術式として扱われますが、この式は評価すると 数値になるものでなければなりません。 subscript を評価すると 0 未満の数になる場合、最大のインデックス +1 からのオフセットとして扱われます。つまり、subscript が -1 のときは、配列の最後の要素を参照します。 インデックスによる配列を明示的に宣言するには、 declare -a name を使います (後述の シェルの組み込みコマンド を参照)。 declare -a name[subscript] も許されます。このとき subscript は無視されます。

連想配列は declare -A name で作ります。

組み込みコマンドの declare と readonly を使うと、配列変数に対して属性を設定できます。 どの属性も配列のメンバ全てに対して適用されます。

配列の代入は name=(value1 ... valuen) という形式の複合代入 (compound assignment) を用いて行います。 ここでそれぞれの value の形式は [subscript]=string です。 インデックスによる配列では、ブラケット ([]) と subscript は省略できます。 ブラケットと subscript を省略しなかった場合、 そのインデックスに対して代入が行われます。 省略した場合には、代入される要素のインデックスは、 その文の中で直前に代入されたインデックスに 1 を加えたものになります。 インデックスは 0 から始まります。

連想配列への代入では、subscript は省略できません。

この記法は組み込みコマンド declare でも使えます。個別の配列要素に対する代入は、先に説明した name[subscript]=value の記法を使って行います。

配列の任意の要素は、${name[subscript]} を使って参照できます。 パス名展開との衝突を避けるためにブレースが必要です。 subscript が @ か * ならば、配列の参照は name の全ての要素に展開されます。この 2 つの添字が異なるのは、 単語がダブルクォートの内部にある場合だけです。 単語がダブルクォートされていれば、${name[*]} は 1 つの単語に展開されます。 この単語は、配列の各メンバの値を特殊変数 IFS の最初の値で区切って並べたものです。一方、${name[@]} は、 name の各要素を別々の単語に展開します。 配列のメンバが全くないときは、${name[@]} は空の単語に展開されます。 単語の中でダブルクォートの展開が行われるときには、 元の単語のダブルクォートより前の部分の後に 最初のパラメータの展開結果がつながり、 最後のパラメータの展開結果の後に 元の単語のダブルクォートより後の部分がつながります。 これは特殊パラメータ * や @ の展開に似ています (前述の 特殊パラメータ を参照)。 ${#name[subscript]} は ${name[subscript]} の長さに展開されます。 subscript が * または @ の場合は、 配列中の要素数に展開されます。添字なしで配列変数を参照すると、 0 番目の要素を参照したことになります。

配列変数は subscript に対して値が代入されていれば 設定されているとみなされます。 空文字列は有効な値です。

組み込みコマンドの unset は配列の削除に使われます。unset name[subscript] とすると、インデックスが subscript である配列の要素が削除されます。 パス名展開による意図しない副作用に注意してください。 unset name (name は配列) または unset name[subscript] (subscript が * または @) とすると、 配列全体が削除されます。

組み込みコマンドの declare, local, readonly いずれにおいても、 -a オプションでインデックスによる配列を指定できます。 -A また、オプションで連想配列を指定できます。 両方が指定されたときには、 -A が優先します。 組み込みコマンド read では、 -a オプションを使えば標準入力から読み込んだ単語のリストを 配列に代入できます。 組み込みコマンド set と declare では、別の変数への代入に再利用できるような形で配列の値を表示します。

ブレース展開¶

ブレース展開 (brace expansion) を使うと、任意の文字列を生成できます。この仕組みは パス名展開に似ていますが、 生成されたファイル名が実在する必要はありません。 ブレース展開されるパターンは、 前置部分 (preamble: 省略可能)、 対になるブレースで囲んだコンマ区切りの文字列またはシーケンス式、 後置部分 (postscript: 省略可能) を順に並べたものです。 前置部分はブレース内にある文字列それぞれの先頭部分に追加され、 後置部分は左から右に順に展開されて得られた それぞれの文字列の末尾に追加されます。

ブレース展開は入れ子にできます。 展開して得られた文字列はソートされず、 左から右への順番がそのまま残ります。 例えば a{d,c,b}e は `ade ace abe' と展開されます。

シーケンス式は {x..y[..incr]} の形になります。x と y は整数または 1 つの文字で、 省略可能な incr は増減分の整数です。 整数が与えられると、 x と y の間の両端を含む数を全て列挙した形に展開されます。 与る整数の前に 0 を付けると、全ての項が同じ幅に揃えられます。 つまり、x か y のどちらかが 0 で始まる場合、生成される全ての項が 同じ文字数になるように、必要であれば前に 0 が付けられます。 文字が与えられると 辞書順で x と y の間の両端を含む文字を全て列挙した形に展開されます。 x と y は同じ型である必要があります。 incr が与えられると、その値が各項の間の差となります。 incr のデフォルトは、1 または -1 のうち適切な方です。

ブレース展開はほかのどの展開よりも前に実行されます。 また、ほかの展開において特殊な意味を持つ文字もそのまま結果に残ります。 つまり、厳密にテキスト操作だけを行います。 bash は、展開の文脈やブレースの間のテキストに対して 文法的な解釈を適用することは一切ありません。

正しい形のブレース展開には、クォートされていない開きブレースと 閉じブレース、そしてシーケンス式か少なくとも 1 つのクォートされていないコンマが 含まれていなければなりません。正しい形でないブレース展開は全て、 変更されないでそのまま残ります。 { や , をバックスラッシュでクォートすれば、 ブレース展開の一部と解釈されないようにできます。 パラメータ展開との衝突を避けるため、文字列 ${ はブレース展開の対象とは解釈されません。

この仕組みは、 生成される文字列の共通先頭部分が上記の例より長い場合に、 短縮表現としてよく使用されます:

ブレース展開の導入によって、伝統的な sh とは少し非互換になった部分があります。 sh は単語の一部として開きブレースや閉じブレースが現われても特別扱いはせず、 そのまま出力に残します。 bash はブレース展開の結果として単語からブレースを取り除きます。例えば sh に file{1,2} のように入力された単語はそのままの形で出力されますが、 bash ではこの同じ単語は展開されて file1 file2 のように出力されます。 厳密に sh と互換にしたければ、 bash を +B オプションを付けて起動するか、 set コマンドに +B オプションを与えてブレース展開を無効にしてください (後述する シェル組み込みコマンド を参照)。

チルダ展開¶

クォートされていないチルダ (`~') で単語が始まった場合、 クォートされていないスラッシュよりも前にある文字全て (クォートされていないスラッシュが無ければ全ての文字) はチルダプレフィックス (tilde-prefix) と解釈されます。 クォートされている文字がチルダプレフィックス中に無ければ、 チルダプレフィックス中のチルダ以降の文字は、 ログイン名 (login name) になるかもしれない文字列として扱われます。 このログイン名が空文字列ならば、チルダはシェルパラメータ HOME の値に置き換えられます。 HOME が設定されていない場合は、代わりにシェルを実行しているユーザの ホームディレクトリに置き換えられます。 ログイン名が空でなければ、 チルダプレフィックスは指定されたログイン名に対応する ホームディレクトリに置き換えられます。

チルダプレフィックスが `~+' ならば、チルダプレフィックスはシェル変数 PWD の値に置き換えられます。 チルダプレフィックスが `~-' ならば、シェル変数 OLDPWD の値に置き換えられます (値が設定されていれば)。 チルダプレフィックス中のチルダより後の文字が数値 N であれば (数値の前に `+' や `-' を置くこともできます)、 チルダプレフィックスはディレクトリスタック内の対応する要素に置換されます。 置換される要素は、チルダプレフィックスを引き数として組み込みコマンド dirs を実行したときに表示されるものです。 チルダプレフィックスにおけるチルダ以降の文字が、 先行する `+' や `-' のない数値である場合は、`+' であるとみなされます。

ログイン名が有効でない場合や、チルダ展開が失敗した場合には、 単語は置き換えられません。

全ての変数代入において、 : や = の直後にクォートされていないチルダプレフィックスがないかチェックが行われます。 もし見つかった場合にはこれらもチルダ展開されます。 したがって、 PATH, MAILPATH, CDPATH への代入にチルダを含むファイル名を使えば、 シェルは展開された値を代入します。

パラメータの展開¶

`$' 文字があると、パラメータ展開、コマンド置換、 算術式展開が行われます。展開されるパラメータ名やシンボルは、 ブレースで括ることもできます。 ブレースは省略可能ですが、 変数の直後に変数名の一部と解釈できる文字が置かれた場合に、 その文字と共に変数が展開されてしまうのを防ぐために用意されています。

ブレースを使った場合、対になるのは最初に表れる `}' です。 ただしバックスラッシュでエスケープされているものや クォートされている文字列中のものは含まれませんし、ブレースの内側にある 算術式展開やコマンド置換、パラメータ展開に入っているものも含まれません。

${parameter}

parameter の値に置換されます。ブレースが必要になるのは、 parameter が 2 桁以上の数字を持つ位置パラメータの場合や、 parameter の直後の文字を名前の一部として解釈させたくない場合です。

parameter の最初の文字が感嘆符ならば、変数間接展開が行われます。 bash は残りの parameter からなる変数の値を変数の名前と見なします。 そしてそこで得られた名前の変数を展開した値を、置換処理の続きで使います。 これが 間接展開 です。 ただし ${!prefix*} や ${!name[@]} の展開は例外です。 これは以下で説明します。 間接展開を表すには、感嘆符は左ブレースの直後に続ける必要があります。

以下に示すそれぞれの場合、word に対してチルダ展開、 パラメータ展開、コマンド置換、算術式展開が行われます。

部分文字列展開以外の場合、以下の形式で、 bash はパラメータが設定されているか、空ではないかを調べます。 コロンを省略した場合には設定されているかどうかのみを調べます。

${parameter:-word}

デフォルトの値を使います。 parameter が設定されていないか空文字列であれば、 word を展開したものに置換されます。そうでなければ、 parameter の値に置換されます。

${parameter:=word}

デフォルトの値を代入します。 parameter が設定されていないか空文字列であれば、 word を展開したものが parameter に代入されます。それから parameter の値への置換が行われます。 位置パラメータや特殊パラメータへの代入をこのように行うことはできません。

${parameter:?word}

空文字列または設定されていない場合にエラーを表示します。 parameter が空文字列または設定されていない場合、word を展開したもの (word がなければ パラメータが空文字列または設定されていないことを示すメッセージ) が標準エラー出力に出力されます。シェルが対話的でなければ、 シェルは終了します。パラメータに空文字列以外が設定されていれば、 parameter の値への置換が行われます。

${parameter:+word}

別の値を使用します。 parameter が空文字列または設定されていなければ、空文字列に置換されます。 そうでなければ word を展開したものに置換されます。

${parameter:offset}

${parameter:offset:length}

部分文字列展開。 parameter を展開したものから最大 length 文字を取り出します。 先頭の文字は offset で指定します。length を省略すると、 offset で指定した文字を先頭にして、 parameter の残り全部が含まれる部分文字列に展開します。 length と offset は算術式です (後述の 算術式評価 を参照)。 offset を評価すると 0 未満の数になる場合、この値は parameter の値の末尾からのオフセットとして使われます。 length を評価すると 0 未満の数になる場合、 parameter が @ ではなく、配列でも連想配列でもなければ、 この値は文字数ではなく parameter の値の末尾からのオフセットとして使われ、 展開結果は 2 つのオフセットの間の部分文字列となります。 parameter が @ ならば、結果は offset から始まる length 個の位置パラメータになります。 parameter が @ または * のインデックスが付いている配列名ならば、 結果は配列の ${parameter[offset]} を先頭とする要素 length 個となります。 負の offset は、指定された配列の最大のインデックス + 1 からの相対値と解釈されます。 連想配列に部分文字列展開した場合の結果は決められていません。 負のオフセットを指定するときには、:- 式と混同されないよう、 1 つ以上の空白でコロンと離す必要があることに注意してください。 位置パラメータを使う場合以外は、 部分文字列のインデックスは 0 から始まります。位置パラメータの場合には、 インデックスは 1 から始まります。 位置パラメータが使われて offset が 0 の場合、 $0 の値が先頭に置かれます。

${!prefix*}

${!prefix@}

前方一致する変数名。 prefix で始まる全ての変数の名前に展開して、 IFS 特殊変数の最初の文字によって区切ります。 ダブルクォートの中で @ が使われた場合、それぞれの変数の名前は 別々の単語に展開されます。

${!name[@]}

${!name[*]}

配列のキーのリスト。 name が配列変数であれば、配列 name の インデックス (キー) のリストに展開されます。 name が配列でない場合は、name が設定されていれば 0 に、 そうでなければ空に展開されます。 ダブルクォートの中で @ が使われた場合、それぞれのキーは 別々の単語に展開されます。

${#parameter}

パラメータの長さ。 parameter の値に含まれる文字数に置換されます。 parameter が * または @ ならば、位置パラメータの数に置換されます。 parameter が * または @ が添字になっている配列名ならば、配列中の要素数に置換されます。

${parameter#word}

${parameter##word}

パターンに前方一致した部分を取り除く。 word が展開され、パス名展開の場合と同じようなパターンを作ります。 このパターンが parameter の値の先頭部分とマッチする場合、展開して得られる値は parameter を展開した値から最短一致パターン (“#”の場合) または最長一致パターン (“##” の場合) を取り除いたものになります。 parameter が @ または * である場合、 パターンを削除する操作は全ての位置パラメータに順番に適用され、 展開結果はリストとして得られます。 parameter が @ または * が添字になっている配列変数である場合、 パターンを削除する操作は配列の全ての要素に順番に適用され、 展開結果はリストとして得られます。

${parameter%word}

${parameter%%word}

パターンに後方一致した部分を取り除く。 word が展開され、パス名展開の場合と同じようなパターンを作ります。 このパターンが parameter を展開した値の末尾の部分とマッチする場合、展開結果は parameter を展開した値から最短一致パターン (“%” の場合) または最長一致パターン (“%%” の場合) を取り除いたものになります。 parameter が @ または * である場合、 パターンを削除する操作は全ての位置パラメータに順番に適用され、 展開結果はリストとして得られます。 parameter が @ または * が添字になっている配列変数である場合、 パターンを削除する操作は配列の全ての要素に順番に適用され、 展開結果はリストとして得られます。

${parameter/pattern/string}

パターンの置換。 pattern が展開され、 パス名展開の場合と同じようなパターンを作ります。 parameter の展開が行われ、 その値のうち pattern に最長一致する部分が string に置換されます。 pattern が / で始まる場合には、pattern に マッチした部分は全て string に置換されます。 そうでない場合には、最初にマッチした部分だけが置換されます。 pattern が # で始まる場合には、パターンは parameter を展開した値の先頭にマッチしなければなりません。 pattern が % で始まる場合には、パターンは parameter を展開した値の末尾にマッチしなければなりません。 string が空の場合には pattern にマッチした部分は削除されます。 またこの場合には、pattern の後に続く / は省略可能です。 parameter が @ または * である場合、置換操作は全ての位置パラメータに順番に適用され、 展開結果はリストとして得られます。 parameter が @ または * が添字になっている配列変数である場合、 置換操作は配列の全ての要素に順番に適用され、 展開結果はリストとして得られます。

${parameter^pattern}

${parameter^^pattern}

${parameter,pattern}

${parameter,,pattern}

大文字小文字の変換。 parameter に含まれるアルファベットの大文字小文字を変換します。 pattern が展開され、 パス名展開の場合と同じようなパターンを作ります。 ^ 演算子は pattern にマッチした小文字を大文字に変換します。 , 演算子は pattern にマッチした大文字を小文字に変換します。 ^^ 演算子と ,, 演算子は、マッチした全ての文字を変換します。 ^ 演算子と , 演算子の場合は、マッチした最初の文字だけ変換します。 pattern を省略した場合、? を指定したものとして扱われ、 全ての文字にマッチします。 parameter が @ または * である場合、大文字小文字の変換は全ての位置パラメータに順番に適用され、 展開結果はリストとして得られます。 parameter が添字に @ または * の付いた配列変数の場合は、配列の要素のそれぞれに大文字小文字の変換が適用され、 結果はリストに展開されます。

コマンド置換¶

コマンド置換 (command substitution) を用いると、 コマンド名をコマンドの出力で置き換えられます。 コマンド置換には以下の 2 つの形式があります:

bash は command を実行し、 command の標準出力でコマンド置換の部分を置き換えます。 この際、末尾の改行文字は削除されます。 文字列の途中にある改行文字は削除されませんが、 単語分割の際に削除されることがあります。 コマンド置換 $(cat file) は、同じ意味を持ち、 しかも高速な $(< file) に置き換え可能です。

バッククォートを使う古い形式の置換を用いたとき、 バックスラッシュは文字通りの意味を保ちますが、 $, `, \ の前にある場合は例外となります。 コマンド置換は、バックスラッシュが前置されていない バッククォートまでの部分です。 $(command) という形式を用いたときは、 括弧の間にある全ての文字がコマンドとなります。 特別扱いされる文字はありません。

コマンド置換は入れ子にできます。 バッククォート形式のときに入れ子を行うには、 内側のバッククォートをバックスラッシュでエスケープします。

置換がダブルクォート内部にある場合には、 置換の結果に対する単語分割とパス名展開は行われません。

算術式展開¶

算術式展開を使うと、算術式を評価して、その結果に置換できます。 算術式展開のフォーマットを次に示します:

expression はダブルクォート内部にある場合と同様に扱われますが、 括弧の内側のダブルクォートが特別扱いされることはありません。 式に含まれる全てのトークンに対して、 パラメータ展開・文字列展開・コマンド置換・クォートの削除が行われます。 算術式置換は入れ子にできます。

評価は後述の 算術式評価 で示す規則に基づいて行われます。 expression が不正であれば、 bash は評価の失敗を示すメッセージを出力し、置換を全く行いません。

プロセス置換¶

プロセス置換 (process substitution) がサポートされるのは、 名前付きパイプ (FIFO) または ファイル・ディスクリプターの /dev/fd 形式での指定 をサポートしているシステムです。これは <(list) または >(list) の形になります。 プロセス list は、その入力や出力が FIFO または /dev/fd 中の 何らかのファイルに接続された状態で実行されます。 このファイルの名前は、展開の結果として、 引き数の形で現在のコマンドに渡されます。 >(list) の形式を使った場合、 ファイルへの書き込みは list への入力となります。 <(list) の形式を使った場合、 引き数として渡されたファイルは list の出力を得るために読み込まれます。

利用可能であれば、プロセス置換 (process substitution) は、 パラメータ展開、変数展開、コマンド置換、算術式展開と同時に行われます。

単語の分割¶

パラメータ展開、コマンド置換、算術式展開が行われたのが、ダブル クォートの内側ではない場合、シェルは展開の結果をスキャンして、 単語分割 を行います。

シェルは IFS のそれぞれの文字を区切り文字として扱い、 ほかの展開の結果をこれらの文字によって単語に分割します。 IFS が設定されていないか、その値がデフォルト値の <スペース><タブ><改行> と全く同じならば、前段の展開の結果の先頭や末尾の <スペース>, <タブ>, <改行> の並びは無視され、 先頭と末尾以外の IFS 文字の並びで単語が区切られます。 IFS の値がデフォルト以外のときに、 スペース や タブ という空白文字の並びが単語の先頭と末尾で無視されるのは、 その空白文字が IFS の値に含まれるとき ( IFS の空白文字の一つであるとき) だけです。 IFS に含まれ、 IFS 空白文字ではない文字は全て、隣接する任意の IFS 空白文字と一緒になってフィールドの区切りとなります。 IFS 空白文字の列も区切り文字として扱われます。 IFS の値が空文字列であれば、単語分割は全く行われません。

明示的に指定した空の引き数 ("" または '') は削除されずに残ります。 クォートされていない暗黙的な空の引き数が、 値を持たないパラメータを展開した結果として得られますが、 これらは削除されます。 値を持たないパラメータがダブルクォート内部で展開されると、 空である引き数となり、消されずに残ります。

展開が行われなければ単語分割も行われない点に注意してください。

パス名展開¶

-f オプションが指定されていなければ、単語分割を行った後に bash はそれぞれの単語が *, ?, [ を含んでいるかどうか調べます。 これらの文字のいずれかが見つかると、その単語は パターン とみなされ、 パターンにマッチするファイル名を アルファベット順にソートしたリストに置換されます。 マッチするファイル名が見つからず、かつシェルのオプション nullglob が無効ならば、その単語は変更されずにそのまま残ります。 nullglob オプションが設定されていて、かつマッチするファイル名が見つからなければ、 その単語は削除されます。 failglob オプションが設定されていて、かつマッチするファイル名が見つからなければ、 エラーメッセージが表示されコマンドは実行されません。 シェルのオプション nocaseglob が有効ならば、マッチングにおいてアルファベットの大文字と小文字は区別さ れません。 パターンをパス名展開に使うとき、名前の先頭やスラッシュの直後の “.” は明示的にマッチさせなければなりません。ただしシェルのオプション dotglob が設定されている場合は例外です。 パス名のマッチングを行うとき、 スラッシュ文字は必ず明示的にマッチさせなければなりません。 これ以外の場合には、 “.” が特別扱いされることはありません。 シェルのオプション nocaseglob, nullglob, failglob, dotglob の詳しい説明については、後述の シェルの組み込みコマンド に書かれている shopt の説明を参照してください。

シェル変数 GLOBIGNORE を使って、 パターン にマッチするファイル名の集合を制限できます。 GLOBIGNORE が設定されていれば、マッチするファイル名のうち GLOBIGNORE 中のパターンにもマッチしたものは、 マッチしたもののリストから取り除かれます。 ファイル名 “.” と “..” は GLOBIGNORE に空でない値が設定されていても必ず無視されます。しかし、 GLOBIGNORE に空でない値を設定するとシェルオプションの dotglob が有効になるので、 “.” で始まるほかのファイル名は全てマッチします。 “.” で始めるファイル名を無視する古い動作をさせるには、 “.*” を GLOBIGNORE のパターンに含めてください。 GLOBIGNORE を unset すると、 dotglob オプションは無効になります。

パターンマッチング

パターンに含まれる文字のうち、以下の特殊パターン文字以外の文字は、 自分自身にマッチします。NUL 文字がパターン中に現われてはいけません。 バックスラッシュは直後の文字をエスケープします。 このバックスラッシュは、マッチングでは無視されます 特殊パターン文字をその文字そのものにマッチさせるためには、 クォートしなければなりません。

特殊パターン文字は以下の意味を持っています:

組み込みコマンドの shopt を使ってシェルのオプション extglob が有効にされていると、 拡張パターンマッチング演算子がいくつか認識されるようになります。 以下の説明では、pattern-list は | で区切られた 1 つ以上のパターンのリストであるものとします。 以下のサブパターンを 1 つあるいは複数使うことにより、 複合パターンを作れます。

クォートの削除¶

先に処理される展開の後、クォートされていない \, ', " のうち、先の展開の結果でないものは全て削除されます。

入力のリダイレクト¶

入力をリダイレクトすると、 word を展開した結果の名前を持つファイルがオープンされ、 ファイル・ディスクリプター n で読み込めるようになります。 n が指定されていなければ、読み込みは標準入力 (ファイル・ディスクリプター 0) で行われます。

入力のリダイレクトは、一般的には以下の形式です:

出力のリダイレクト¶

出力をリダイレクトすると、 word の展開した結果の名前を持つファイルがオープンされ、 ファイル・ディスクリプター n で書き込めるようになります。 n が指定されていなければ、書き込みは標準出力 (ファイル・ディスクリプター 1) に行われます。 ファイルが存在しなかった場合は作成されます。 ファイルが存在した場合はサイズ 0 に切り詰められます。

出力のリダイレクトは、一般的には以下の形式です:

リダイレクト演算子が > であり、かつ 組み込みコマンド set で noclobber オプションが有効になっている場合、 word の展開で得たファイルが存在し、 かつそれが通常ファイルならば、リダイレクトは失敗します。 リダイレクト演算子が >| の場合、もしくは リダイレクト演算子が > で組み込みコマンド set で noclobber オプションが有効になっていない場合、 word という名前のファイルが存在していてもリダイレクトが試みられます。

リダイレクトによる追加出力¶

この形式を使って出力のリダイレクトを行うと、 word を展開した結果の名前を持つファイルがオープンされ、 ファイル・ディスクリプター n に対する出力がこのファイルに追加されるようになります。 n を指定しなければ、標準出力 (ファイル・ディスクリプター 1) で追加されます。 ファイルが存在しなければ、新しく作られます。

追加出力は一般的には以下の形式です:

標準出力と標準エラー出力のリダイレクト¶

この構造を使うと、 標準出力 (ファイル・ディスクリプター 1) と標準エラー出力 (ファイル・ディスクリプター 2) の両方を、 word を展開した結果の名前を持つファイルにリダイレクトできます。

標準出力と標準エラー出力に対する形式は 2 つあります:

両者のうち望ましいのは前者の方です。 上記は以下と同じ意味です:

標準出力と標準エラー出力の追加出力¶

この構造を使うと、 標準出力 (ファイル・ディスクリプター 1) と標準エラー出力 (ファイル・ディスクリプター 2) の両方を、 word を展開した結果の名前を持つファイルに追加できます。

標準出力と標準エラー出力の追加出力は以下の形式です:

これは次のものと同じ意味です:

ヒアドキュメント(Here Documents)¶

この形式のリダイレクトを用いると、 シェルは現在のソースから入力を読み込みます。 この読み込みは word を単独で含む行 (末尾にブランク文字があってはいけません) が現われるまで続きます。 その行までに読み込んだ行は、 コマンドの標準入力として扱われます。

ヒアドキュメントの形式を以下に示します:

<<[-]word


        here-document
delimiter

word に対するパラメータ展開・コマンド置換・算術式展開・ パス名展開は全く行われません。 word が一部でもクォートされている場合は、 delimiter は word のクォートをほどいた結果 (クォート文字を削除した結果) となり、 ヒアドキュメントに含まれる行では展開が行われなくなります。 word がクォートされていなければ、 ヒアドキュメント中の全ての行に対して パラメータ展開・コマンド置換・算術式展開が行われます。 word がクォートされていない場合には、 \<newline> という文字列は無視され、 \, $, ` といった文字は \ を用いてクォートしなければなりません。

リダイレクト演算子が <<- ならば、行頭にあるタブ文字は全て入力行および delimiter を含む行から取り除かれます。 これにより、シェルスクリプト中のヒアドキュメントを 自然な形でインデントさせることができます。

ヒアストリング(Here Strings)¶

ヒアドキュメントの変形で、以下の形式です:

<<<word

word は展開されてコマンドの標準入力に与えられます。

ファイル・ディスクリプターの複製¶

リダイレクト演算子

を使うと入力ファイル・ディスクリプターを複製できます。 word が 1 桁以上の数値に展開された場合、 n で示されるファイル・ディスクリプターが生成され、 word で指定された数値のファイル・ディスクリプターのコピーとなります。 word に含まれる数値が入力用にオープンされたファイル・ディスクリプターを 指していない場合、リダイレクト・エラーが起きます。 word を評価した結果が - となった場合、ファイル・ディスクリプター n はクローズされます。 n が指定されていない場合、標準入力 (ファイル・ディスクリプター 0) が使われます。

同様に、演算子

を使って出力ファイル・ディスクリプターを複製できます。 n が指定されていない場合は、標準出力 (ファイル・ディスクリプター 1) が使われます。 word に含まれる数値が、出力用にオープンされた ファイル・ディスクリプターを指していない場合、 リダイレクト・エラーが起きます。特別な場合ですが、 n が省略され、かつ word が 1 桁以上の数字には展開されなかった場合、 前に説明したように標準出力と標準エラー出力がリダイレクトされます。

ファイル・ディスクリプターの変更¶

リダイレクト演算子

を使うと、ファイル・ディスクリプターの digit を n に変更します。 n が指定されていない場合は、標準入力 (ファイル・ディスクリプター 0) が使われます。 digit は n に複製された後にクローズされます。

同様に、演算子

を使うと、ファイル・ディスクリプターの digit を n に変更します。 n が指定されていない場合は、標準出力 (ファイル・ディスクリプター 1) が使われます。

読み書きのためのファイル・ディスクリプターのオープン¶

リダイレクト演算子

を使うと、 word を展開した結果の名前を持つファイルがファイル・ディスクリプター n での読み書きのためにオープンされます。 n が指定されていなければ、 ファイル・ディスクリプター 0 で読み書きが行われます。 ファイルが存在しなければ、新しく生成されます。

Readline の記法¶

このセクションでは、emacs 形式の記法を使ってキーストロークを表します。 コントロールキーは C-key で表します (例: C-n は Control-N の意味です)。同様に メタ キーは M-key で表すので、M-x は Meta-X を表すことになります。 (メタ キーがないキーボードでは、M-x は ESC x を表します。つまり、 エスケープキーを押した後に x キーを押します。これは ESC を メタプレフィックス (meta prefix) にする操作です。 M-C-x の組み合わせは、ESC-Control-x つまり、エスケープキーを押した後に、コントロールキーを押したまま x を押すことを意味します。)

Readline のコマンドには数値の 引き数 を指定できます。通常これは繰り返しの回数として作用します。 ただし、場合によっては、引き数の符号が意味を持つこともあります。 順方向に作用するコマンド (例: kill-line) に負の引き数を渡すと、 コマンドは逆方向に作用します。 引き数を指定した場合の動作がこの説明と異なるコマンドについては後で説明します。

コマンドがテキストをキル (kill) すると説明されているときは、 削除されたテキストは、 後で取り出せる (ヤンク (yank) できる) ように保存されます。 キルされたテキストは、キルリング (kill ring) に保存されます。 連続してキルを行うと、テキストは 1 つのまとまりとして保存されるので、 全部を一度にヤンクできます。テキストをキルしないコマンドが挟まると、 キルリング上のテキストが分離されます。

Readline の初期化¶

readline をカスタマイズするには、 コマンドを初期化ファイル (inputrc ファイル) に追加します。 このファイルの名前は、変数 INPUTRC の値から決まります。 この変数が設定されていない場合のデフォルト値は ~/.inputrc です。 readline ライブラリを使うプログラムが起動する際には、 この初期化ファイルが読み込まれ、キー割り当てと変数が設定されます。 readline の初期化ファイル中で使用できる基本的構文は、 以下のように少ししかありません。 空行は無視されます。 # で始まる行はコメントです。 $ で始まる行は条件文です。 それ以外の行はキー割り当てと変数の設定です。

デフォルトのキー割り当ては inputrc ファイルで変更できます。 このライブラリを使う他のプログラムからも、 独自のコマンドとキー割り当てを追加できます。

例えば、

以下に示すシンボル名を使うことができます: RUBOUT, DEL, ESC, LFD, NEWLINE, RET, RETURN, SPC, SPACE, TAB。

readline では、キーにはコマンド名だけでなく文字列を割り当てることもでき、 その場合には、そのキーが押されると割り当てられた文字列が挿入されます (マクロ)。

Readline のキー割り当て¶

inputrc ファイルにおける制御キーの割り当て方は単純です。 必要なものは、コマンド名あるいはマクロの文字列と、 これらが割り当てられるキーシーケンスだけです。 名前は 2 通りの方法で指定できます。 つまり、シンボリックなキーの名前 (たいていは、Meta- や Control- プレフィックスと組み合わせて使われる) による指定と、 キーシーケンスによる指定です。

「keyname:function-name」あるいは 「keyname:macro」の形式を使うときには、 keyname は英語で書き下したキーの名前となります。例を以下に示します:

この例では、 C-u が universal-argument に、 M-DEL が backward-kill-word に割り当てられます。 また、 C-o はマクロの実行に割り当てられ、右辺値に展開されます (つまり、テキスト ``> output'' が編集行に挿入されます)。

後者の形式である「"keyseq":function-name」または 「"keyseq":macro」においては、 keyseq は先程の keyname とは異なり、 ダブルクォートで括ってキーシーケンス全体を示す文字列を表記しています。 以下の例で示すように、GNU Emacs 形式のキーエスケープの一部を使えます。 ただしシンボリックな文字名は認識されません。

この例でも、 C-u が universal-argument 機能に割り当てられています。 C-x C-r は re-read-init-file 機能に割り当てられ、 ESC [ 1 1 ~ は ``Function Key 1'' という文字列の挿入に割り当てられています。

GNU Emacs 形式のエスケープシーケンスを以下に全て示します:

GNU Emacs 形式のエスケープシーケンスに加えて、 別形式のバックスラッシュエスケープも使えます:

マクロのテキストを入力する際には、マクロ定義を示すために シングルクォートやダブルクォートを使わなければなりません。 クォートされていないテキストは関数名とみなされます。 マクロ本体では、前述のバックスラッシュによるエスケープは展開されます。 バックスラッシュはマクロのテキスト内の他の文字を全てエスケープします。 これには " や ' も含まれます。

bash では、組み込みコマンドの bind を使って、readline の現在の キー割り当ての表示と変更を行えます。 また、組み込みコマンド set に対して -o オプションを使えば、編集モードを対話的利用の途中に切り替え可能です (後述の シェルの組み込みコマンド を参照)。

Readline の変数¶

Readline には、動作を細かくカスタマイズするために変数があります。 変数は inputrc ファイル中に

という形式の文で設定できます。 特に断らない限り、readline の変数がとる値は On か Off のいずれかです。大文字と小文字の違いは考慮しません。 認識できない変数名は無視されます。 変数の値を読み取るとき、設定されてない場合や、空文字列、"on" (大文字と小文字は区別しない)、"1" は On とみなされます。それ以外の値は Off とみなされます。 変数とそのデフォルト値を以下に示します:

bell-style (audible)

readline が端末のベルを鳴らそうとしたときの動作を制御します。 none が設定されている場合は、readline はベルを鳴らしません。 visible が設定されている場合には、可能であれば可視ベル (visible bell) が用いられます。audible が設定されている場合には、 readline は端末のベルを鳴らそうとします。

bind-tty-special-chars (On)

On が設定されていると、 カーネルの端末ドライバによって特別扱いされるコントロール文字の機能の代わりに readline の同等の機能を割り当てようとします。

comment-begin (“#”)

readline の insert-comment コマンドが実行されたときに挿入される文字列です。 このコマンドは emacs モードでは M-# に割り当てられ、vi コマンドモードでは # に割り当てられます。

completion-ignore-case (Off)

On が設定されていると、 readline がファイル名のマッチングと補完を行う際に 大文字と小文字が区別されません。

completion-prefix-display-length (0)

補完候補のリストでそのまま表示される共通先頭部分の文字数。 0 より大きい値が設定されると、補完候補を表示するときに、 この値より長い共通先頭部分は省略記号で置き換えられます

completion-query-items (100)

possible-completions コマンドが生成した補完候補の数が、 いくつを越えると表示の可否をユーザに問い合わせるのかを決めます。 この変数には 0 以上の任意の整数を設定できます。 補完の候補数がこの変数の値以上の場合には、 ユーザに対して候補を表示するかどうかの問い合わせがなされます。 そうでない場合には、単に端末に補完の候補がリスト表示されます。

convert-meta (On)

On を設定すると、readline は 8 番目のビットがセットされている文字を ASCII のキーシーケンスに変換します。 変換は、8 番目のビットを落として、 エスケープ文字を前に追加することによって行います (実際にはエスケープ文字をメタプレフィックスとして用います)。

disable-completion (Off)

On を設定すると、readline は単語の補完を行わなくなります。 補完される文字の編集行への挿入は、 その文字を self-insert に割り当てたかのように行われます。

editing-mode (emacs)

readline の起動時に emacs と vi のどちらに似たキー割り当てを使うのかを制御します。 editing-mode には emacs と vi のいずれかを指定できます。

echo-control-characters (On)

On が設定されていると、サポートしている OS では、 キーボード操作でシグナルが起こされたときに相当する文字を画面に出力します。

enable-keypad (Off)

On を設定すると、 readline は呼び出されたときにアプリケーションキーパッドを有効にしようとします。 一部のシステムでは、矢印キーを使うためにこれを有効にする必要があります。

enable-meta-key (On)

On が設定されていると、 readline は端末がサポートを要求するメタ修飾キーを有効にしようとします。 多くの端末では、メタキーは 8 ビット文字を送信するのに使われます。

expand-tilde (Off)

On を設定すると、 readline が単語の補完を試みるときにチルダ展開が行われます。

history-preserve-point (Off)

On が設定されていると、 previous-history や next-history で履歴行を取り出したときに、 ポイントを行内の同じ位置に置こうとします。

history-size (0)

履歴リストに保存する履歴エントリの最大数を設定する。 0 が設定されていると、履歴リストのエントリの数は制限されません。

horizontal-scroll-mode (Off)

On が設定されていると、readline は表示の際に 1 行しか 使わないようになります。つまり、行がスクリーンの幅より長くなると、 新しい行に折り返すのではなく、1 つの入力行の中で横にスクロールします。

input-meta (Off)

On が設定されていると、readline は 8 ビットの入力が可能になりま す(つまり、読み込んだ文字の再上位ビットを落としません)。この動作は、端 末のサポートとは無関係に行われます。 meta-flag という名前は、この変数の別名です。

isearch-terminators (“C-[C-J”)

インクリメンタル検索を終了させる文字からなる文字列です (終了後にその文字がコマンドとして実行されることもありません)。 この変数に値が設定されていなければ、 ESC と C-J でインクリメンタル検索が終わります。

keymap (emacs)

現在の readline のキーマップを設定します。 有効なキーマップ名は、 emacs, emacs-standard, emacs-meta, emacs-ctlx, vi, vi-command, .IR vi-insert です。vi は vi-command と等価で、emacs は emacs-standard と等価です。 デフォルト値は emacs です。 editing-mode の値もデフォルトキーマップに影響を与えます。

mark-directories (On)

On が設定されていると、 補完されたディレクトリ名の末尾にスラッシュが追加されます。

mark-modified-lines (Off)

On が設定されていると、履歴行を表示する際に、 以前に変更されたものの先頭にアスタリスク (*) を付けて表示します。

mark-symlinked-directories (Off)

On が設定されていると、 ディレクトリへのシンボリックリンクが補完されたときに、 (mark-directories が有効であれば) 名前の末尾にスラッシュが追加されます。

match-hidden-files (On)

On が設定されていると、 ファイル名の補完で `.' で始まる名前のファイル (隠しファイル) にもマッチします。 Off が設定されているときには、`.' で始まる名前のファイルを 補完するには先頭の `.' をユーザが入力する必要があります。

menu-complete-display-prefix (Off)

On が設定されていると、 メニュー補完 (menu completion) で補完候補のリスト (空の場合も含む) を順番に表示する前に、共通先頭部分を表示します。

output-meta (Off)

On が設定されていると、 readline は 8 番目のビットが立っている文字を直接表示します。 メタ文字を前置したエスケープシーケンスでの表示は行いません。

page-completions (On)

On が設定されていると、 一度に一画面分の補完候補を表示するために readline は組み込みの more 風ページャを使います。

print-completions-horizontally (Off)

On が設定されていると、 readline は補完でマッチするものをアルファベット順にして、 縦方向ではなく横方向に並べて表示します。

revert-all-at-newline (Off)

On が設定されていると、 accept-line が実行されて readline から戻るときに、 履歴に加えられた全ての変更を元に戻します。 デフォルトでは、readline の各呼び出しを通じて 履歴行が変更され単一のアンドゥリストが保持されます。

show-all-if-ambiguous (Off)

これは補完機能のデフォルトの挙動を変えます。 On が設定されている場合、単語に対する補完候補が複数個あると、 ベルは鳴らされずに、マッチするものが即座にリスト表示されます。

show-all-if-unmodified (Off)

これは show-all-if-ambiguous と同様に 補完機能のデフォルトの挙動を変えます。 On が設定されている場合、単語に対する補完候補が複数個あって、 部分的な補完ができない (補完候補が共通先頭部分を持たない) と、 マッチするものが即座にリスト表示されます。 ベルは鳴らされません。

skip-completed-text (Off)

On が設定されていると、 これは補完機能がマッチしたものを行に挿入するときのデフォルトの挙動を変えます。 単語の途中で補完を実行したときにだけ意味があります。 有効になっていると、readline は、単語のカーソル以後の部分が重複しないように、 補完された単語のうちポイント以後の文字を挿入しません。

visible-stats (Off)

On が設定されていると、 stat(2) で得られるファイルの種類を表す文字が、 補完候補のリスト表示の際に追加されます。

Readline の条件構文¶

Readline には、 C 言語のプリプロセッサの条件付きコンパイル機能と 似たコンセプトに基づく機能が実装されています。 これを使うと、条件に応じてキー割り当てや変数の設定を実行できます。 パーザディレクティブは 4 つあります。

$if

$if 構文を使うと、編集モードや使用中の端末、 readline を使っているアプリケーションに応じた割り当てを行えます。 行末までの全テキストが評価対象となります。 これを分離するには文字は必要ありません。

$if Bash
# Quote the current or previous word
"\C-xq": "\eb\"\ef\""
$endif

$endif

このコマンドは $if コマンドを終了させます (上記の例の通り)。

$else

$if ディレクティブのこの分岐内に書かれたコマンドは、 評価が失敗したときに実行されます。

$include

このディレクティブはファイル名 1 つを引き数に取り、 そのファイルからコマンドとキー割り当てを読み込みます。 例えば以下のディレクティブを使うと /etc/inputrc が読み込まれます:

$include  /etc/inputrc

検索¶

readline には、指定した文字列を含む行をコマンド履歴内から探すコマンド が用意されています (後述の 履歴 を参照)。 検索のモードには、 インクリメンタル (incremental) モードと 非インクリメンタル (non-incremental) モードの 2 つがあります。

インクリメンタル検索では、 ユーザが検索文字列全体の入力が終わるより前に検索が開始されます。 検索文字列に文字が追加されるたびに、 readline はそれまでに入力した文字列にマッチする履歴から 次のエントリを表示します。 インクリメンタル検索では、探している履歴エントリを見つけるために 必要な数の文字を入力すれば十分です。 isearch-terminators の値に含まれる文字を入力すると、 インクリメンタル検索は終了します。 この変数に値が代入されていない場合には、エスケープ文字または Control-J でインクリメンタル検索が終了します。 Control-G はインクリメンタル検索を異常終了させ、元の行を復元します。 検索が終了すると、検索文字列を含む履歴エントリが現在の行になります。

マッチした他の履歴リストのエントリを見つけるには、Control-S または Control-R を適宜入力します。これにより、 今まで入力した検索文字列にマッチする次のエントリを 履歴の前方または後方に向かって探します。 readline に割り当てられた他のキーシーケンスを入力すると検索が終わり、 入力したキーシーケンスに対応するコマンドが実行されます。 例えば、改行は検索を終了させて、その行を入力します。 これにより、履歴リスト中のコマンドが実行されます。

readline は前回のインクリメンタル検索で入力された 検索文字列を覚えています。 新しい検索文字を間に挟まずに Control-R を 2 回入力すると、 覚えている検索文字列が使われます。

インクリメンタルでない検索の場合には、検索文字列全体を読み込んでから、 履歴行にマッチするものの検索を始めます。 検索文字列には、ユーザが入力したものか、現在の行の内容の一部が使えます。

Readline のコマンド名¶

以下は、 コマンドの名前およびそれらが割り当てられている デフォルトのキーシーケンスの一覧です。 対応するキーシーケンスがないコマンド名には、 デフォルトではキーは割り当てられていません。 以下の説明では、ポイント (point) は現在のカーソルの位置を表し、 マーク (mark) は set-mark コマンドによって保存されたカーソル位置を表します。 ポイントとマークの間のテキストは、リージョン (region) と呼びます。

移動コマンド¶

beginning-of-line (C-a)

現在の行の先頭に移動します。

end-of-line (C-e)

行の末尾に移動します。

forward-char (C-f)

1 文字進みます。

backward-char (C-b)

1 文字戻ります。

forward-word (M-f)

次の単語の最後に進みます。単語は英数字 (英字と数字) からなります。

backward-word (M-b)

現在あるいは直前の単語の先頭に戻ります。 単語は英数字 (英字と数字) からなります。

shell-forward-word

次の単語の最後に進みます。 単語はクォートされていないシェルのメタ文字で区切られます。

shell-backward-word

現在の単語あるいは前の単語の先頭に戻ります。 単語はクォートされていないシェルのメタ文字で区切られます。

clear-screen (C-l)

現在の行を画面の一番上の行に残したまま、画面をクリアします。 引き数を付けると、画面をクリアせずに現在の行を再描画します。

redraw-current-line

現在の行を再描画します。

履歴操作のためのコマンド¶

accept-line (Newline, Return)

カーソルの位置に関わらず、行を確定します。この行が空でなければ、変数 HISTCONTROL の状態に従って、これが履歴リストに追加されます。 行が履歴リストを変更したものならば、履歴行は元の状態に戻されます。

previous-history (C-p)

履歴リストを戻り、履歴リストから前の行を取り出します。

next-history (C-n)

履歴リストを進み、履歴リストから次の行を取り出します。

beginning-of-history (M-<)

履歴の最初の行に移動します。

end-of-history (M->)

入力履歴の最後に移動します。つまり、現在入力中の行に移動します。

reverse-search-history (C-r)

現在の行を開始点にして後方に向かって検索を行い、 必要に応じて履歴を「遡って」いきます。これはインクリメンタル検索です。

forward-search-history (C-s)

現在の行を開始点にして前方に向かって検索を行い、 必要に応じて履歴を「下って」いきます。これはインクリメンタル検索です。

non-incremental-reverse-search-history (M-p)

現在の行を開始点にして、履歴リストを後方に向かって検索を行います。 ユーザが入力した文字列を非インクリメンタルモードで検索します。

non-incremental-forward-search-history (M-n)

現在の行を開始点にして、履歴リストを前方に向かって検索を行います。 ユーザが入力した文字列を非インクリメンタルモードで検索します。

history-search-forward

履歴を前方に向かって検索し、 現在の行の先頭とポイントの間の文字列を探します。 これは非インクリメンタル検索です。

history-search-backward

履歴を後方に向かって検索し、 現在の行の先頭およびポイントの間の文字列を探します。 これは非インクリメンタル検索です。

yank-nth-arg (M-C-y)

前のコマンドに対する最初の引き数 (通常は前の行の 2 番目の単語) をポイントに挿入します。引き数 n が付いていると、前のコマンドの n 番目の単語 (前のコマンドの単語は 0 から数えます)。 引き数が負ならば、前のコマンドの最後から n 番目の単語が挿入されます。 引き数 n が一度決まると、コマンドの引き数が履歴の展開での "!n" の指定のように展開されます。

yank-last-arg (M-., M-_)

前のコマンドの最後の引き数 (一つ前の履歴エントリの最後の単語) を挿入します。 引き数があると、yank-nth-arg と全く同じように動作します。 yank-last-arg を繰り返して呼び出すと、 履歴リストを遡って参照が行われ、 それぞれの行の最後の引き数が順番に挿入されます。 繰り返して呼び出すときの引き数は、履歴の中を動く方向を決めます。 負の引き数は、履歴の中を動く方向 (後方または前方) を反転します。 履歴の展開での "!$" の指定のように、 最後の引き数の展開に履歴の展開の機能が使われます。

shell-expand-line (M-C-e)

シェルが行うのと同じように行の展開を行います。 エイリアスや履歴の展開を含め、シェルの行う全ての単語展開が行われます。 履歴の展開の説明については、後述の 履歴の展開 を参照してください。

history-expand-line (M-^)

現在の行で履歴の展開を行います。 履歴の展開の説明については、後述の 履歴の展開 を参照してください。

magic-space

現在の行で履歴の展開を行い、空白を挿入します。 履歴の展開の説明については、後述の 履歴の展開 を参照してください。

alias-expand-line

現在の行でエイリアスの展開を行います。 エイリアスの展開の説明については、前述の エイリアス を参照してください。

history-and-alias-expand-line

現在の行で履歴とエイリアスの展開を行います。

insert-last-argument (M-., M-_)

yank-last-arg と同じものです。

operate-and-get-next (C-o)

現在の行を実行し、 履歴内の現在の行の次の行を編集用に取得します。 引き数は全て無視されます。

edit-and-execute-command (C-xC-e)

エディタを起動して現在のコマンドラインの内容を開き、 その結果をシェルのコマンドとして実行します。 bash はエディタとして $VISUAL, $EDITOR, emacs の順で起動を試みます。

テキスト編集のためのコマンド¶

delete-char (C-d)

ポイントの文字を削除します。 ポイントが行の先頭であり、その行に文字がなく、 さらに打ち込んだ最後の文字が delete-char に割り当てられていなければ、 EOF が返されます。

backward-delete-char (Rubout)

カーソルの前の文字を削除します。数値の引き数を与えると、 削除したテキストをキルリングに保存します。

forward-backward-delete-char

カーソルが行末になければカーソルがある位置の文字を削除します。 カーソルが行末にある場合には、カーソルの前の文字を削除します。

quoted-insert (C-q, C-v)

次に打ち込んだ文字をそのまま行に追加します。 これは C-q 等の文字を挿入するために使います。

tab-insert (C-v TAB)

タブ文字を挿入します。

self-insert (a, b, A, 1, !, ...)

打ち込んだ文字を挿入します。

transpose-chars (C-t)

ポイントの前にある文字を動かし、 現在ポイントがある文字の後ろに持っていきます。 同時にポイントも前に進みます。ポイントが行の最後にある場合は、 ポイントの前の 2 文字が交換されます。 負の引き数を指定すると、何も起こりません。

transpose-words (M-t)

ポイントの前にある単語を動かし、 ポイントの後ろにある単語の後ろに持っていきます。 この際には、ポイントも始めに前にあった単語の後ろまで移動します。 ポイントが行の最後にある場合は、行の最後の 2 単語が交換されます。

upcase-word (M-u)

現在の (または後ろの) 単語を大文字にします。 負の引き数を指定すると、前の単語を大文字にしますが、 ポイントは動きません。

downcase-word (M-l)

現在の (または後ろの) 単語を小文字にします。 負の引き数を指定すると、前の単語を小文字にしますが、 ポイントは動きません。

capitalize-word (M-c)

現在の (または後ろの) 単語をキャピタライズします (単語の先頭の文字を大文字にします)。 負の引き数を指定すると前の単語をキャピタライズしますが、 ポイントは動きません。

overwrite-mode

上書きモードをトグルさせます。 正の引き数を指定すると上書きモードに切り替えます。 負の引き数を指定すると挿入モードに切り替えます。 このコマンドは emacs モードでのみ有効です。 vi モードでは違った形で上書きします。 readline() を呼び出したときは毎回、挿入モードで始まります。 上書きモードでは、self-insert が割り当てられた文字は、 ポイントの位置のテキストを右に押し出すのではなく置き換えます。 backward-delete-char が割り当てられた文字は、 ポイントの前の文字をスペースで置き換えます。 このコマンドはデフォルトではキーに割り当てられていません。

キルとヤンク¶

kill-line (C-k)

ポイントから行末までのテキストをキルします。

backward-kill-line (C-x Rubout)

現在のカーソル位置から行頭までをキルします。

unix-line-discard (C-u)

ポイントから行頭までをキルします。 キルされたテキストはキルリング (kill-ring) に入ります。

kill-whole-line

現在の行の文字を全てキルします。ポイントの位置は関係ありません。

kill-word (M-d)

ポイントから現在の単語の終わりまでをキルします。 ポイントが単語と単語の間であれば、後ろの単語の終わりまでをキルします。 単語の境界は forward-word で使われているものと同じです。

backward-kill-word (M-Rubout)

ポイントの前にある単語をキルします。 単語の境界は backward-word で使われているものと同じです。

shell-kill-word (M-d)

ポイントから現在の単語の終わりまでをキルします。 ポイントが単語と単語の間であれば、後ろの単語の終わりまでをキルします。 単語の境界は shell-forward-word で使われているものと同じです。

shell-backward-kill-word (M-Rubout)

ポイントの前にある単語をキルします。 単語の境界は shell-backward-word で使われているものと同じです。

unix-word-rubout (C-w)

ポイントの前にある単語をキルします。 その際には空白を単語の境界として用います。 キルされたテキストはキルリングに入ります。

unix-filename-rubout

ポイントの前にある単語をキルします。 その際には空白とスラッシュを単語の境界として用います。 キルされたテキストはキルリングに入ります。

delete-horizontal-space (M-\)

ポイントの周りの空白とタブを全て削除します。

kill-region

現在のリージョン中のテキストをキルします。

copy-region-as-kill

リージョン中のテキストをキルバッファにコピーします。

copy-backward-word

ポイントの前の単語をキルバッファにコピーします。単語の境界は backward-word と同じです。

copy-forward-word

ポイントの後ろの単語をキルバッファにコピーします。単語の境界は forward-word と同じです。

yank (C-y)

キルリングの先頭のテキストをバッファ中のポイントにヤンクします。

yank-pop (M-y)

キルリングの順番を 1 つ移動し、新たに先頭になったテキストをヤンクします。 yank または yank-pop の後にしか使えません。

数値の引き数¶

digit-argument (M-0, M-1, ..., M--)

すでに入力された引き数にこの数字を追加するか、 またはこの数字によって新しい引き数を始めます。 M-- を使うと、負の値を指定できます。

universal-argument

引き数を指定する別の方法です。 このコマンドに続けて 1 つ以上の数字が入力された場合 (頭にマイナス記号を付けることもできます)、 これらの数字で引き数が定義されます。 このコマンドの後に数字が続いた場合、 universal-argument を再び実行すると数値の引き数を終了しますが、 そうでない場合は無視されます。 特殊なケースとして、 このコマンドの直後に数字でもマイナス記号でもない文字がある場合には、 次のコマンドに対する引き数カウントが 4 倍になります。 引き数カウントは最初は 1 なので、 この機能を一度実行すると引き数カウントは 4 になり、 もう一度実行すると引き数カウントは 16 になります。 それ以降も同様です。

補完¶

complete (TAB)

ポイントの前のテキストについて補完を試みます。 bash が補完を行う際には、 変数 (テキストが $ で始まる場合)、 ユーザ名 (テキストが ~ で始まる場合)、 ホスト名 (テキストが @ で始まる場合)、 コマンド (エイリアスや関数も含みます) の順序でマッチを行います。 いずれにもマッチしない場合には、 ファイル名補完を試みます。

possible-completions (M-?)

ポイントの前のテキストの補完候補を列挙します。

insert-completions (M-*)

ポイントの前のテキストを補完して得られるものを全て挿入します。 挿入されるものは、possible-completions で列挙されるものと同じです。

menu-complete

complete コマンドに似ていますが、 補完される単語を補完候補リストのうちの 1 つと置換します。 menu-complete を繰り返して実行すると、 補完候補のリストが次々と順番に挿入されます。 補完リストの最後まで来るとベルが (bell-style の設定に基づいて) 鳴らされ、元のテキストに戻ります。 引き数 n を指定すると、リスト中の位置が n 個進みます。 負の引き数を指定すると、リスト中を逆向きに戻れます。 このコマンドは TAB に割り当てることを意図して用意されたものですが、 デフォルトでは割り当ては行われていません。

menu-complete-backward

menu-complete コマンドに似ていますが、 menu-complete に負の引き数を与えたときのように、 補完候補のリストを逆向きに進みます。 このコマンドはデフォルトではキーに割り当てられていません。

delete-char-or-list

カーソルが行頭や行末に無ければ、カーソルの下の文字を削除します (delete-char と同様です)。 カーソルが行末にある場合は、 possible-completions と同じ動作をします。 このコマンドはデフォルトではキーに割り当てられていません。

complete-filename (M-/)

ポイントの前のテキストについてファイル名の補完を試みます。

possible-filename-completions (C-x /)

ポイントの前のテキストについて補完候補を列挙します。 テキストはファイル名として扱われます。

complete-username (M-~)

ポイントの前のテキストについて補完を試みます。 テキストはユーザ名として扱われます。

possible-username-completions (C-x ~)

ポイントの前のテキストについて補完候補を列挙します。 テキストはユーザ名として扱われます。

complete-variable (M-$)

ポイントの前のテキストについて補完を試みます。 テキストはシェル変数として扱われます。

possible-variable-completions (C-x $)

ポイントの前のテキストについて補完候補を列挙します。 テキストはシェル変数として扱われます。

complete-hostname (M-@)

ポイントの前のテキストについて補完を試みます。 テキストはホスト名として扱います。

possible-hostname-completions (C-x @)

ポイントの前のテキストについて補完候補を列挙します。 テキストはホスト名として扱います。

complete-command (M-!)

ポイントの前のテキストについて補完を試みます。 テキストはコマンド名として扱います。 コマンド補完の際にマッチングを試みる順序は、 エイリアス、予約語、シェル関数、シェルの組み込みコマンド、 実行ファイルです。

possible-command-completions (C-x !)

ポイントの前のテキストについて補完候補を列挙します。 テキストはコマンド名として扱います。

dynamic-complete-history (M-TAB)

ポイントの前のテキストについて補完を試みます。 履歴リストの各行に対してテキストの比較が行われ、 マッチしたものが補完の候補となります。

dabbrev-expand

ポイントの前のテキストについてメニュー補完を試みます。 履歴リストの各行に対してテキストの比較が行われ、 マッチしたものが補完の候補となります。

complete-into-braces (M-{)

ファイル名補完を実行し、補完候補のリストを挿入します。 シェルから利用可能なリストとなるように、 返される候補はブレースで括られます (前述の ブレース展開 を参照)。

キーボードマクロ¶

start-kbd-macro (C-x ()

現在のキーボードマクロに対して入力される文字列の保存を開始します。

end-kbd-macro (C-x ))

現在のキーボードマクロに対して入力された文字列の保存を終了し、 その定義を格納します。

call-last-kbd-macro (C-x e)

最後に定義されたキーボードマクロを再実行します。 マクロ内の各文字があたかもキーボードから入力されたかのように出力されます。

その他¶

re-read-init-file (C-x C-r)

inputrc ファイルの内容を読み込み、 このファイル中の割り当てや変数設定を取り込みます。

abort (C-g)

現在の編集行を捨て、端末のベルを鳴らします (動作は bell-style の設定に従います)。

do-uppercase-version (M-a, M-b, M-x, ...)

メタ文字と共に入力された文字 x が小文字であれば、 x に対応する大文字に割り当てられているコマンドを実行します。

prefix-meta (ESC)

次に入力される文字を、 メタ文字と共に入力されたことにします。 ESC f は Meta-f と同じ意味です。

undo (C-_, C-x C-u)

インクリメンタルアンドゥを行います。 履歴は行ごとに別々に記憶されています。

revert-line (M-r)

この行に対して行った変更を全て取り消します。 このコマンドは、行が初期状態に戻るまで undo コマンドを実行するようなものです。

tilde-expand (M-&)

現在の単語についてチルダ展開を実行します。

set-mark (C-@, M-<space>)

ポイントにマークを設定します。 数字の引き数が与えられた場合には、 マークはその位置に設定されます。

exchange-point-and-mark (C-x C-x)

ポイントをマークと入れ換えます。 保存されている位置が現在のカーソル位置になり、 古いカーソル位置がマークとして保存されます。

character-search (C-])

文字を 1 つ読み込み、 その文字が次に現われる場所にポイントを移動させます。 負のカウントを与えると、その文字が前に現われた場所を探します。

character-search-backward (M-C-])

文字を 1 つ読み込み、 その文字が前に現われた場所にポイントを移動させます。 負のカウントを与えると、その文字が次に現われる場所を探します。

skip-csi-sequence

Home や End などのキーに定義されるような複数キーからなるシーケンスを 使い切るだけの文字を読み込みます。 これらのシーケンスは、通常 ESC-[ で表されるコントロールシーケンス (CSI) で始まります。 このシーケンスが "\[" に割り当てられているとすると、 キーが明示的に readline のコマンドに割り当てられている場合を除き、 それらのシーケンスを生み出すキーは、 はぐれた文字を編集バッファに挿入されず、何もしません。 このコマンドはデフォルトではキーに割り当てられていませんが、 多くの場合 ESC-[ に割り当てられます。

insert-comment (M-#)

数字の引き数を指定しない場合、readline の comment-begin 変数の値が現在の行の先頭に挿入されます。 数字の引き数を指定すると、トグル状に動作します。 つまり、行の先頭の文字が comment-begin の値にマッチしない場合には、 その値が挿入されます。マッチする場合には、comment-begin の文字が行の先頭から削除されます。 いずれの場合も、改行が打ち込まれたのと同じように行の入力が完了します。 comment-begin のデフォルト値によって、 このコマンドは現在の行をシェルのコメントとします。 数字の引き数を指定したことでコメントの文字が削除されると、 行はシェルにより実行されます。

glob-complete-word (M-g)

ポイントの前の単語がパス名展開のパターンとして扱われます。 末尾に暗黙のアスタリスクが付いているものとみなされます。 このパターンを使って補完候補のファイル名のリストが生成されます。

glob-expand-word (C-x *)

ポイントの前の単語がパス名展開のパターンとして扱われ、 この単語と置き換えられる形でマッチするファイル名のリストが挿入されます。 数字の引き数を与えると、パス名展開の前に末尾にアスタリスクを追加します。

glob-list-expansions (C-x g)

glob-expand-word で生成されるのと同じ展開結果のリストが表示され、 行が再描画されます。 数字の引き数を与えると、パス名展開の前に末尾にアスタリスクを追加します。

dump-functions

全ての関数とそのキー割り当てを、 readline の出力ストリームに出力します。 数値の引き数を与えると、 出力は inputrc に書き込める形に整形されます。

dump-variables

全ての設定可能な readline の変数とその値を、 readline の出力ストリームに出力します。 数値の引き数を与えると、 出力は inputrc に書き込める形に整形されます。

dump-macros

マクロに割り当てられた readline のキーシーケンスと マクロが出力する文字列を全て出力します。 数値の引き数を与えると、 出力は inputrc に書き込める形に整形されます。

display-shell-version (C-x C-v)

現在実行している bash のバージョン情報を表示します。

プログラム補完¶

complete 組み込みコマンドで 補完仕様 (compspec) が定義されているコマンドに対して 引き数の単語補完が試みられると、 プログラム補完の機能が呼び出されます (組み込みコマンド complete については、後述する シェルの組み込みコマンド を参照)。

まず、コマンド名が特定されます。 コマンド名の単語が空文字列であれば (空の行の先頭で補完しようとしたとき)、 complete の -E オプションで定義された補完仕様が使われます。 そのコマンドに対して補完仕様が定義されていれば、 その補完仕様がその単語の補完候補のリスト生成に使われます。 コマンドの単語がフルパス名であれば、 最初にフルパス名の補完仕様が検索されます。 フルパス名に対する補完仕様が見つからなかった場合は、 最後のスラッシュ以降の部分に対して該当する補完仕様を見つけようとします。 補完仕様が見つからなかった場合は、 complete の -D オプションで定義された補完仕様が使われます。

補完仕様が見つかると、その補完仕様を使って マッチする単語のリストが生成されます。 補完仕様が見つからなかった場合は、 前述の 補完 の節で説明したような bash のデフォルトの補完が行われます。

まず、補完仕様で指定された動作が用いられます。 補完される単語の前置部分にマッチするものだけが返されます。 ファイル名やディレクトリ名の補完に -f や -d オプションが使用された場合は、シェル変数 FIGNORE がマッチのフィルタとして使用されます。

続いて -G オプションによって指定された ファイル名展開パターンの補完が生成されます。 パターンによって生成された単語は、 補完される単語とマッチする必要はありません。 GLOBIGNORE シェル変数はマッチのフィルタとしては使われませんが、 FIGNORE 変数は使用されます。

次に、 -W オプションで指定された引き数の文字列が考慮されます。 文字列は、最初に IFS 特殊変数の文字を区切り文字として分割されます。 シェルのクォート処理は考慮されます。 それぞれの単語は、前述の 展開 で示したように、ブレース展開、チルダ展開、パラメータと変数の展開、 コマンド置換、算術式展開、パス名展開が行われます。 結果は、前述の単語の分割で示した規則によって分割されます。 展開の結果は補完される単語の前置部分とマッチが行われ、 マッチした単語が補完候補となります。

これらのマッチが生成された後、 シェル関数や -F や -C オプションで指定されたコマンドが呼び出されます。 コマンドや関数が呼び出されるときは、 COMP_LINE, COMP_POINT, COMP_KEY, COMP_TYPE 変数に前述のシェル変数で示すように値が設定されます。 シェル関数が呼び出される場合は、 COMP_WORDS と COMP_CWORD 変数も設定されます。 関数やコマンドが呼び出されるときは、 最初の引き数は引き数が補完されるコマンドの名前、 二番目の引き数は補完される単語、 三番目の引き数は現在のコマンドラインで補完中の単語の 前に置かれる単語となります。 補完される単語に対して生成された補完の候補はフィルタリングされません。 関数やコマンドは生成されたマッチとは無関係に補完されます。

-F で指定された関数がまず呼び出されます。 関数は、後述する compgen 組み込みコマンドを含めた、 全てのシェルの機能を使ってマッチを生成します。 補完候補は必ず COMPREPLY 配列変数に格納されます。

続いて -C オプションで指定されたコマンドが呼び出され、 環境変数をコマンド置換します。 このコマンドは、補完候補を 1 行にひとつずつ標準出力に出力します。 必要があれば、バックスラッシュが改行をエスケープするために使用されます。

全ての補完候補が生成された後で、 -X オプションで指定されたフィルタが補完候補に作用します。 フィルタは、パス名展開で使用されたようなパターンです。パターン中の & は補完される単語に置換されます。 文字通りの & はバックスラッシュでエスケープします。 バックスラッシュはマッチを試みる前に削除されます。 パターンにマッチした補完は候補から削除されます。 先行する ! はパターンを否定します。 この場合、パターンにマッチしなかった補完が削除されます。

最後に、-P と -S オプションで指定された 前置部分と後置部分が補完候補のそれぞれに加えられます。 そして結果が readline 補完コードに補完候補のリストとして返されます。

直前に行われた動作が何にもマッチせず、 補完仕様が定義されたときに -o dirnames オプションが complete に与えられていれば、 ディレクトリ名への補完が試みられます。

補完仕様が定義されたときに -o plusdirs オプションが complete に与えられていれば、 ディレクトリ名への補完が試みられ、マッチした候補が全て ほかの動作の結果に付け加えられます。

デフォルトでは、補完仕様が見つかった場合、 それが生成したものがなんであれ、 全ての補完候補のリストとして、補完コードに返されます。 デフォルトの bash 補完は試みられず、 readline のデフォルトのファイル名補完は無効になります。 補完仕様が定義されたときに -o bashdefault オプションが complete に与えられていれば、 補完仕様が何にもマッチしなければ bash のデフォルトの補完が試みられます。 補完仕様が定義されたときに -o default オプションが complete に与えられていれば、 補完仕様が (試みられていれば、デフォルトの bash の補完も) 何にもマッチしなければ readline のデフォルトの補完が行われます。

補完仕様でディレクトリ名の補完が必要とされる場合、 プログラム補完の関数は readline に、 ディレクトリへのシンボリックリンクに補完された名前の最後に スラッシュを追加させます。 これは readline の変数mark-symlinked-directories の設定に関わらず、 readline の変数 mark-directories の値に左右されます。

動的に補完を変えるための方法があります。 これは complete -D で指定されたデフォルトの補完と 組み合わせたときに非常に便利です。 補完の処理のために実行されたシェル関数は、終了ステータスとして 124 を返すことで、補完を再度試みることを指示できます。 シェル関数が 124 を返し、補完が試みられるコマンド (関数が実行されるときの第 1 引き数) に対して定義された補完仕様が 変更されていれば、プログラム補完はコマンドの新しい補完仕様を 探すために最初からやり直されます。 これにより一連の補完が、一度に読み込まれるのではなく、 補完が試みられるときに動的に組み立てられます。

例えば、補完仕様のライブラリがあり、それぞれがコマンドの名前に 合わせたファイルに保存されていると仮定すると、 以下のデフォルトの補完関数は補完を動的に読み込みます。

_completion_loader()
{
. "/etc/bash_completion.d/$1.sh" >/dev/null 2>&1 && return 124
}
complete -D -F _completion_loader

イベント指示子 (Event Designator)¶

イベント指示子は、 履歴リスト中のコマンドラインエントリを参照するものです。 絶対位置の参照でない限り、イベントは履歴リスト内の 現在の位置からの相対的な位置を示します。

!

履歴置換を開始します。ただし、 ブランク文字、 改行文字、 = 、 ( (シェルオプション extglob が組み込みコマンド shopt によって有効になっている場合) のいずれかが後に続く場合は除きます。

!n

n 個目のコマンドラインを参照します。

!-n

現在から n 個前のコマンドを参照します。

!!

直前のコマンドを参照します。`!-1' と同義です。

!string

string で始まるコマンドのうち、履歴リスト中の現在位置以前で、 一番近いところで実行したものを参照します。

!?string[?]

string を含むコマンドのうち、履歴リスト中の現在位置以前で、 一番近いところで実行したものを参照します。 string の直後が改行文字ならば、最後の ? は省略してもかまいません。

^string1^string2^

簡易置換。 string1 を string2 に置換して直前のコマンドを繰り返します。 “!!:s/string1/string2/” と同義です (後述の修飾子を参照)。

!#

これまでに打ち込んだコマンドライン全体。

単語指示子 (Word Designators)¶

単語指示子 (word designator) は、 イベントから所望の欲しい単語を選ぶときに用いられます。 イベント指定と単語指示子のセパレータには : を用います。 単語指示子が ^, $, *, -, % のいずれかで始まる場合には、このセパレータは省略できます。 単語には行の先頭から順に番号が振られ、 先頭の単語が 0 になります。 単語は現在の行に、空白 1 つで区切られて挿入されます。

0 (ゼロ)

0 番目の単語。シェルにとっては、コマンドを表す単語になります。

n

n 番目の単語。

^

最初の引き数。つまり 1 番目の単語です。

$

最後の引き数。

%

`?string?' 検索にマッチする、一番現在に近い単語。

x-y

単語の範囲。`0-y' の省略形として `-y' が使えます。

*

0 番目を除く全ての単語。これは `1-$' の別表現です。 イベント中に単語が 1 つしかない場合に * を使ってもエラーにはなりません。 この場合には空文字列が返されます。

x*

x-$ の省略形です。

x-

x* と同様に x-$ の省略形ですが、 ただし最後の単語は含みません。

イベント指定なしに単語指示子が与えられた場合、 直前のコマンドがイベントとして使われます。

修飾子 (Modifiers)¶

単語指示子 (省略可能) の後には、 1 個以上の以下に示す修飾子を並べて置くことができます。 それぞれの修飾子の前には `:' を付けます。

h

パス名から末尾にある部分 (ファイル名) を取り除き、 前の方 (ディレクトリ部) だけを残します。

t

パス名から前の方 (ディレクトリ部) を取り除き、 末尾にある部分 (ファイル名) だけを残します。

r

末尾にある .xxx 形式のサフィックスを取り除き、 ベース名 (basename) だけを残します。

e

末尾のサフィックスだけを残して、全ての部分を取り除きます。

p

新しいコマンドを表示しますが、実行はしません。

q

置換が行われた単語をクォートし、それ以上の置換が行われないようにします。

x

q と同じように置換後の単語をクォートしますが、 空白文字 と改行文字のところで単語に分割します。

s/old/new/

イベント行で最初に現われた old を new に置き換えます。/ の代わりに任意の区切り文字を使うこともできます。 最後の区切り文字がイベント行の最後の文字ならば、 これは省略できます。 バックスラッシュ 1 つでクォートすれば、 old と new の中で区切り文字も使えます。 new に & が含まれている場合には、 & は old に置き換えられます。 バックスラッシュ 1 つを前に置けば & をクォートできます。 old が空文字列ならば、最後に置換された old が設定されます。 以前に履歴置換が全く行われていない場合には、現在に一番近い !?string[?] の検索で使われた string が設定されます。

&

直前の置換を繰り返します。

g

変更をイベント行全体に適用します。 これは `:s' (例:`:gs/old/new/') や `:&' と組み合わせて使われます。 `:s' と一緒に使った場合には、 / の代わりに任意の区切り文字を使えます。 また、最後の区切り文字がイベント行の最後の文字ならば、 これは省略できます。 g の別名として a を使うこともできます。

G

この修飾子に続く `s' 修飾子をイベント行の各単語に 1 回ずつ適用します。