Debian Codegraph @

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