1Pod::Simple::JustPod(3)User Contributed Perl DocumentatioPnod::Simple::JustPod(3)
2
3
4

NAME

6       Pod::Simple::JustPod -- just the Pod, the whole Pod, and nothing but
7       the Pod
8

SYNOPSIS

10        my $infile  = "mixed_code_and_pod.pm";
11        my $outfile = "just_the_pod.pod";
12        open my $fh, ">$outfile" or die "Can't write to $outfile: $!";
13
14        my $parser = Pod::Simple::JustPod->new();
15        $parser->output_fh($fh);
16        $parser->parse_file($infile);
17        close $fh or die "Can't close $outfile: $!";
18

DESCRIPTION

20       This class returns a copy of its input, translated into Perl's internal
21       encoding (UTF-8), and with all the non-Pod lines removed.
22
23       This is a subclass of Pod::Simple::Methody and inherits all its
24       methods.  And since, that in turn is a subclass of Pod::Simple, you can
25       use any of its methods.  This means you can output to a string instead
26       of a file, or you can parse from an array.
27
28       This class strives to return the Pod lines of the input completely
29       unchanged, except for any necessary translation into Perl's internal
30       encoding, and it makes no effort to return trailing spaces on lines;
31       these likely will be stripped.  If the input pod is well-formed with no
32       warnings nor errors generated, the extracted pod should generate the
33       same documentation when formatted by a Pod formatter as the original
34       file does.
35
36       By default, warnings are output to STDERR
37

SEE ALSO

39       Pod::Simple, Pod::Simple::Methody
40

SUPPORT

42       Questions or discussion about POD and Pod::Simple should be sent to the
43       <mailto:pod-people@perl.org> mail list. Send an empty email to
44       <mailto:pod-people-subscribe@perl.org> to subscribe.
45
46       This module is managed in an open GitHub repository,
47       <https://github.com/theory/pod-simple/>. Feel free to fork and
48       contribute, or to clone <git://github.com/theory/pod-simple.git> and
49       send patches!
50
51       Patches against Pod::Simple are welcome. Please send bug reports to
52       <mailto:<bug-pod-simple@rt.cpan.org>.
53

55       Copyright (c) 2002 Sean M. Burke.
56
57       This library is free software; you can redistribute it and/or modify it
58       under the same terms as Perl itself.
59
60       This program is distributed in the hope that it will be useful, but
61       without any warranty; without even the implied warranty of
62       merchantability or fitness for a particular purpose.
63

AUTHOR

65       Pod::Simple was created by Sean M. Burke <sburke@cpan.org>.  But don't
66       bother him, he's retired.
67
68       Pod::Simple is maintained by:
69
70       •   Allison Randal "allison@perl.org"
71
72       •   Hans Dieter Pearcey "hdp@cpan.org"
73
74       •   David E. Wheeler "dwheeler@cpan.org"
75
76       Pod::Simple::JustPod was developed by John SJ Anderson
77       "genehack@genehack.org", with contributions from Karl Williamson
78       "khw@cpan.org".
79
80
81
82perl v5.32.1                      2021-01-27           Pod::Simple::JustPod(3)
Impressum