mod2html: Translate module pods to html

SYNOPSIS

\*(C`mod2html\*(C' [\*(C`--base\*(C' url] [\*(C`--css\*(C' url] [\*(C`--index\*(C' title] [\*(C`--\*(C'[\*(C`no\*(C']\*(C`toc\*(C'] [\*(C`--hr\*(C' level] [\*(C`--bgcolor\*(C' #rrggbb] [\*(C`--text\*(C' #rrggbb] modDir HTMLdir

DESCRIPTION

\*(C`mod2html\*(C' locates all the PODs under modDir translates them to \s-1HTML\s0, and writes them to a directory tree under HTMLdir.

The directory tree maps the module namespaces.

It makes the \s-1HTML\s0 files world-readable.

OPTIONS

Translate \*(C`L<>\*(C' sequences into \s-1HTML\s0 links relative to url. Specifies a Cascanding Style Sheet for the generated \s-1HTML\s0 page. Writes an index of all the \s-1HTML\s0 files to HTMLDir/index.html. title is used as the title of the index page. Includes or omits the table of contents. Default is to include the \s-1TOC\s0. Controls the profusion of horizontal lines in the output, as follows:

    level   horizontal lines
    0       none
    1       between TOC and body
    2       after each =head1
    3       after each =head1 and =head2

Default is level 1. Set the background color to #rrggbb. Default is white. Set the text color to #rrggbb. Default is black.

REQUIRES

\*(C`Pod::Tree::HTML\*(C'

RELATED TO mod2html…

\*(C`pod2html\*(C', \*(C`pods2html\*(C', \*(C`Pod::Tree::HTML\*(C'

AUTHOR

Steven McDougall, <[email protected]>

mod2html (1p)