PODCHECKER(1) Perl Programmers Reference Guide PODCHECKER(1)
podchecker - check the syntax of POD format documentation
files
podchecker [-help] [-man] [-(no)warnings] [file ...]
-help Print a brief help message and exit.
-man Print the manual page and exit.
-warnings -nowarnings
Turn on/off printing of warnings. Repeating -warn-
ings increases the warning level, i.e. more warnings
are printed. Currently increasing to level two
causes flagging of unescaped "<,>" characters.
file 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 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 unambigouus
results, call podchecker with one single argument only.
Pod::Parser and Pod::Checker
perl v5.8.8 2006-06-30 1
PODCHECKER(1) Perl Programmers Reference Guide PODCHECKER(1)
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>
perl v5.8.8 2006-06-30 2
Generated on 2013-04-27 00:20:00 by $MirOS: src/scripts/roff2htm,v 1.77 2013/01/01 20:49:09 tg Exp $
These manual pages and other documentation are copyrighted by their respective writers;
their source is available at our CVSweb,
AnonCVS, and other mirrors. The rest is Copyright © 2002‒2013 The MirOS Project, Germany.
This product includes material
provided by Thorsten Glaser.
This manual page’s HTML representation is supposed to be valid XHTML/1.1; if not, please send a bug report – diffs preferred.