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

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

classes() Instance Public methods

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

complete(name) Instance Public methods Completes name based on

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

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

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

display_page_list(store, pages = store.cache[:pages], search = nil) Instance Public methods

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

display_class(name) Instance Public methods Outputs formatted RI data for class

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
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