shaunrd0/dot

Fork 0

Files

Shaun Reed 10251dd1cb Add bash line editor.

2026-02-14 12:43:31 -05:00

51 KiB

Raw Blame History

[ Languages: English (英語) | 日本語 ]

ble.sh (/blɛʃ/) ―Bash Line Editor―

[ README | 説明書 | Q&A | contrib | 逆引き ]

ble.sh^†1 (Bash Line Editor) はピュア Bash^†2 スクリプトで書かれたコマンドラインエディタで、標準の GNU Readline を置き換える形で動作します。

現在の開発バージョンは 0.4 です。このスクリプトは Bash 3.0 以降で利用できますが、速度・機能などの観点から 4.0 以降のリリース版 Bash でお使い頂くことがお薦めです。また POSIX の基本的なコマンドが存在することも想定しています。現時点では、文字コードとして UTF-8 のみの対応です。このスクリプトは BSD License (3条項 BSD ライセンス) の下で提供されます。

簡単設定

ble.sh を取得するには主に2つの方法があります: git を用いてソースを取得しビルドする方法と、 curl または wget を用いて nightly ビルドをダウンロードする方法です。試用とインストール方法の詳細に関しては節1.1 と節1.2 を、 ~/.bashrc の設定の詳細に関しては節1.3 を御覧ください。

Note

fzf を ble.sh と組み合わせてお使いの場合は互換性の問題を避けるため節2.8 を必ず御覧ください。

git を用いてソースを取得し ble.sh を生成

この方法では git, make (GNU make), 及び gawk が必要です。以下、GNU make が gmake として提供されているシステム (BSD など) では、make を gmake に置き換えて実行してください。

# 簡単お試し (インストールせずにお試しいただけます)

git clone --recursive --depth 1 --shallow-submodules https://github.com/akinomyoga/ble.sh.git
make -C ble.sh
source ble.sh/out/ble.sh

# インストール & .bashrc 簡単設定 (動かない場合は節1.3を御参照下さい)

git clone --recursive --depth 1 --shallow-submodules https://github.com/akinomyoga/ble.sh.git
make -C ble.sh install PREFIX=~/.local
echo 'source -- ~/.local/share/blesh/ble.sh' >> ~/.bashrc

生成過程では、複数のBashスクリプトファイルを前処理・結合することで ble.sh を生成し、他の関連ファイルを正しく配置し、またソースコード中のコードコメントを削除してロードを最適化します。

※生成過程は、C/C++ のコンパイルも伴わずバイナリも生成しませんので、コンパイラを準備していただく必要はありません。

curl を用いて nightly ビルドをダウンロード

この方法では curl, tar (オプション J に対応), 及び xz (XZ Utils) が必要です。

# 簡単お試し (インストールせずにお試しいただけます)

curl -L https://github.com/akinomyoga/ble.sh/releases/download/nightly/ble-nightly.tar.xz | tar xJf -
source ble-nightly/ble.sh

# インストール & .bashrc 簡単設定 (動かない場合は節1.3を御参照下さい)

curl -L https://github.com/akinomyoga/ble.sh/releases/download/nightly/ble-nightly.tar.xz | tar xJf -
bash ble-nightly/ble.sh --install ~/.local/share
echo 'source -- ~/.local/share/blesh/ble.sh' >> ~/.bashrc

インストール後はディレクトリ ble-nightly は削除して問題ありません。

wget を用いて nightly ビルドをダウンロード

この方法では wget, tar (オプション J に対応), 及び xz (XZ Utils) が必要です。

# 簡単お試し (インストールせずにお試しいただけます)

wget -O - https://github.com/akinomyoga/ble.sh/releases/download/nightly/ble-nightly.tar.xz | tar xJf -
source ble-nightly/ble.sh

# インストール & .bashrc 簡単設定 (動かない場合は節1.3を御参照下さい)

wget -O - https://github.com/akinomyoga/ble.sh/releases/download/nightly/ble-nightly.tar.xz | tar xJf -
bash ble-nightly/ble.sh --install ~/.local/share
echo 'source -- ~/.local/share/blesh/ble.sh' >> ~/.bashrc

インストール後はディレクトリ ble-nightly は削除して問題ありません。

パッケージ管理システムを通じてパッケージをインストール (現在限られたパッケージのみ)

この方法では対応するパッケージ管理ツールのみが必要です。

AUR (Arch Linux) blesh-git (devel), blesh (stable 0.3.4)
NixOS (nixpkgs) blesh (devel)
Guix blesh (0.4.0-devel2)

既存の ble.sh を更新

# 更新 (ble.sh をロードした状態で)

ble-update

# 更新 (ble.sh 外部から)

bash /path/to/ble.sh --update

ble.sh のパッケージ作成

ble.sh は単にシェルスクリプトの集合ですので環境に依存せずにお使いいただけます (いわゆる "noarch") ので、単にリリースページからビルド済みの tarball をダウンロードし中身を /tmp/blesh-package/usr/local など所定の位置に配置するだけで問題ありません。それでも何らかの理由により自前でビルドする必要がある場合には以下のコマンドをお使いください。ビルドの為には git リポジトリ (.git) が必要になることにご注意ください。

