podchecker

check the syntax of POD format documentation files

SYNOPSIS

Header "SYNOPSIS" podchecker [ -help ][ -man ][ -(no)warnings ][ file ...]

OPTIONS AND ARGUMENTS

Header "OPTIONS AND ARGUMENTS"

" -help "8 Item "-help" Print a brief help message and exit.

" -man "8 Item "-man" Print the manual page and exit.

" -warnings -nowarnings "8 Item "-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 (L"<,> (R" characters.

" file "8 Item "file" The pathname of a PODfile to syntax-check (defaults to standard input).

DESCRIPTION

Header "DESCRIPTION" podchecker will read the given input files looking for POD syntax errors in the PODdocumentation 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 (L" podchecker() (R" in Pod::Checker for more details.

RETURN VALUE

Header "RETURN VALUE" podchecker returns a 0 (zero) exit status if all specified PODfiles are ok.

ERRORS

Header "ERRORS" podchecker returns the exit status 1 if at least one of the given PODfiles has syntax errors.

The status 2 indicates that at least one of the specified files does not contain any PODcommands.

Status 1 overrides status 2. If you want unambiguous results, call podchecker with one single argument only.

AUTHORS

Header "AUTHORS" 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>

SEE ALSO

Header "SEE ALSO" Pod::Simple and Pod::Checker

Copied to clipboard
free 100$ digital ocean credit