pod2html

convert .pod files to .html files

SYNOPSIS

Header "SYNOPSIS" 8 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

Header "DESCRIPTION" Converts files from pod format (see perlpod) to HTMLformat.

ARGUMENTS

Header "ARGUMENTS" pod2html takes the following arguments:

"help" 4 Item "help" 1 --help Displays the usage message.

"htmldir" 4 Item "htmldir" 1 --htmldir=name Sets the directory to which all cross references in the resulting HTMLfile 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" 4 Item "htmlroot" 1 --htmlroot=URL Sets the base URLfor the HTMLfiles. When cross-references are made, the HTMLroot is prepended to the URL. 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" 4 Item "infile" 1 --infile=name Specify the pod file to convert. Input is taken from STDINif no infile is specified.

"outfile" 4 Item "outfile" 1 --outfile=name Specify the HTMLfile to create. Output goes to STDOUTif no outfile is specified.

"podroot" 4 Item "podroot" 1 --podroot=name Specify the base directory for finding library pods.

"podpath" 4 Item "podpath" 1 --podpath=name:...:name Specify which subdirectories of the podroot contain pod files whose HTMLconverted forms can be linked-to in cross-references.

"cachedir" 4 Item "cachedir" 1 --cachedir=name Specify which directory is used for storing cache. Default directory is the current working directory.

"flush" 4 Item "flush" 1 --flush Flush the cache.

"backlink" 4 Item "backlink" 1 --backlink Turn =head1 directives into links pointing to the top of the HTMLfile.

"nobacklink" 4 Item "nobacklink" 1 --nobacklink Do not turn =head1 directives into links pointing to the top of the HTMLfile (default behaviour).

"header" 4 Item "header" 1 --header Create header and footer blocks containing the text of the (L" NAME(R" section.

"noheader" 4 Item "noheader" 1 --noheader Do not create header and footer blocks containing the text of the (L" NAME(R" section (default behaviour).

"poderrors" 4 Item "poderrors" 1 --poderrors Include a (L" PODERRORS (R" section in the outfile if there were any PODerrors in the infile (default behaviour).

"nopoderrors" 4 Item "nopoderrors" 1 --nopoderrors Do not include a (L" PODERRORS (R" section in the outfile if there were any POD errors in the infile.

"index" 4 Item "index" 1 --index Generate an index at the top of the HTMLfile (default behaviour).

"noindex" 4 Item "noindex" 1 --noindex Do not generate an index at the top of the HTMLfile.

"recurse" 4 Item "recurse" 1 --recurse Recurse into subdirectories specified in podpath (default behaviour).

"norecurse" 4 Item "norecurse" 1 --norecurse Do not recurse into subdirectories specified in podpath.

"css" 4 Item "css" 1 --css=URL Specify the URLof cascading style sheet to link from resulting HTMLfile. Default is none style sheet.

"title" 4 Item "title" 1 --title=title Specify the title of the resulting HTMLfile.

"quiet" 4 Item "quiet" 1 --quiet Don't display mostly harmless warning messages.

"noquiet" 4 Item "noquiet" 1 --noquiet Display mostly harmless warning messages (default behaviour). But this is not the same as (L"verbose (R" mode.

"verbose" 4 Item "verbose" 1 --verbose Display progress messages.

"noverbose" 4 Item "noverbose" 1 --noverbose Do not display progress messages (default behaviour).

BUGS

Header "BUGS" See Pod::Html for a list of known bugs in the translator.

COPYRIGHT

Header "COPYRIGHT" This program is distributed under the Artistic License.

SEE ALSO

Header "SEE ALSO" perlpod, Pod::Html

AUTHOR

Header "AUTHOR" Tom Christiansen, <tchrist@perl.com>.

Copied to clipboard
free 100$ digital ocean credit