NAME

perl2html - generate Perl documentation in HTML

SYNOPSIS

perl2html [--[no]toc] [--hr level] [--bgcolor #rrggbb] [--text #rrggbb] [--v verbosity] PerlDir HTMLDir

DESCRIPTION

perl2html translates Perl documentation to HTML. PerlDir is the root of the Perl source tree. The HTML pages are organized into a directory tree rooted at HTMLDir. A top-level index is written to HTMLDir/index.html

In addition to the Perl sources, perl2html searches @INC for module PODs, and $ENV{PATH} for program PODS.

All the HTML pages are created world-readable.

Perldir and HTMLDir must be absolute path names.

OPTIONS

--[no]toc

Includes or omits a table of contents in each page. 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 off-white.

--text #rrggbb

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

--v verbosity

Verbosity level: 0, 1, 2, 3

REQUIRES

Getopt::Long, Pod::Usage

SEE ALSO

pods2html, Pod::Tree, Pod::Tree::HTML, Pod::Tree::Bin, Pod::Tree::Dist, Pod::Tree::Func, Pod::Tree::Lib, Pod::Tree::Map, Pod::Tree::Pod, Pod::Tree::Top

NOTES

perl2html finds all modules under @INC, and @INC usually contains . (the current working directory). To prevent perl2html from finding modules in strange places, you may want to cd to an empty directory before running it.

BUGS

• Perldir and HTMLDir must be absolute path names.

AUTHOR

Steven McDougall, swmcd@world.std.com

COPYRIGHT

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