ri(1) [centos man page]

RI(1)							 Ruby Programmers Reference Guide						     RI(1)

NAME

     ri -- Ruby API reference front end

SYNOPSIS

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

DESCRIPTION

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

     ri 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 ri.

     -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 char-
		    acters.

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

		    When ri 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 sup-
		    ported) 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 ri'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 <security@ruby-lang.org>.  Reported problems will be published after being fixed.

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

AUTHORS

     Written by Dave Thomas <dave@pragmaticprogrammer.com>

UNIX
								 November 7, 2012							      UNIX

Check Out this Related Man Page

ERB(1)							 Ruby Programmers Reference Guide						    ERB(1)

NAME

     erb -- Ruby Templating

SYNOPSIS

     erb [--version] [-UPdnvx] [-E ext[:int]] [-S level] [-T mode] [-r library] [--] [file ...]

DESCRIPTION

     erb is a command line front-end for ERB library, which is an implementation of eRuby.

     ERB provides an easy to use but powerful templating system for Ruby.  Using ERB, actual Ruby code can be added to any plain text document for
     the purposes of generating document information details and/or flow control.

     erb is a part of Ruby.

OPTIONS

     --version	    Prints the version of erb.

     -E external[:internal]
     --encoding external[:internal]
		    Specifies the default value(s) for external encodings and internal encoding. Values should be separated with colon (:).

		    You can omit the one for internal encodings, then the value (Encoding.default_internal) will be nil.

     -P 	    Evaluates lines starting with % as Ruby code and removes the tailing EOLs.

     -S level	    Specifies the safe level in which eRuby script will run.

     -T mode	    Specifies trim mode (default 0).  mode can be one of

			  0	  EOL remains after the embedded ruby script is evaluated.

			  1	  EOL is removed if the line ends with %>.

			  2	  EOL is removed if the line starts with <% and ends with %>.

			  -	  EOL is removed if the line ends with -%>.  And leading whitespaces are removed if the erb directive starts with
				  <%-.

     -U 	    can be one of Sets the default value for internal encodings (Encoding.default_internal) to UTF-8.

     -d
     --debug	    Turns on debug mode.  $DEBUG will be set to true.

     -h
     --help	    Prints a summary of the options.

     -n 	    Used with -x.  Prepends the line number to each line in the output.

     -v 	    Enables verbose mode.  $VERBOSE will be set to true.

     -x 	    Converts the eRuby script into Ruby script and prints it without line numbers.

EXAMPLES

     Here is an eRuby script

	   <?xml version="1.0" ?>
	   <% require 'prime' -%>
	   <erb-example>
	     <calc><%= 1+1 %></calc>
	     <var><%= __FILE__ %></var>
	     <library><%= Prime.each(10).to_a.join(", ") %></library>
	   </erb-example>

     Command
	   % erb -T - example.erb
     prints

	   <?xml version="1.0" ?>
	   <erb-example>
	     <calc>2</calc>
	     <var>example.erb</var>
	     <library>2, 3, 5, 7</library>
	   </erb-example>

SEE ALSO

     ruby(1).

     And see ri(1) documentation for ERB class.

REPORTING BUGS

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

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

AUTHORS

     Written by Masatoshi SEKI.

UNIX
								 November 7, 2012							      UNIX

Linux and UNIX Man Pages

ri(1) [centos man page]

Check Out this Related Man Page