NAME

installhtml - converts a collection of POD pages to HTML format.

SYNOPSIS

    installhtml  [--help] [--podpath=<name>:...:<name>] [--podroot=<name>]
         [--htmldir=<name>] [--htmlroot=<name>]  [--norecurse] [--recurse]
         [--splithead=<name>,...,<name>]   [--splititem=<name>,...,<name>]
         [--libpods=<name>,...,<name>]  [--verbose]

DESCRIPTION

installhtml converts a collection of POD pages to a corresponding collection of HTML pages. This is primarily used to convert the pod pages found in the perl distribution.

OPTIONS

--help help: Displays the usage.
--podroot POD search path base directory: The base directory to search for all .pod and .pm files to be converted. Default is current directory.
--podpath POD search path: The list of directories to search for .pod and .pm files to be converted. Default is `podroot/.'.
--recurse recurse on subdirectories: Whether or not to convert all .pm and .pod files found in subdirectories too. Default is to not recurse.
--htmldir HTML destination directory: The base directory which all HTML files will be written to. This should be a path relative to the filesystem, not the resulting URL.
--htmlroot URL base directory: The base directory which all resulting HTML files will be visible at in a URL. The default is `/'.
--splithead POD files to split on =head directive: Colon-separated list of pod files to split by the =head directive. The .pod suffix is optional. These files should have names specified relative to podroot.
--splititem POD files to split on =item directive: Colon-separated list of all pod files to split by the =item directive. The .pod suffix is optional. installhtml does not do the actual split, rather it invokes splitpod to do the dirty work. As with --splithead, these files should have names specified relative to podroot.
--splitpod Directory containing the splitpod program: The directory containing the splitpod program. The default is `podroot/pod'.
--libpods library PODs for Lltgt links: Colon-separated list of ``library'' pod files. This is the same list that will be passed to pod2html when any pod is converted.
--verbose verbose output: Self-explanatory.

EXAMPLE

The following command-line is an example of the one we use to convert perl documentation:

    ./installhtml --podpath=lib:ext:pod:vms   \
                        --podroot=/usr/src/perl     \
                        --htmldir=/perl/nmanual     \
                        --htmlroot=/perl/nmanual    \
                        --splithead=pod/perlipc     \
                        --splititem=pod/perlfunc    \
                        --libpods=perlfunc:perlguts:perlvar:perlrun:perlop \
                        --recurse \
                        --verbose

AUTHOR

Chris Hall <hallc@cs.colorado.edu>

TODO

DISCLAIMER

We are painfully aware that these documents may contain incorrect links and misformatted HTML. Such bugs lie in the automatic translation process that automatically created the hundreds and hundreds of separate documents that you find here. Please do not report link or formatting bugs, because we cannot fix per-document problems. The only bug reports that will help us are those that supply working patches to the installhtml or pod2html programs, or to the Pod::HTML module itself, for which I and the entire Perl community will shower you with thanks and praises.

If rather than formatting bugs, you encounter substantive content errors in these documents, such as mistakes in the explanations or code, please use the perlbug utility included with the Perl distribution.

--Tom Christiansen, Perl Documentation Compiler and Editor

Return to the Perl Documentation Index.
Return to the Perl Home Page.