ReFe

$Id: refe.ja.rhtml,v 1.2 2003/10/17 15:16:37 aamine Exp $

• 基本セット + リファレンス + Rubyソースコード
• 基本セット + リファレンス
• 基本セット (100KB)
• 旧バージョンのリスト

クラス名とメソッド名から Ruby のリファレンスマニュアルのエントリを引く、 コマンドライン用のツールです。読みは「りふぇ」。 ri をパクって日本語・RD に対応させたものです。

# 最も簡単な例

~ % refe String concat
String#concat
--- self << other
--- concat(other)

    文字列 other の内容を self に連結します。
    other が 0 から 255 の範囲の Fixnum である場合は
    その 1 バイトを末尾に追加します。

    self を返します。

クラス名やメソッド名の補完機能があるので長いメソッド名を 全部入力する必要がありません。 例えば String#gsub! なら refe s gsu で検索できます。

またオプションとして、Ruby の拡張ライブラリ API リファレンスや ruby の関数を引くこともできます。たとえば refe -e data get で Data_Get_Struct のマニュアルを見ることができます。

実行例

### メソッドのドキュメントを検索
$ refe String          String のメソッド一覧を表示
$ refe each_with_index Enumerable#each_with_index の説明を表示
$ refe String#index    String#index の説明を表示
$ refe s#ind           String#index の説明を表示
$ refe inde            Array#index String#index など、一致する候補を表示
$ refe s ind           String#index の説明を表示
$ refe st g!           String#gsub! の説明を表示

### Ruby C API のドキュメントを検索
$ refe -e r d class          rb_define_class() の説明を表示
$ refe -e _s args            rb_scan_args() の説明を表示

### メソッドの実体の関数を検索 (メソッド名から)
$ refe -c s g!               rb_str_gsub_bang() の内容を表示

### メソッドの実体の関数を検索 (関数名から)
$ refe -C rb_str_gsub_bang   rb_str_gsub_bang() の内容を表示
$ refe -C r e s w            下線でくぎられた単語ごとに補完可能！
			     → rb_eval_string_wrap()
$ refe -C r eval             最後の単語が完全一致したら残りは切り捨て
			     → rb_eval()

### sprintf フォーマットなども検索できる
$ refe man.sprintf