Debian Codegraph @

upstream/debian-unstable/man3/Pod::Simple::DumpAsXML.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::DumpAsXML 3perl"
58 .TH Pod::Simple::DumpAsXML 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::DumpAsXML \-\- turn Pod into XML
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 3
68 \& perl \-MPod::Simple::DumpAsXML \-e \e
69 \& "exit Pod::Simple::DumpAsXML\->filter(shift)\->any_errata_seen" \e
70 \& thingy.pod
71 .Ve
72 .SH DESCRIPTION
73 .IX Header "DESCRIPTION"
74 Pod::Simple::DumpAsXML is a subclass of Pod::Simple that parses Pod
75 and turns it into indented and wrapped XML. This class is of
76 interest to people writing Pod formatters based on Pod::Simple.
77 .PP
78 Pod::Simple::DumpAsXML inherits methods from
79 Pod::Simple.
80 .SH "SEE ALSO"
81 .IX Header "SEE ALSO"
82 Pod::Simple::XMLOutStream is rather like this class.
83 Pod::Simple::XMLOutStream's output is space-padded in a way
84 that's better for sending to an XML processor (that is, it has
85 no ignorable whitespace). But
86 Pod::Simple::DumpAsXML's output is much more human-readable, being
87 (more-or-less) one token per line, with line-wrapping.
88 .PP
89 Pod::Simple::DumpAsText is rather like this class,
90 except that it doesn't dump with XML syntax. Try them and see
91 which one you like best!
92 .PP
93 Pod::Simple, Pod::Simple::DumpAsXML
94 .PP
95 The older libraries Pod::PXML, Pod::XML, Pod::SAX
96 .SH SUPPORT
97 .IX Header "SUPPORT"
98 Questions or discussion about POD and Pod::Simple should be sent to the
99 pod\[email protected] mail list. Send an empty email to
100 pod\-people\[email protected] to subscribe.
101 .PP
102 This module is managed in an open GitHub repository,
103 <https://github.com/perl\-pod/pod\-simple/>. Feel free to fork and contribute, or
104 to clone <https://github.com/perl\-pod/pod\-simple.git> and send patches!
105 .PP
106 Patches against Pod::Simple are welcome. Please send bug reports to
107 <bug\-pod\[email protected]>.
108 .SH "COPYRIGHT AND DISCLAIMERS"
109 .IX Header "COPYRIGHT AND DISCLAIMERS"
110 Copyright (c) 2002 Sean M. Burke.
111 .PP
112 This library is free software; you can redistribute it and/or modify it
113 under the same terms as Perl itself.
114 .PP
115 This program is distributed in the hope that it will be useful, but
116 without any warranty; without even the implied warranty of
117 merchantability or fitness for a particular purpose.
118 .SH AUTHOR
119 .IX Header "AUTHOR"
120 Pod::Simple was created by Sean M. Burke <[email protected]>.
121 But don't bother him, he's retired.
122 .PP
123 Pod::Simple is maintained by:
124 .IP \(bu 4
125 Allison Randal \f(CW\*(C`[email protected]\*(C'\fR
126 .IP \(bu 4
127 Hans Dieter Pearcey \f(CW\*(C`[email protected]\*(C'\fR
128 .IP \(bu 4
129 David E. Wheeler \f(CW\*(C`[email protected]\*(C'\fR