podchecker

check the syntax of POD format documentation files

Synopsis

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

add an example, a script, a trick and tips

: email address (won't be displayed)
: name

Step 2

Thanks for this example ! - It will be moderated and published shortly.

Feel free to post other examples Oops ! There is a tiny cockup. A damn 404 cockup. Please contact the loosy team who maintains and develops this wonderful site by clicking in the mighty feedback button on the side of the page. Say what happened. Thanks!

examples

no example yet ...

... Feel free to add your own example above to help other Linux-lovers !

description

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 "podchecker()" in Pod::Checker for more details.

errors

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 unambiguous results, call podchecker with one single argument only.

options and arguments

-help

Print a brief help message and exit.

-man

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.

file

The pathname of a POD file to syntax-check (defaults to standard input).

return value

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

see also

Pod::Parser and Pod::Checker

authors

Please report bugs using <http://rt.cpan.org>.

Brad Appleton <bradapp[:at:]enteract[:dot:]com>, Marek Rouchal <marekr[:at:]cpan[:dot:]org>

Based on code for Pod::Text::pod2text(1) written by Tom Christiansen <tchrist[:at:]mox.perl[:dot:]com>