rdoc - Generate documentation from ruby source files

Usage:

  rdoc [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 subdirectories) are processed.

Options:

-a, --all

include all methods (not just public) in the output

-c charset, --charset charset

specifies HTML character-set

-D, --debug

displays lots on internal stuff

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

-x pattern, --exclude pattern

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

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

-f format_name, --fmt format_name

set the output formatter (see below)

-h, --help

print out a brief help summary

-O, --help-output

explain the various output options

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

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

-S, --inline-source

Show method source code inline, rather than via a popup link

-N, --line-numbers

Include line numbers in the source code

-m name, --main name

'name' will be the initial page displayed

-1, --one-file

put all the output into a single file

-o dir, --op dir

set the output directory

-n name, --opname name

Set the 'name' of the output. Has no effect for HTML.

-q, --quiet

don't show progress as we parse

-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

-w width, --tab-width width

Set the width of tab characters (default 8)

-T template_name, --template template_name

Set the template used when generating output

-t text, --title text

Set 'txt' as the title for the output

-v, --version

display RDoc's version

Available output formatters: chm, html, xml

For information on where the output goes, use

   rdoc --help-output

This manpage was contributed by Brian Almeida <bma@debian.org>