Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

181 lines (180 sloc) 4.222 kB
.\"Ruby is copyrighted by Yukihiro Matsumoto <>.
.Dd December 29, 2008
.Dt RI(1) "" "Ruby Programmers Reference Guide"
.Nm ri
.Nd Ruby API reference front end
.Op Fl Ti
.Op Fl d Ar directory
.Op Fl f Ar format
.Op Fl -list-doc-dirs
.Op Fl -no-standard-docs
.Op Fl - Ns Oo Cm no- Oc Ns Bro Cm system Ns | Ns Cm site Ns | Ns Cm gems Ns | Ns Cm home Brc
.Op Fl - Ns Oo Cm no- Oc Ns Cm use-cache
.Op Fl -width Ns = Ns Ar width
.Op Ar target ...
is a CUI front end for the Ruby API reference.
You can search and read API reference for classes and methods with
.Nm .
is a part of Ruby.
.Ar target
can be one of the following forms:
.Bl -diag -offset indent
.It Class
for classes
.It Class::method
for class methods
.It Class#method
for instance methods
.It Class.method
for both class and instance methods
.It method
for both class and instance methods
All class names may be abbreviated to their minimum unambiguous form. If a name
is ambiguous, all valid options will be listed.
For example:
.Bd -literal -offset indent
ri Fil
ri File
ri zip
Note that shell quoting may be required for method names containing
.Bd -literal -offset indent
ri 'Array.[]'
ri compact\!
.Bl -tag -width "1234567890123" -compact
.It Fl -version
Prints the version of
.Nm .
.It Fl T
.It Fl -no-pager
Send output directly to stdout, rather than to a pager.
.It Fl d Ar directory
.It Fl -doc-dir Ns = Ns Ar directory
List of directories from which to source documentation in addition to the standard
directories. May be repeated.
.It Fl f Ar FORMAT
.It Fl -fmt Ar FORMAT
.It Fl -format Ns = Ns FORMAT
Format to use when displaying output:
.Dd ansi, bs, html, plain, simple
Use 'bs' (backspace) with most pager programs. To use ANSI, either disable the
pager or tell the pager to allow control characters.
.It Fl i
.It Fl -interactive
This makes
go into interactive mode.
is in interactive mode it will allow the user to disambiguate lists of
methods in case multiple methods match against a method search string. It also
will allow the user to enter in a method name (with auto-completion, if readline
is supported) when viewing a class.
.It Fl -list-doc-dirs
List the directories from which ri will source documentation on stdout and exit.
.It Fl -no-standard-docs
Do not include documentation from the Ruby standard library,
.Pa site_lib ,
installed gems, or
.Pa ~/.rdoc .
Equivalent to specifying the options
.Fl -no-system , Fl -no-site , Fl -no-gems ,
.Fl -no-home .
.It Fl - Ns Oo Cm no- Oc Ns Cm system
Include documentation from Ruby's standard library. Defaults to true.
.It Fl - Ns Oo Cm no- Oc Ns Cm site
Include documentation from libraries installed in site_lib. Defaults to true.
.It Fl - Ns Oo Cm no- Oc Ns Cm gems
Include documentation from RubyGems. Defaults to true.
.It Fl - Ns Oo Cm no- Oc Ns Cm home
Include documentation stored in ~/.rdoc. Defaults to true.
.It Fl - Ns Oo Cm no- Oc Ns Cm use-cache
Whether or not to use
.Nm Ns
.Ns 's cache. True by default.
.It Fl w Ar width
.It Fl -width Ns = Ns Ar width
Set the width of the output.
.Bl -tag -width "USERPROFILE" -compact
.It Ev RI
Additional options.
Used as the name of pager program for displaying.
Path to user's home directory.
.Bl -tag -width "USERPROFILE" -compact
.It Pa ~/.ri
Caches recently referenced documents here.
.It Pa ~/.rdoc
Searches user-wide documents here.
.Xr ruby 1
.Xr rdoc 1
.Xr gem 1
.Bl -bullet
.Li Security vulnerabilities should be reported via an email to
.Aq Ns
.Li .
Reported problems will be published after fixed.
.Li And you can report other bugs and feature requests via the
Ruby Issue Tracking System (
Do not report security vulnerabilities
via the system because it publishes the vulnerabilities immediately.
Written by Dave Thomas
Jump to Line
Something went wrong with that request. Please try again.