-*- coding: utf-8 -*-
ssss---------------------------------------------------

◆ xah@xah-VB3◆ 2012-12-08 15:40 ◆ ~
◆ ri --help
Usage: ri [options] [names...]

Where name can be:

  Class | Class::method | Class#method | Class.method | method

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.

For example:

    ri Fil
    ri File
    ri File.new
    ri zip

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.

Options may also be set in the 'RI' environment variable.

Options:

    -f, --format=NAME                Uses the selected formatter. The default
                                     formatter is bs for paged output and ansi
                                     otherwise. Valid formatters are:
                                     ansi bs html label rdoc test

    -T, --no-pager                   Send output directly to stdout,
                                     rather than to a pager.

    -w, --width=WIDTH                Set the width of the output.

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

    -l, --list                       List classes ri knows about.

        --[no-]profile               Run with the ruby profiler

Data source options:

        --list-doc-dirs              List the directories from which ri will
                                     source documentation on stdout and exit.

    -d, --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:

        --dump=CACHE                 Dumps data from an ri cache or data file
◆ xah@xah-VB3◆ 2012-12-08 15:41 ◆ ~