Pod::Html
See the current Perl documentation for Pod::Html.
Here is our local, out-dated (pre-5.6) version:
Pod::Html - module to convert pod files to
HTML
use Pod::Html;
pod2html([options]);
Converts files from pod format (see perlpod) to
HTML format. It can automatically generate indexes and
cross-references, and it keeps a cache of things it knows how to
cross-reference.
Pod::Html takes the following arguments:
- help
-
--help
Displays the usage message.
- htmlroot
-
--htmlroot=name
Sets the base
URL for the
HTML files. When cross-references are made, the
HTML root is prepended to the
URL.
- infile
-
--infile=name
Specify the pod file to convert. Input is taken from
STDIN if no infile is specified.
- outfile
-
--outfile=name
Specify the
HTML file to create. Output goes to
STDOUT if no outfile is specified.
- podroot
-
--podroot=name
Specify the base directory for finding library pods.
- podpath
-
--podpath=name:...:name
Specify which subdirectories of the podroot contain pod files whose
HTML converted forms can be linked-to in
cross-references.
- libpods
-
--libpods=name:...:name
List of page names (eg, ``perlfunc'') which contain linkable =item s.
- netscape
-
--netscape
Use Netscape
HTML directives when applicable.
- nonetscape
-
--nonetscape
Do not use Netscape
HTML directives (default).
- index
-
--index
Generate an index at the top of the
HTML file (default behaviour).
- noindex
-
--noindex
Do not generate an index at the top of the
HTML file.
- recurse
-
--recurse
Recurse into subdirectories specified in podpath (default behaviour).
- norecurse
-
--norecurse
Do not recurse into subdirectories specified in podpath.
- title
-
--title=title
Specify the title of the resulting
HTML file.
- verbose
-
--verbose
Display progress messages.
pod2html("pod2html",
"--podpath=lib:ext:pod:vms",
"--podroot=/usr/src/perl",
"--htmlroot=/perl/nmanual",
"--libpods=perlfunc::perlguts:perlvar:perlrun:perlop",
"--recurse",
"--infile=foo.pod",
"--outfile=/perl/nmanual/foo.html");
Tom Christiansen, <tchrist@perl.com>.
Has trouble with etc in = commands.
perlpod
This program is distributed under the Artistic License.
|