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 2
  • References/Ruby on Rails/Ruby/Classes/RDoc/RDoc::RI/RDoc::RI::Driver

run() Instance Public methods Looks up and displays ri data according to the

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

dump(data_path) Class Public methods Dump data_path using pp

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

load_methods_matching(name) Instance Public methods Returns an Array of RI data

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

interactive() Instance Public methods Runs ri interactively using

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

setup_pager() Instance Public methods Sets up a pager program to pass output

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

formatter(io) Instance Public methods Creates a new

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

process_args(argv) Class Public methods Parses argv and returns

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

display_page(name) Instance Public methods Outputs formatted RI data for page

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

class_document(name, found, klasses, includes, extends) Instance Public methods Builds

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