Debian Codegraph @

upstream/debian-unstable/man3/Pod::Perldoc::ToChecker.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::Perldoc::ToChecker 3perl"
58 .TH Pod::Perldoc::ToChecker 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::Perldoc::ToChecker \- let Perldoc check Pod for errors
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 3
68 \& % perldoc \-o checker SomeFile.pod
69 \& No Pod errors in SomeFile.pod
70 \& (or an error report)
71 .Ve
72 .SH DESCRIPTION
73 .IX Header "DESCRIPTION"
74 This is a "plug-in" class that allows Perldoc to use
75 Pod::Simple::Checker as a "formatter" class (or if that is
76 not available, then Pod::Checker), to check for errors in a given
77 Pod file.
78 .PP
79 This is actually a Pod::Simple::Checker (or Pod::Checker) subclass, and
80 inherits all its options.
81 .SH "SEE ALSO"
82 .IX Header "SEE ALSO"
83 Pod::Simple::Checker, Pod::Simple, Pod::Checker, Pod::Perldoc
84 .SH "COPYRIGHT AND DISCLAIMERS"
85 .IX Header "COPYRIGHT AND DISCLAIMERS"
86 Copyright (c) 2002 Sean M. Burke. All rights reserved.
87 .PP
88 This library is free software; you can redistribute it and/or modify it
89 under the same terms as Perl itself.
90 .PP
91 This program is distributed in the hope that it will be useful, but
92 without any warranty; without even the implied warranty of
93 merchantability or fitness for a particular purpose.
94 .SH AUTHOR
95 .IX Header "AUTHOR"
96 Current maintainer: Mark Allen \f(CW\*(C`<[email protected]>\*(C'\fR
97 .PP
98 Past contributions from:
99 brian d foy \f(CW\*(C`<[email protected]>\*(C'\fR
100 Adriano R. Ferreira \f(CW\*(C`<[email protected]>\*(C'\fR,
101 Sean M. Burke \f(CW\*(C`<[email protected]>\*(C'\fR