# ビルド & パッケージ作成用コマンド

git clone --recursive --depth 1 --shallow-submodules https://github.com/akinomyoga/ble.sh.git
make -C ble.sh install DESTDIR=/tmp/blesh-package PREFIX=/usr/local

スクリプトファイル、ライセンスファイル。ドキュメントファイルのインストール場所を詳細に指定する方法については、後ろの節インストール and パッケージ作成を御参照ください。

スクリプトファイル _package.bash を ${prefix}/share/blesh/lib/_package.bash に配置することで、 ble-update で用いるパッケージ更新方法を指定することができます。詳細については節 _package.bash を御参照ください。

# ${prefix}/share/blesh/lib/_package.bash

_ble_base_package_type=XXX
function ble/base/package:XXX/update {
  update-the-package-in-a-proper-way
}

機能概要

構文着色: fish や zsh-syntax-highlighting のような文法構造に従った着色を行います。 zsh-syntax-highlighting のような単純な着色ではなく、構文の入れ子構造や複数のヒアドキュメントなども正しく解析して着色します。着色は全て設定可能です。
補完増強: 補完を大幅に増強します。 文法構造に応じた補完、クォートやパラメータ展開を展開した上でのプログラム補完、曖昧補完に対応しています。また、候補をカーソルキーや TAB, S-TAB で選択できる メニュー補完、 fish や zsh-autosuggestions のような 自動補完 (Bash 4.0 以上) の機能もあります。更に、従来 peco や fzf を呼び出さなければならなかった補完候補の絞り込みも メニュー絞り込み (Bash 4.0 以上) として自然な形で組み込んでいます。他に、動的略語展開 や、zsh abbreviations・zsh-abbr のような 静的略語展開 にも対応しています。
Vim編集モード: set -o vi による編集モードを増強します。挿入・ノーマルモードの他に(行・矩形)ビジュアルモード、置換モードなどの各種モードに対応しています。テキストオブジェクト・各種レジスタ・オペレータ・キーボードマクロなどにも対応しています。拡張として vim-surround も提供しています。
他にも ステータス行, コマンド履歴共有, 右プロンプト, 過渡的プロンプト, xterm タイトル, など様々な機能に対応しています。

注意: ble.sh は、(プロンプト (PS1)、エイリアス、関数などを提供する) 典型的な Bash 設定集と異なります。 ble.sh はより低層の基盤を提供するもので、ユーザは自分でプロンプトやエイリアスを設定する必要があります。勿論 bash-it や oh-my-bash の様な他の Bash 設定と一緒に使っていただくことも可能です。

デモ

来し方行く末

このプロジェクトは初めは .bashrc の片隅で行われた小さな実験からスタートしました。 2013年5月に zsh-syntax-highlighting のとある記事に触発されたのがきっかけでした。初めは数百行のコードを書けば構文着色が簡単に実現できるのではないかと思って始めた実験ですが、すぐに行エディタを根本から書き直さなければ実現できないのではないかということが分かり、独立したファイルにコードを移動した後に ble.sh という名前を与えました。この名前は Zsh の行エディタ (ZLE (Zsh Line Editor)) を真似て、但しシェルで書かれているという事を意識して .sh という拡張子にしたように記憶しています。 ble.sh の読み方について屡々訊かれるのですが、最初に書いたように特に定まった読み方はありません。最初の実験は2週間程コードを弄って原理的に行エディタを作れるという事を結論づけて終わりました。本格的な実装が始まったのは2015年2月の事で12月には公開しました。その時点で行エディタとしては普段遣いに堪える程度に完成していました。 Vimモードの実装は2017年9月に始まり2018年3月に一先ず完成としました。続いて補完の拡張は2018年8月に始まり2019年2月には一通り完成しました。現在は漫然とメンテナンスしている所でいつになるかは分かりませんが、以下に挙げるような機能も加えたいと何となく考えています。

2013-06 v0.0 -- 実験
2015-12 v0.1 -- 構文着色 [v0.1.15]
2018-03 v0.2 -- Vim モード [v0.2.7]
2019-02 v0.3 -- 拡張補完 [v0.3.4]
20xx-xx v0.4 (plan) -- プログラム着色 [nightly build]
20xx-xx v0.5 (plan) -- TUI設定画面
20xx-xx v0.6 (plan) -- エラー診断?

制限および前提

ble.sh の実装形態から来る制限があります。ユーザー設定や他の Bash の枠組みとの干渉によって問題が起こる可能性があります。

