Debian Codegraph @

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