Skip to content

Commit

Permalink
docs: add keybinding in blerc and elaborate README for uninstalling
Browse files Browse the repository at this point in the history
* blerc: describe keybinding to accept autosuggestion by TAB
* README: clarify the "installed directory" in the uninstall section
  • Loading branch information
akinomyoga committed Dec 6, 2023
1 parent 2682635 commit cd06986
Show file tree
Hide file tree
Showing 5 changed files with 98 additions and 20 deletions.
15 changes: 11 additions & 4 deletions README-ja_JP.md
Original file line number Diff line number Diff line change
Expand Up @@ -362,11 +362,18 @@ make INSDIR="$HOME/.local/share/blesh" install
基本的に `ble.sh` ディレクトリとユーザの追加した設定を単に削除していただければ問題ありません。

- 全ての `ble.sh` セッション (`ble.sh` をロードしている Bash 対話セッション) を終了します。
- `.bashrc` に追加した行があれば削除します。
- `blerc` 設定ファイル (`~/.blerc` または `~/.config/blesh/init.sh`) があれば削除します。
- `ble.sh` をインストールしたディレクトリを削除します。
- 関連するユーザーデータを削除します。これらのデータを保持しておきたい場合は必要に応じてスキップしてください。
- `.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` が生成されていればそれを削除します。
- 状態ディレクトリ `~/.cache/blesh` が生成されていればそれを削除します。
- 一時ディレクトリ `/tmp/blesh` が生成されていればそれを削除します。これは `/tmp` の内容が自動的にクリアされないシステムで必要です。

# 2 基本設定
Expand Down
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -377,11 +377,18 @@ make INSDIR="$HOME/.local/share/blesh" install
Basically you can simply delete the installed directory and the settings that the user added.

- Close all the `ble.sh` sessions (the Bash interactive sessions with `ble.sh`)
- Remove the added lines in `.bashrc`.
- Remove `blerc` files (`~/.blerc` or `~/.config/blesh/init.sh`) if any.
- Remove the installed directory.
- Remove related user data. If you would like to keep them, you can skip these steps.
- Remove the added lines in `.bashrc`.
- Remove `blerc` files (`~/.blerc` or `~/.config/blesh/init.sh`) if any.
- Remove the state directory `~/.local/state/blesh` if any.
- Remove the directory where `ble.sh` is installed. When you use `out/ble.sh`
inside the working tree of the git repository, the installed directory is the
directory of the repository. When you use `ble.sh` installed by `make
install`, the installed directory is `<PREFIX>/share/blesh` where `<PREFIX>`
(default: `~/.local`) is the prefix specified to `make install` in the
installation stage. When you use the version extracted from a tarball, the
directory created by extracting the tarball is the installed directory.
- Remove the cache directory `~/.cache/blesh` if any.
- Remove the state directory `~/.local/state/blesh` if any.
- Remove the temporary directory `/tmp/blesh` if any [ Only needed when your system does not automatically clears `/tmp` ].

# 2 Basic settings
Expand Down
23 changes: 23 additions & 0 deletions blerc.template
Original file line number Diff line number Diff line change
Expand Up @@ -966,6 +966,29 @@
#ble-bind -f C-w 'kill-region-or kill-uword'
#ble-bind -f M-w 'copy-region-or copy-uword'


## The following keybindings can be used to execute the command by RET even in
## the multiline mode.

# # For emacs editing mode
# ble-bind -m emacs -f 'C-m' 'accept-line'
# ble-bind -m emacs -f 'RET' 'accept-line'

# # For vim editing mode
# ble-bind -m vi_imap -f 'C-m' 'accept-line'
# ble-bind -m vi_imap -f 'RET' 'accept-line'
# ble-bind -m vi_nmap -f 'C-m' 'accept-line'
# ble-bind -m vi_nmap -f 'RET' 'accept-line'


## If you want to accept the suggestion by auto-complete using TAB, please use
## the following keybindings. By default, <right> key can be used to accept
## the suggestion, and <TAB> is assigned to the normal TAB completion which is
## independent of auto-complete.

# ble-bind -m auto_complete -f C-i auto_complete/insert
# ble-bind -m auto_complete -f TAB auto_complete/insert

##-----------------------------------------------------------------------------
## Settings for Emacs mode

