Debian Codegraph @

upstream/mageia-cauldron/man3pm/Pod::Simple::DumpAsText.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::DumpAsText 3pm"
61 .TH Pod::Simple::DumpAsText 3pm 2023-12-22 "perl v5.42.0" "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::DumpAsText \-\- dump Pod\-parsing events as text
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 3
71 \& perl \-MPod::Simple::DumpAsText \-e \e
72 \& "exit Pod::Simple::DumpAsText\->filter(shift)\->any_errata_seen" \e
73 \& thingy.pod
74 .Ve
75 .SH DESCRIPTION
76 .IX Header "DESCRIPTION"
77 This class is for dumping, as text, the events gotten from parsing a Pod
78 document. This class is of interest to people writing Pod formatters
79 based on Pod::Simple. It is useful for seeing exactly what events you
80 get out of some Pod that you feed in.
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::DumpAsXML
86 .PP
87 Pod::Simple
88 .SH SUPPORT
89 .IX Header "SUPPORT"
90 Questions or discussion about POD and Pod::Simple should be sent to the
91 pod\[email protected] mail list. Send an empty email to
92 pod\-people\[email protected] to subscribe.
93 .PP
94 This module is managed in an open GitHub repository,
95 <https://github.com/perl\-pod/pod\-simple/>. Feel free to fork and contribute, or
96 to clone <https://github.com/perl\-pod/pod\-simple.git> and send patches!
97 .PP
98 Patches against Pod::Simple are welcome. Please send bug reports to
99 <bug\-pod\[email protected]>.
100 .SH "COPYRIGHT AND DISCLAIMERS"
101 .IX Header "COPYRIGHT AND DISCLAIMERS"
102 Copyright (c) 2002 Sean M. Burke.
103 .PP
104 This library is free software; you can redistribute it and/or modify it
105 under the same terms as Perl itself.
106 .PP
107 This program is distributed in the hope that it will be useful, but
108 without any warranty; without even the implied warranty of
109 merchantability or fitness for a particular purpose.
110 .SH AUTHOR
111 .IX Header "AUTHOR"
112 Pod::Simple was created by Sean M. Burke <[email protected]>.
113 But don\*(Aqt bother him, he\*(Aqs retired.
114 .PP
115 Pod::Simple is maintained by:
116 .IP \(bu 4
117 Allison Randal \f(CW\*(C`[email protected]\*(C'\fR
118 .IP \(bu 4
119 Hans Dieter Pearcey \f(CW\*(C`[email protected]\*(C'\fR
120 .IP \(bu 4
121 David E. Wheeler \f(CW\*(C`[email protected]\*(C'\fR