Debian Codegraph @

upstream/debian-unstable/man3/Pod::Simple::Checker.3perl

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 "Pod::Simple::Checker 3perl"
58 .TH Pod::Simple::Checker 3perl 2025-11-16 "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 Pod::Simple::Checker \-\- check the Pod syntax of a document
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 3
68 \& perl \-MPod::Simple::Checker \-e \e
69 \& "exit Pod::Simple::Checker\->filter(shift)\->any_errata_seen" \e
70 \& thingy.pod
71 .Ve
72 .SH DESCRIPTION
73 .IX Header "DESCRIPTION"
74 This class is for checking the syntactic validity of Pod.
75 It works by basically acting like a simple-minded version of
76 Pod::Simple::Text that formats only the "Pod Errors" section
77 (if Pod::Simple even generates one for the given document).
78 .PP
79 This is a subclass of Pod::Simple and inherits all its methods.
80 .SH "SEE ALSO"
81 .IX Header "SEE ALSO"
82 Pod::Simple, Pod::Simple::Text, Pod::Checker
83 .SH SUPPORT
84 .IX Header "SUPPORT"
85 Questions or discussion about POD and Pod::Simple should be sent to the
86 pod\[email protected] mail list. Send an empty email to
87 pod\-people\[email protected] to subscribe.
88 .PP
89 This module is managed in an open GitHub repository,
90 <https://github.com/perl\-pod/pod\-simple/>. Feel free to fork and contribute, or
91 to clone <https://github.com/perl\-pod/pod\-simple.git> and send patches!
92 .PP
93 Patches against Pod::Simple are welcome. Please send bug reports to
94 <bug\-pod\[email protected]>.
95 .SH "COPYRIGHT AND DISCLAIMERS"
96 .IX Header "COPYRIGHT AND DISCLAIMERS"
97 Copyright (c) 2002 Sean M. Burke.
98 .PP
99 This library is free software; you can redistribute it and/or modify it
100 under the same terms as Perl itself.
101 .PP
102 This program is distributed in the hope that it will be useful, but
103 without any warranty; without even the implied warranty of
104 merchantability or fitness for a particular purpose.
105 .SH AUTHOR
106 .IX Header "AUTHOR"
107 Pod::Simple was created by Sean M. Burke <[email protected]>.
108 But don't bother him, he's retired.
109 .PP
110 Pod::Simple is maintained by:
111 .IP \(bu 4
112 Allison Randal \f(CW\*(C`[email protected]\*(C'\fR
113 .IP \(bu 4
114 Hans Dieter Pearcey \f(CW\*(C`[email protected]\*(C'\fR
115 .IP \(bu 4
116 David E. Wheeler \f(CW\*(C`[email protected]\*(C'\fR