.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 "YARD 1"
.TH YARD 1 "2020-09-16" "0.9.24" ""
.\" 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"
yard \- documentation tool for Ruby
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fByard\fR \fIcommand\fR [\fIoptions\fR]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fByard\fR 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
Below are listed the commands that can be passed to the \fByard\fR on the command
line. For more details about a \fIcommand\fR, use \fByard\fR \fBhelp\fR \fIcommand\fR from
the command line.
.SH "COMMANDS"
.IX Header "COMMANDS"
.IP "\fBconfig\fR" 4
.IX Item "config"
Views or edits current global configuration
.IP "\fBdiff\fR" 4
.IX Item "diff"
Returns the object diff of two gems or .yardoc files
.IP "\fBdisplay\fR" 4
.IX Item "display"
Displays a formatted object
.IP "\fBdoc\fR" 4
.IX Item "doc"
Generates documentation. \fByardoc\fR(1) is a synonym of \fByard\fR \fBdoc\fR.
.IP "\fBgems\fR" 4
.IX Item "gems"
Builds \s-1YARD\s0 index for gems
.IP "\fBgraph\fR" 4
.IX Item "graph"
Graphs class diagram using Graphviz
.IP "\fBhelp\fR" 4
.IX Item "help"
Retrieves help for a command
.IP "\fBi18n\fR" 4
.IX Item "i18n"
Generates .pot file from source code and extra documentation
.IP "\fBlist\fR" 4
.IX Item "list"
Lists all constant and methods. Uses \fByard\fR \fBdoc\fR \fB\-\-list\fR.
.IP "\fBmarkups\fR" 4
.IX Item "markups"
Lists all available markup types and libraries
.IP "\fBri\fR" 4
.IX Item "ri"
A tool to view documentation in the console like \fBri\fR(1). \fByri\fR(1) is a synonym of \fByard\fR \fBri\fR.
.IP "\fBserver\fR" 4
.IX Item "server"
Runs a local documentation server
.IP "\fBstats\fR" 4
.IX Item "stats"
Prints documentation statistics on a set of files
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fByardoc\fR(1), \fByri\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).