# Read 組込みコマンド

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

## 構文

- `read [-Aer] [-d 行区切り] [-P|-p プロンプト] 変数名…`

## 説明

Read コマンドは標準入力から一行の文字列を読み込み、それを​変数に代入します。

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

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

通常、入力行は改行文字まで読み込まれます。`-d` (`--delimiter`) オプションを指定すると、改行文字の代わりに指定された行区切り文字まで読み込みます。行区切り文字は 1 文字である必要があります。

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

## オプション

`-A`
`--array`

  最後に指定した変数を​配列にします。分割後の各文字列が配列の要素として設定されます。

`-d 行区切り`
`--delimiter=行区切り`

  改行文字の代わりに指定された行区切り文字まで読み込みます。

`-e`
`--line-editing`

  読み込みに​行編集を使用します。

  行編集が有効になるには以下の条件が全て満たされている必要があります:

  - シェルが​対話モードである。

  - vi または emacs オプションが有効になっている。

  - 標準入力と標準エラーが端末である。

  - 行区切りが改行文字である。

`-P`
`--ps1`

  シェルが対話モードで標準入力が端末ならば、(最初の) 行を読み込む前に `PS1` 変数をプロンプトとしてを表示します。

`-p プロンプト`
`--prompt=プロンプト`

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

`-r`
`--raw-mode`

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

## オペランド

変数名

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

## 終了ステータス

行を正常に読み込んだ場合は終了ステータスは 0 です。 入力の終わりに達した場合は 1 です。この場合はそれまでに読み込んだ文字列が変数に代入されます。 変数が読み取り専用の場合は 2 です。 標準入力が読み込めない場合は 3 です。 コマンドライン引数に構文エラーがある場合は 4 です。

## 補足

Read コマンドは​必須組込みコマンドです。

POSIX では `-d` と `-r` オプションのみが規定されています。他のオプションは POSIX 準拠モードでは使えません。 終了ステータスは 0 と 1 だけが POSIX で固定されています。他のエラーの場合はシェルによって終了ステータスが異なります。

`PS1` 変数をプロンプトとして表示する際、​`PS1R` および `PS1S` 変数も使用されます。 `PS2` についても同様です。