4
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:
26
: --accessor, -A ((|accessorname[,..]|))
27
comma separated list of additional class methods that should be treated
28
like 'attr_reader' and friends. Option may be repeated. Each accessorname
29
may have '=text' appended, in which case that text appears where the
30
r/w/rw appears for normal accessors.
33
include all methods (not just public) in the output.
35
: --charset, -c ((|charset|))
36
specifies HTML character-set
39
displays lots on internal stuff
42
generate diagrams showing modules and classes. You need dot V1.8.6 or
43
later to use the --diagram option correctly. Dot is available from
44
((<URL:http://www.research.att.com/sw/tools/graphviz/>)).
46
: --exclude, -x ((|pattern|))
47
do not process files or directories matching pattern. Files given
48
explicitly on the command line will never be excluded.
50
: --extension, -E ((|new|))=((|old|))
51
treat files ending with .new as if they ended with .old. Using '-E cgi=rb'
52
will cause xxx.cgi to be parsed as a Ruby file
55
classes are put in boxes which represents files, where these classes
56
reside. Classes shared between more than one file are shown with list of
57
files that sharing them. Silently discarded if --diagram is not given
60
: --fmt, -f ((|formatname|))
61
set the output formatter (see below).
67
explain the various output options.
69
: --image-format, -I ((|(('gif|png|jpg|jpeg'))|))
70
sets output image format for diagrams. Can be png, gif, jpeg, jpg. If this
71
option is omitted, png is used. Requires --diagram.
73
: --include, -i ((|dir[,dir...]|))
74
set (or add to) the list of directories to be searched when satisfying
75
((':include:')) requests. Can be used more than once.
78
show method source code inline, rather than via a popup link.
81
include line numbers in the source code
83
: --main, -m ((|name|))
84
((|name|)) will be the initial page displayed.
87
when creating ri output, merge processed classes into previously
88
documented classes of the name name.
91
put all the output into a single file.
94
set the output directory.
96
: --opname, -n ((|name|))
97
set the ((|name|)) of the output. Has no effect for HTML.
100
When documenting a file that contains a module or class also defined in
101
other files, show all stuff for that module/class in each files page. By
102
default, only show stuff defined in that particular file.
105
don't show progress as we parse.
108
generate output for use by 'ri.' The files are stored in the '.rdoc'
109
directory under your home directory unless overridden by a subsequent --op
110
parameter, so no special privileges are needed.
113
generate output for use by 'ri.' The files are stored in a site-wide
114
directory, making them accessible to others, so special privileges are
118
generate output for use by 'ri.' The files are stored in a system-level
119
directory, making them accessible to others, so special privileges are
120
needed. This option is intended to be used during Ruby installations.
123
a name of the form #name in a comment is a possible hyperlink to an
124
instance method name. When displayed, the '#' is removed unless this
127
: --style, -s ((|stylesheet-url|))
128
specifies the URL of a separate stylesheet.
130
: --tab-width, -w ((|n|))
131
set the width of tab characters (default 8).
133
: --template, -T ((|template-name|))
134
set the template used when generating output.
136
: --title, -t ((|text|))
137
set ((|text|)) as the title for the output.
140
display RDoc's version.
142
: --webcvs, -W ((|url|))
143
specify a URL for linking to a web frontend to CVS. If the URL contains a
144
'%s', the name of the current file will be substituted; if the URL doesn't
145
contain a '%s', the filename will be appended to it.
added
removed
debian/rdoc1.9.1.rd
