POD2HTML(1perl)

💖 POD2HTML 💖

okay bestie, welcome to pod2html from the Perl Programmers Reference Guide — yes, section 1perl, she's a real one 💅

---

✨ NAME ✨

pod2html — convert .pod files to .html files 🦋

---

🌸 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 👑

Converts files from pod format (peep perlpod for the lore) to HTML format. that's the whole job. she converts. she slays. periodt ✨

---

🎀 ARGUMENTS 🎀

pod2html takes the following arguments, and no I'm not skipping any of them, we're doing all of them together like besties:

• backlink — --backlink / --nobacklink: turn =head1 directives into links pointing to

the top of the HTML file. --nobacklink (which is the default behavior) does not create these backlinks. so by default: no links back up top, no cap 🫶

• cachedir — --cachedir=name: specify which directory is used for storing cache. default directory is the current working directory. lowkey important, don't lose track of it 📁
• css — --css=URL: specify the URL of cascading style sheet to link from resulting HTML file. default is none style sheet. she's serving raw, unseasoned HTML by default, iconic honestly 💅
• flush — --flush: flush the cache. bye cache 🚮
• header — --header / --noheader: create header and footer blocks containing the text of the "NAME" section. --noheader — which is the default behavior — does not create header or footer blocks.
• help — --help: displays the usage message. when you're lost bestie, she'll tell you where you are 🧭
• 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, fr fr 🚫

• 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.

do not pass both this and --htmldir to pod2html; they are mutually exclusive. pick a lane bestie 🌈

• index — --index: generate an index at the top of the HTML file (default behaviour). ✨
  • noindex — --noindex: do not generate an index at the top of the HTML file. sometimes no index is the vibe 🙈
• infile — --infile=name: specify the pod file to convert. input is taken from STDIN if no infile is specified.
• outfile — --outfile=name: specify the HTML file to create. output goes to STDOUT if no outfile is specified. ✨
• poderrors — --poderrors / --nopoderrors: include a "POD ERRORS" section in the outfile if there were any POD errors in the infile (default behaviour). --nopoderrors does not create this "POD ERRORS" section.
• podpath — --podpath=name:...:name: specify which subdirectories of the podroot contain pod files whose HTML converted forms can be linked-to in cross-references. 🦋
• podroot — --podroot=name: specify the base directory for finding library pods. 🏠
• quiet — --quiet / --noquiet: don't display mostly harmless warning messages. --noquiet — which is the default behavior — does display these mostly harmless warning messages (but this is not the same as "verbose" mode). they're mostly harmless. mostly. 😭
• recurse — --recurse / --norecurse: recurse into subdirectories specified in podpath (default behaviour). --norecurse does not recurse into these subdirectories. going in deep by default 🌊
• title — --title=title: specify the title of the resulting HTML file. gotta have a title, main character energy only 📛
• verbose — --verbose / --noverbose: display progress messages. --noverbose — which is the default behavior — does not display these progress messages. if you want the play-by-play, say --verbose 💬

---

🌟 AUTHOR 🌟

Tom Christiansen, <tchrist@perl.com>. shoutout to the icon who wrote this 👑

---

💀 BUGS 💀

See Pod::Html for a list of known bugs in the translator. yeah, she's not perfect, but neither are we 🫶

---

🦋 SEE ALSO 🦋

• perlpod
• Pod::Html

---

🌈 COPYRIGHT 🌈

This program is distributed under the Artistic License. ✨

---

and that's the whole page bestie!! this one comes to you from perl v5.44.0, dated 2026-10-17 — mwah, go forth and pod2html responsibly 💖🎀💅