1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
.\" DO NOT MODIFY THIS FILE! it was generated by rd2
.TH ri1.9.1 "April 2005"
.SH NAME
.PP
ri1.9.1 \- Ruby Information at your fingertips
.SH SYNOPSIS
.PP
ri1.9.1 [options] [names...]
.SH DESCRIPTION
.PP
\fIri1.9.1\fP displaies information on Ruby classes, modules, and methods.
You can give the names of classes or methods to see their documentation.
Partial names may be given: if the names match more than
one entity, a list will be shown, otherwise details on
that entity will be displayed.
.PP
Nested classes and modules can be specified using the normal
Name::Name notation, and instance methods can be distinguished
from class methods using "." (or "#") instead of "::".
.PP
For example:
.nf
\& ri1.9.1 File
\& ri1.9.1 File.new
\& ri1.9.1 F.n
\& ri1.9.1 zip
.fi
.PP
Note that shell quoting may be required for method names
containing punctuation:
.nf
\& ri1.9.1 'Array.[]'
\& ri1.9.1 compact\\!
.fi
.SH OPTIONS
.TP
.fi
.B
\-\-classes, \-c
Display the names of classes and modules we know about.
.TP
.fi
.B
\-\-doc\-dir, \-d dirname
A directory to search for documentation. If not specified, we search the
standard rdoc/ri directories.
.TP
.fi
.B
\-\-format, \-f name
Format to use when displaying output: ansi, bs, html, plain, simple. Use
\'bs' (backspace) with most pager programs. To use ANSI, either also use
the \-T option, or tell your pager to allow control characters. (for
example using the \-R option to less.)
.TP
.fi
.B
\-\-list\-names, \-l
List all the names known to RDoc, one per line.
.TP
.fi
.B
\-\-no\-pager, \-T
Send output directly to stdout.
.TP
.fi
.B
\-\-width, \-w width
Set the width of the output.
.TP
.fi
.B
\-\-version, \-v
Display the version of ri1.9.1.
.TP
.fi
.B
\-\-help, \-h
Display help.
.PP
Options may also be passed in the 'RI' environment variable
|
