.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" 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 "PODS2HTML 1p"
.TH PODS2HTML 1p "2019-02-25" "perl v5.28.1" "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"
pods2html \- translate a tree of PODs to HTML
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\f(CW\*(C`pods2html\*(C'\fR
[\f(CW\*(C`\-\-base\*(C'\fR \fIurl\fR]
[\f(CW\*(C`\-\-css\*(C'\fR \fIurl\fR]
[\f(CW\*(C`\-\-empty\*(C'\fR]
[\f(CW\*(C`\-\-index\*(C'\fR \fItitle\fR]
[\f(CW\*(C`\-\-module\*(C'\fR]
[\f(CW\*(C`\-\-\*(C'\fR[\f(CW\*(C`no\*(C'\fR]\f(CW\*(C`toc\*(C'\fR] [\f(CW\*(C`\-\-hr\*(C'\fR \fIlevel\fR]
[\f(CW\*(C`\-\-bgcolor\*(C'\fR \fI#rrggbb\fR] [\f(CW\*(C`\-\-text\*(C'\fR \fI#rrggbb\fR]
[\f(CW\*(C`\-\-variables\*(C'\fR \fIvalues.pl\fR]
\&\fIPODdir\fR \fIHTMLdir\fR [\fItemplate\fR [\fIvariable\fR=\fIvalue\fR ...]]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`pods2html\*(C'\fR finds all the \fI.pod\fR and \fI.pm\fR files in the
directory tree rooted at \fIPODdir\fR.
It translates each \s-1POD\s0 to \s-1HTML,\s0
and writes it to a parallel directory tree rooted at \fIHTMLdir\fR
.PP
It makes the \s-1HTML\s0 files world-readable.
.PP
If a \fItemplate\fR file is provided,
then \fItemplate\fR will be filled in by the \f(CW\*(C`Text::Template\*(C'\fR module and written to \fIdest\fR.
Here is a minimal template, showing all the variables that are set by \f(CW\*(C`pods2html\*(C'\fR.
.PP
.Vb 11
\&
\&
\&
\&
\& {$title}
\&
\&
\& {$toc}
\& {$body}
\&
\&
.Ve
.PP
If the \f(CW\*(C`\-\-variables\*(C'\fR option is provided, then the file \fIvalues.pl\fR will be executed with a \f(CW\*(C`do\*(C'\fR
call before the template is filled in. \fIvalues.pl\fR may contain arbitrary Perl code.
The program fragments in the template are evaulted in the \f(CW\*(C`Pod::Tree::HTML\*(C'\fR package.
Any variables that \fIvalues.pl\fR sets in this package will be available to the template.
.PP
Additional scalar variables may be set on the command line with the \fIvariable\fR=\fIvalue\fR syntax.
Variables set on the command line override variables set in \fIvalues.pl\fR.
.SH "OPTIONS"
.IX Header "OPTIONS"
.ie n .IP """\-\-base"" \fIurl\fR" 4
.el .IP "\f(CW\-\-base\fR \fIurl\fR" 4
.IX Item "--base url"
Specifies a base \s-1URL\s0 for \s-1HTML\s0 links.
.ie n .IP """\-\-css"" \fIurl\fR" 4
.el .IP "\f(CW\-\-css\fR \fIurl\fR" 4
.IX Item "--css url"
Specifies a Cascanding Style Sheet for the generated \s-1HTML\s0 pages.
Here are example rules for all the different \s-1HTML\s0 elements that may appear in a \s-1POD.\s0
.Sp
.Vb 10
\& a:link { background: #ff8080 }
\& body { background: #f0f0f0 }
\& code { background: #c0ffc0 }
\& dd { background: #ffffe0 }
\& dl { background: #fffff0 }
\& dt { background: #ffffc0 }
\& h1 { background: #ffc0c0 }
\& h2 { background: #ffe0e0 }
\& hr { background: #ff0000; height: 5px }
\& i { background: #ffc0c0 }
\& li { background: #e0e0e0 }
\& ol { background: #fff0ff }
\& p { background: #f0f0ff }
\& pre { background: #f0fff0 }
\& ul { background: #f0ffff }
.Ve
.ie n .IP """\-\-empty""" 4
.el .IP "\f(CW\-\-empty\fR" 4
.IX Item "--empty"
Creates \s-1HTML\s0 files for empty PODs.
If this option is not provided, then no \s-1HTML\s0 file is created for empty PODs.
.ie n .IP """\-\-index"" \fItitle\fR" 4
.el .IP "\f(CW\-\-index\fR \fItitle\fR" 4
.IX Item "--index title"
Writes an index of all the \s-1HTML\s0 files to \fIHTMLDir\fR\fI/index.html\fR.
\&\fItitle\fR is used as the title of the index page.
.ie n .IP """\-\-module""" 4
.el .IP "\f(CW\-\-module\fR" 4
.IX Item "--module"
Ignores files in directories named \fIt/\fR and \fIblib/\fR.
Useful for translating PODs in a module development directory.
.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 the table of contents.
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 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.
.SH "REQUIRES"
.IX Header "REQUIRES"
\&\f(CW\*(C`Pod::Tree::HTML\*(C'\fR,
\&\f(CW\*(C`HTML::Stream\*(C'\fR
.SH "BUGS"
.IX Header "BUGS"
The recursion check doesn't work on Win32.
This means that the program will enter an infinite recursion
if \fIHTMLdir\fR is a subdirectory of \fIPODdir\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\f(CW\*(C`pod2html\*(C'\fR,
\&\f(CW\*(C`Pod::Tree::HTML\*(C'\fR
.SH "AUTHOR"
.IX Header "AUTHOR"
Steven McDougall,
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 1999\-2010 by Steven McDougall. This program is free software;
you can redistribute it and/or modify it under the same terms as Perl.