Debian Codegraph @

upstream/mageia-cauldron/man3pm/Pod::Simple::JustPod.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::JustPod 3pm"
61 .TH Pod::Simple::JustPod 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::JustPod \-\- just the Pod, the whole Pod, and nothing but the Pod
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 3
71 \& my $infile = "mixed_code_and_pod.pm";
72 \& my $outfile = "just_the_pod.pod";
73 \& open my $fh, ">$outfile" or die "Can\*(Aqt write to $outfile: $!";
74 \&
75 \& my $parser = Pod::Simple::JustPod\->new();
76 \& $parser\->output_fh($fh);
77 \& $parser\->parse_file($infile);
78 \& close $fh or die "Can\*(Aqt close $outfile: $!";
79 .Ve
80 .SH DESCRIPTION
81 .IX Header "DESCRIPTION"
82 This class returns a copy of its input, translated into Perl\*(Aqs internal
83 encoding (UTF\-8), and with all the non\-Pod lines removed.
84 .PP
85 This is a subclass of Pod::Simple::Methody and inherits all its methods.
86 And since, that in turn is a subclass of Pod::Simple, you can use any of
87 its methods. This means you can output to a string instead of a file, or
88 you can parse from an array.
89 .PP
90 This class strives to return the Pod lines of the input completely unchanged,
91 except for any necessary translation into Perl\*(Aqs internal encoding, and it makes
92 no effort to return trailing spaces on lines; these likely will be stripped.
93 If the input pod is well\-formed with no warnings nor errors generated, the
94 extracted pod should generate the same documentation when formatted by a Pod
95 formatter as the original file does.
96 .PP
97 By default, warnings are output to STDERR
98 .SH "SEE ALSO"
99 .IX Header "SEE ALSO"
100 Pod::Simple, Pod::Simple::Methody
101 .SH SUPPORT
102 .IX Header "SUPPORT"
103 Questions or discussion about POD and Pod::Simple should be sent to the
104 <mailto:pod\[email protected]> mail list. Send an empty email to
105 <mailto:pod\-people\[email protected]> to subscribe.
106 .PP
107 This module is managed in an open GitHub repository,
108 <https://github.com/theory/pod\-simple/>. Feel free to fork and contribute, or
109 to clone <https://github.com/theory/pod\-simple.git> and send patches!
110 .PP
111 Patches against Pod::Simple are welcome. Please send bug reports to
112 <mailto:<bug\-pod\[email protected]>.
113 .SH "COPYRIGHT AND DISCLAIMERS"
114 .IX Header "COPYRIGHT AND DISCLAIMERS"
115 Copyright (c) 2002 Sean M. Burke.
116 .PP
117 This library is free software; you can redistribute it and/or modify it
118 under the same terms as Perl itself.
119 .PP
120 This program is distributed in the hope that it will be useful, but
121 without any warranty; without even the implied warranty of
122 merchantability or fitness for a particular purpose.
123 .SH AUTHOR
124 .IX Header "AUTHOR"
125 Pod::Simple was created by Sean M. Burke <[email protected]>.
126 But don\*(Aqt bother him, he\*(Aqs retired.
127 .PP
128 Pod::Simple is maintained by:
129 .IP \(bu 4
130 Allison Randal \f(CW\*(C`[email protected]\*(C'\fR
131 .IP \(bu 4
132 Hans Dieter Pearcey \f(CW\*(C`[email protected]\*(C'\fR
133 .IP \(bu 4
134 David E. Wheeler \f(CW\*(C`[email protected]\*(C'\fR
135 .PP
136 Pod::Simple::JustPod was developed by John SJ Anderson
137 \&\f(CW\*(C`[email protected]\*(C'\fR, with contributions from Karl Williamson
138 \&\f(CW\*(C`[email protected]\*(C'\fR.