77.Nd Ruby API reference front end
88.Sh SYNOPSIS
99.Nm
10- .Op Fl Ti
10+ .Op Fl alTi
1111.Op Fl d Ar directory
1212.Op Fl f Ar format
13- .Op Fl -list-doc-dirs
13+ .Op Fl w Ar width
14+ .Op Fl -server Ns [= Ns Ar PORT Ns ]
1415.Op Fl -no-standard-docs
16+ .Op Fl - Ns Oo Cm no- Oc Ns Cm list-doc-dirs
1517.Op Fl - Ns Oo Cm no- Oc Ns Bro Cm system Ns | Ns Cm site Ns | Ns Cm gems Ns | Ns Cm home Brc
16- .Op Fl - Ns Oo Cm no- Oc Ns Cm use-cache
17- .Op Fl -width Ns = Ns Ar width
1818.Op Ar target ...
1919.Sh DESCRIPTION
2020.Nm
@@ -60,9 +60,22 @@ ri compact\!
6060.Sh OPTIONS
6161.Bl -tag -width " 1234567890123" -compact
6262.Pp
63+ .It Fl -help
64+ Show help and exit.
65+ .Pp
66+ .It Fl v
6367.It Fl -version
64- Prints the version of
65- .Nm .
68+ Output version information and exit.
69+ .Pp
70+ .It Fl a
71+ .It Fl - Ns Oo Cm no- Oc Ns Cm all
72+ Show all documentation for a class or module.
73+ .Pp
74+ .It Fl l
75+ .It Fl - Ns Oo Cm no- Oc Ns Cm list
76+ List classes
77+ .Nm
78+ knows about.
6679.Pp
6780.It Fl T
6881.It Fl -no-pager
@@ -73,18 +86,20 @@ Send output directly to stdout, rather than to a pager.
7386List of directories from which to source documentation in addition to the standard
7487directories. May be repeated.
7588.Pp
89+ .It Fl -server Ns [= Ns Ar PORT Ns ]
90+ Run RDoc server on the given port. The default port is 8214.
91+ .Pp
7692.It Fl f Ar FORMAT
77- .It Fl -fmt Ar FORMAT
7893.It Fl -format Ns = Ns FORMAT
7994Format to use when displaying output:
8095.Pp
81- ansi, bs, html, plain, simple
96+ ansi, bs, markdown, rdoc
8297.Pp
8398Use 'bs' (backspace) with most pager programs. To use ANSI, either disable the
8499pager or tell the pager to allow control characters.
85100.Pp
86101.It Fl i
87- .It Fl -interactive
102+ .It Fl - Ns Oo Cm no- Oc Ns Cm interactive
88103This makes
89104.Nm
90105go into interactive mode.
@@ -96,7 +111,7 @@ methods in case multiple methods match against a method search string. It also
96111will allow the user to enter in a method name (with auto-completion, if readline
97112is supported) when viewing a class.
98113.Pp
99- .It Fl -list-doc-dirs
114+ .It Fl - Ns Oo Cm no- Oc Ns Cm list-doc-dirs
100115List the directories from which ri will source documentation on stdout and exit.
101116.Pp
102117.It Fl -no-standard-docs
@@ -122,11 +137,6 @@ Include documentation from RubyGems. Defaults to true.
122137.It Fl - Ns Oo Cm no- Oc Ns Cm home
123138Include documentation stored in ~/.rdoc. Defaults to true.
124139.Pp
125- .It Fl - Ns Oo Cm no- Oc Ns Cm use-cache
126- Whether or not to use
127- .Nm Ns
128- .Ns 's cache. True by default.
129- .Pp
130140.It Fl w Ar width
131141.It Fl -width Ns = Ns Ar width
132142Set the width of the output.
0 commit comments