Ruby Pocket Reference

RDoc Options

Usage:

rdoc [options] [names . . . ]

names is a list of one or more filenames that you want to process with RDoc. Files are parsed, and the information they contain collected, before any output is produced. This allows cross-references between all files that are to be resolved.

If a filename on the command line is a directory, it is traversed. If no names are specified on the command line, all Ruby files in the current directory (and subdirectories) are processed.

Options:

--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.

--all, -a

Includes all methods (not just public) in the output.

--charset, -c charset

Specifies HTML character set.

--debug, -D

Displays internal information.

--diagram, -d

Generates 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.

--exclude, -x pattern

Does not process files or directories matching pattern. Files given explicitly on the command line will never be excluded.

--extension, -E new=old

Treats 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.

--fileboxes, -F

Classes are put in boxes that represent files, where these classes reside. Classes shared ...