既定では、実行コストの都合上、ble.sh は前回のコマンドライン実行後の PIPESTATUS を設定しません。代わりに BLE_PIPESTATUS を参照することができます。もし本当に PIPESTATUS 経由でこれらの値を利用する必要がある場合には設定 bleopt exec_restore_pipestatus=1 を使用して下さい。
既定では、よりなめらかな描画の為に、ble.sh は PROMPT_COMMAND および PRECMD フックが端末内のカーソル位置およびレイアウトを変更しないことを想定します。 PROMPT_COMMAND および PRECMD で出力を行うまたはカーソル位置を変更する設定をお持ちの場合は、設定 bleopt prompt_command_changes_layout=1 を使用してください。
ble.sh は一般的な変数名のシェル変数や環境変数 (LC_* など) がグローバルで読み込み専用変数になっていないことを想定します。 Bash ではグローバル変数の読み込み専用属性は関数のローカルスコープに於いても制限を与えます。つまり、同名の異なるローカル変数さえ定義することができません。この問題は ble.sh 固有の制限ではなく、あらゆる Bash の枠組みがグローバルの読み込み専用変数に影響を受けます。一般的にグローバルスコープに読み込み変数を設定することはセキュリティ的な理由がない限りは非推奨と考えられています (参照 [1], [2], [3])。また、ble.sh はビルトインコマンド readonly をシェル関数で置き換え、グローバル変数を読み込み専用にするのをブロックします。例外として、全て大文字の変数 (ble.sh が内部使用するものを除く) および _* の形の変数 (_ble_* および __ble_* を除く) を読み込み専用にすることは可能です。
ble.sh は Bash のビルトインコマンド (trap, readonly, bind, history, read, exit) をシェル関数で上書きし、ble.sh と干渉しないようにその振る舞いを調整します。ユーザーまたは他の枠組みが元のビルトインを直接呼び出した場合、または ble.sh の定義したシェル関数を別のシェル関数で上書きした場合、正しい動作を保証できません。
シェル及び端末の設定はラインエディタ用とコマンド実行用で異なります。ble.sh はラインエディタ向けに必要な調整を行い、ユーザが指定したコマンド実行用の設定をできるだけ復元します。但し、様々な理由により、一部の設定については意図的に復元しない場合や復元することができない場合があります。詳細については wiki (英語) に情報があります。

批判

^†1Q. "ble.sh の読み方が分からない"--- A. ble.sh はお好きな様に読んでいただいて問題ありませんが、一番短いのは標記の /blɛʃ/ になりましょう。しかし個人的には脳裡で /biːɛliː/ または /biːɛliː dɑt ɛseɪtʃ/ と読んでいるものですから、標記の読み方は飽くまで参考と受け止めていただければ幸いです。
^†2Q. "コマンドを実行するのだからピュアBashのはずがない。ピュアBashとは何たることか"--- A. ラインエディタ本体がピュア Bashで書かれているという意味です。勿論、ユーザーが外部コマンドを入力・実行した場合にはその外部コマンドが呼び出されます。更に、ユーザーコマンド実行前後には TTY を適切に設定する為に stty (POSIX) が呼び出されます。他にも処理の高速化の為に、初期化・終了処理、巨大なデータの処理 (補完、貼り付けなど) の局面でPOSIX 標準コマンドを利用しています。 ble.sh 実装における本来の目標はピュアBashで実装することではなく、 POSIX環境におけるBashの互換性を保った範囲で高速な動作を実現することです。ピュアBashによって大抵の場合は fork & exec コストを削減することができますが、個々のケースで外部コマンドによる実装の方が効率的な場合には、 ble.shはピュアBash実装よりも外部コマンドによる実装を優先します。

1 使い方

1.1 ソースからのビルド方法^†

ble.sh 生成

ble.sh を生成する為には gawk (GNU awk) と gmake (GNU make) が必要です。以下のコマンドで生成できます。 GNU make が gmake という名前でインストールされている場合は、make の代わりに gmake として下さい。

$ git clone --recursive https://github.com/akinomyoga/ble.sh.git
$ cd ble.sh
$ make

スクリプトファイル ble.sh がサブディレクトリ ble.sh/out 内に生成されます。

試用

生成された ble.sh は source コマンドを用いてお試しいただけます。

$ source out/ble.sh

インストール^†

指定したディレクトリにインストールするには make install コマンドを使用します。

# ~/.local/share/blesh にインストール
make install

# 指定したディレクトリにインストール
make install INSDIR=/path/to/blesh

メインファイル ble.sh 及び関連スクリプトファイルのインストール先ディレクトリは Make 変数 INSDIR を用いて指定できます。ライセンス及びドキュメントのインストール先は Make 変数 INSDIR_LICENSE と INSDIR_DOC を用いて指定できます。 INSDIR が指定されている時、INSDIR_LICENSE と INSDIR_DOC の既定値はそれぞれ $INSDIR/licenses と $INSDIR/doc です。 INSDIR および後述の DESTDIR/PREFIX が指定されていない時、INSDIR, INSDIR_LICENSE, INSDIR_DOC の規定値はそれぞれ $data/blesh, $data/blesh/licenses, $data/doc/blesh になります。但し、data は ${XDG_DATA_HOME:-$HOME/.local/share} を指します。

Make 変数 USE_DOC=no が指定されている時、ドキュメントファイルの処理が無効化されます。

