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

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

filter_methods(found, name) Instance Public methods Filters the methods in found

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

add_from(out, store) Instance Public methods Adds â(from â¦)â to out

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

page() Instance Public methods Paginates output through a pager program.

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

ancestors_of(klass) Instance Public methods Returns ancestor classes of klass

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

add_extends(out, extends) Instance Public methods Adds extends

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