Name
pod2html - convert .pod files to .html filesSynopsis
\& pod2html --help --htmldir=<name> --htmlroot=<URL> \& --infile=<name> --outfile=<name> \& --podpath=<name>:...:<name> --podroot=<name> \& --cachedir=<name> --flush --recurse --norecurse \& --quiet --noquiet --verbose --noverbose \& --index --noindex --backlink --nobacklink \& --header --noheader --poderrors --nopoderrors \& --css=<URL> --title=<name>Description
Converts files from pod format (see perlpod) to \s-1HTML\s0 format.Arguments
pod2html takes the following arguments:\& --help Displays the usage message.
\& --htmldir=name Sets the directory to which all cross references in the resulting \s-1HTML\s0 file will be relative. Not passing this causes all links to be absolute since this is the value that tells Pod::Html the root of the documentation tree. Do not use this and --htmlroot in the same call to pod2html; they are mutually exclusive.
\& --htmlroot=URL Sets the base \s-1URL\s0 for the \s-1HTML\s0 files. When cross-references are made, the \&\s-1HTML\s0 root is prepended to the \s-1URL.\s0 Do not use this if relative links are desired: use --htmldir instead. Do not pass both this and --htmldir to pod2html; they are mutually exclusive.
\& --infile=name Specify the pod file to convert. Input is taken from \s-1STDIN\s0 if no infile is specified.
\& --outfile=name Specify the \s-1HTML\s0 file to create. Output goes to \s-1STDOUT\s0 if no outfile is specified.
\& --podroot=name Specify the base directory for finding library pods.
\& --podpath=name:...:name Specify which subdirectories of the podroot contain pod files whose \&\s-1HTML\s0 converted forms can be linked-to in cross-references.
\& --cachedir=name Specify which directory is used for storing cache. Default directory is the current working directory.
\& --flush Flush the cache.
\& --backlink Turn =head1 directives into links pointing to the top of the \s-1HTML\s0 file.
\& --nobacklink Do not turn =head1 directives into links pointing to the top of the \s-1HTML\s0 file (default behaviour).
\& --header Create header and footer blocks containing the text of the \*(L"\s-1NAME\*(R"\s0 section.
\& --noheader Do not create header and footer blocks containing the text of the \*(L"\s-1NAME\*(R"\s0 section (default behaviour).
\& --poderrors Include a \*(L"\s-1POD ERRORS\*(R"\s0 section in the outfile if there were any \s-1POD\s0 errors in the infile (default behaviour).
\& --nopoderrors Do not include a \*(L"\s-1POD ERRORS\*(R"\s0 section in the outfile if there were any \s-1POD\s0 errors in the infile.
\& --index Generate an index at the top of the \s-1HTML\s0 file (default behaviour).
\& --noindex Do not generate an index at the top of the \s-1HTML\s0 file.
\& --recurse Recurse into subdirectories specified in podpath (default behaviour).
\& --norecurse Do not recurse into subdirectories specified in podpath.
\& --css=URL Specify the \s-1URL\s0 of cascading style sheet to link from resulting \s-1HTML\s0 file. Default is none style sheet.
\& --title=title Specify the title of the resulting \s-1HTML\s0 file.
\& --quiet Don't display mostly harmless warning messages.
\& --noquiet Display mostly harmless warning messages (default behaviour). But this is not the same as \*(L"verbose\*(R" mode.
\& --verbose Display progress messages.
\& --noverbose Do not display progress messages (default behaviour).