yri(1) [debian man page]

YRI(1)																	    YRI(1)

NAME

       yri - documentation tool in console for Ruby

SYNOPSIS

       yri [options] Path_to_object

DESCRIPTION

       yard(1) is an extensible documentation generation tool for the Ruby programming language. It enables the user to generate consistent,
       usable documentation that can be exported to a number of formats very easily, and also supports extending for custom Ruby constructs such
       as custom class level definitions.

       yri(1), synonym for yard ri gives the possibility to read the documentation for Ruby programs inside a console, pretty much like ri(1).

OPTIONS

   General Options:
       -b, --db FILE
	   Use a specified .yardoc db to search in

       -T, --no-pager
	   No pager

       -p, --pager PAGER
	   Use PAGER as a pager

   Other options:
       -e, --load FILE
	   A Ruby script to load before running command.

       --plugin PLUGIN
	   Load a YARD plugin (gem with `yard-' prefix)

       --legacy
	   Use old style Ruby parser and handlers. Always on in 1.8.x.

       --safe
	   Enable safe mode for this instance

       -q, --quiet
	   Show no warnings.

       --verbose
	   Show more information.

       --debug
	   Show debugging information.

       --backtrace
	   Show stack traces

       -v, --version
	   Show version.

       -h, --help
	   Show a help message, similar to this page.

EXAMPLES

       yri String#gsub

SEE ALSO

       yard(1).

AUTHORS

       yard has been developed by Loren Segal <lsegal@soen.ca>.

       This manual page has been written for the Debian Project by CA(C)dric Boutillier (but may used by others).

								    2012-05-08								    YRI(1)

RUBY-SWITCH(1)															    RUBY-SWITCH(1)

NAME

       ruby-switch - switch between different Ruby interpreters

USAGE

       ruby-switch --list

       ruby-switch --check

       ruby-switch --set RUBYVERSION

       ruby-switch --auto

DESCRIPTION

       ruby-switch can be used to easily switch to different Ruby interpreters as the default system-wide interpreter for your Debian system.

       When run with --list, all supported Ruby interpreters are listed.

       When --check is passed, ruby-switch will check which Ruby interpreter is currently being used. If the settings are inconsistent -- e.g.
	 `ruby` is Ruby 1.8 and `gem` is using Ruby 1.9.1, ruby-switch will issue a big warning.

       When --set RUBYINTERPRETER is used ruby-switch will switch your system to the corresponding Ruby interpreter. This includes, for example,
       the default implementations for the following programs: ruby, gem, irb, erb, testrb, rdoc, ri.

       ruby-switch --set auto will make your system use the default Ruby interpreter currently suggested by Debian.

OPTIONS

       -h, --help
	   Displays the help and exits.

A NOTE ON RUBY 1.9.x
       Ruby uses two parallel versioning schemes: the `Ruby library compatibility version' (1.9.1 at the time of writing this), which is similar
       to a library SONAME, and the `Ruby version' (1.9.3 is about to be released at the time of writing).

       Ruby packages in Debian are named using the Ruby library compatibility version, which is sometimes confusing for users who do not follow
       Ruby development closely.

       ruby-switch also uses the Ruby library compatibility version, so specifying `ruby1.9.1' might give you Ruby with version 1.9.2, or with
       version 1.9.3, depending on the current Ruby version of the `ruby1.9.1' package.

COPYRIGHT AND AUTHORS

       Copyright (c) 2011, Antonio Terceiro <terceiro@debian.org>

       This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by
       the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

       This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.

       You should have received a copy of the GNU General Public License along with this program.  If not, see <http://www.gnu.org/licenses/>.

								    2011-11-20							    RUBY-SWITCH(1)