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:

                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.

     -i
     --interactive  This makes ri go into interactive mode.

                When ri 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 ri'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
     [email protected].  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 [email protected]

Opportunity

Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.

Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.

Free Software

Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.

Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.

Free Books

The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.

Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.

Education

Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.

Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.