.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "PERL2HTML 1p"
.TH PERL2HTML 1p "2022-11-19" "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
perl2html \- generate Perl documentation in HTML
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBperl2html\fR 
[\fB\-\-\fR[\fBno\fR]\fBtoc\fR] 
[\fB\-\-hr\fR \fIlevel\fR] 
[\fB\-\-bgcolor\fR \fB#\fR\fIrrggbb\fR] 
[\fB\-\-text\fR \fB#\fR\fIrrggbb\fR] 
[\fB\-\-v\fR \fIverbosity\fR]
\&\fIPerlDir\fR \fIHTMLDir\fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBperl2html\fR translates Perl documentation to \s-1HTML.\s0
\&\fIPerlDir\fR is the root of the Perl source tree.
The \s-1HTML\s0 pages are organized into a directory tree rooted at \fIHTMLDir\fR.
A top-level index is written to \fIHTMLDir\fR\f(CW\*(C`/index.html\*(C'\fR
.PP
In addition to the Perl sources,
\&\fBperl2html\fR searches \f(CW@INC\fR for module PODs,
and \f(CW$ENV{PATH}\fR for program \s-1PODS.\s0
.PP
All the \s-1HTML\s0 pages are created world-readable.
.PP
\&\fIPerldir\fR and \fIHTMLDir\fR must be absolute path names.
.SH "OPTIONS"
.IX Header "OPTIONS"
.ie n .IP """\-\-""[""no""]""toc""" 4
.el .IP "\f(CW\-\-\fR[\f(CWno\fR]\f(CWtoc\fR" 4
.IX Item "--[no]toc"
Includes or omits a table of contents in each page.
Default is to include the \s-1TOC.\s0
.ie n .IP """\-\-hr"" \fIlevel\fR" 4
.el .IP "\f(CW\-\-hr\fR \fIlevel\fR" 4
.IX Item "--hr level"
Controls the profusion of horizontal lines in the output, as follows:
.Sp
.Vb 5
\&    level   horizontal lines
\&    0       none
\&    1       between TOC and body
\&    2       after each =head1
\&    3       after each =head1 and =head2
.Ve
.Sp
Default is level 1.
.ie n .IP """\-\-bgcolor"" \fI#rrggbb\fR" 4
.el .IP "\f(CW\-\-bgcolor\fR \fI#rrggbb\fR" 4
.IX Item "--bgcolor #rrggbb"
Set the background color to \fI#rrggbb\fR.
Default is off-white.
.ie n .IP """\-\-text"" \fI#rrggbb\fR" 4
.el .IP "\f(CW\-\-text\fR \fI#rrggbb\fR" 4
.IX Item "--text #rrggbb"
Set the text color to \fI#rrggbb\fR.
Default is black.
.ie n .IP """\-\-v"" \fIverbosity\fR" 4
.el .IP "\f(CW\-\-v\fR \fIverbosity\fR" 4
.IX Item "--v verbosity"
Verbosity level: 0, 1, 2, 3
.SH "REQUIRES"
.IX Header "REQUIRES"
Perl 5
\&\f(CW\*(C`Getopt::Long\*(C'\fR,
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\f(CW\*(C`pods2html\*(C'\fR, 
\&\f(CW\*(C`Pod::Tree\*(C'\fR,
\&\f(CW\*(C`Pod::Tree::HTML\*(C'\fR,
\&\f(CW\*(C`Pod::Tree::PerlBin\*(C'\fR,
\&\f(CW\*(C`Pod::Tree::PerlDist\*(C'\fR,
\&\f(CW\*(C`Pod::Tree::PerlFunc\*(C'\fR,
\&\f(CW\*(C`Pod::Tree::PerlLib\*(C'\fR,
\&\f(CW\*(C`Pod::Tree::PerlMap\*(C'\fR,
\&\f(CW\*(C`Pod::Tree::PerlPod\*(C'\fR,
\&\f(CW\*(C`Pod::Tree::PerlTop\*(C'\fR
.SH "AUTHOR"
.IX Header "AUTHOR"
Steven McDougall, swmcd@world.std.com
.SH "COPYRIGHT"
.IX Header "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.