1
.\" DO NOT MODIFY THIS FILE! it was generated by rd2
2
.TH rdoc1.9 1 "May 2007"
5
rdoc1.9 \- Generate documentation from Ruby script files
8
\& rdoc1.9 [options] [names...]
12
Files are parsed, and the information they contain collected, before any
13
output is produced. This allows cross references between all files to be
14
resolved. If a name is a directory, it is traversed. If no names are
15
specified, all Ruby files in the current directory (and subdirectories) are
18
Available output formatters: chm, html, ri, xml
20
For information on where the output goes, use:
22
\& rdoc \-\-help\-output
28
\-\-accessor, \-A accessorname[,..]
29
comma separated list of additional class methods that should be treated
30
like 'attr_reader' and friends. Option may be repeated. Each accessorname
31
may have '=text' appended, in which case that text appears where the
32
r/w/rw appears for normal accessors.
37
include all methods (not just public) in the output.
41
\-\-charset, \-c charset
42
specifies HTML character\-set
47
displays lots on internal stuff
52
generate diagrams showing modules and classes. You need dot V1.8.6 or
53
later to use the \-\-diagram option correctly. Dot is available from
54
<URL:http://www.research.att.com/sw/tools/graphviz/>.
58
\-\-exclude, \-x pattern
59
do not process files or directories matching pattern. Files given
60
explicitly on the command line will never be excluded.
64
\-\-extension, \-E new=old
65
treat files ending with .new as if they ended with .old. Using '\-E cgi=rb'
66
will cause xxx.cgi to be parsed as a Ruby file
71
classes are put in boxes which represents files, where these classes
72
reside. Classes shared between more than one file are shown with list of
73
files that sharing them. Silently discarded if \-\-diagram is not given
78
\-\-fmt, \-f formatname
79
set the output formatter (see below).
89
explain the various output options.
93
\-\-image\-format, \-I gif|png|jpg|jpeg
94
sets output image format for diagrams. Can be png, gif, jpeg, jpg. If this
95
option is omitted, png is used. Requires \-\-diagram.
99
\-\-include, \-i dir[,dir...]
100
set (or add to) the list of directories to be searched when satisfying
101
:include: requests. Can be used more than once.
105
\-\-inline\-source, \-S
106
show method source code inline, rather than via a popup link.
110
\-\-line\-numbers, \-N
111
include line numbers in the source code
116
name will be the initial page displayed.
121
when creating ri output, merge processed classes into previously
122
documented classes of the name name.
127
put all the output into a single file.
132
set the output directory.
137
set the name of the output. Has no effect for HTML.
142
When documenting a file that contains a module or class also defined in
143
other files, show all stuff for that module/class in each files page. By
144
default, only show stuff defined in that particular file.
149
don't show progress as we parse.
154
generate output for use by 'ri.' The files are stored in the '.rdoc'
155
directory under your home directory unless overridden by a subsequent \-\-op
156
parameter, so no special privileges are needed.
161
generate output for use by 'ri.' The files are stored in a site\-wide
162
directory, making them accessible to others, so special privileges are
168
generate output for use by 'ri.' The files are stored in a system\-level
169
directory, making them accessible to others, so special privileges are
170
needed. This option is intended to be used during Ruby installations.
175
a name of the form #name in a comment is a possible hyperlink to an
176
instance method name. When displayed, the '#' is removed unless this
181
\-\-style, \-s stylesheet\-url
182
specifies the URL of a separate stylesheet.
186
\-\-tab\-width, \-w n
187
set the width of tab characters (default 8).
191
\-\-template, \-T template\-name
192
set the template used when generating output.
197
set text as the title for the output.
202
display RDoc's version.
207
specify a URL for linking to a web frontend to CVS. If the URL contains a
208
'%s', the name of the current file will be substituted; if the URL doesn't
209
contain a '%s', the filename will be appended to it.
added
removed
debian/manpages/rdoc1.9.1.1
