perldoc > Pod::Simple::Checker

man perldoc info pydoc3 ri search

✔️ NAME

Pod::Simple::Checker — check the Pod syntax of a document

🚀 Quick Reference

Use Case	Command	Description
🔍 Check a Pod file for errors	perl -MPod::Simple::Checker -e "exit Pod::Simple::Checker->filter(shift)->any_errata_seen" file.pod	Returns exit code 0 if no errors, non-zero if errors found
📡 Check Pod from STDIN	perl -MPod::Simple::Checker -e "exit Pod::Simple::Checker->filter(\*STDIN)->any_errata_seen"	Pipe Pod content to check without a file
📋 Check Pod with verbose error output	perl -MPod::Simple::Checker -e "Pod::Simple::Checker->filter(shift)" file.pod 2>&1	Outputs any Pod errors to stderr

📋 SYNOPSIS

perl -MPod::Simple::Checker -e \
       "exit Pod::Simple::Checker->filter(shift)->any_errata_seen" \
       thingy.pod

📖 DESCRIPTION

This class is for checking the syntactic validity of Pod. It works by basically acting like a simple-minded version of Pod::Simple::Text that formats only the "Pod Errors" section (if Pod::Simple even generates one for the given document).

This is a subclass of Pod::Simple and inherits all its methods.

🔗 SEE ALSO

• Pod::Simple
• Pod::Simple::Text
• Pod::Checker

🆘 SUPPORT

Questions or discussion about POD and Pod::Simple should be sent to the pod-people AT perl.org mail list. Send an empty email to pod-people-subscribe AT perl.org to subscribe.

This module is managed in an open GitHub repository, <https://github.com/perl-pod/pod-simple/>. Feel free to fork and contribute, or to clone <git://github.com/perl-pod/pod-simple.git> and send patches!

Patches against Pod::Simple are welcome. Please send bug reports to <bug-pod-simple AT rt.org>.

📜 COPYRIGHT AND DISCLAIMERS

Copyright (c) 2002 Sean M. Burke.

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

This program is distributed in the hope that it will be useful, but without any warranty; without even the implied warranty of merchantability or fitness for a particular purpose.

👤 AUTHOR

Pod::Simple was created by Sean M. Burke <sburke AT cpan.org>. But don't bother him, he's retired.

Pod::Simple is maintained by:

• Allison Randal "allison AT perl.org"
• Hans Dieter Pearcey "hdp AT cpan.org"
• David E. Wheeler "dwheeler AT cpan.org"

✔️ NAME 🚀 Quick Reference 📋 SYNOPSIS 📖 DESCRIPTION 🔗 SEE ALSO 🆘 SUPPORT 📜 COPYRIGHT AND DISCLAIMERS 👤 AUTHOR