PODCHECKER(1) Perl Programmers Reference Guide PODCHECKER(1)

NAME
       podchecker - check the syntax of POD format documentation files

SYNOPSIS
       ppooddcchheecckkeerr [-hheellpp] [-mmaann] [-((nnoo))wwaarrnniinnggss] [file ...]

OOPPTTIIOONNSS AANNDD AARRGGUUMMEENNTTSS
       -hheellpp   Print a brief help message and exit.

       -mmaann    Print the manual page and exit.

       -wwaarrnniinnggss -nnoowwaarrnniinnggss
               Turn on/off printing of warnings. Repeating -wwaarrnniinnggss 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 stan-
               dard input).

DESCRIPTION
       ppooddcchheecckkeerr 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 num-
       ber of errors found.

       Directories are ignored, an appropriate warning message is printed.

       ppooddcchheecckkeerr invokes the ppooddcchheecckkeerr(()) function exported by PPoodd::::CChheecckkeerr
       Please see "podchecker()" in Pod::Checker for more details.

RREETTUURRNN VVAALLUUEE
       ppooddcchheecckkeerr returns a 0 (zero) exit status if all specified POD files
       are ok.

EERRRROORRSS
       ppooddcchheecckkeerr 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 ppoodd-
       cchheecckkeerr with one single argument only.

SEE ALSO
       Pod::Parser and Pod::Checker

AUTHORS       Please report bugs using .

       Brad Appleton , Marek Rouchal 

       Based on code for PPoodd::::TTeexxtt::::ppoodd22tteexxtt((11)) written by Tom Christiansen
       



perl v5.8.6                       2009-01-12                     PODCHECKER(1)