Next: Pod::InputObjects | Previous: Pod::Find | [Table of Contents] | [Index] |
Pod::Html - module to convert pod files to HTML
use Pod::Html; pod2html([options]);
Converts files from pod format (see the perlpod manpage) 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:
--backlink="Back to Top"Adds "Back to Top" links in front of every HEAD1 heading (except for the first). By default, no backlink are being generated.
--css=stylesheetSpecify the URL of a cascading style sheet.
--flushFlushes the item and directory caches.
--header --noheaderCreates header and footer blocks containing the text of the NAME section. By default, no headers are being generated.
--helpDisplays the usage message.
--htmldir=nameSets the directory in which the resulting HTML file is placed. This is used to generate relative links to other files. Not passing this causes all links to be absolute, since this is the value that tells Pod::Html the root of the documentation tree.
--htmlroot=nameSets the base URL for the HTML files. When cross-references are made, the HTML root is prepended to the URL.
--index --noindexGenerate an index at the top of the HTML file. This is the default behaviour.
--infile=nameSpecify the pod file to convert. Input is taken from STDIN if no infile is specified.
--libpods=name:...:nameList of page names (eg, "perlfunc") which contain linkable
=item
s.
--netscape --nonetscapeUse Netscape HTML directives when applicable. By default, they will not be used.
--outfile=nameSpecify the HTML file to create. Output goes to STDOUT if no outfile is specified.
--podpath=name:...:nameSpecify which subdirectories of the podroot contain pod files whose HTML converted forms can be linked-to in cross-references.
--podroot=nameSpecify the base directory for finding library pods.
--quiet --noquietDon't display mostly harmless warning messages. These messages will be displayed by default. But this is not the same as
verbose
mode.
--recurse --norecurseRecurse into subdirectories specified in podpath (default behaviour).
--title=titleSpecify the title of the resulting HTML file.
--verbose --noverboseDisplay progress messages. By default, they won't be displayed.
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");
Uses $Config{pod2html} to setup default options.
Tom Christiansen, <tchrist@perl.com>.
the perlpod manpage
This program is distributed under the Artistic License.