pod2html - Unix, Linux Command
NAME
pod2html - convert .pod files to .html files
SYNOPSIS
pod2html --help --htmlroot=<name> --infile=<name> --outfile=<name>
--podpath=<name>:...:<name> --podroot=<name>
--libpods=<name>:...:<name> --recurse --norecurse --verbose
--index --noindex --title=<name>
|
DESCRIPTION
Converts files from pod format (see perlpod) to HTML format.
ARGUMENTS
pod2html takes the following arguments:
Tag |
Description |
help
|
Displays the usage message.
|
htmlroot
|
Sets the base URL for the HTML files. When cross-references are made,
the HTML root is prepended to the URL.
|
infile
|
Specify the pod file to convert. Input is taken from STDIN if no
infile is specified.
|
outfile
|
Specify the HTML file to create. Output goes to STDOUT if no outfile
is specified.
|
podroot
|
Specify the base directory for finding library pods.
|
podpath
|
Specify which subdirectories of the podroot contain pod files whose
HTML converted forms can be linked-to in cross-references.
|
libpods
|
List of page names (eg, perlfunc) which contain linkable =items.
|
netscape
|
Use Netscape HTML directives when applicable.
|
nonetscape
|
Do not use Netscape HTML directives (default).
|
index
|
Generate an index at the top of the HTML file (default behaviour).
|
noindex
|
Do not generate an index at the top of the HTML file.
|
recurse
|
Recurse into subdirectories specified in podpath (default behaviour).
|
norecurse
|
Do not recurse into subdirectories specified in podpath.
|
title
|
Specify the title of the resulting HTML file.
|
verbose
|
Display progress messages.
|
AUTHOR
Tom Christiansen, <[email protected]>.
BUGS
See Pod::Html for a list of known bugs in the translator.
SEE ALSO
perlpod, Pod::Html
COPYRIGHT
This program is distributed under the Artistic License.