= Read 組込みコマンド
:encoding: UTF-8
:lang: ja
//:title: Yash マニュアル - Read 組込みコマンド

dfn:[Read 組込みコマンド]は標準入力から行を読み込み変数に代入します。

[[syntax]]
== 構文

- +read [-Aer] [-P|-p] {{変数名}}...+

[[description]]
== 説明

Read コマンドは標準入力から一行の文字列を読み込み、それをlink:params.html#variables[変数]に代入します。

+-r+ (+--raw-mode+) オプションを付けると、行内のバックスラッシュは通常の文字と同様に扱われます。

+-r+ (+--raw-mode+) オプションを付けない場合、読み込んだ文字列の中のバックスラッシュ (+\+) はlink:syntax.html#quotes[引用符]として働きます。バックスラッシュが行末にあるときは行の連結を行います。link:interact.html[対話モード]のシェルが 2 行目以降を読み込むとき、標準入力が端末ならば link:params.html#sv-ps2[+PS2+ 変数]の値がプロンプトとして出力されます。

読み込んだ文字列は、link:expand.html#split[単語分割]によって分割します。分割後の各文字列が、それぞれオペランドで指定された変数の値に順に設定されます。指定された変数の数より分割結果のほうが多い場合は、最後の変数に残りの分割結果の全てが入ります。分割結果の数より指定された変数のほうが多い場合は、余った変数には空文字列が入ります。

[[options]]
== オプション

+-A+::
+--array+::
最後に指定した変数をlink:params.html#arrays[配列]にします。分割後の各文字列が配列の要素として設定されます。

+-e+::
+--line-editing+::
読み込みにlink:lineedit.html[行編集]を使用します。
+
行編集が有効になるには以下の条件が全て満たされている必要があります:
+
- シェルがlink:interact.html[対話モード]である。
- link:_set.html#so-vi[vi] または link:_set.html#so-emacs[emacs] オプションが有効になっている。
- 標準入力と標準エラーが端末である。

+-P+::
+--ps1+::
シェルが対話モードで標準入力が端末ならば、(最初の) 行を読み込む前に link:params.html#sv-ps1[+PS1+ 変数]をプロンプトとしてを表示します。

+-p {{プロンプト}}+::
+--prompt={{プロンプト}}+::
シェルが対話モードで標準入力が端末ならば、(最初の) 行を読み込む前に{{プロンプト}}を表示します。

+-r+::
+--raw-mode+::
読み込んだ文字列の中のバックスラッシュを引用符として扱わないようにします。

[[operands]]
== オペランド

{{変数名}}::
読み込んだ文字列を格納する変数の名前です。

[[exitstatus]]
== 終了ステータス

エラーがない限り read コマンドの終了ステータスは 0 です。

なお、行を完全に読み込む前に入力が終端に達した時は終了ステータスは非 0 になります。

[[notes]]
== 補足

Read コマンドはlink:builtin.html#types[準特殊組込みコマンド]です。

POSIX には +-A+ (+--array+) オプションに関する規定はありません。よってこのオプションは link:posix.html[POSIX 準拠モード]では使えません。

+PS1+ 変数をプロンプトとして表示する際、link:params.html#sv-ps1r[+PS1R+] および link:params.html#sv-ps1s[+PS1S+] 変数も使用されます。 +PS2+ についても同様です。

// vim: set filetype=asciidoc expandtab:
