Copyright (C) 2000-2012 |
Manpages PODCHECKERSection: Perl Programmers Reference Guide (1)Updated: 2005-03-28 Index Return to Main Contents NAMEpodchecker - check the syntax of POD format documentation filesSYNOPSISpodchecker [-help] [-man] [-(no)warnings] [file ...]OPTIONS AND ARGUMENTS
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. podchecker invokes the podchecker() function exported by Pod::Checker Please see ``podchecker()'' in Pod::Checker for more details. 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. Status 1 overrides status 2. If you want unambigouus results, call podchecker with one single argument only. SEE ALSOPod::Parser and Pod::CheckerAUTHORSBrad Appleton <bradapp@enteract.com>, Marek Rouchal <marek@saftsack.fs.uni-bayreuth.de>Based on code for Pod::Text::pod2text(1) written by Tom Christiansen <tchrist@mox.perl.com>
IndexThis document was created by man2html, using the manual pages. Time: 09:37:40 GMT, April 26, 2024 |