NAME
SYNOPSIS
DESCRIPTION
OPTIONS
REQUIRES
BUGS
SEE ALSO
AUTHOR
COPYRIGHT

NAME

pods2html - translate a tree of PODs to HTML

SYNOPSIS

pods2html [--base url] [--css url] [--index title] [--[no]toc] [--hr level] [--bgcolor #rrggbb] [--text #rrggbb] PODdir HTMLdir

DESCRIPTION

pod2html finds all the .pod and .pm files in the directory tree rooted at PODdir. It translates each POD to HTML, and writes it to a parallel directory tree rooted at HTMLdir

It makes the HTML files world-readable.

OPTIONS

--base url

Specifies a base URL for HTML links.

--css url

Specifies a Cascanding Style Sheet for the generated HTML pages.

--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, HTML::Stream

BUGS

The recursion check doesn't work on Win32. This means that the program will enter an infinite recursion if HTMLdir is a subdirectory of PODdir.

AUTHOR

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