# Bindkey 組込みコマンド

Bindkey 組込みコマンドは​行編集におけるキーバインド設定を表示・設定します。

## 構文

- `bindkey -aev [キー [コマンド]]`

- `bindkey -l`

## 説明

`-l` (`--list`) オプションを付けて実行すると、bindkey コマンドはキーバインド設定で利用可能な​行編集コマンドの一覧を標準出力に出力します。

他のオプションを付けて実行すると、bindkey コマンドはキーバインド設定の表示または設定を行います。

- オペランドとしてキー・コマンドを与えない場合、現在のキーバインド設定の内容を (コマンドとして解釈可能な形式で) 標準出力に出力します。

- キーのみを与えると、そのキーに対する現在の設定だけを出力します。

- キーとコマンドを両方与えると、そのキーを入力したときに実行するコマンドを指定したコマンドに設定します。

## オプション

`-a`
`--vi-command`

  Vi 風編集モードのコマンドモードにおけるキーバインドを表示・設定します。

`-e`
`--emacs`

  Emacs 風編集モードにおけるキーバインドを表示・設定します。

`-v`
`--vi-insert`

  Vi 風編集モードの挿入モードにおけるキーバインドを表示・設定します。

## オペランド

キー

  表示・設定する対象のキー入力シーケンスです。このオペランドの値にはバックスラッシュで始まる​エスケープシーケンスが利用できます。

コマンド

  設定する​行編集コマンドです。ハイフン一つ (`-`) を指定すると、指定したキーに対する設定を削除します。

## 終了ステータス

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

## 補足

Bindkey コマンドは​準特殊組込みコマンドです。 POSIX では bindkey コマンドの動作は規定されていません。