Linux "pod2html" Command Line Options and Examples
convert .pod files to .html files
Converts files from pod format (see perlpod) to HTML format.ARGUMENTS pod2html takes the following arguments: help --help Displays the usage message. htmldir --htmldir=name Sets the directory to which all cross references in the resulting HTML file will be relative.
Usage:
pod2html --help --htmldir=
--infile=
--podpath=
--cachedir=
--quiet --noquiet --verbose --noverbose
--index --noindex --backlink --nobacklink
--header --noheader --poderrors --nopoderrors
--css=
Command Line Options:
--help
Displays the usage message.htmldir
pod2html --help ...
--htmldir
Sets the directory to which all cross references in the resulting HTML file will be relative. Not passingthis causes all links to be absolute since this is the value that tells Pod::Html the root of thedocumentation tree.Do not use this and --htmlroot in the same call to pod2html; they are mutually exclusive.htmlroot
pod2html --htmldir ...
--htmlroot
Sets the base URL for the HTML files. When cross-references are made, the HTML root is prepended to theURL.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
pod2html --htmlroot ...
--infile
Specify the pod file to convert. Input is taken from STDIN if no infile is specified.outfile
pod2html --infile ...
--outfile
Specify the HTML file to create. Output goes to STDOUT if no outfile is specified.podroot
pod2html --outfile ...
--podroot
Specify the base directory for finding library pods.podpath
pod2html --podroot ...
--podpath
Specify which subdirectories of the podroot contain pod files whose HTML converted forms can be linked-toin cross-references.cachedir
pod2html --podpath ...
--cachedir
Specify which directory is used for storing cache. Default directory is the current working directory.flush
pod2html --cachedir ...
--flush
Flush the cache.backlink
pod2html --flush ...
--backlink
Turn =head1 directives into links pointing to the top of the HTML file.nobacklink
pod2html --backlink ...
--nobacklink
Do not turn =head1 directives into links pointing to the top of the HTML file (default behaviour).header
pod2html --nobacklink ...
--header
Create header and footer blocks containing the text of the "NAME" section.noheader
pod2html --header ...
--noheader
Do not create header and footer blocks containing the text of the "NAME" section (default behaviour).poderrors
pod2html --noheader ...
--poderrors
Include a "POD ERRORS" section in the outfile if there were any POD errors in the infile (defaultbehaviour).nopoderrors
pod2html --poderrors ...
--nopoderrors
Do not include a "POD ERRORS" section in the outfile if there were any POD errors in the infile.index
pod2html --nopoderrors ...
--index
Generate an index at the top of the HTML file (default behaviour).noindex
pod2html --index ...
--noindex
Do not generate an index at the top of the HTML file.recurse
pod2html --noindex ...
--recurse
Recurse into subdirectories specified in podpath (default behaviour).norecurse
pod2html --recurse ...
--norecurse
Do not recurse into subdirectories specified in podpath.css
pod2html --norecurse ...
--css
Specify the URL of cascading style sheet to link from resulting HTML file. Default is none style sheet.title
pod2html --css ...
--title
Specify the title of the resulting HTML file.quiet
pod2html --title ...
--quiet
Don't display mostly harmless warning messages.noquiet
pod2html --quiet ...
--noquiet
Display mostly harmless warning messages (default behaviour). But this is not the same as "verbose" mode.verbose
pod2html --noquiet ...
--verbose
Display progress messages.noverbose
pod2html --verbose ...
--noverbose
Do not display progress messages (default behaviour).AUTHORTom Christiansen, <tchrist@perl.com>.BUGSSee Pod::Html for a list of known bugs in the translator.
pod2html --noverbose ...