- reverted version patch to use RUBY_LIB_VERSION_STYLE=2 (minor)

[packages/ruby.git] / rdoc.1

.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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.  | will give a
.\" real vertical bar.  \*(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-|\(bv\*(Tr
.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" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "RDOC 1"
.TH RDOC 1 "2003-08-19" "perl v5.8.0" "User Contributed Perl Documentation"
.SH "NAME"
rdoc \- Generate documentation from ruby source files
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
Usage:
.PP
.Vb 1
\&  rdoc [options]  [names...]
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Files are parsed, and the information they contain
collected, before any output is produced. This allows cross
references between all files to be resolved. If a name is a
directory, it is traversed. If no names are specified, all
Ruby files in the current directory (and subdirectories) are
processed.
.SH "OPTIONS"
.IX Header "OPTIONS"
Options:
.IP "\fB\-a\fR, \fB\-\-all\fR" 8
.IX Item "-a, --all"
include all methods (not just public) in the output
.IP "\fB\-c\fR \fIcharset\fR, \fB\-\-charset\fR \fIcharset\fR" 8
.IX Item "-c charset, --charset charset"
specifies \s-1HTML\s0 character-set
.IP "\fB\-D\fR, \fB\-\-debug\fR" 8
.IX Item "-D, --debug"
displays lots on internal stuff
.IP "\fB\-d\fR, \fB\-\-diagram\fR" 8
.IX Item "-d, --diagram"
Generate diagrams showing modules and classes.
You need dot V1.8.6 or later to use the \-\-diagram
option correctly. Dot is available from
http://www.research.att.com/sw/tools/graphviz/
.IP "\fB\-x\fR \fIpattern\fR, \fB\-\-exclude\fR \fIpattern\fR" 8
.IX Item "-x pattern, --exclude pattern"
do not process files or directories matching
pattern. Files given explicitly on the command
line will never be excluded.
.IP "\fB\-F\fR, \fB\-\-fileboxes\fR" 8
.IX Item "-F, --fileboxes"
classes are put in boxes which represents
files, where these classes reside. Classes
shared between more than one file are
shown with list of files that sharing them.
Silently discarded if \-\-diagram is not given
Experimental.
.IP "\fB\-f\fR \fIformat_name\fR, \fB\-\-fmt\fR \fIformat_name\fR" 8
.IX Item "-f format_name, --fmt format_name"
set the output formatter (see below)
.IP "\fB\-h\fR, \fB\-\-help\fR" 8
.IX Item "-h, --help"
print out a brief help summary
.IP "\fB\-O\fR, \fB\-\-help\-output\fR" 8
.IX Item "-O, --help-output"
explain the various output options
.IP "\fB\-I\fR \fIgif|jpg|jpg|jpeg\fR, \fB\-\-image\-format\fR \fIgif|png|jpg|jpeg\fR" 8
.IX Item "-I gif|jpg|jpg|jpeg, --image-format gif|png|jpg|jpeg"
Sets output image format for diagrams. Can
be png, gif, jpeg, jpg. If this option is
omitted, png is used. Requires \-\-diagram.
.IP "\fB\-i\fR \fIdir[,dir,...]\fR, \fB\-\-include\fR \fIdir[,dir,...]\fR" 8
.IX Item "-i dir[,dir,...], --include dir[,dir,...]"
set (or add to) the list of directories
to be searched when satisfying :include:
requests. Can be used more than once.
.IP "\fB\-S\fR, \fB\-\-inline\-source\fR" 8
.IX Item "-S, --inline-source"
Show method source code inline, rather
than via a popup link
.IP "\fB\-N\fR, \fB\-\-line\-numbers\fR" 8
.IX Item "-N, --line-numbers"
Include line numbers in the source code
.IP "\fB\-m\fR \fIname\fR, \fB\-\-main\fR \fIname\fR" 8
.IX Item "-m name, --main name"
\&'name' will be the initial page displayed
.IP "\fB\-1\fR, \fB\-\-one\-file\fR" 8
.IX Item "-1, --one-file"
put all the output into a single file
.IP "\fB\-o\fR \fIdir\fR, \fB\-\-op\fR \fIdir\fR" 8
.IX Item "-o dir, --op dir"
set the output directory
.IP "\fB\-n\fR \fIname\fR, \fB\-\-opname\fR \fIname\fR" 8
.IX Item "-n name, --opname name"
Set the 'name' of the output. Has no
effect for \s-1HTML\s0.
.IP "\fB\-q\fR, \fB\-\-quiet\fR" 8
.IX Item "-q, --quiet"
don't show progress as we parse
.IP "\fB\-H\fR, \fB\-\-show\-hash\fR" 8
.IX Item "-H, --show-hash"
A name of the form #name in a comment
is a possible hyperlink to an instance
method name. When displayed, the '#' is
removed unless this option is specified
.IP "\fB\-w\fR \fIwidth\fR, \fB\-\-tab\-width\fR \fIwidth\fR" 8
.IX Item "-w width, --tab-width width"
Set the width of tab characters (default 8)
.IP "\fB\-T\fR \fItemplate_name\fR, \fB\-\-template\fR \fItemplate_name\fR" 8
.IX Item "-T template_name, --template template_name"
Set the template used when generating output
.IP "\fB\-t\fR \fItext\fR, \fB\-\-title\fR \fItext\fR" 8
.IX Item "-t text, --title text"
Set 'txt' as the title for the output
.IP "\fB\-v\fR, \fB\-\-version\fR" 8
.IX Item "-v, --version"
display  RDoc's version
.SH "NOTES"
.IX Header "NOTES"
Available output formatters: chm, html, xml
.PP
For information on where the output goes, use
.PP
.Vb 1
\&   rdoc --help-output
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
This manpage was contributed by Brian Almeida <bma@debian.org>