ri(1) [osx man page]
RI(1) Ruby Programmers Reference Guide RI(1) NAME
ri -- Ruby API reference front end SYNOPSIS
ri [-Ti] [-d directory] [-f format] [--list-doc-dirs] [--no-standard-docs] [--[no-]{system|site|gems|home}] [--[no-]use-cache] [--width=width] [target ...] DESCRIPTION
ri is a CLI front end for the Ruby API reference. You can search and read API reference for classes and methods with ri. ri is a part of Ruby. target can be one of the following forms: Class for classes Class::method for class methods Class#method for instance methods Class.method for both class and instance methods 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: ri Fil ri File ri File.new ri zip Note that shell quoting may be required for method names containing punctuation: ri 'Array.[]' ri compact OPTIONS
--version Prints the version of ri. -T --no-pager Send output directly to stdout, rather than to a pager. -d directory --doc-dir=directory List of directories from which to source documentation in addition to the standard directories. May be repeated. -f FORMAT --fmt FORMAT --format=FORMAT Format to use when displaying output: Use 'bs' (backspace) with most pager programs. To use ANSI, either disable the pager or tell the pager to allow control char- acters. -i --interactive This makes go into interactive mode. When 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. --list-doc-dirs List the directories from which ri will source documentation on stdout and exit. --no-standard-docs Do not include documentation from the Ruby standard library, site_lib, installed gems, or ~/.rdoc. Equivalent to specifying the options --no-system, --no-site, --no-gems, and --no-home. --[no-]system Include documentation from Ruby's standard library. Defaults to true. --[no-]site Include documentation from libraries installed in site_lib. Defaults to true. --[no-]gems Include documentation from RubyGems. Defaults to true. --[no-]home Include documentation stored in ~/.rdoc. Defaults to true. --[no-]use-cache Whether or not to use 's cache. True by default. -w width --width=width Set the width of the output. ENVIRONMENT
RI Additional options. PAGER Used as the name of pager program for displaying. HOME USERPROFILE HOMEPATH Path to user's home directory. FILES
~/.ri Caches recently referenced documents here. ~/.rdoc Searches user-wide documents here. SEE ALSO
ruby(1) rdoc(1) gem(1) REPORTING BUGS
Security vulnerabilities should be reported via an email to <security@ruby-lang.org>. Reported problems will be published after being fixed. 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. AUTHORS
Written by Dave Thomas <dave@pragmaticprogrammer.com> UNIX
June 1, 2019 UNIX
Check Out this Related Man Page
RI(1) Ruby Programmer's Reference Guide RI(1) NAME
ri -- Ruby API reference front end SYNOPSIS
ri [-ahilTv] [-d DIRNAME] [-f FORMAT] [-w WIDTH] [--[no-]pager] [--server[=PORT]] [--[no-]list-doc-dirs] [--no-standard-docs] [--[no-]{system|site|gems|home}] [--[no-]profile] [--dump=CACHE] [name ...] DESCRIPTION
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. 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. A '.' 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. For example: 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 will search, run: ri --list-doc-dirs Specifying the --system, --site, --home, --gems, or --doc-dir options will limit ri to searching only the specified directories. ri options may be set in the RI environment variable. The ri pager can be set with the RI_PAGER environment variable or the PAGER environment variable. OPTIONS
-i --[no-]interactive In interactive mode you can repeatedly look up methods with autocomplete. -a --[no-]all Show all documentation for a class or module. -l --[no-]list List classes ri knows about. --[no-]pager Send output to a pager, rather than directly to stdout. -T Synonym for --no-pager. -w WIDTH --width=WIDTH Set the width of the output. --server[=PORT] Run RDoc server on the given port. The default port is 8214. -f FORMAT --format=FORMAT Use the selected formatter. The default formatter is bs for paged output and ansi otherwise. Valid formatters are: ansi, bs, markdown, rdoc. -h --help Show help and exit. -v --version Output version information and exit. Data source options: --[no-]list-doc-dirs List the directories from which ri will source documentation on stdout and exit. -d DIRNAME --doc-dir=DIRNAME List of directories from which to source documentation in addition to the standard directories. May be repeated. --no-standard-docs Do not include documentation from the Ruby standard library, site_lib, installed gems, or ~/.rdoc. Use with --doc-dir. --[no-]system Include documentation from Ruby's standard library. Defaults to true. --[no-]site Include documentation from libraries installed in site_lib. Defaults to true. --[no-]gems Include documentation from RubyGems. Defaults to true. --[no-]home Include documentation stored in ~/.rdoc. Defaults to true. Debug options: --[no-]profile Run with the Ruby profiler. --dump=CACHE Dump data from an ri cache or data file. ENVIRONMENT
RI Options to prepend to those specified on the command-line. RI_PAGER PAGER Pager program to use for displaying. HOME USERPROFILE HOMEPATH Path to the user's home directory. FILES
~/.rdoc Path for ri data in the user's home directory. SEE ALSO
ruby(1), rdoc(1), gem(1) REPORTING BUGS
o Security vulnerabilities should be reported via an email to security@ruby-lang.org. Reported problems will be published after being fixed. o Other bugs and feature requests can be reported via the Ruby Issue Tracking System (http://bugs.ruby-lang.org). Do not report security vulnerabilities via this system because it publishes the vulnerabilities immediately. AUTHORS
Written by Dave Thomas <dave@pragmaticprogrammer.com>. UNIX
April 20, 2017 UNIX