RD documentation can be included directly in a Ruby source program or
written into a separate file (which by convention will have the
extension
.rd). These files are processed using the
rd2
command to produce appropriately formatted output.
rd2 [
options
] inputfile [ >outputfile ]
|
Some common options include:
-r
format
|
Select an output
format. -rrd/rd2html-lib.rb produces HTML output (the
default). -rrd/rd2man-lib.rb produces Unix man page output. |
-o
name
|
Set the base part of the output filename. |
--help
|
List the full set of options. |
