| Short description: |
A "perldoc" like for Ruby |
|---|
| Category: |
Documentation/From source |
|---|
| Status: |
usable |
|---|
| Created: |
2003-07-26 00:40:11 GMT |
|---|
| Last update: |
2003-09-24 19:01:37 GMT |
| Owner: |
greg
(Projects of this owner) |
|---|
| Homepage: |
http://gregoire.lejeune.free.fr |
|---|
| Download: |
http://gregoire.lejeune.free.fr/rubydoc_0.0.3.tar.gz
|
|---|
| License: |
GPL |
|---|
| Dependency: |
|
|---|
| Description: |
=begin
= NAME
rubydoc - Look up Ruby documentation in RD format.
= SYNOPSIS
rubydoc [options] <file>
= DESCRIPTION
rubydoc looks up a piece of documentation in RD format that is embedded in the ruby installation tree or in a ruby script, and displays it with 'man'.
You must have rdtool installed on your system.
rubydoc index is rubyidx (try $rubydoc rubyidx)
= OPTIONS
-P, --path path : set search path for manual pages to `path'.
-F, --file file : display manual pages for `file'.
-v, --version : show version.
-h, --help : show this usage message.
= EXEMPLE
$ rubydoc cgi
or
$ rubydoc -F/usr/bin/rubydoc
= CONFIG
You can configure rubydoc by creating a ~/.rubydoc file.
Example :
## man program
$RD_MAN = "/usr/bin/man"
## additinal ruby path file (separate by ,)
$RD_ADD_PATH = "~/dev/ruby,~/src/ruby"
= Changes
0.0.3
Ruby1.8 support
0.0.2
- Include and unofficial RD format of the "Ruby 1.4.6
Reference Manual"
(see: http://www.ruby-lang.org/en/20020107.html)
- Include end unofficial RD format of "The Ruby Language
FAQ"
(see: http://www.rubycentral.com/faq/rubyfaq.html)
0.0.1
Inital Release
= SEE ALSO
ruby(1)
=end
|
|---|