.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "YRI 1"
.TH YRI 1 2024-03-03 0.9.36 ""
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
yri \- documentation tool in console for Ruby
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fByri\fR [\fIoptions\fR] \fIPath_to_object\fR
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fByard\fR(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.
.PP
\&\fByri\fR(1), synonym for \fByard\fR \fBri\fR gives the possibility to read the
documentation for Ruby programs inside a console, pretty much like \fBri\fR(1).
.SH OPTIONS
.IX Header "OPTIONS"
.SS "General Options:"
.IX Subsection "General Options:"
.IP "\fB\-b\fR, \fB\-\-db\fR \fIFILE\fR" 4
.IX Item "-b, --db FILE"
Use a specified .yardoc db to search in
.IP "\fB\-T\fR, \fB\-\-no\-pager\fR" 4
.IX Item "-T, --no-pager"
No pager
.IP "\fB\-p\fR, \fB\-\-pager\fR \fIPAGER\fR" 4
.IX Item "-p, --pager PAGER"
Use \fIPAGER\fR as a pager
.SS "Other options:"
.IX Subsection "Other options:"
.IP "\fB\-e\fR, \fB\-\-load\fR \fIFILE\fR" 4
.IX Item "-e, --load FILE"
A Ruby script to load before running command.
.IP "\fB\-\-plugin\fR \fIPLUGIN\fR" 4
.IX Item "--plugin PLUGIN"
Load a YARD plugin (gem with `yard\-' prefix)
.IP \fB\-\-legacy\fR 4
.IX Item "--legacy"
Use old style Ruby parser and handlers. Always on in 1.8.x.
.IP \fB\-\-safe\fR 4
.IX Item "--safe"
Enable safe mode for this instance
.IP "\fB\-q\fR, \fB\-\-quiet\fR" 4
.IX Item "-q, --quiet"
Show no warnings.
.IP \fB\-\-verbose\fR 4
.IX Item "--verbose"
Show more information.
.IP \fB\-\-debug\fR 4
.IX Item "--debug"
Show debugging information.
.IP \fB\-\-backtrace\fR 4
.IX Item "--backtrace"
Show stack traces
.IP "\fB\-v\fR, \fB\-\-version\fR" 4
.IX Item "-v, --version"
Show version.
.IP "\fB\-h\fR, \fB\-\-help\fR" 4
.IX Item "-h, --help"
Show a help message, similar to this page.
.SH EXAMPLES
.IX Header "EXAMPLES"
\&\fByri\fR \fIString#gsub\fR
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fByard\fR(1).
.SH AUTHORS
.IX Header "AUTHORS"
\&\fByard\fR has been developed by Loren Segal <lsegal@soen.ca>.
.PP
This manual page has been written for the Debian Project by Cédric Boutillier (but
may used by others).