> On Nov 18, 2016, at 17:02, Michael Lutsiuk <michael.lutsiuk / gmail.com> wrote:
> 
> Hi people, i have few questions. Where do i find paths where "ri"
> finds the documentation? I saw the rdoc/ri/paths.rb, but it is not the
> best way to know about paths. So, i'd like to see a documentation
> about where ri searches/saves a parsed documentation...
> 
> Didn't find anything on https://rdoc.github.io
> 
> Second, so "ri" generates a cli-docs from usual rdoc comments or it
> requires some additional/another markup? I looked to the
> rdoc/ri/driver.rb, but not sure.

3577 % ri --help
Usage: ri [options] [names...]

[...]

Options:

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

    -a, --[no-]all                   Show all documentation for a class or
                                     module.

    -l, --[no-]list                  List classes ri knows about.

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

    -T                               Synonym for --no-pager

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

        --server [PORT]              Run RDoc server on the given port.
                                     The default port is 8214.

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

Data source options:

        --[no-]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:

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

        --dump=CACHE                 Dumps data from an ri cache or data file


3577 % ri --list-doc-dirs
/System/Library/Frameworks/Ruby.framework/Versions/2.0/usr/share/ri/2.0.0/system
/System/Library/Frameworks/Ruby.framework/Versions/2.0/usr/share/ri/2.0.0/site
/Users/ryan/.rdoc
/System/Library/Frameworks/Ruby.framework/Versions/2.0/usr/lib/ruby/gems/2.0.0/doc/CFPropertyList-2.2.8/ri
/Library/Ruby/Gems/2.0.0/doc/ZenTest-4.12.0/ri
/Library/Ruby/Gems/2.0.0/doc/benchmark-ips-2.7.2/ri
/Library/Ruby/Gems/2.0.0/doc/coderay-1.1.0/ri
/Library/Ruby/Gems/2.0.0/doc/hoe-3.15.2/ri
/Library/Ruby/Gems/2.0.0/doc/hoe-doofus-1.0.0/ri
/Library/Ruby/Gems/2.0.0/doc/hoe-seattlerb-1.3.5/ri
/Library/Ruby/Gems/2.0.0/doc/isolate-3.3.1/ri
/Library/Ruby/Gems/2.0.0/doc/json-1.8.3/ri
/System/Library/Frameworks/Ruby.framework/Versions/2.0/usr/lib/ruby/gems/2.0.0/doc/libxml-ruby-2.6.0/ri
/Library/Ruby/Gems/2.0.0/doc/makerakeworkwell-1.0.3/ri
/Library/Ruby/Gems/2.0.0/doc/minitest-5.9.1/ri
/Library/Ruby/Gems/2.0.0/doc/minitest-autotest-1.0.3/ri
/Library/Ruby/Gems/2.0.0/doc/minitest-bisect-1.4.0/ri
/Library/Ruby/Gems/2.0.0/doc/minitest-server-1.0.4/ri
/Library/Ruby/Gems/2.0.0/doc/minitest-sprint-1.2.0/ri
/System/Library/Frameworks/Ruby.framework/Versions/2.0/usr/lib/ruby/gems/2.0.0/doc/nokogiri-1.5.6/ri
/Library/Ruby/Gems/2.0.0/doc/path_expander-1.0.0/ri
/Library/Ruby/Gems/2.0.0/doc/racc-1.4.14/ri
/Library/Ruby/Gems/2.0.0/doc/rake-10.4.2/ri
/Library/Ruby/Gems/2.0.0/doc/rake-compiler-0.9.9/ri
/Library/Ruby/Gems/2.0.0/doc/rdoc-4.2.2/ri
/Library/Ruby/Gems/2.0.0/doc/rubygems-cleanroom-1.0.3/ri
/Library/Ruby/Gems/2.0.0/doc/rubygems-sandbox-1.3.0/ri
/System/Library/Frameworks/Ruby.framework/Versions/2.0/usr/lib/ruby/gems/2.0.0/doc/sqlite3-1.3.7/ri
3578 % 



Unsubscribe: <mailto:ruby-talk-request / ruby-lang.org?subject=unsubscribe>
<http://lists.ruby-lang.org/cgi-bin/mailman/options/ruby-talk>