podchecker(1)

1PODCHECKER(1)         User Contributed Perl Documentation        PODCHECKER(1)
2
3
4

NAME

6       podchecker - check the syntax of POD format documentation files
7

SYNOPSIS

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

OPTIONS AND ARGUMENTS

12       -help   Print a brief help message and exit.
13
14       -man    Print the manual page and exit.
15
16       -warnings -nowarnings
17               Turn on/off printing of warnings. Repeating -warnings increases
18               the warning level, i.e. more warnings are printed. Currently
19               increasing to level two causes flagging of unescaped "<,>"
20               characters.
21
22       file    The pathname of a POD file to syntax-check (defaults to
23               standard input).
24

DESCRIPTION

26       podchecker will read the given input files looking for POD syntax
27       errors in the POD documentation and will print any errors it find to
28       STDERR. At the end, it will print a status message indicating the
29       number of errors found.
30
31       Directories are ignored, an appropriate warning message is printed.
32
33       podchecker invokes the podchecker() function exported by Pod::Checker
34       Please see "podchecker()" in Pod::Checker for more details.
35

RETURN VALUE

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

ERRORS

41       podchecker returns the exit status 1 if at least one of the given POD
42       files has syntax errors.
43
44       The status 2 indicates that at least one of the specified files does
45       not contain any POD commands.
46
47       Status 1 overrides status 2. If you want unambiguous results, call
48       podchecker with one single argument only.
49

AUTHORS

54       Please report bugs using <http://rt.cpan.org>.
55
56       Brad Appleton <bradapp@enteract.com>, Marek Rouchal <marekr@cpan.org>
57
58       Based on code for Pod::Text::pod2text(1) written by Tom Christiansen
59       <tchrist@mox.perl.com>
60
61
62
63perl v5.32.1                      2021-01-27                     PODCHECKER(1)