PODCHECKERSection: Perl Programmers Reference Guide (1)
Index Return to Main Contents
NAMEpodchecker - check the syntax of POD format documentation files
SYNOPSISpodchecker [-help] [-man] [-(no)warnings] [file ...]
OPTIONS AND ARGUMENTS
- Print a brief help message and exit.
- Print the manual page and exit.
- -warnings -nowarnings
- 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).
DESCRIPTIONpodchecker 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.
RETURN VALUEpodchecker returns a 0 (zero) exit status if all specified POD files are ok.
ERRORSpodchecker 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.
SEE ALSOPod::Parser and Pod::Checker
AUTHORSPlease report bugs using <http://rt.cpan.org>.
This document was created by man2html, using the manual pages.
Time: 05:29:09 GMT, December 24, 2015