1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
IHelp README
============
The IHelp (Interactive Help) package provides contextual help for
objects and methods by using ri.
Requirements
------------
* Ruby 1.8
* generated ri documentation
Install
-------
De-compress archive and enter its top directory.
Then type:
($ su)
# ruby setup.rb
These simple step installs this program under the default
location of Ruby libraries. You can also install files into
your favorite directory by supplying setup.rb some options.
Try "ruby setup.rb --help".
Usage
-----
Example:
require 'ihelp'
12.help
"string".help :reverse # cute syntax - "string".help:reverse
Array.help :map
help "Array#map"
# and, after generating ri docs for this (rdoc --ri ihelp/):
IHelp.help
To load IHelp automatically with irb, add the following to your .irbrc:
require 'ihelp'
If you think it makes the irb startup too slow, load it in a thread:
Thread.new{ require 'ihelp' }
Note that calling help will fail before it's completely loaded.
This may not work on Windows, so only use it if absolutely necessary.
See also
--------
ri --help
rdoc --help
ruby --help
The ruby-doc.org Ruby documentation project: http://www.ruby-doc.org/
Pickaxe book: http://www.ruby-doc.org/find/pickaxe
Why's (Poignant) Guide to Ruby: http://poignantguide.net/ruby/
License
-------
Ruby's
Ilmari Heikkinen <kig misfiring net>
http://fhtr.org/projects/ihelp/
|
