.\" DO NOT MODIFY THIS FILE! it was generated by rd2
.TH ri1.8 1 "April 2005"
.SH NAME
.PP
ri1.8 \- Ruby Information at your fingertips
.SH SYNOPSIS
.PP
ri1.8 [options] [names...]
.SH DESCRIPTION
.PP
\fIri1.8\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.8 File
\&    ri1.8 File.new
\&    ri1.8 F.n
\&    ri1.8 zip
.fi
.PP
Note that shell quoting may be required for method names
containing punctuation:
.nf
\&    ri1.8 'Array.[]'
\&    ri1.8 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.8.
.TP
.fi
.B
\-\-help, \-h
Display help.
.PP
Options may also be passed in the 'RI' environment variable