EnglishFrenchSpanish

OnWorks favicon

yri - Online in the Cloud

Run yri in OnWorks free hosting provider over Ubuntu Online, Fedora Online, Windows online emulator or MAC OS online emulator

This is the command yri that can be run in the OnWorks free hosting provider using one of our multiple free online workstations such as Ubuntu Online, Fedora Online, Windows online emulator or MAC OS online emulator

PROGRAM:

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

Use yri online using onworks.net services


Free Servers & Workstations

Download Windows & Linux apps

Linux commands

Ad