Next: pod2latex | Previous: pl2pm | [Table of Contents] | [Index] |
pod2html - convert .pod files to .html files
pod2html --help --htmlroot=<name> --infile=<name> --outfile=<name> --podpath=<name>:...:<name> --podroot=<name> --libpods=<name>:...:<name> --recurse --norecurse --verbose --index --noindex --title=<name>
Converts files from pod format (see the perlpod manpage) to HTML format.
pod2html takes the following arguments:
--helpDisplays the usage message.
--htmlroot=nameSets the base URL for the HTML files. When cross-references are made, the HTML root is prepended to the URL.
--infile=nameSpecify the pod file to convert. Input is taken from STDIN if no infile is specified.
--outfile=nameSpecify the HTML file to create. Output goes to STDOUT if no outfile is specified.
--podroot=nameSpecify the base directory for finding library pods.
--podpath=name:...:nameSpecify which subdirectories of the podroot contain pod files whose HTML converted forms can be linked-to in cross-references.
--libpods=name:...:nameList of page names (eg, "perlfunc") which contain linkable
=item
s.
--netscapeUse Netscape HTML directives when applicable.
--nonetscapeDo not use Netscape HTML directives (default).
--indexGenerate an index at the top of the HTML file (default behaviour).
--noindexDo not generate an index at the top of the HTML file.
--recurseRecurse into subdirectories specified in podpath (default behaviour).
--norecurseDo not recurse into subdirectories specified in podpath.
--title=titleSpecify the title of the resulting HTML file.
--verboseDisplay progress messages.
Tom Christiansen, <tchrist@perl.com>.
See the Pod::Html manpage for a list of known bugs in the translator.
the perlpod manpage, the Pod::Html manpage
This program is distributed under the Artistic License.