Expand Down
1 change: 1 addition & 0 deletions docs/ChangeLog.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@
- docs(CONTRIBUTING): add styleguide (motivated by bkerin) `#D2056` 44cf6756
- docs(README): fix dead links to blerc.template (fixed by weskeiser) e0f3ac28
- github: add FUNDING `#D2080` 3f133936
- blerc: describe keybinding to accept autosuggestion by TAB (motivated by TehFunkWagnalls) `#D2090` xxxxxxxx

## Test

Expand Down
64 changes: 52 additions & 12 deletions note.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1905,18 +1905,6 @@ bash_tips
- make_command.sh の整理 (scan 分離, char_width 分離)
- note.txt -> memo.txt

2023-12-05

* wiki,blerc: TAB で auto-complete を確定させる方法
https://www.reddit.com/r/fishshell/comments/17xn8zs/comment/kbsrm2e/?utm_source=reddit&utm_medium=web2x&context=3

* アンインストールする方法

これは毎回確認を取ってから削除していくのが良い気がする。

アンインストールのスクリプトは独立したファイルであるべき? でも ble.sh 自体
を開きながら bash が処理すると考えれば途中で unlink してもちゃんと動く筈。

2023-10-04

* {,dir/}*.* が failglob エラー着色になる。本来は *.* に対して一致が試みられ
Expand Down Expand Up @@ -7064,6 +7052,58 @@ bash_tips

2023-12-06

* reject: 自動アンインストール機能? (motivated by BeastOfCaerbannog) [#D2091]
https://askubuntu.com/questions/1493857/powershell-like-history-auto-suggestion-for-bash

これは毎回確認を取ってから削除していくのが良い気がする。

アンインストールのスクリプトは独立したファイルであるべき? でも ble.sh 自体
を開きながら bash が処理すると考えれば途中で unlink してもちゃんと動く筈。

と思ったが実装するのは結構面倒そうな気がする。

x 先ず初めに複数の場所に ble.sh がインストールされていてその内の一つだけを
削除したいという時にどうすれば良いのか? 何処にあるのかも分からない他の
ble.sh のコピーを見つけるのは困難である。という事を考えると現在の ble.sh
コピーに関連する物だけを削除するしかない。

ユーザーに尋ねるとしてもユーザーは尋ねられれば、他の ble.sh コピーに関係
なく削除しても良いと勘違いする可能性もある。

x また state 等の情報に関しては勝手に削除しない方が良い様に思われる。ユーザー
自身が記述した設定に関しても勝手に削除する訳にはいかない。.bashrc の中の
記述を勝手に修正するのも困難だし不自然である。結局勝手に削除しても良いと
思われるのは ble.sh 本体のディレクトリとキャッシュディレクトリと tmp ディ
レクトリである。

結局 ble.sh 本体のディレクトリを削除する事ぐらいしか安全に自動化できない。
インストールディレクトリを検出するぐらいならできるかもしれないが、堅牢に検
出できるかわからないしそれ程便利でもない様な気がする。

取り敢えず README は更新した。

* wiki,blerc: TAB で auto-complete を確定させる方法 (motivated by TehFunkWagnalls) [#D2090]
https://www.reddit.com/r/fishshell/comments/17xn8zs/comment/kbsrm2e/?utm_source=reddit&utm_medium=web2x&context=3

blerc.template には追記した。一方で wiki の方にはそもそもそういう事を書いて
ある記事はない。Edit の中に例として記述するべきか? Vim 関連に関しては vim
editing mode 用の記事に書かれている。そもそも Edit は Manual の一部なので具
体的な設定の例を載せるのも変な気がする。だとすれば新しい記事を作るべきだろ
うか? というか Q&A の頁があった気がする。Q&A のページに書き加えた。

? 同時に Q&A にある設定例が blerc に反映されているか、及び逆はどうなのだろ
うか。確認してみると共有されている物は一個あったがそれ以外は全く共有され
ていない。

Q&A には複雑な物も含まれているので全てを blerc.template に転記するのは適
切でない気がする。取り敢えず RET で accept-line にするのは転記した。他は
blerc.template に入れる程のものでもない気がする。

一方で、blerc.template に含まれている物で Q&A に載せたら良さそうな物はあ
るか? →一つ転記した。一方で magic-slash 及び magic-space の無効化に関し
てはそういう Q&A がそうそう出てくるとも思えないので取り敢えずは転記しない
事にする。

* make: termux 内部でビルドできない (reported by rashil2000) [#D2089]
https://github.com/akinomyoga/ble.sh/issues/374

Expand Down

0 comments on commit cd06986

Please sign in to comment.