ri.1

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