|RI(1)||1 (ruby programmer's reference guide)||RI(1)|
ri — Ruby API
reference front end
ri is a command-line front end for the
Ruby API reference. You can search and read the API reference for classes
and methods with
ri is a part of Ruby.
name can be:
- Class | Module | Module::Class
- Class::method | Class#method | Class.method | method
- gem_name: | gem_name:README | gem_name:History
All class names may be abbreviated to their minimum unambiguous form. If a name is ambiguous, all valid options will be listed.
.’ matches either class
or instance methods, while #method matches only instance and ::method
matches only class methods.
README and other files may be displayed by prefixing them with the
gem name they're contained in. If the gem name is followed by a
:’ all files in the gem will be
shown. The file name extension may be omitted where it is unambiguous.
ri Fil ri File ri File.new ri zip ri rdoc:README
Note that shell quoting or escaping may be required for method names containing punctuation:
ri 'Array.' ri compact\!
To see the default directories
ri to searching only the specified
ri options may be set in the
RI environment variable.
ri pager can be set with the
RI_PAGER environment variable or the
PAGER environment variable.
- In interactive mode you can repeatedly look up methods with autocomplete.
- Show all documentation for a class or module.
- List classes
- Send output to a pager, rather than directly to stdout.
- Synonym for
- Set the width of the output.
- Run RDoc server on the given port. The default port is 8214.
- Use the selected formatter. The default formatter is
bsfor paged output and
ansiotherwise. Valid formatters are:
- Show help and exit.
- Output version information and exit.
Data source options:
- List the directories from which
riwill source documentation on stdout and exit.
- List of directories from which to source documentation in addition to the standard directories. May be repeated.
- Do not include documentation from the Ruby standard library,
site_lib, installed gems, or
~/.rdoc. Use with
- Include documentation from Ruby's standard library. Defaults to true.
- Include documentation from libraries installed in site_lib. Defaults to true.
- Include documentation from RubyGems. Defaults to true.
- Include documentation stored in ~/.rdoc. Defaults to true.
- Run with the Ruby profiler.
- Dump data from an ri cache or data file.
- Path for ri data in the user's home directory.
- Security vulnerabilities should be reported via an email to email@example.com. Reported problems will be published after being fixed.
- Other bugs and feature requests can be reported via the Ruby Issue Tracking System (https://bugs.ruby-lang.org/). Do not report security vulnerabilities via this system because it publishes the vulnerabilities immediately.
Written by Dave Thomas ⟨firstname.lastname@example.org⟩.
|April 20, 2017||UNIX|