.Dd November 7, 2012 .Dt RI(1) "" "Ruby Programmers Reference Guide" .Os UNIX .Sh NAME .Nm ri .Nd Ruby API reference front end .Sh SYNOPSIS .Nm .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 ... .Sh DESCRIPTION .Nm is a CLI front end for the Ruby API reference. You can search and read API reference for classes and methods with .Nm .
p .Nm is a part of Ruby.
p .Ar target can be one of the following forms: l -diag -offset indent t Class for classes t Class::method for class methods t Class#method for instance methods t Class.method for both class and instance methods t method for both class and instance methods .El
p All class names may be abbreviated to their minimum unambiguous form. If a name is ambiguous, all valid options will be listed.
p For example: d -literal -offset indent ri Fil ri File ri File.new ri zip .Ed
p Note that shell quoting may be required for method names containing punctuation: d -literal -offset indent ri 'Array.[]' ri compact\! .Ed .Sh OPTIONS l -tag -width "1234567890123" -compact
p t Fl -version Prints the version of .Nm .
p t Fl T t Fl -no-pager Send output directly to stdout, rather than to a pager.
p t Fl d Ar directory t Fl -doc-dir Ns = Ns Ar directory List of directories from which to source documentation in addition to the standard directories. May be repeated.
p t Fl f Ar FORMAT t Fl -fmt Ar FORMAT t Fl -format Ns = Ns FORMAT Format to use when displaying output:
p ansi, bs, html, plain, simple
p Use 'bs' (backspace) with most pager programs. To use ANSI, either disable the pager or tell the pager to allow control characters.
p t Fl i t Fl -interactive This makes .Nm go into interactive mode.
p When .Nm 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.
p t Fl -list-doc-dirs List the directories from which ri will source documentation on stdout and exit.
p t Fl -no-standard-docs Do not include documentation from the Ruby standard library,
a site_lib , installed gems, or
a ~/.rdoc .
p Equivalent to specifying the options .Fl -no-system , Fl -no-site , Fl -no-gems , and .Fl -no-home .
p t Fl - Ns Oo Cm no- Oc Ns Cm system Include documentation from Ruby's standard library. Defaults to true.
p t Fl - Ns Oo Cm no- Oc Ns Cm site Include documentation from libraries installed in site_lib. Defaults to true.
p t Fl - Ns Oo Cm no- Oc Ns Cm gems Include documentation from RubyGems. Defaults to true.
p t Fl - Ns Oo Cm no- Oc Ns Cm home Include documentation stored in ~/.rdoc. Defaults to true.
p t Fl - Ns Oo Cm no- Oc Ns Cm use-cache Whether or not to use .Nm Ns .Ns 's cache. True by default.
p t Fl w Ar width t Fl -width Ns = Ns Ar width Set the width of the output.
p .El
p .Sh ENVIRONMENT l -tag -width "USERPROFILE" -compact
p t Ev RI Additional options.
p t Ev PAGER Used as the name of pager program for displaying.
p t Ev HOME t Ev USERPROFILE t Ev HOMEPATH Path to user's home directory. .El
p .Sh FILES l -tag -width "USERPROFILE" -compact
p t Pa ~/.ri Caches recently referenced documents here.
p t Pa ~/.rdoc Searches user-wide documents here.
p .El
p .Sh SEE ALSO .Xr ruby 1 .Xr rdoc 1 .Xr gem 1
p .Sh REPORTING BUGS l -bullet .Li Security vulnerabilities should be reported via an email to .Aq security@ruby-lang.org Ns .Li . Reported problems will be published after being fixed.
p .Li And you can report other bugs and feature requests via the Ruby Issue Tracking System (http://bugs.ruby-lang.org). Do not report security vulnerabilities via the system because it publishes the vulnerabilities immediately. .El .Sh AUTHORS Written by Dave Thomas .Aq dave@pragmaticprogrammer.com