Rubyのオンライン・マニュアル

このところ「初めてのRuby」をかじっている。そのp19に検索のコマンド「ri」の紹介が在る。このコマンドで「クラス名やメソッド名を入力するとリファレンス(英語)が引ける」ようです。

そこで「man ri」を打つとマニュアルがでるものの、実例を打っても意味ある回答がでません。

div-mm:~ u1$ ri String
Nothing known about String 

どうも、「ri」が表示すべきデータは「rdoc」コマンドで生成する必要があるようです。

どうせなら日本語のオンライン・マニュアルが欲しいので、検索すると；

上記の「Ruby 1.8.7/1.9.2リファレンスマニュアル」をダウンロードしてダブルクリックすると,下記のように解凍される；

div-mm:~/Downloads/ruby-refm-1.9.2-dynamic-20110729 u1$ ll
total 3000
drwxr-xr-x@ 22 u1  staff      748  7 29 22:41 bitclust/
drwxr-xr-x@  9 u1  staff      306  7 29 22:42 db-1_8_7/
drwxr-xr-x@  9 u1  staff      306  7 29 22:42 db-1_9_2/
-rw-r--r--   1 u1  staff     1012  7 29 22:42 readme.html
-rwxr-xr-x@  1 u1  staff       98  7 29 22:42 refe-1_8_7*
-rw-r--r--@  1 u1  staff      102  7 29 22:42 refe-1_8_7.cmd
-rwxr-xr-x@  1 u1  staff       98  7 29 22:42 refe-1_9_2*
-rw-r--r--@  1 u1  staff      102  7 29 22:42 refe-1_9_2.cmd
-rw-r--r--@  1 u1  staff  1503232  7 29 22:41 server.exe
-rw-r--r--@  1 u1  staff     5724  7 29 22:41 server.exy
-rwxr-xr-x@  1 u1  staff      316  7 29 22:42 server.rb*
div-mm:~/Downloads/ruby-refm-1.9.2-dynamic-20110729 u1$

この内、「*.cmd, *.exe, *.exy」はMacでは不要である。 上のディレクトリは「~/myLocal/ruby_references/ruby-refm-1.9.2-dynamic-20110729/」に移動し、これを$PATHに登録している「~/myLocal/bin/」に修正したシェル・スクリプトを置いた；

div-mm:~ u1$ cd myLocal/
div-mm:~/myLocal u1$ ll
total 0
drwxr-xr-x  7 u1  staff  238  1 27 23:49 bin/
drwxr-xr-x  5 u1  staff  170  1 27 23:53 ruby_references/
div-mm:~/myLocal u1$ ll bin/
total 24
-rwxr-xr-x  1 u1  staff  141  1 27 20:51 refe18*
-rwxr-xr-x  1 u1  staff  141  1 27 21:18 refe19*
-rwxr-xr-x  1 u1  staff   92  1 27 22:48 refers*
drwxr-xr-x  3 u1  staff  102  1 27 23:35 test/
div-mm:~/myLocal u1$ ll ruby_references/
total 0
drwxr-xr-x  11 u1  staff  374  1 27 12:33 Wib_Info/
drwxr-xr-x@ 10 u1  staff  340  1 27 22:33 ruby-refm-1.9.2-dynamic-20110729/
div-mm:~/myLocal u1$ ll ruby_references/ruby-refm-1.9.2-dynamic-20110729/
total 32
drwxr-xr-x@ 22 u1  staff   748  7 29  2011 bitclust/
drwxr-xr-x@  9 u1  staff   306  7 29  2011 db-1_8_7/
drwxr-xr-x@  9 u1  staff   306  7 29  2011 db-1_9_2/
-rw-r--r--   1 u1  staff  1012  7 29  2011 readme.html
-rwxr-xr-x@  1 u1  staff    98  7 29  2011 refe-1_8_7*
-rwxr-xr-x@  1 u1  staff    98  7 29  2011 refe-1_9_2*
-rwxr-xr-x   1 u1  staff   316  7 29  2011 server.rb*
div-mm:~/myLocal u1$ cd bin
div-mm:~/myLocal/bin u1$ cat refe18
#!/bin/sh
cd ~/myLocal/ruby_references/ruby-refm-1.9.2-dynamic-20110729/
exec ruby -Ke -I bitclust/lib bitclust/bin/refe.rb -d db-1_8_7 "$@"
div-mm:~/myLocal/bin u1$ 
div-mm:~/myLocal/bin u1$ cat refe19
#!/bin/sh
cd ~/myLocal/ruby_references/ruby-refm-1.9.2-dynamic-20110729/
exec ruby -Ke -I bitclust/lib bitclust/bin/refe.rb -d db-1_9_2 "$@"
div-mm:~/myLocal/bin u1$ 
div-mm:~/myLocal/bin u1$ cat refers
#!/bin/sh
cd ~/myLocal/ruby_references/ruby-refm-1.9.2-dynamic-20110729/
exec ruby server.rbdiv-mm:~/myLocal/bin u1$ 

従って、ターミナル使用中にレファレンス・マニュアルを書き出しが可能となる。；

• $ refe18 複数キーワード：Ruby 1.8.7のリファレンス・マニュアル(日本語) 
• $ refe19 複数キーワード：Ruby 1.9.2のリファレンス・マニュアル(日本語) 

またブラウザでローカルなリファレンス・マニュアルを出すには；

• ターミナルで「$ refers」と打って、マニュアル・サーバを準備して、
• ブラウザで「http://localhost:10080/」を開く。

ここら辺はもう少し工夫をすれば、スマートになるだろう。

ーーーー このポストの履歴

1. 開始 2012-01-27  (金) 01:59
2. 修正 2012-01-28  (土) 00:06