POD2HTML(1)

📦
version 5.42.3 · 22 versions
, in alpine 3.24

🌸 NAME 🌸

hey bestie, welcome to POD2HTML(1) from the Perl Programmers Reference Guide — yep, the pod2html page. pod2html converts .pod files to .html files. It’s giving tiny translator icon energy ✨.

🛠️ SYNOPSIS 🛠️

    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 💖

pod2html converts files from pod format (see perlpod) to HTML format. That’s literally the whole mission, and it ate 💅.

🎀 ARGUMENTS 🎀

pod2html takes the following arguments, bestie — every single one, no skipping:

  • --backlink — turns =head1 directives into links pointing to the top of the HTML file.
  • --nobacklink — does not create these backlinks. This is the default behavior.

cachedir

  • --cachedir=name — picks which directory is used for storing cache. The default directory is the current working directory.

css

  • --css=URL — gives the URL of a cascading style sheet to link from the resulting HTML file. Default is none style sheet.

flush

  • --flush — flushes the cache. bye cache, love u 🫶
  • --header — creates header and footer blocks containing the text of the "NAME" section.
  • --noheader — does not create header or footer blocks. This is the default behavior.

help

  • --help — displays the usage message. iconic.

htmldir

  • --htmldir=name — sets the directory to which all cross references in the resulting HTML 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. that’s the rule, periodt.

htmlroot

  • --htmlroot=URL — sets the base URL for the HTML files. When cross-references are made, the HTML root is prepended to the URL.
🚨 do not use this if relative links are desired — use --htmldir instead. Also do not pass both this and --htmldir to pod2html; they are mutually exclusive.

index

  • --index — generates an index at the top of the HTML file. This is the default behaviour.

noindex

  • --noindex — does not generate an index at the top of the HTML file.

infile

  • --infile=name — specifies the pod file to convert. Input is taken from STDIN if no infile is specified.

outfile

  • --outfile=name — specifies the HTML file to create. Output goes to STDOUT if no outfile is specified.

poderrors

  • --poderrors — includes a "POD ERRORS" section in the outfile if there were any POD errors in the infile. This is the default behaviour.
  • --nopoderrors — does not create this "POD ERRORS" section.

podpath

  • --podpath=name:...:name — specifies which subdirectories of the podroot contain pod files whose HTML converted forms can be linked-to in cross-references.

podroot

  • --podroot=name — specifies the base directory for finding library pods.

quiet

  • --quiet — don’t display mostly harmless warning messages.
  • --noquiet — displays these mostly harmless warning messages. This is the default behavior (but this is not the same as "verbose" mode).

recurse

  • --recurse — recurses into subdirectories specified in podpath. This is the default behaviour.
  • --norecurse — does not recurse into these subdirectories.

title

  • --title=title — specifies the title of the resulting HTML file.

verbose

  • --verbose — displays progress messages.
  • --noverbose — does not display these progress messages. This is the default behavior.

👑 AUTHOR 👑

Tom Christiansen, <tchrist@perl.com>.

💀 BUGS 💀

See Pod::Html for a list of known bugs in the translator. (not me manifesting bugs, just reporting the tea 🍵)

🦋 SEE ALSO 🦋

  • perlpod
  • Pod::Html

This program is distributed under the Artistic License.

mwah 💋 this page is from perl v5.42.3, dated 2026-11-03 — that’s the footer tea, bestie, and we’re done. 🎀✨

📦 where this page comes from