PODCHECKER(1) | Perl Programmers Reference Guide | PODCHECKER(1) |
podchecker - check the syntax of POD format documentation files
podchecker [-help] [-man] [-(no)warnings] [file ...]
podchecker will read the given input files looking for POD syntax errors in the POD documentation and will print any errors it find to STDERR. At the end, it will print a status message indicating the number of errors found.
Directories are ignored, an appropriate warning message is printed.
podchecker invokes the podchecker() function exported by Pod::Checker Please see "podchecker()" in Pod::Checker for more details.
podchecker returns a 0 (zero) exit status if all specified POD files are ok.
podchecker returns the exit status 1 if at least one of the given POD files has syntax errors.
The status 2 indicates that at least one of the specified files does not contain any POD commands.
Status 1 overrides status 2. If you want unambiguous results, call podchecker with one single argument only.
Pod::Simple and Pod::Checker
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>
2024-04-13 | perl v5.34.1 |