mirror of
https://github.com/ruby/ruby.git
synced 2022-11-09 12:17:21 -05:00
f63aae063a
a patch from Eugene Ossintsev <eugoss AT gmail.com>. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@13609 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
49 lines
1.5 KiB
Ruby
Executable file
49 lines
1.5 KiB
Ruby
Executable file
#!/usr/bin/env ruby
|
|
# usage:
|
|
#
|
|
# ri name...
|
|
#
|
|
# where name can be
|
|
#
|
|
# Class | Class::method | Class#method | Class.method | method
|
|
#
|
|
# All names may be abbreviated to their minimum unambiguous form. If a name
|
|
# _is_ ambiguous, all valid options will be listed.
|
|
#
|
|
# The form '.' method matches either class or instance methods, while
|
|
# #method matches only instance and ::method matches only class methods.
|
|
#
|
|
#
|
|
# == Installing Documentation
|
|
#
|
|
# 'ri' uses a database of documentation built by the RDoc utility.
|
|
#
|
|
# So, how do you install this documentation on your system?
|
|
# It depends on how you installed Ruby.
|
|
#
|
|
# <em>If you installed Ruby from source files</em> (that is, if it some point
|
|
# you typed 'make' during the process :), you can install the RDoc
|
|
# documentation yourself. Just go back to the place where you have
|
|
# your Ruby source and type
|
|
#
|
|
# make install-doc
|
|
#
|
|
# You'll probably need to do this as a superuser, as the documentation
|
|
# is installed in the Ruby target tree (normally somewhere under
|
|
# <tt>/usr/local</tt>.
|
|
#
|
|
# <em>If you installed Ruby from a binary distribution</em> (perhaps
|
|
# using a one-click installer, or using some other packaging system),
|
|
# then the team that produced the package probably forgot to package
|
|
# the documentation as well. Contact them, and see if they can add
|
|
# it to the next release.
|
|
#
|
|
|
|
|
|
require 'rdoc/ri/ri_driver'
|
|
|
|
######################################################################
|
|
|
|
ri = RiDriver.new
|
|
ri.process_args
|
|
|