Debian Codegraph @

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