Rubyのドキュメント

Rubyリファレンスマニュアル

Rubyのリファレンスマニュアルには言語仕様・組み込みクラスライブラリ・標準添付ライブラリ・拡張ライブラリAPIの全てが記述されている。

拡張ライブラリのリファレンスは付録の「Ruby Documentation Project (RDP)」の先にある。

いちいちウェブブラウザを立ちあげてリファレンスを索くのは面倒である。そこで筆者が作成した ReFe だ。これを使うとコマンドラインからリファレンスが索ける。補完もできるので例えば

% refe s g!

と打つと String#gsub! のリファレンスが表示される。

この ReFe に食わせるのは、HTML だとパースしにくいので、その元になっている RD というフォーマットのものを使っている。そのファイルももちろん同梱した。以下の二つがそうだ。

ReFe に関しては http://i.loveruby.net/ja/prog/refe.html を参照のこと。

シェルより Emacs が好き、という方には、るびきちさん作の RDindex をお勧めする。