# Ri

**URL:** <https://rubytalk.org/t/ri/73909>\
**Category:** ruby-talk\
**Created:** [19 November 2016 01:02 UTC](https://rubytalk.org/t/ri/73909 "2016-11-19T01:02:44Z")\
**Posts on this page:** 2\
**Page:** 1

<div class="post-metadata">

**Author:** ![Michael\_Lutsiuk](https://avatars.discourse-cdn.com/v4/letter/m/5fc32e/32.png) [@Michael\_Lutsiuk](https://rubytalk.org/u/Michael_Lutsiuk)\
**Post date:** [19 November 2016 01:02 UTC](https://rubytalk.org/t/ri/73909/1 "2016-11-19T01:02:44Z")

</div>

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

---

<div class="post-metadata">

**Author:** ![Ryan\_Davis1](https://yyz1.discourse-cdn.com/flex029/user_avatar/rubytalk.org/ryan_davis1/32/1848_2.png) [@Ryan\_Davis1](https://rubytalk.org/u/Ryan_Davis1)\
**Post date:** [19 November 2016 01:39 UTC](https://rubytalk.org/t/ri/73909/2 "2016-11-19T01:39:30Z")

</div>

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

[...]

Options:

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

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

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

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

&nbsp;&nbsp;&nbsp;&nbsp;-T Synonym for --no-pager

&nbsp;&nbsp;&nbsp;&nbsp;-w, --width=WIDTH Set the width of the output.

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

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

Data source options:

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;--[no-]list-doc-dirs List the directories from which ri will  
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;source documentation on stdout and exit.

&nbsp;&nbsp;&nbsp;&nbsp;-d, --doc-dir=DIRNAME List of directories from which to source  
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;documentation in addition to the standard  
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;directories. May be repeated.

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;--no-standard-docs Do not include documentation from  
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;the Ruby standard library, site\_lib,  
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;installed gems, or ~/.rdoc.  
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Use with --doc-dir

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;--[no-]system Include documentation from Ruby's standard  
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;library. Defaults to true.

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;--[no-]site Include documentation from libraries  
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;installed in site\_lib.  
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Defaults to true.

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;--[no-]gems Include documentation from RubyGems.  
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Defaults to true.

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;--[no-]home Include documentation stored in ~/.rdoc.  
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Defaults to true.

Debug options:

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;--[no-]profile Run with the ruby profiler

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;--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 %

> **···**
>
> > 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](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.