summaryrefslogtreecommitdiffstats
path: root/upstream/debian-unstable/man3/Pod::Simple::JustPod.3perl
diff options
context:
space:
mode:
Diffstat (limited to 'upstream/debian-unstable/man3/Pod::Simple::JustPod.3perl')
-rw-r--r--upstream/debian-unstable/man3/Pod::Simple::JustPod.3perl135
1 files changed, 135 insertions, 0 deletions
diff --git a/upstream/debian-unstable/man3/Pod::Simple::JustPod.3perl b/upstream/debian-unstable/man3/Pod::Simple::JustPod.3perl
new file mode 100644
index 00000000..f815283e
--- /dev/null
+++ b/upstream/debian-unstable/man3/Pod::Simple::JustPod.3perl
@@ -0,0 +1,135 @@
+.\" -*- mode: troff; coding: utf-8 -*-
+.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
+.ie n \{\
+. ds C` ""
+. ds C' ""
+'br\}
+.el\{\
+. ds C`
+. ds C'
+'br\}
+.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\"
+.\" If the F register is >0, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.\"
+.\" Avoid warning from groff about undefined register 'F'.
+.de IX
+..
+.nr rF 0
+.if \n(.g .if rF .nr rF 1
+.if (\n(rF:(\n(.g==0)) \{\
+. if \nF \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. if !\nF==2 \{\
+. nr % 0
+. nr F 2
+. \}
+. \}
+.\}
+.rr rF
+.\" ========================================================================
+.\"
+.IX Title "Pod::Simple::JustPod 3perl"
+.TH Pod::Simple::JustPod 3perl 2024-01-12 "perl v5.38.2" "Perl Programmers Reference Guide"
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
+.SH NAME
+Pod::Simple::JustPod \-\- just the Pod, the whole Pod, and nothing but the Pod
+.SH SYNOPSIS
+.IX Header "SYNOPSIS"
+.Vb 3
+\& my $infile = "mixed_code_and_pod.pm";
+\& my $outfile = "just_the_pod.pod";
+\& open my $fh, ">$outfile" or die "Can\*(Aqt write to $outfile: $!";
+\&
+\& my $parser = Pod::Simple::JustPod\->new();
+\& $parser\->output_fh($fh);
+\& $parser\->parse_file($infile);
+\& close $fh or die "Can\*(Aqt close $outfile: $!";
+.Ve
+.SH DESCRIPTION
+.IX Header "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.
+.PP
+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.
+.PP
+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.
+.PP
+By default, warnings are output to STDERR
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+Pod::Simple, Pod::Simple::Methody
+.SH SUPPORT
+.IX Header "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.
+.PP
+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!
+.PP
+Patches against Pod::Simple are welcome. Please send bug reports to
+<mailto:<bug\-pod\-simple@rt.cpan.org>.
+.SH "COPYRIGHT AND DISCLAIMERS"
+.IX Header "COPYRIGHT AND DISCLAIMERS"
+Copyright (c) 2002 Sean M. Burke.
+.PP
+This library is free software; you can redistribute it and/or modify it
+under the same terms as Perl itself.
+.PP
+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.
+.SH AUTHOR
+.IX Header "AUTHOR"
+Pod::Simple was created by Sean M. Burke <sburke@cpan.org>.
+But don't bother him, he's retired.
+.PP
+Pod::Simple is maintained by:
+.IP \(bu 4
+Allison Randal \f(CW\*(C`allison@perl.org\*(C'\fR
+.IP \(bu 4
+Hans Dieter Pearcey \f(CW\*(C`hdp@cpan.org\*(C'\fR
+.IP \(bu 4
+David E. Wheeler \f(CW\*(C`dwheeler@cpan.org\*(C'\fR
+.PP
+Pod::Simple::JustPod was developed by John SJ Anderson
+\&\f(CW\*(C`genehack@genehack.org\*(C'\fR, with contributions from Karl Williamson
+\&\f(CW\*(C`khw@cpan.org\*(C'\fR.