MOD2HTML(1)

NAME
mod2html - translate module PODs to HTML

SYNOPSIS
"mod2html" ["--base" url] ["--css" url] ["--index" title] ["--"["no"]"toc"] ["--hr" level] ["--bgcolor" #rrggbb] ["--text" #rrggbb] modDir HTMLdir

DESCRIPTION
"mod2html" locates all the PODs under modDir translates them to HTML, and writes them to a directory tree under HTMLdir.

The directory tree maps the module namespaces.

It makes the HTML files world-readable.

OPTIONS

"--base" url
    Translate "L<>" sequences into HTML links relative to url.

"--css" url
    Specifies a Cascanding Style Sheet for the generated HTML page.

"--index" title
    Writes an index of all the HTML files to HTMLDir/index.html. title is used as the title of the index page.

"--"["no"]"toc"
    Includes or omits the table of contents. Default is to include the TOC.

"--hr" level
    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.

"--bgcolor" #rrggbb
    Set the background color to #rrggbb. Default is white.

"--text" #rrggbb
    Set the text color to #rrggbb. Default is black.

REQUIRES
"Pod::Tree::HTML"

SEE ALSO
"pod2html", "pods2html", "Pod::Tree::HTML"

AUTHOR
Steven McDougall, <swmcd@world.std.com>

COPYRIGHT
Copyright (c) 2003 by Steven McDougall. This program is free software; you can redistribute it and/or modify it under the same terms as Perl.