PODCHECKER(1)

🌸 NAME 🌸

okay so you're on the PODCHECKER(1) page, bestie, and this iconic lil tool is here to check the syntax of POD format documentation files. that's it, that's the vibe — POD syntax check supreme 💖

---

✨ SYNOPSIS ✨

podchecker [-help] [-man] [-(no)warnings] [file ...]

---

💅 OPTIONS AND ARGUMENTS 💅

• -help — prints a brief help message and exits. short, sweet, helpful 🎀
• -man — prints the manual page and exits. yes, the manpage of manpage-checking, we love recursion-adjacent behavior 👑
• -quiet — do not print a success message. silence is golden, lowkey 🌙
• -warnings — turns on printing of warnings. repeating -warnings increases the warning level, i.e. more warnings are printed. currently, increasing to level two causes flagging of unescaped "<,>" characters. spicy warning escalation fr fr 🔥
• -nowarnings — turns off printing of warnings. no warnings era, protected peace 🫶
• file — the pathname of a POD file to syntax-check. it defaults to standard input. drop a file path or feed it stdin, your call ✨

---

🦋 DESCRIPTION 🦋

so podchecker will read the given input files looking for POD syntax errors in the POD documentation, and it will print any errors it finds to STDERR. at the end, it prints a status message indicating the number of errors found. receipts at the end, always 💅

directories are ignored, and an appropriate warning message is printed. not today, directory 😭

podchecker invokes the podchecker() function exported by Pod::Checker. please see "podchecker()" in Pod::Checker for more details. iykyk 🧚

---

🎀 RETURN VALUE 🎀

podchecker returns a 0 (zero) exit status if all specified POD files are ok. clean, valid, slaying ✅

---

💀 ERRORS 💀

podchecker returns the exit status 1 if at least one of the given POD files has syntax errors. uh oh, syntax drama 💀

the status 2 indicates that at least one of the specified files does not contain any POD commands. no POD commands found, awkward silence 🙈

status 1 overrides status 2. if you want unambiguous results, call podchecker with one single argument only. one file at a time if you want the clean tea, bestie ☕

---

👑 SEE ALSO 👑

Pod::Simple and Pod::Checker — go read those too, they're the supporting cast 💖

---

🫶 AUTHORS 🫶

please report bugs using <http://rt.cpan.org>.

Brad Appleton <bradapp@enteract.com>, Marek Rouchal <marekr@cpan.org>

based on code for Pod::Text::pod2text(1) written by Tom Christiansen <tchrist@mox.perl.com>

---

mwah 💋 — this page is from perl v5.42.3, dated 2026-11-03, and it ate, no crumbs 🌈