NAME

Pod::Html - module to convert pod files to HTML

SYNOPSIS

    use Pod::Html;
    pod2html([options]);

DESCRIPTION

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.

ARGUMENTS

Pod::Html takes the following arguments:

help

    --help

Displays the usage message.

htmldir

    --htmldir=name

Sets 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

    --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 =items.

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.

css

    --css=stylesheet

Specify the URL of a cascading style sheet.

verbose

    --verbose

Display progress messages.

quiet

    --quiet

Don't display mostly harmless warning messages.

EXAMPLE

    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");

ENVIRONMENT

Uses $Config{pod2html} to setup default options.

AUTHOR

Tom Christiansen, <tchrist@perl.com>.

SEE ALSO

perlpod

COPYRIGHT

This program is distributed under the Artistic License.