Cheap web site hosting service by

 Back to Index


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.
-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).


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 Pod::Checker/podchecker() 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


Brad Appleton <>, Marek Rouchal <>

Based on code for Pod::Text::pod2text(1) written by Tom Christiansen <>




Cheap domain name:
Domain name services from just
$8.95/year only

Register domain name search -
Buy domain name registration and cheap domain transfer at low, affordable price.

2002-2004 Web Site Hosting Service


[ All parts should go together without forcing. You must remember that the parts you are reassembling were disassembled by you. Therefore, if you can't get them together again, there must be a reason. By all means, do not use a hammer.   ]



Disclaimer: This documentation is provided only for the benefits of our web hosting customers.
For authoritative source of the documentation, please refer to