from small one page howto to huge articles all in one place
 

search text in:





Poll
Which kernel version do you use?





poll results

Last additions:
using iotop to find disk usage hogs

using iotop to find disk usage hogs

words:

887

views:

100356

userrating:

average rating: 1.7 (84 votes) (1=very good 6=terrible)


May 25th. 2007:
Words

486

Views

215463

why adblockers are bad


Workaround and fixes for the current Core Dump Handling vulnerability affected kernels

Workaround and fixes for the current Core Dump Handling vulnerability affected kernels

words:

161

views:

96392

userrating:

average rating: 1.3 (28 votes) (1=very good 6=terrible)


April, 26th. 2006:

Druckversion
You are here: manpages





RI(1)

Section: Misc. Reference Manual Pages ()
Updated: Ruby Programmers Reference Guide
Index Return to Main Contents

BSD mandoc
UNIX  

NAME

ri - Ruby API reference front end  

SYNOPSIS

[-Ti [-d directory ] ] [-f format ] [--list-doc-dirs ] [--no-standard-docs ] [-- [no- Bro system | site | gems | home Brc ] ] [-- [no- use-cache ] ] [--width = width ] [target ... ]  

DESCRIPTION

is a CUI front end for the Ruby API reference. You can search and read API reference for classes and methods with .

is a part of Ruby.

target can be one of the following forms:

Class
for classes
Class::method
for class methods
Class#method
for instance methods
Class.method
for both class and instance methods
method
for both class and instance methods

All class names may be abbreviated to their minimum unambiguous form. If a name is ambiguous, all valid options will be listed.

For example:

ri Fil
ri File
ri File.new
ri zip

Note that shell quoting may be required for method names containing punctuation:

ri 'Array.[]'
ri compact
 

OPTIONS

--version
Prints the version of .

-T
--no-pager
Send output directly to stdout, rather than to a pager.

-d directory
--doc-dir = directory
List of directories from which to source documentation in addition to the standard directories. May be repeated.

-f FORMAT
--fmt FORMAT
--format = FORMAT
Format to use when displaying output: ansi, bs, html, plain, simple

Use 'bs' (backspace) with most pager programs. To use ANSI, either disable the pager or tell the pager to allow control characters.

-i
--interactive
This makes go into interactive mode.

When is in interactive mode it will allow the user to disambiguate lists of methods in case multiple methods match against a method search string. It also will allow the user to enter in a method name (with auto-completion, if readline is supported) when viewing a class.

--list-doc-dirs
List the directories from which ri will source documentation on stdout and exit.

--no-standard-docs
Do not include documentation from the Ruby standard library, site_lib installed gems, or ~/.rdoc

Equivalent to specifying the options --no-system , --no-site , --no-gems and --no-home

-- [no- system ]
Include documentation from Ruby's standard library. Defaults to true.

-- [no- site ]

 Include documentation from libraries installed in site_lib. Defaults to true.

-- [no- gems ]
Include documentation from RubyGems. Defaults to true.

-- [no- home ]
Include documentation stored in ~/.rdoc. Defaults to true.

-- [no- use-cache ]
Whether or not to use 's cache. True by default.

-w width
--width = width
Set the width of the output.

 

ENVIRONMENT

RI
Additional options.

PAGER
Used as the name of pager program for displaying.

HOME
USERPROFILE
HOMEPATH
Path to user's home directory.

 

FILES

~/.ri
Caches recently referenced documents here.

~/.rdoc
Searches user-wide documents here.

 

SEE ALSO

ruby(1) rdoc(1) gem(1)

 

REPORTING BUGS

    Security vulnerabilities should be reported via an email to Aq security@ruby-lang.org Ns . Reported problems will be published after fixed.

    And you can report other bugs and feature requests via the Ruby Issue Tracking System (http://redmine.ruby-lang.org). Do not report security vulnerabilities via the system because it publishes the vulnerabilities immediately.

 

AUTHORS

Written by Dave Thomas Aq dave@pragmaticprogrammer.com


 

Index

NAME
SYNOPSIS
DESCRIPTION
OPTIONS
ENVIRONMENT
FILES
SEE ALSO
REPORTING BUGS
AUTHORS


Please read "Why adblockers are bad".



Other free services
toURL.org
Shorten long
URLs to short
links like
http://tourl.org/2
tourl.org
.
Reverse DNS lookup
Find out which hostname(s)
resolve to a
given IP or other hostnames for the server
www.reversednslookup.org
rdf newsfeed | rss newsfeed | Atom newsfeed
- Powered by LeopardCMS - Running on Gentoo -
Copyright 2004-2017 Sascha Nitsch Unternehmensberatung UG(haftungsbeschränkt)
Valid XHTML1.1 : Valid CSS : buttonmaker
- Level Triple-A Conformance to Web Content Accessibility Guidelines 1.0 -
- Copyright and legal notices -
Time to create this page: 3.5 ms