DOKK / manpages / debian 12 / yard / yri.1.en
YRI(1) YRI(1)

yri - documentation tool in console for Ruby

yri [options] Path_to_object

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

Use a specified .yardoc db to search in
No pager
Use PAGER as a pager

A Ruby script to load before running command.
Load a YARD plugin (gem with `yard-' prefix)
Use old style Ruby parser and handlers. Always on in 1.8.x.
Enable safe mode for this instance
Show no warnings.
Show more information.
Show debugging information.
Show stack traces
Show version.
Show a help message, similar to this page.

yri String#gsub

yard(1).

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

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

2023-02-08 0.9.28