【FreeBSD】POSIXのマニュアルをサクッと開きたい

確認環境

POXIX(というよりSUS？)のマニュアルはこちらのサイトで公開されている。
(POSIXとは何かについてはこちらの記事を参照。)

しかし、各マニュアルを開くためには通常下記手順が必要。とても面倒だ。

こんなんじゃマニュアル開くまでに、調べたいことを忘れちゃうよ。

もっとサクッとPOSIXのマニュアルを開けないものか。。。

manコマンドのように、POSIXのマニュアルページを開くシェルスクリプトを作れないだろうか。

シェルスクリプトの動作イメージは下記。

うん、これならそんなに難しくない気がする。

やってみよう。

以降、今回作成するシェルスクリプト名をpmanとする前提で説明。

単語を入力して検索フォームのトップページを開く。

> pman

POSIX(というよりSUS?)の仕様は下記分類になっており、マニュアルを開くには、どの分類のどのページなのか指定する必要がある。

今回のシェルスクリプトでは、分類はオプション(-b,-f,-u)で指定し、その後にページ名を指定する。

> pamn -b stdio.h   # XBD分類の stdio.h のページを開く  
> pamn -f printf    # XSH分類の printf のページを開く  
> pamn -u grep      # XCU分類の grep のページを開く

これは、調べたい対象の分類とページ名が分かっている場合のみ使える。
わからない場合は、後述の-sオプションを使って検索する。
一番頻度が高いと思われるgrepなどのコマンドなら、オプション-uは省略して良い。

> pman grep         # '-u'と同じでXCU分類の grep のページを開く

なお、XRATのページはあまり無さそうだったので用意していない。
(XRATのページを読みたい場合は、検索トップページに'Rationale'というリンクがあるよ)

分類やページ名が分からないときは、-sオプションで単語検索できる。
引数の単語での検索結果一覧ページを開く。

> pamn -s terminal

もし、wgetとw3mをインストールしていない場合は、下記コマンドでインストールしておこう。
(root権限で実行してね)

> pkg install wget ja-w3m

今回用意したシェルスクリプトはこちら。

ざっくりポイント解説。

スクリプトは、パスが通ったディレクトリ(*1)に保存して、実行権限を追加(chmod +x)するのをお忘れなく。
*1 ... 参考) パスを通す

wgetに--post-dataオプションをつけることで、HTTPのPOSTリクエストを送ることができる。

上記コードでは、valueという名前のパラメータに、変数$PAGE_NAMEの値を渡していることになる。

パラメータ名やリクエストを送るURLはサイトのHTMLのソースで確認。

これで、マニュアルを開くまでの手順を簡略化できた。

少し幸せになった。

ちなみにwgetに-kをつけているのは、リンクを絶対パスに変換するため。
実はこのオプションに頼るために、わざわざ一時ファイルとして保存している。
本当はオンメモリだけで済ませた方がいいのだろうけども、手抜きですな。

気に入らない人はチャレンジしてみてねと。

以上。