MENU
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

run
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::RI/RDoc::RI::Driver

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

2025-01-10 15:47:30
display_method
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::RI/RDoc::RI::Driver

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

2025-01-10 15:47:30
find_methods
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::RI/RDoc::RI::Driver

find_methods(name) Instance Public methods Yields items matching name

2025-01-10 15:47:30
method_type
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::RI/RDoc::RI::Driver

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

2025-01-10 15:47:30
default_options
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::RI/RDoc::RI::Driver

default_options() Class Public methods Default options for ri

2025-01-10 15:47:30
expand_class
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::RI/RDoc::RI::Driver

expand_class(klass) Instance Public methods Expands abbreviated klass klass

2025-01-10 15:47:30
start_server
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::RI/RDoc::RI::Driver

start_server() Instance Public methods Starts a

2025-01-10 15:47:30
add_extension_modules
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::RI/RDoc::RI::Driver

add_extension_modules(out, type, extensions) Instance Public methods Adds a

2025-01-10 15:47:30
add_includes
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::RI/RDoc::RI::Driver

add_includes(out, includes) Instance Public methods Adds includes

2025-01-10 15:47:30
display
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::RI/RDoc::RI::Driver

display(document) Instance Public methods Converts document to

2025-01-10 15:47:30