RDOC2.3(1) General Commands Manual RDOC2.3(1)
rdoc2.3 – Generate documentation from Ruby script files
rdoc2.3 [options] [names…]
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 subdirecto‐
ries) are processed.
Available output formatters: chm, html, ri, xml
For information on where the output goes, use:
–accessor, -A accessorname[,..]
comma separated list of additional class methods that should be
treated like ‘attr_reader’ and friends. Option may be repeated.
Each accessorname may have ‘=text’ appended, in which case that
text appears where the r/w/rw appears for normal accessors.
include all methods (not just public) in the output.
–charset, -c charset
specifies HTML character-set
displays lots on internal stuff
generate diagrams showing modules and classes. You need dot
V1.8.6 or later to use the –diagram option correctly. Dot is
–exclude, -x pattern
do not process files or directories matching pattern. Files
given explicitly on the command line will never be excluded.
–extension, -E new = old
treat files ending with .new as if they ended with .old. Using
‘-E cgi=rb’ will cause xxx.cgi to be parsed as a Ruby file
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.
–fmt, -f formatname
set the output formatter (see below).
explain the various output options.
–image-format, -I 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.
–include, -i dir[,dir…]
set (or add to) the list of directories to be searched when sat‐
isfying :include: requests. Can be used more than once.
show method source code inline, rather than via a popup link.
include line numbers in the source code
–main, -m name
name will be the initial page displayed.
when creating ri output, merge processed classes into previously
documented classes of the name name.
put all the output into a single file.
–op, -o dir
set the output directory.
–opname, -n name
set the name of the output. Has no effect for HTML.
When documenting a file that contains a module or class also
defined in other files, show all stuff for that module/class in
each files page. By default, only show stuff defined in that
don’t show progress as we parse.
generate output for use by ‘ri.’ The files are stored in the
‘.rdoc’ directory under your home directory unless overridden by
a subsequent –op parameter, so no special privileges are
generate output for use by ‘ri.’ The files are stored in a
site-wide directory, making them accessible to others, so spe‐
cial privileges are needed.
generate output for use by ‘ri.’ The files are stored in a sys‐
tem-level directory, making them accessible to others, so spe‐
cial privileges are needed. This option is intended to be used
during Ruby installations.
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.
–style, -s stylesheet-url
specifies the URL of a separate stylesheet.
–tab-width, -w n
set the width of tab characters (default 8).
–template, -T template-name
set the template used when generating output.
–title, -t text
set text as the title for the output.
display RDoc’s version.
–webcvs, -W url
specify a URL for linking to a web frontend to CVS. If the URL
contains a contain a ‘%s’, the filename will be appended to it.
July 2014 RDOC2.3(1)