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

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

add_method_list(out, methods, name) Instance Public methods Adds a list of

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

find_pager_jruby(pager) Instance Public methods Finds the given pager

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

in_path?(file) Instance Public methods Is file in

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

new(initial_options = {}) Class Public methods Creates a new driver using

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

add_also_in(out, also_in) Instance Public methods Adds paths for undocumented

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

list_methods_matching(name) Instance Public methods Returns an Array of methods

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

paging?() Instance Public methods Are we using a pager?

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

list_known_classes(names = []) Instance Public methods Lists classes known to

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

name_regexp(name) Instance Public methods Returns a regular expression for name

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

parse_name(name) Instance Public methods Extracts the class, selector and method

2025-01-10 15:47:30