既定ではコード中のコメント行や空行はインストール時に自動で削除されます。コメントや空行を保持したい場合は strip_comment=no を make の引数に指定して下さい。

.bashrc の設定に関しては節1.3を御覧ください。

パッケージ作成^†

パッケージ作成者は Make 変数 DESTDIR 及び PREFIX を用いて INSDIR, INSDIR_LICENSE, INSDIR_DOC の既定値を一括で設定することができます。

# パッケージ作成 - 例1
make install DESTDIR=/tmp/blesh-package PREFIX=/usr/local

# パッケージ作成 - 例2
make install DESTDIR="$build" PREFIX="$prefix" \
  INSDIR_LICENSE="$build/$prefix/share/licenses/blesh"

# パッケージ作成 - 例3
make install DESTDIR="$build" PREFIX="$prefix" \
  INSDIR_LICENSE="$build/$prefix/share/blesh/doc" \
  INSDIR_DOC="$build/$prefix/share/blesh/doc"

# パッケージ作成 - 例4
make install USE_DOC=no DESTDIR="$build" PREFIX="$prefix"

INSDIR の代わりに Make 変数 DESTDIR または PREFIX が指定されている時、 INSDIR の値は $DESTDIR/$PREFIX/share/blesh に設定され、ライセンス及びドキュメントファイルの場所 INSDIR_LICENSE と INSDIR_DOC の既定値は $DESTDIR/$PREFIX/share/doc/blesh になります。

`_package.bash`

スクリプトファイル _package.bash を ${prefix}/share/blesh/lib/_package.bash に配置することで、 ble-update で用いるパッケージ更新方法を指定することができます。スクリプトファイル _package.bash では、次で示すような変数と関数を定義します。但し XXX はパッケージ管理システムの名前に置き換えてください。

# ${prefix}/share/blesh/lib/_package.bash

_ble_base_package_type=XXX

function ble/base/package:XXX/update {
  update-the-package-in-a-proper-way
  return 0
}

シェル関数の終了ステータス 0 は更新が成功したことを表し、更新処理完了後に ble.sh が自動的にリロードされます。シェル関数がステータス 6 で終了した場合、更新処理完了後に ble.sh のタイムスタンプが確認され、ble.sh が現セッションの開始時刻よりも新しい時に限りリロードが行われます。シェル関数がステータス 125 で終了した場合、ble.sh に組み込みの更新処理が試みられます。それ以外の場合には更新処理が中断されます。この場合、シェル関数が状況を説明するメッセージを出力するようにして下さい。具体例として AUR パッケージの _package.bash も参考にしていただければ幸いです。

1.2 tarball のダウンロード^†

GitHub Releases から ble.sh の tarball をダウンロードすることもできます。ダウンロード・試用・インストールの方法については各リリースページの説明を御覧ください。現在、安定版は開発版に比べてかなり古いので様々な機能が欠けていることにご注意下さい。

開発版 v0.4.0-devel3 (2023-04), nightly build
安定版 v0.3.4 (2019-02 fork) 拡張補完
安定版 v0.2.7 (2018-03 fork) Vim モード
安定版 v0.1.15 (2015-12 fork) 構文着色

1.3 `.bashrc` の設定^†

対話シェルで常用する場合には .bashrc に設定を行います。単に ble.sh を source して頂くだけでも大抵の場合動作しますが、より確実に動作させる為には以下の様にコードを記述します。

# bashrc

# .bashrc の先頭近くに以下を追加して下さい。
[[ $- == *i* ]] && source -- /path/to/blesh/ble.sh --attach=none

# 間に通常の bashrc の内容を既述します。

# .bashrc の末端近くに以下を追加して下さい。
[[ ! ${BLE_VERSION-} ]] || ble-attach

source -- /path/to/ble.sh 及び ble-attach を呼び出す時は、標準ストリーム (stdin, stdout, stderr) が現在のセッションの制御端末とは別の物にリダイレクトされていない様にして下さい。 source -- /path/to/ble.sh をシェル関数の中から実行するのは避けて下さい。この「より確実な設定」が必要になる詳細な条件については Discussion #254 への回答 (英語) で説明されています。

1.4 初期化スクリプト `~/.blerc`

ユーザー設定は初期化スクリプト ~/.blerc (またはもし ~/.blerc が見つからなければ ${XDG_CONFIG_HOME:-$HOME/.config}/blesh/init.sh) に記述します。初期化スクリプトは ble.sh ロード時に自動で読み込まれる Bash スクリプトなので、Bash で使えるコマンドを初期化スクリプトの中で利用できます。初期化スクリプトの位置を変更する場合には、source ble.sh 時に --rcfile INITFILE を指定します。以下に例を挙げます。テンプレートとしてリポジトリの blerc.template というファイルを利用できます (お使いの ble.sh に対応する commit のテンプレートファイルを使う必要があることにご注意ください)。

# in bashrc

# Example 1: ~/.blerc will be used by default
[[ $- == *i* ]] && source -- /path/to/blesh/ble.sh --attach=none

