RI(1)                1 (ruby programmer's reference guide)               RI(1)

<?><?><?> (NAME)
     ri - <?><?><?><?> <?><?> <?><?><?><?><?> <?><?><?><?> <?><?><?><?> API
     <?><?><?><?>

<?><?><?><?><?> <?><?><?><?><?> (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 <?><?> <?><?><?><?> <?><?> <?><?><?><?><?> <?><?><?><?> <?><?><?><?>
     API <?><?><?><?> Ruby <?><?><?>.  <?><?><?><?><?><?><?><?><?> <?><?>
     <?><?><?><?><?><?><?> <?><?> ri <?><?><?><?> API <?><?><?><?><?><?><?>
     <?> <?><?><?><?><?> <?><?> <?><?><?><?><?> <?><?><?><?> <?>
     <?><?><?><?><?><?> <?><?><?><?>.

     ri <?><?><?><?> <?><?> Ruby <?><?><?>.

     name <?><?><?><?><?><?><?><?> <?><?><?> <?><?> <?><?><?><?><?> <?><?><?>
     <?><?><?><?>:

           Class | Module | Module::Class
           Class::method | Class#method | Class.method | method
           gem_name: | gem_name:README | gem_name:History
           ruby: | ruby:NEWS | ruby:globals

     <?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?><?><?><?> <?><?>
     <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?><?><?><?> <?><?><?>
     <?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?> <?><?><?>.
     <?><?><?> <?><?><?><?> <?><?><?><?> <?><?><?><?><?> <?><?><?><?>
     <?><?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?>
     <?><?><?><?><?><?> <?><?>.

     <?><?> `.' <?><?> <?><?><?><?><?><?> <?><?><?><?> <?><?> <?><?><?><?><?>
     (instance) <?><?><?><?><?><?> <?><?><?><?><?> <?><?> <?><?><?><?> <?><?>
     #method <?><?><?><?> <?><?> <?><?><?><?><?><?> <?><?><?><?><?> <?>
     ::method <?><?><?><?> <?><?> <?><?><?><?><?><?> <?><?><?><?>
     <?><?><?><?><?><?> <?><?><?><?><?><?><?>.

     <?><?><?><?><?><?><?><?> README <?> <?><?><?><?> <?><?><?><?><?><?><?>
     <?><?> <?><?><?><?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?> <?><?><?>
     gem <?><?><?><?> <?><?><?><?><?> <?><?> <?><?><?><?><?>
     <?><?><?><?><?><?> <?><?><?><?><?> <?><?><?>. <?><?><?> <?><?><?> <?><?>
     <?><?><?> gem <?><?> `:' <?><?><?><?> <?><?><?><?><?> <?><?><?><?>
     <?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?> <?><?> gem
     <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?> <?><?>.  <?><?><?><?><?>
     <?><?><?> <?><?><?><?> <?><?> <?><?><?><?><?> <?><?> <?><?><?><?><?><?>
     <?><?><?><?> <?><?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?>
     <?><?><?> <?><?><?>.

     <?><?><?><?> <?><?><?><?><?>:

           ri Fil
           ri File
           ri File.new
           ri zip
           ri rdoc:README

     <?><?><?><?> <?><?><?><?><?> <?><?><?><?><?> <?><?> <?><?><?><?>
     <?><?><?> <?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?> <?><?>
     <?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?><?>
     <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?> (quoting) <?><?>
     <?><?><?><?> (escaping) <?><?> <?><?><?><?><?> <?><?><?><?> <?><?><?><?>:

           ri 'Array.[]'
           ri compact\!

     <?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?><?><?><?><?>
     <?><?><?><?><?><?><?><?> <?><?> ri <?><?> <?><?><?><?><?> <?><?><?><?><?>
     <?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?> <?><?> <?><?><?><?>
     <?><?><?><?>:

           ri --list-doc-dirs

     <?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?><?> --system, --site,
     --home, --gems, <?><?> --doc-dir <?><?><?><?><?><?> ri <?><?>
     <?><?><?><?> <?><?> <?><?><?><?><?><?><?><?><?><?><?><?><?>
     <?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?>.

     <?><?><?><?><?><?><?><?><?> ri <?><?> <?><?><?><?><?><?><?> <?><?>
     <?><?><?><?><?> <?><?><?><?><?> RI <?><?><?><?><?> <?><?><?>.

     <?><?><?><?><?><?><?><?><?><?><?><?><?><?><?> (pager) <?><?><?><?><?><?>
     ri <?><?> <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?> <?><?><?><?><?>
     RI_PAGER <?><?> <?><?><?><?><?> <?><?><?><?><?> PAGER <?><?><?><?><?>
     <?><?><?>.

<?><?><?><?><?><?><?><?> (OPTIONS)
     -i
     --[no-]interactive
                    <?><?> <?><?><?><?> <?><?><?><?><?><?>
                    <?><?><?><?><?><?><?><?><?> <?><?> <?><?><?> <?><?><?><?>
                    <?><?><?><?><?> <?><?> <?><?> <?><?><?><?><?><?><?> <?><?>
                    <?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?>
                    <?><?><?><?>.

     -a
     --[no-]all     <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?>
                    <?><?><?><?><?> <?><?> <?><?> <?><?><?><?> <?><?>
                    <?><?><?><?><?>.

     -l
     --[no-]list    <?><?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?><?><?>
                    <?><?> ri <?><?> <?><?><?><?><?> <?><?><?><?> <?><?><?>.

     --[no-]pager   <?><?><?><?><?> <?><?><?><?><?> <?><?> <?><?>
                    <?><?><?><?><?><?><?><?><?><?><?><?><?><?><?> (pager)<?>
                    <?><?> <?><?><?> <?><?><?><?><?> <?><?><?><?><?><?> <?><?>
                    stdout.

     -T             <?><?><?><?><?><?> <?><?> --no-pager.

     -w WIDTH
     --width=WIDTH  <?><?><?><?><?> <?><?><?> <?><?><?><?><?>.

     --server[=PORT]
                    <?><?><?><?><?> <?><?><?><?> RDoc <?><?><?>
                    <?><?><?><?><?> <?><?><?><?><?><?><?><?>.  <?><?><?><?><?>
                    <?><?><?><?><?><?><?> 8214 <?><?><?>.

     -f FORMAT
     --format=FORMAT
                    <?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?><?>
                    (formatter) <?><?><?><?><?><?><?><?><?><?>.
                    <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?>
                    <?><?><?><?> <?><?><?><?><?>
                    <?><?><?><?><?><?><?><?><?><?><?><?><?> bs <?> <?><?>
                    <?><?><?> <?><?><?> <?><?><?><?> ansi <?><?><?>.
                    <?><?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?>
                    <?><?><?><?><?><?><?> <?><?>: ansi, bs, markdown, rdoc.

     -h
     --help         <?><?><?><?><?> <?><?><?><?><?><?> <?> <?><?><?><?>.

     -v
     --version      <?><?><?> <?><?><?><?><?><?><?> <?><?><?><?> <?>
                    <?><?><?><?>.

     <?><?><?><?><?><?><?><?><?> <?><?><?><?> <?><?><?><?>:

     --[no-]list-doc-dirs
                    <?><?><?><?><?> <?><?><?><?>
                    <?><?><?><?><?><?><?><?><?><?><?><?><?><?> <?><?> ri
                    <?><?><?><?><?><?><?> <?><?> <?><?> <?><?><?><?><?>
                    <?><?><?><?><?> <?><?><?><?><?><?> <?><?> stdout <?>
                    <?><?><?><?>.

     -d DIRNAME
     --doc-dir=DIRNAME
                    <?><?><?><?><?><?> <?><?>
                    <?><?><?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?>
                    <?><?> <?><?><?><?><?><?><?><?><?><?><?><?><?>
                    <?><?><?><?><?><?><?><?><?> <?><?> <?><?><?><?><?><?><?>
                    <?><?> <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?>.
                    <?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?>.

     --no-standard-docs
                    <?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?>
                    <?><?><?><?><?><?><?><?><?> Ruby<?> site_lib <?>
                    gem<?><?><?> <?><?><?><?><?><?><?><?> <?><?> ~/.rdoc
                    <?><?><?><?> <?><?><?><?>.  <?><?><?><?><?> <?><?>
                    --doc-dir <?><?><?><?><?><?><?> <?><?><?>.

     --[no-]system  <?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?> <?><?>
                    <?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?> Ruby.
                    <?><?><?><?><?><?><?> true <?><?><?>.

     --[no-]site    <?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?> <?><?>
                    <?><?><?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?>
                    <?><?> site_lib.  <?><?><?><?><?><?><?> true <?><?><?>.

     --[no-]gems    <?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?> <?><?>
                    RubyGems. <?><?><?><?><?><?><?> true <?><?><?>.

     --[no-]home    <?><?><?><?> <?><?><?><?> <?><?><?><?><?><?><?>
                    <?><?><?><?><?><?><?><?><?> <?><?> ~/.rdoc.
                    <?><?><?><?><?><?><?> true <?><?><?>.

     <?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?><?><?>:

     --[no-]profile
                    <?><?><?><?> <?><?><?><?><?> <?><?>
                    <?><?><?><?><?><?><?><?> Ruby.

     --dump=CACHE   <?><?><?><?><?> (dump) <?><?><?><?><?><?><?> <?><?>
                    <?><?><?><?><?> <?><?> <?><?> <?><?><?><?> <?><?><?><?>
                    ri.

<?><?><?><?> (ENVIRONMENT)
     RI           <?><?><?><?><?><?><?><?><?><?> <?><?> <?><?>
                  <?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?>
                  <?><?><?><?><?><?><?><?> <?><?> <?><?> <?><?><?><?><?>
                  <?><?><?><?><?> <?><?><?><?><?><?><?>.

     RI_PAGER
     PAGER        <?><?><?><?><?><?>
                  <?><?><?><?><?><?><?><?><?><?><?><?><?><?><?> (pager)
                  <?><?><?><?> <?><?><?><?><?><?><?> <?><?><?><?>
                  <?><?><?><?><?>.

     HOME
     USERPROFILE
     HOMEPATH     <?><?><?><?> <?><?><?><?><?><?><?><?><?> <?><?><?><?><?>
                  <?><?><?><?><?>.

<?><?><?><?><?><?><?> (FILES)
     ~/.rdoc      <?><?><?><?> <?><?><?><?><?><?><?><?> ri <?><?>
                  <?><?><?><?><?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?>.

<?><?><?><?><?><?> <?><?><?><?><?><?> (SEE ALSO)
     ruby(1), rdoc(1), gem(1)

<?><?><?><?><?> <?><?><?><?><?><?> (BUGS)
     o   <?><?><?><?><?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?>
         <?><?><?><?> <?><?> <?><?><?><?> <?><?><?><?><?> <?><?>
         security@ruby-lang.org <?><?><?><?><?> <?><?><?><?>.
         <?><?><?><?><?><?> <?><?><?><?><?><?><?><?><?> <?><?> <?><?>
         <?><?><?> <?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?> <?><?>.

     o   <?><?><?><?> <?><?><?><?><?><?> <?> <?><?><?><?><?><?><?><?><?><?><?>
         <?><?><?><?><?><?> <?><?><?><?> <?><?> <?><?><?><?><?><?><?> <?><?>
         <?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?><?> <?><?><?><?><?>
         Ruby (https://bugs.ruby-lang.org) <?><?><?><?><?> <?><?><?>.
         <?><?><?><?><?><?><?><?><?><?><?><?><?><?> <?><?><?><?><?><?> <?><?>
         <?><?> <?><?><?><?> <?><?><?> <?><?><?><?><?><?> <?><?><?><?><?>
         <?><?><?><?><?> <?><?><?> <?><?> <?><?><?><?><?><?><?><?>
         <?><?><?><?><?><?><?><?><?><?><?><?><?> <?><?> <?><?> <?><?><?>
         <?><?><?><?><?> <?><?><?><?><?> <?><?><?><?><?><?>.

<?><?><?><?><?><?><?><?><?> (AUTHORS)
     <?><?><?><?><?><?><?><?><?> <?><?><?><?> Dave Thomas
     <dave@pragmaticprogrammer.com>.

UNIX                            April 20, 2017                            UNIX