Linux "ri" Command Line Options and Examples

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. ri is a part of Ruby.

Usage:

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 ...]

Related Commands

ruby

Command Line Options:

--[no-]interactive

In interactive mode you can repeatedly look up methods with autocomplete.


                            ri --[no-]interactive ...

--[no-]all

Show all documentation for a class or module.


                            ri --[no-]all ...

--[no-]list

List classes ri knows about.


                            ri --[no-]list ...

--[no-]pager

Send output to a pager, rather than directly to stdout.


                            ri --[no-]pager ...

-T

Synonym for --no-pager.


                            ri -T ...

--width

Set the width of the output.


                            ri --width ...

--server[

Run RDoc server on the given port. The default port is 8214.


                            ri --server[ ...

--format

Use the selected formatter. The default formatter is bs for paged output and ansi otherwise.Valid formatters are: ansi, bs, markdown, rdoc.


                            ri --format ...

--help

Show help and exit.


                            ri --help ...

--version

Data source options:


                            ri --version ...

--[no-]list-doc-dirs

List the directories from which ri will source documentation on stdout and exit.


                            ri --[no-]list-doc-dirs ...

--doc-dir

List of directories from which to source documentation in addition to the standard directories.May be repeated.


                            ri --doc-dir ...

--no-standard-docs

Do not include documentation from the Ruby standard library, site_lib, installed gems, or~/.rdoc. Use with --doc-dir.


                            ri --no-standard-docs ...

--[no-]system

Include documentation from Ruby's standard library. Defaults to true.


                            ri --[no-]system ...

--[no-]site

Include documentation from libraries installed in site_lib. Defaults to true.


                            ri --[no-]site ...

--[no-]gems

Include documentation from RubyGems. Defaults to true.


                            ri --[no-]gems ...

--[no-]profile

Run with the Ruby profiler.


                            ri --[no-]profile ...

--dump=CACHE

ENVIRONMENTRI Options to prepend to those specified on the command-line.RI_PAGERPAGER Pager program to use for displaying.HOMEUSERPROFILEHOMEPATH Path to the user's home directory.FILES~/.rdoc Path for ri data in the user's home directory.


                            ri --dump=CACHE ...