# Example 2: /path/to/your/blerc will be used
[[ $- == *i* ]] && source -- /path/to/blesh/ble.sh --attach=none --rcfile /path/to/your/blerc

1.5 アップデート

Git (git'), GNU awk (gawk), 及び GNU make (make) が必要になります。 ble-0.3以上をお使いの場合はble.shをロードした状態でble-update` を実行して下さい。

$ ble-update

ble-0.4 以上をお使いの場合は ble.sh をロードしなくても以下のコマンドで更新可能です。

$ bash /path/to/ble.sh --update

それ以外の場合には、以下のように git pull で最新版を入手・インストールできます。

cd ble.sh   # ※既に持っている git リポジトリに入る
git pull
git submodule update --recursive --remote
make
make INSDIR="$HOME/.local/share/blesh" install

1.6 アンインストール

基本的に ble.sh ディレクトリとユーザの追加した設定を単に削除していただければ問題ありません。

全ての ble.sh セッション (ble.sh をロードしている Bash 対話セッション) を終了します。
関連するユーザーデータを削除します。これらのデータを保持しておきたい場合は必要に応じてスキップしてください。
- .bashrc に追加した行があれば削除します。
- blerc 設定ファイル (~/.blerc または ~/.config/blesh/init.sh) があれば削除します。
- 状態ディレクトリ ~/.cache/blesh が生成されていればそれを削除します。
ble.sh をインストールしたディレクトリを削除します。git リポジトリ内の out/ble.sh を直接ご使用の場合はインストールしたディレクトリは、git リポジトリ自体です。make intall を用いてインストールした場合は、インストールしたディレクトリは <PREFIX>/share/blesh です。但し、<PREFIX> (既定値: ~/.local) は make install に指定した PREFIX の値です。生成済み tarball をご利用の際には、インストールしたディレクトリは tarball を展開して得られたディレクトリを配置した場所です。
キャッシュディレクトリ ~/.cache/blesh が生成されていればそれを削除します。
一時ディレクトリ /tmp/blesh が生成されていればそれを削除します。これは /tmp の内容が自動的にクリアされないシステムで必要です。

1.7 トラブルシューティング

Performance (英語) では ble.sh の動作速度の改善に関する情報について説明しています。
Reporting Issue (英語) では問題報告をする前に確認しておくと良い情報を説明しています。

キャッシュの消去

原理的に発生しないはずなのですが「ble.sh で何も入力できなくなってしまった」という報告が偶にあります。原因不明で再現もできないため現在調査中ですが、ble.sh のキャッシュを消去すると直ることが多いようです。 ble.sh をロードしていないセッションで以下のコマンドを実行することでキャッシュを消去できます。

$ bash /path/to/ble.sh --clear-cache

ble.sh をロードしていないセッションを開始するには、例えば ~/.bashrc を編集して ble.sh をソースしている行をコメントアウトしてから Bash を開始してください。または Bash 以外のシェル (ash, dash, ksh, zsh など) を使うこともお考えください。もし問題が直接アクセスできないリモートホストで発生していて問題のない既存のセッションがない場合は、非対話的なコマンドで ~/.bashrc を移動することで ~/.bashrc を無効化できます。

# 例 (ssh)

local$ ssh remote 'mv .bashrc .bashrc.backup'

# 例 (rsh)

local$ rsh remote 'mv .bashrc .bashrc.backup'

2 基本設定

ここでは ~/.blerc に記述する基本的な設定を幾つか紹介します。質問と回答、逆引きレシピ、 contrib リポジトリにも便利な設定があります。その他の全ての設定項目はテンプレート blerc.template に含まれています。詳細な説明に関しては説明書を参照して下さい。

2.1 Vim モード

Vim モードについては Wiki の説明ページを御覧ください。

2.2 各機能の無効化

よくお尋ね頂くご質問の一つにそれぞれの機能をどのように無効化すれば良いのかというものが御座います。各機能の無効化方法を以下にまとめます。 ble.sh の振る舞いを Readline に近づける設定 config/readline (ble-import config/readline で読み込めます) も御覧ください。

# 構文着色を無効化
bleopt highlight_syntax=

# ファイル名に基づく構文着色を無効化
bleopt highlight_filename=

# 変数の種類に基づく構文着色の無効化
bleopt highlight_variable=

# 自動補完の無効化 (自動補完は Bash 4.0 以降にて既定で有効です)
bleopt complete_auto_complete=
# Tip: 代わりに自動補完の起動遅延をミリ秒単位でご指定いただくこともできます。
bleopt complete_auto_delay=300

# コマンド履歴に基づく自動補完の無効化
bleopt complete_auto_history=

# 曖昧補完の無効化
bleopt complete_ambiguous=

# TAB によるメニュー補完の無効化
bleopt complete_menu_complete=

# メニュー自動絞り込みの無効化 (Bash 4.0 以降にて既定で有効化されます)
bleopt complete_menu_filter=

# 行末マーカー "[ble: EOF]" の無効化
bleopt prompt_eol_mark=''
# Tip: 代わりに他の文字列をご指定頂くこともできます。
bleopt prompt_eol_mark='⏎'

# 終了ステータスマーカー "[ble: exit %d]" の無効化
bleopt exec_errexit_mark=
# Tip: 代わりに他の文字列をご指定頂くこともできます。
bleopt exec_errexit_mark=$'\e[91m[error %d]\e[m'

# コマンド実行時間マーカー "[ble: elapsed 1.203s (CPU 0.4%)]" の無効化
bleopt exec_elapsed_mark=
# Tip: 代わりに別の文字列をご指定いただくこともできます。
bleopt exec_elapsed_mark=$'\e[94m[%ss (%s %%)]\e[m'
# Tip: マーカーを表示する条件を変更することも可能です。
bleopt exec_elapsed_enabled='sys+usr>=10*60*1000' # 例: 合計CPU時間が 10 分以上の時に表示

# 終了マーカー "[ble: exit]" の無効化
bleopt exec_exit_mark=

# その他のマーカー "[ble: ...]" の無効化
bleopt edit_marker=
bleopt edit_marker_error=

2.3 曖昧文字幅

設定 char_width_mode を用いて、曖昧文字幅を持つ文字 (Unicode 参考特性 East_Asian_Width が A (Ambiguous) の文字) の幅を制御できます。現在は 4 つの選択肢 emacs, west, east, auto が用意されています。設定値 emacs を指定した場合、GNU Emacs における既定の文字幅と同じ物を使います。設定値 west を指定した場合、全ての曖昧文字幅を 1 (半角) と解釈します。設定値 east を指定した場合、全ての曖昧文字幅を 2 (全角) と解釈します。設定値 auto を指定した場合、west か east かを端末とのやり取りに基づいて自動判定します。既定値は auto です。この設定項目は、利用している端末の振る舞いに応じて適切に設定する必要があります。例えば west に設定する場合は以下の様にします:

bleopt char_width_mode='west'

2.4 文字コード

設定 input_encoding は入力の文字コードを制御するのに使います。現在 UTF-8 と C のみに対応しています。設定値 C を指定した場合は、受信したバイト値が直接文字コードであると解釈されます。既定値は UTF-8 です。C に設定を変更する場合には以下の様にします:

bleopt input_encoding='C'

2.5 ベル

設定 edit_bell は編集関数 bell の振る舞いを制御するコロン区切りのリストです。値 abell, vbell, visual はそれぞれ対応するベルの提示方法を有効化します。値 abell は音による通知に対応し、制御文字の BEL (0x07) を stderr に出力します。値 vbell は画面での通知に対応し、端末画面上にメッセージを表示します。値 visual は画面の反転に対応し、DECSCNM を用いて端末画面を瞬間的に反転します。既定では音による通知のみが有効になっています。

設定 vbell_default_message は画面での通知で使用するメッセージ文字列を指定します。既定値は ' Wuff, -- Wuff!! ' です。設定 vbell_duration は画面での通知を表示する時間の長さを指定します。単位はミリ秒です。既定値は 2000 です。設定 vbell_align は画面での通知の表示位置を指定します。left, center, right が指定できます。

例えば、以下の設定によって、音による通知を無効化して画面での通知を設定・有効化できます。

bleopt edit_bell=vbell vbell_{default_message=' BEL ',duration=3000,align=right}

2.6 着色の設定

構文に従った着色で使用される、各文法要素の色と属性は ble-face シェル関数で設定します。既定の設定は以下のコードに対応します:

# 編集に関連する着色の設定
ble-face -s region                    bg=60,fg=231
ble-face -s region_target             bg=153,fg=black
ble-face -s region_match              bg=55,fg=231
ble-face -s region_insert             fg=27,bg=254
ble-face -s disabled                  fg=242
ble-face -s overwrite_mode            fg=black,bg=51
ble-face -s vbell                     reverse
ble-face -s vbell_erase               bg=252
ble-face -s vbell_flash               fg=green,reverse
ble-face -s prompt_status_line        fg=231,bg=240

# 構文着色の設定
ble-face -s syntax_default            none
ble-face -s syntax_command            fg=brown
ble-face -s syntax_quoted             fg=green
ble-face -s syntax_quotation          fg=green,bold
ble-face -s syntax_escape             fg=magenta
ble-face -s syntax_expr               fg=33
ble-face -s syntax_error              bg=203,fg=231
ble-face -s syntax_varname            fg=202
ble-face -s syntax_delimiter          bold
ble-face -s syntax_param_expansion    fg=133
ble-face -s syntax_history_expansion  bg=94,fg=231
ble-face -s syntax_function_name      fg=99,bold
ble-face -s syntax_comment            fg=242
ble-face -s syntax_glob               fg=198,bold
ble-face -s syntax_brace              fg=37,bold
ble-face -s syntax_tilde              fg=63,bold
ble-face -s syntax_document           fg=100
ble-face -s syntax_document_begin     fg=100,bold
ble-face -s command_builtin_dot       fg=red,bold
ble-face -s command_builtin           fg=red
ble-face -s command_alias             fg=teal
ble-face -s command_function          fg=99
ble-face -s command_file              fg=green
ble-face -s command_keyword           fg=blue
ble-face -s command_jobs              fg=red
ble-face -s command_directory         fg=33,underline
ble-face -s command_suffix            fg=231,bg=28
ble-face -s command_suffix_new        fg=231,bg=124
ble-face -s filename_directory        underline,fg=33
ble-face -s filename_directory_sticky underline,fg=231,bg=26
ble-face -s filename_link             underline,fg=teal
ble-face -s filename_orphan           underline,fg=16,bg=224
ble-face -s filename_executable       underline,fg=green
ble-face -s filename_setuid           underline,fg=black,bg=220
ble-face -s filename_setgid           underline,fg=black,bg=191
ble-face -s filename_other            underline
ble-face -s filename_socket           underline,fg=cyan,bg=black
ble-face -s filename_pipe             underline,fg=lime,bg=black
ble-face -s filename_character        underline,fg=231,bg=black
ble-face -s filename_block            underline,fg=yellow,bg=black
ble-face -s filename_warning          underline,fg=red
ble-face -s filename_url              underline,fg=blue
ble-face -s filename_ls_colors        underline
ble-face -s varname_array             fg=orange,bold
ble-face -s varname_empty             fg=31
ble-face -s varname_export            fg=200,bold
ble-face -s varname_expr              fg=99,bold
ble-face -s varname_hash              fg=70,bold
ble-face -s varname_new               fg=34
ble-face -s varname_number            fg=64
ble-face -s varname_readonly          fg=200
ble-face -s varname_transform         fg=29,bold
ble-face -s varname_unset             fg=245
ble-face -s argument_option           fg=teal
ble-face -s argument_error            fg=black,bg=225

# 補完の着色
ble-face -s auto_complete             fg=238,bg=254
ble-face -s menu_complete_match       bold
ble-face -s menu_complete_selected    reverse
ble-face -s menu_desc_default         none
ble-face -s menu_desc_type            ref:syntax_delimiter
ble-face -s menu_desc_quote           ref:syntax_quoted
ble-face -s menu_filter_fixed         bold
ble-face -s menu_filter_input         fg=16,bg=229

現在の描画設定の一覧は以下のコマンドでも確認できます (ble-face を無引数で呼び出す)。

$ ble-face

色コードはシェル関数 ble-color-show (ble.sh 内で定義) で確認できます。

$ ble-color-show

2.7 キーバインディング

キーバインディングはシェル関数 ble-bind を使って変更できます。例えば C-x h を入力した時に "Hello, world!" と挿入させたければ以下のようにします。

ble-bind -f 'C-x h' 'insert-string "Hello, world!"'

上記の C-x h の様なキー表記についてはマニュアル §3.1 で詳細に説明されています。スペース・タブ・エンター・バックスペース・エスケープなどの特殊キーの表記についてはマニュアル §3.1.1 で説明されています: スペースは SP と表現します。タブキーは端末によって C-i または TAB と表現します。エンター・リターンキーは端末によって C-m または RET と表現します。バックスペースは端末によって C-?, DEL, C-h, または BS 等様々な表現があります。 Ctrl+Return や Shift+Return などの修飾された特殊キーの取り扱いについてはマニュアル §3.6.4 で説明されています。お使いの端末が modifyOtherKeys に対応していない場合、手動で各キーの組み合わせに対応するエスケープシーケンスを設定する必要があります。

M-c を入力した時にコマンドを実行するには以下のようにします。

ble-bind -c 'M-c' 'my-command'

C-r を入力した時に、ユーザー定義編集関数 (Bash の bind -x で指定するのと同様の物) を実行するには以下のようにします。

ble-bind -x 'C-r' 'my-edit-function'

既存のキーバインディングは以下のコマンドで確認できます。

$ ble-bind -P

以下のコマンドでキーバインディングに使える編集関数一覧を確認できます。

$ ble-bind -L

それぞれの編集関数の説明は wiki のマニュアルを参照して下さい。

一つのキーで複数の編集関数を呼び出したい場合は、以下の例の様に、 ble/widget/編集関数の名前 という名前のシェル関数を通して新しい編集関数を定義できます。既存の標準の編集関数と名前が重複しない様に、編集関数の名前は ユーザー名/, my/, blerc/, dotfiles/ などで始める事が強く推奨されます。

# C-t で複数の操作を行う例
function ble/widget/my/example1 {
  ble/widget/beginning-of-logical-line
  ble/widget/insert-string 'echo $('
  ble/widget/end-of-logical-line
  ble/widget/insert-string ')'
}
ble-bind -f C-t my/example1

2.8 fzf との統合^†

fzf を ble.sh と一緒にお使いいただく場合には、互換性の問題を避けるために、contrib/fzf 統合機能を用いて fzf を設定していただく必要があります。詳細についてはリンク先の説明を御覧ください。

# blerc

# 注意: fzf を bash_completion と組み合わせて使用する場合は、fzf-completion よ
# りも先に bash_completion をロードしておく必要があります。これは ble.sh と関係
# なく必要です。
source /etc/profile.d/bash_completion.sh

ble-import -d integration/fzf-completion
ble-import -d integration/fzf-key-bindings

上記 ble-import に指定されているオプション -d は指定したファイルの読み込みを遅延させます。このように設定した場合、指定したファイルはプロンプトが表示された後にバックグランドで読み込まれます。詳細に関しては ble-import - 説明書 §8 を御覧ください。

fzf に対する追加設定がある場合

fzf の設定を読み込んだ後に追加の設定コードを実行したい場合、上記の fzf 設定の遅延読み込みのために、単に設定コードを上記の設定に続けて記述しても動きません。この場合、四つの方法がございます。最も単純な方法はオプション -d を指定せずに遅延読み込みを無効化する方法 [1] です。

# [1] オプション -d を使用しない
ble-import integration/fzf-completion
ble-import integration/fzf-key-bindings
<settings>

しかし上の方法を用いると初期化時間が長くなります。別の方法として、 ble-import -d [2] または ble/util/idle.push [3] を用いて追加設定も同様に遅延させることができます。または、fzf 設定ファイルの読み込み完了に対して ble-import -C [4] を用いてフックを設定することもできます。

# [2] 追加設定も ble-import -d を使う
ble-import -d integration/fzf-completion
ble-import -d integration/fzf-key-bindings
ble-import -d '<filename containing the settings>'

# [3] 追加設定を ble/util/idle.push で登録
ble-import -d integration/fzf-completion
ble-import -d integration/fzf-key-bindings
ble/util/idle.push '<settings>'

# [4] 追加設定を ble-import -C で登録
ble-import -d integration/fzf-completion
ble-import -d integration/fzf-key-bindings
ble-import -C '<settings>' integration/fzf-key-bindings

3 ヒント

3.1 複数行モード

コマンドラインに改行が含まれている場合、複数行モード (MULTILINE モード) になります。

C-v C-j または C-q C-j とすると改行をコマンドラインの一部として入力できます。複数行モードでは、RET (C-m) はコマンドの実行ではなく新しい改行の挿入になります。複数行モードでは、C-j を用いてコマンドを実行して下さい。

shopt -s cmdhist が設定されているとき (既定)、もし RET (C-m) を押した時にコマンドラインが構文的に閉じていなければ、コマンドの実行ではなく改行の挿入を行います。

3.2 Vim モード

.bashrc に set -o vi が設定されているとき、または .inputrc に set editing-mode vi が設定されているとき、vim モードが有効になります。 Vim モードの詳細な設定については Wiki のページ (英語) を御覧ください。

3.3 自動補完

Bash 4.0 以降では自動補完が有効になり、予測候補が表示されます。候補を確定するには S-RET を入力します (編集文字列の末尾にいる時は right, C-f または end でも確定できます)。表示されている候補の初めの単語だけ部分的に確定する時は M-f または M-right を入力します。現在の候補で確定しそのままコマンドを実行する場合には C-RET (※お使いの端末が対応している時) を入力します。お使いの端末が対応していない時はマニュアル §3.6.4 を参照して下さい。

3.4 静的略語展開

特定の単語を静的略語展開に登録することで好きな文字列に展開することができます。登録済み単語に一致する単語の直後で SP を入力した時に静的略語展開が起きます。例えば、以下の設定をしておくと command L まで入力した状態で SP を押した時に、コマンドラインが command | less に展開されます。

# blerc
ble-sabbrev L='| less'

実際に実行したいコマンドに含まれる可能性の低い単語として、\ で始まる単語を静的略語展開に登録することもお薦めです。

# blerc
ble-sabbrev '\L'='| less'

~ で始まる静的略語展開は / でも展開されます。これは Zsh の名前付きディレクトリ (named directories) に模した使い方ができます。例えば、以下の設定の下で ~mybin/ と入力すると、/home/user/bin/ など (HOME=/home/user の場合) に展開されます。

# blerc

ble-sabbrev "~mybin=$HOME/bin"

その他の詳細についてはマニュアルの静的略語展開の節を御覧ください。

4 謝辞

GitHub の Issue/PR を通して多くの方からフィードバックを頂き、皆様に本当に感謝しております。特に以下の方には大きな寄与を受けたので言及させていただきます。

@cmplstofB 様には vim モードの実装において初期よりテスト及び様々な提案をしていただきました。
@dylankb 様には fzf との互換性や ble.sh 初期化に関連して様々な問題報告をいただきました。
@rux616 様には幾つかの問題報告および .blerc の既定パス解決のバグ修正をいただきました。
@timjrd 様には補完の枠組みの高速化に関する PR をいただきました。
@3ximus 様には広範囲に渡る様々な問題について報告いただきました。
@SuperSandro2000 様には NixOS 関係を始め様々なご報告をいただきました。

51 KiB Raw Blame History Unescape Escape