Linuxコマンドの使い方を調べるときに、manコマンドの説明を見ても分かりにくいと感じて、ブラウザで調べることが多々あって面倒だなと感じていました。
そこで、コマンドの説明が書かれたページをブラウザで表示するためのコマンドbman
を作成しました。
github: t-yng/bman
使い方
インストール方法
リポジトリをローカルにクローンして、install.sh
を実行してください。
$ git clone https://github.com/t-yng/bman && cd bman
$ sh ./install.sh
/usr/local/bin/
にシンボリックリンクが作成されます。
シンボリックリンクの作成場所は、環境に応じてinstal.sh
の中身を書き換えて、適宜変更してください。
※ スクリプトはRubyで書かれているので、Rubyの実行環境が必要になります。
マニュアルの表示
マニュアルページを表示したいコマンドを引数に渡すだけです。
$ bman ls
マニュアルの更新
新しいコマンドの追加や表示するマニュアルページの更新は--config
オプションで実行できます。
コマンドと対応するマニュアルページを入力することで、新しくコマンドとマニュアルページを追加できます。
もし既存のコマンドを指定した場合は、表示するマニュアルページを更新されます。
$ bman --config
add or update manual
command: awk
url of manual: https://hydrocul.github.io/wiki/commands/awk.html
コマンドとマニュアルページの一覧はmanual.json
に記述されているので、エディタでファイルを直接開いて、修正することも出来ます。
manual.json
{
"manual": [
{
"command": "&",
"url": "http://itpro.nikkeibp.co.jp//article/COLUMN/20060224/230589/"
},
{
"command": "&&",
"url": "http://itpro.nikkeibp.co.jp//article/COLUMN/20060224/230604/"
},
...