perl2html - generate Perl documentation in HTML
perl2html [--[no]toc] [--hr level] [--bgcolor #rrggbb] [--text #rrggbb] [--v verbosity] PerlDir HTMLDir
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
/index.html
In addition to the Perl sources, perl2html searches @INC for module PODs, and $ENV{PATH} for program PODS.
@INC
$ENV{PATH}
All the HTML pages are created world-readable.
Perldir and HTMLDir must be absolute path names.
--
no
toc
Includes or omits a table of contents in each page. Default is to include the TOC.
--hr
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
Set the background color to #rrggbb. Default is off-white.
--text
Set the text color to #rrggbb. Default is black.
--v
Verbosity level: 0, 1, 2, 3
Perl 5 Getopt::Long,
Getopt::Long
pods2html, Pod::Tree, Pod::Tree::HTML, Pod::Tree::PerlBin, Pod::Tree::PerlDist, Pod::Tree::PerlFunc, Pod::Tree::PerlLib, Pod::Tree::PerlMap, Pod::Tree::PerlPod, Pod::Tree::PerlTop
pods2html
Pod::Tree
Pod::Tree::HTML
Pod::Tree::PerlBin
Pod::Tree::PerlDist
Pod::Tree::PerlFunc
Pod::Tree::PerlLib
Pod::Tree::PerlMap
Pod::Tree::PerlPod
Pod::Tree::PerlTop
Steven McDougall, swmcd@world.std.com
Copyright 2000 by Steven McDougall. This program is free software; you can redistribute it and/or modify it under the same terms as Perl.
To install Pod::Tree, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Pod::Tree
CPAN shell
perl -MCPAN -e shell install Pod::Tree
For more information on module installation, please visit the detailed CPAN module installation guide.