PODCHECKER(1) Perl Programmers Reference Guide PODCHECKER(1) #
PODCHECKER(1) Perl Programmers Reference Guide PODCHECKER(1)
NNAAMMEE #
podchecker - check the syntax of POD format documentation files
SSYYNNOOPPSSIISS #
ppooddcchheecckkeerr [--hheellpp] [--mmaann] [--((nnoo))wwaarrnniinnggss] [_f_i_l_e ...]
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.
_f_i_l_e The pathname of a POD file to syntax-check (defaults to standard
input).
DDEESSCCRRIIPPTTIIOONN #
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 number of errors
found.
Directories are ignored, an appropriate warning message is printed.
ppooddcchheecckkeerr invokes the ppooddcchheecckkeerr(()) function exported by PPoodd::::CChheecckkeerr
Please see "ppooddcchheecckkeerr(())" 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 _a_n_y POD commands.
Status 1 overrides status 2. If you want unambiguous results, call
ppooddcchheecckkeerr with one single argument only.
SSEEEE AALLSSOO #
Pod::Simple and Pod::Checker
AAUUTTHHOORRSS #
Please report bugs using <http://rt.cpan.org>.
Brad Appleton <bradapp@enteract.com>, Marek Rouchal <marekr@cpan.org>
Based on code for PPoodd::::TTeexxtt::::ppoodd22tteexxtt((11)) written by Tom Christiansen
<tchrist@mox.perl.com>
perl v5.36.3 2024-03-20 PODCHECKER(1)