1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "PODCHECKER 1"
.TH PODCHECKER 1 2023-12-15 "perl v5.38.2" "Perl Programmers Reference Guide"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
podchecker \- check the syntax of POD format documentation files
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBpodchecker\fR [\fB\-help\fR] [\fB\-man\fR] [\fB\-(no)warnings\fR] [\fIfile\fR\ ...]
.SH "OPTIONS AND ARGUMENTS"
.IX Header "OPTIONS AND ARGUMENTS"
.IP \fB\-help\fR 8
.IX Item "-help"
Print a brief help message and exit.
.IP \fB\-man\fR 8
.IX Item "-man"
Print the manual page and exit.
.IP "\fB\-warnings\fR \fB\-nowarnings\fR" 8
.IX Item "-warnings -nowarnings"
Turn on/off printing of warnings. Repeating \fB\-warnings\fR increases the
warning level, i.e. more warnings are printed. Currently increasing to
level two causes flagging of unescaped "<,>" characters.
.IP \fIfile\fR 8
.IX Item "file"
The pathname of a POD file to syntax-check (defaults to standard input).
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBpodchecker\fR 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.
.PP
Directories are ignored, an appropriate warning message is printed.
.PP
\&\fBpodchecker\fR invokes the \fBpodchecker()\fR function exported by \fBPod::Checker\fR
Please see "\fBpodchecker()\fR" in Pod::Checker for more details.
.SH "RETURN VALUE"
.IX Header "RETURN VALUE"
\&\fBpodchecker\fR returns a 0 (zero) exit status if all specified
POD files are ok.
.SH ERRORS
.IX Header "ERRORS"
\&\fBpodchecker\fR returns the exit status 1 if at least one of
the given POD files has syntax errors.
.PP
The status 2 indicates that at least one of the specified
files does not contain \fIany\fR POD commands.
.PP
Status 1 overrides status 2. If you want unambiguous
results, call \fBpodchecker\fR with one single argument only.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Pod::Simple and Pod::Checker
.SH AUTHORS
.IX Header "AUTHORS"
Please report bugs using <http://rt.cpan.org>.
.PP
Brad Appleton <bradapp@enteract.com>,
Marek Rouchal <marekr@cpan.org>
.PP
Based on code for \fBPod::Text::pod2text\|(1)\fR written by
Tom Christiansen <tchrist@mox.perl.com>
|
