podchecker - check the syntax of POD format documentation files
podchecker [-help] [-man] [-(no)warnings] [file...]
Print a brief help message and exit.
Print the manual page and exit.
Turn on/off 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.
The pathname of a POD file to syntax-check (defaults to standard input).
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 thepodchecker() function exported byPod::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 containany POD commands.
Status 1 overrides status 2. If you want unambiguous results, callpodchecker with one single argument only.
Please report bugs usinghttp://rt.cpan.org.
Brad Appleton <bradapp@enteract.com>, Marek Rouchal <marekr@cpan.org>
Based on code forPod::Text::pod2text(1) written by Tom Christiansen <tchrist@mox.perl.com>
Perldoc Browser is maintained by Dan Book (DBOOK). Please contact him via theGitHub issue tracker oremail regarding any issues with the site itself, search, or rendering of documentation.
The Perl documentation is maintained by the Perl 5 Porters in the development of Perl. Please contact them via thePerl issue tracker, themailing list, orIRC to report any issues with the contents or format of the documentation.