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 ruby: | ruby:NEWS | ruby:globals 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 con- taining 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 --a-[no-]all --l-[no-]list --[no-]pager -T --w-wWiIdDtThH=WIDTH --server[=PORT] --f-fFoOrRmMaAtT=FORMAT --h-help --v-version Data source options: --[no-]list-doc-dirs --d-dDoIcR-NdAiMrE=DIRNAME --no-standard-docs --[no-]system --[no-]site --[no-]gems --[no-]home Debug options: --[no-]profile --dump=CACHE 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 * Security vulnerabilities should be reported via an email to secu- rity@ruby-lang.org. 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 vulnerabili- ties immediately. AUTHORS Written by Dave Thomas <dave@pragmaticprogrammer.com>. UNIX April 20, 2017 RI(1)
NAME | SYNOPSIS | DESCRIPTION | OPTIONS | ENVIRONMENT | FILES | SEE ALSO | REPORTING BUGS | AUTHORS
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=ri&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>