Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Pod::Simple::Checker.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Pod::Simple::Checker 3pm"
61 .TH Pod::Simple::Checker 3pm 2026-03-09 "perl v5.42.1" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Pod::Simple::Checker \-\- check the Pod syntax of a document
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 3
71 \& perl \-MPod::Simple::Checker \-e \e
72 \& "exit Pod::Simple::Checker\->filter(shift)\->any_errata_seen" \e
73 \& thingy.pod
74 .Ve
75 .SH DESCRIPTION
76 .IX Header "DESCRIPTION"
77 This class is for checking the syntactic validity of Pod.
78 It works by basically acting like a simple\-minded version of
79 Pod::Simple::Text that formats only the "Pod Errors" section
80 (if Pod::Simple even generates one for the given document).
81 .PP
82 This is a subclass of Pod::Simple and inherits all its methods.
83 .SH "SEE ALSO"
84 .IX Header "SEE ALSO"
85 Pod::Simple, Pod::Simple::Text, Pod::Checker
86 .SH SUPPORT
87 .IX Header "SUPPORT"
88 Questions or discussion about POD and Pod::Simple should be sent to the
89 pod\[email protected] mail list. Send an empty email to
90 pod\-people\[email protected] to subscribe.
91 .PP
92 This module is managed in an open GitHub repository,
93 <https://github.com/perl\-pod/pod\-simple/>. Feel free to fork and contribute, or
94 to clone <https://github.com/perl\-pod/pod\-simple.git> and send patches!
95 .PP
96 Patches against Pod::Simple are welcome. Please send bug reports to
97 <bug\-pod\[email protected]>.
98 .SH "COPYRIGHT AND DISCLAIMERS"
99 .IX Header "COPYRIGHT AND DISCLAIMERS"
100 Copyright (c) 2002 Sean M. Burke.
101 .PP
102 This library is free software; you can redistribute it and/or modify it
103 under the same terms as Perl itself.
104 .PP
105 This program is distributed in the hope that it will be useful, but
106 without any warranty; without even the implied warranty of
107 merchantability or fitness for a particular purpose.
108 .SH AUTHOR
109 .IX Header "AUTHOR"
110 Pod::Simple was created by Sean M. Burke <[email protected]>.
111 But don\*(Aqt bother him, he\*(Aqs retired.
112 .PP
113 Pod::Simple is maintained by:
114 .IP \(bu 4
115 Allison Randal \f(CW\*(C`[email protected]\*(C'\fR
116 .IP \(bu 4
117 Hans Dieter Pearcey \f(CW\*(C`[email protected]\*(C'\fR
118 .IP \(bu 4
119 David E. Wheeler \f(CW\*(C`[email protected]\*(C'\fR