Pod::Simple::JustPod - just the Pod, the whole Pod, and nothing but the Pod
my $infile = "mixed_code_and_pod.pm"; my $outfile = "just_the_pod.pod"; open my $fh, ">$outfile" or die "Can't write to $outfile: $!"; my $parser = Pod::Simple::JustPod->new(); $parser->output_fh($fh); $parser->parse_file($infile); close $fh or die "Can't close $outfile: $!";
Perl Programmers Reference Guide Pod::Simple::JustPod(3)
NAME
Pod::Simple::JustPod -- just the Pod, the whole Pod, and nothing but
the Pod
SYNOPSIS
my $infile = "mixed_code_and_pod.pm";
my $outfile = "just_the_pod.pod";
open my $fh, ">$outfile" or die "Can't write to $outfile: $!";
my $parser = Pod::Simple::JustPod->new();
$parser->output_fh($fh);
$parser->parse_file($infile);
close $fh or die "Can't close $outfile: $!";
DESCRIPTION
This class returns a copy of its input, translated into Perl's internal
encoding (UTF-8), and with all the non-Pod lines removed.
This is a subclass of Pod::Simple::Methody and inherits all its
methods. And since, that in turn is a subclass of Pod::Simple, you can
use any of its methods. This means you can output to a string instead
of a file, or you can parse from an array.
This class strives to return the Pod lines of the input completely
unchanged, except for any necessary translation into Perl's internal
encoding, and it makes no effort to return trailing spaces on lines;
these likely will be stripped. If the input pod is well-formed with no
warnings nor errors generated, the extracted pod should generate the
same documentation when formatted by a Pod formatter as the original
file does.
By default, warnings are output to STDERR
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+-----------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+-----------------------+
|Availability | runtime/perl-532 |
+---------------+-----------------------+
|Stability | Pass-through volatile |
+---------------+-----------------------+
SEE ALSO
Pod::Simple, Pod::Simple::Methody
SUPPORT
Questions or discussion about POD and Pod::Simple should be sent to the
<mailto:pod-people@perl.org> mail list. Send an empty email to
<mailto:pod-people-subscribe@perl.org> to subscribe.
This module is managed in an open GitHub repository,
<https://github.com/theory/pod-simple/>. Feel free to fork and
contribute, or to clone <git://github.com/theory/pod-simple.git> and
send patches!
Patches against Pod::Simple are welcome. Please send bug reports to
<mailto:<bug-pod-simple@rt.cpan.org>.
COPYRIGHT AND DISCLAIMERS
Copyright (c) 2002 Sean M. Burke.
This library is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
This program is distributed in the hope that it will be useful, but
without any warranty; without even the implied warranty of
merchantability or fitness for a particular purpose.
AUTHOR
Pod::Simple was created by Sean M. Burke <sburke@cpan.org>. But don't
bother him, he's retired.
Pod::Simple is maintained by:
o Allison Randal "allison@perl.org"
o Hans Dieter Pearcey "hdp@cpan.org"
o David E. Wheeler "dwheeler@cpan.org"
Pod::Simple::JustPod was developed by John SJ Anderson
"genehack@genehack.org", with contributions from Karl Williamson
"khw@cpan.org".
NOTES
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from
http://www.cpan.org/src/5.0/perl-5.32.0.tar.gz.
Further information about this software can be found on the open source
community website at https://www.perl.org/.
perl v5.32.0 2020-06-14 Pod::Simple::JustPod(3)