Type:
Class

The RI driver implements the command-line ri tool.

The driver supports:

  • loading RI data from:

    • Ruby's standard library

    • RubyGems

    • ~/.rdoc

    • A user-supplied directory

  • Paging output (uses RI_PAGER environment variable, PAGER environment variable or the less, more and pager programs)

  • Interactive mode with tab-completion

  • Abbreviated names (ri Zl shows Zlib documentation)

  • Colorized output

  • Merging output from multiple RI data sources

find_methods

find_methods(name) Instance Public methods Yields items matching name

2015-05-04 03:59:56
run

run(argv = ARGV) Class Public methods Runs the ri command line executable using

2015-05-04 02:08:28
display_method

display_method(name) Instance Public methods Outputs formatted RI data for method

2015-05-04 03:19:46
expand_class

expand_class(klass) Instance Public methods Expands abbreviated klass klass

2015-05-04 03:44:37
start_server

start_server() Instance Public methods Starts a

2015-05-04 05:07:58
default_options

default_options() Class Public methods Default options for ri

2015-05-04 01:51:28
method_type

method_type(selector) Instance Public methods Returns the type of method (:both

2015-05-04 04:47:40
find_store

find_store(name) Instance Public methods Finds a store that matches name

2015-05-04 04:04:03
expand_name

expand_name(name) Instance Public methods Expands the class portion of name

2015-05-04 03:51:28
display

display(document) Instance Public methods Converts document to

2015-05-04 03:13:49