Name
podchecker - check the syntax of POD format documentation filesSynopsis
\&podchecker [-help] [-man] [-(no)warnings] [file ...]Options And Arguments
Print a brief help message and exit.
Print the manual page and exit.
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 \*(L"<,>\*(R" characters.
The pathname of a \s-1POD\s0 file to syntax-check (defaults to standard input).
Description
\&podchecker will read the given input files looking for \s-1POD\s0 syntax errors in the \s-1POD\s0 documentation and will print any errors it find to \s-1STDERR.\s0 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 \*(L"podchecker()\*(R" in Pod::Checker for more details.
Return Value
\&podchecker returns a 0 (zero) exit status if all specified \&\s-1POD\s0 files are ok.Errors
\&podchecker returns the exit status 1 if at least one of the given \s-1POD\s0 files has syntax errors.The status 2 indicates that at least one of the specified files does not contain any \s-1POD\s0 commands.
Status 1 overrides status 2. If you want unambiguous results, call podchecker with one single argument only.
See Also
Pod::Simple and Pod::CheckerAuthors
Please report bugs using <http://rt.cpan.org>.Brad Appleton <[email protected]>, Marek Rouchal <[email protected]>
Based on code for Pod::Text::pod2text\|(1) written by Tom Christiansen <[email protected]>