Debian Codegraph @

upstream/debian-unstable/man1/podchecker.1

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