554 lines
6.5 KiB
HTML
554 lines
6.5 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of POD2HTML</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>POD2HTML</H1>
|
|
Section: Perl Programmers Reference Guide (1)<BR>Updated: 2020-10-19<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
pod2html - convert .pod files to .html files
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
pod2html --help --htmldir=<name> --htmlroot=<URL>
|
|
--infile=<name> --outfile=<name>
|
|
--podpath=<name>:...:<name> --podroot=<name>
|
|
--cachedir=<name> --flush --recurse --norecurse
|
|
--quiet --noquiet --verbose --noverbose
|
|
--index --noindex --backlink --nobacklink
|
|
--header --noheader --poderrors --nopoderrors
|
|
--css=<URL> --title=<name>
|
|
|
|
</PRE>
|
|
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
|
|
|
|
Converts files from pod format (see perlpod) to <FONT SIZE="-1">HTML</FONT> format.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>ARGUMENTS</H2>
|
|
|
|
|
|
|
|
pod2html takes the following arguments:
|
|
<DL COMPACT>
|
|
<DT id="1">help<DD>
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
--help
|
|
|
|
</PRE>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
|
Displays the usage message.
|
|
<DT id="2">htmldir<DD>
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
--htmldir=name
|
|
|
|
</PRE>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
|
Sets the directory to which all cross references in the resulting <FONT SIZE="-1">HTML</FONT> file
|
|
will be relative. Not passing this causes all links to be absolute since this
|
|
is the value that tells Pod::Html the root of the documentation tree.
|
|
|
|
|
|
<P>
|
|
|
|
|
|
Do not use this and --htmlroot in the same call to pod2html; they are mutually
|
|
exclusive.
|
|
<DT id="3">htmlroot<DD>
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
--htmlroot=URL
|
|
|
|
</PRE>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
|
Sets the base <FONT SIZE="-1">URL</FONT> for the <FONT SIZE="-1">HTML</FONT> files. When cross-references are made, the
|
|
<FONT SIZE="-1">HTML</FONT> root is prepended to the <FONT SIZE="-1">URL.</FONT>
|
|
|
|
|
|
<P>
|
|
|
|
|
|
Do not use this if relative links are desired: use --htmldir instead.
|
|
|
|
|
|
<P>
|
|
|
|
|
|
Do not pass both this and --htmldir to pod2html; they are mutually exclusive.
|
|
<DT id="4">infile<DD>
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
--infile=name
|
|
|
|
</PRE>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
|
Specify the pod file to convert. Input is taken from <FONT SIZE="-1">STDIN</FONT> if no
|
|
infile is specified.
|
|
<DT id="5">outfile<DD>
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
--outfile=name
|
|
|
|
</PRE>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
|
Specify the <FONT SIZE="-1">HTML</FONT> file to create. Output goes to <FONT SIZE="-1">STDOUT</FONT> if no outfile
|
|
is specified.
|
|
<DT id="6">podroot<DD>
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
--podroot=name
|
|
|
|
</PRE>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
|
Specify the base directory for finding library pods.
|
|
<DT id="7">podpath<DD>
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
--podpath=name:...:name
|
|
|
|
</PRE>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
|
Specify which subdirectories of the podroot contain pod files whose
|
|
<FONT SIZE="-1">HTML</FONT> converted forms can be linked-to in cross-references.
|
|
<DT id="8">cachedir<DD>
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
--cachedir=name
|
|
|
|
</PRE>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
|
Specify which directory is used for storing cache. Default directory is the
|
|
current working directory.
|
|
<DT id="9">flush<DD>
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
--flush
|
|
|
|
</PRE>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
|
Flush the cache.
|
|
<DT id="10">backlink<DD>
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
--backlink
|
|
|
|
</PRE>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
|
Turn =head1 directives into links pointing to the top of the <FONT SIZE="-1">HTML</FONT> file.
|
|
<DT id="11">nobacklink<DD>
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
--nobacklink
|
|
|
|
</PRE>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
|
Do not turn =head1 directives into links pointing to the top of the <FONT SIZE="-1">HTML</FONT> file
|
|
(default behaviour).
|
|
<DT id="12">header<DD>
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
--header
|
|
|
|
</PRE>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
|
Create header and footer blocks containing the text of the ``<FONT SIZE="-1">NAME''</FONT> section.
|
|
<DT id="13">noheader<DD>
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
--noheader
|
|
|
|
</PRE>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
|
Do not create header and footer blocks containing the text of the ``<FONT SIZE="-1">NAME''</FONT>
|
|
section (default behaviour).
|
|
<DT id="14">poderrors<DD>
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
--poderrors
|
|
|
|
</PRE>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
|
Include a ``<FONT SIZE="-1">POD ERRORS''</FONT> section in the outfile if there were any <FONT SIZE="-1">POD</FONT> errors in
|
|
the infile (default behaviour).
|
|
<DT id="15">nopoderrors<DD>
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
--nopoderrors
|
|
|
|
</PRE>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
|
Do not include a ``<FONT SIZE="-1">POD ERRORS''</FONT> section in the outfile if there were any <FONT SIZE="-1">POD</FONT>
|
|
errors in the infile.
|
|
<DT id="16">index<DD>
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
--index
|
|
|
|
</PRE>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
|
Generate an index at the top of the <FONT SIZE="-1">HTML</FONT> file (default behaviour).
|
|
<DT id="17">noindex<DD>
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
--noindex
|
|
|
|
</PRE>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
|
Do not generate an index at the top of the <FONT SIZE="-1">HTML</FONT> file.
|
|
<DT id="18">recurse<DD>
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
--recurse
|
|
|
|
</PRE>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
|
Recurse into subdirectories specified in podpath (default behaviour).
|
|
<DT id="19">norecurse<DD>
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
--norecurse
|
|
|
|
</PRE>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
|
Do not recurse into subdirectories specified in podpath.
|
|
<DT id="20">css<DD>
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
--css=URL
|
|
|
|
</PRE>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
|
Specify the <FONT SIZE="-1">URL</FONT> of cascading style sheet to link from resulting <FONT SIZE="-1">HTML</FONT> file.
|
|
Default is none style sheet.
|
|
<DT id="21">title<DD>
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
--title=title
|
|
|
|
</PRE>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
|
Specify the title of the resulting <FONT SIZE="-1">HTML</FONT> file.
|
|
<DT id="22">quiet<DD>
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
--quiet
|
|
|
|
</PRE>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
|
Don't display mostly harmless warning messages.
|
|
<DT id="23">noquiet<DD>
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
--noquiet
|
|
|
|
</PRE>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
|
Display mostly harmless warning messages (default behaviour). But this is not
|
|
the same as ``verbose'' mode.
|
|
<DT id="24">verbose<DD>
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
--verbose
|
|
|
|
</PRE>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
|
Display progress messages.
|
|
<DT id="25">noverbose<DD>
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
--noverbose
|
|
|
|
</PRE>
|
|
|
|
|
|
|
|
|
|
<P>
|
|
|
|
|
|
Do not display progress messages (default behaviour).
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>AUTHOR</H2>
|
|
|
|
|
|
|
|
Tom Christiansen, <<A HREF="mailto:tchrist@perl.com">tchrist@perl.com</A>>.
|
|
<A NAME="lbAG"> </A>
|
|
<H2>BUGS</H2>
|
|
|
|
|
|
|
|
See Pod::Html for a list of known bugs in the translator.
|
|
<A NAME="lbAH"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
|
|
|
|
perlpod, Pod::Html
|
|
<A NAME="lbAI"> </A>
|
|
<H2>COPYRIGHT</H2>
|
|
|
|
|
|
|
|
This program is distributed under the Artistic License.
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="26"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="27"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="28"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="29"><A HREF="#lbAE">ARGUMENTS</A><DD>
|
|
<DT id="30"><A HREF="#lbAF">AUTHOR</A><DD>
|
|
<DT id="31"><A HREF="#lbAG">BUGS</A><DD>
|
|
<DT id="32"><A HREF="#lbAH">SEE ALSO</A><DD>
|
|
<DT id="33"><A HREF="#lbAI">COPYRIGHT</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:24 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|