Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Pod::Perldoc::ToPod.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::Perldoc::ToPod 3pm"
61 .TH Pod::Perldoc::ToPod 3pm 2026-03-09 "perl v5.42.1" "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::Perldoc::ToPod \- let Perldoc render Pod as ... Pod!
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 1
71 \& perldoc \-opod Some::Modulename
72 .Ve
73 .PP
74 (That\*(Aqs currently the same as the following:)
75 .PP
76 .Vb 1
77 \& perldoc \-u Some::Modulename
78 .Ve
79 .SH DESCRIPTION
80 .IX Header "DESCRIPTION"
81 This is a "plug\-in" class that allows Perldoc to display Pod source as
82 itself! Pretty Zen, huh?
83 .PP
84 Currently this class works by just filtering out the non\-Pod stuff from
85 a given input file.
86 .SH "SEE ALSO"
87 .IX Header "SEE ALSO"
88 Pod::Perldoc
89 .SH "COPYRIGHT AND DISCLAIMERS"
90 .IX Header "COPYRIGHT AND DISCLAIMERS"
91 Copyright (c) 2002 Sean M. Burke. All rights reserved.
92 .PP
93 This library is free software; you can redistribute it and/or modify it
94 under the same terms as Perl itself.
95 .PP
96 This program is distributed in the hope that it will be useful, but
97 without any warranty; without even the implied warranty of
98 merchantability or fitness for a particular purpose.
99 .SH AUTHOR
100 .IX Header "AUTHOR"
101 Current maintainer: Mark Allen \f(CW\*(C`<mallencpan.org>\*(C'\fR
102 .PP
103 Past contributions from:
104 brian d foy \f(CW\*(C`<[email protected]>\*(C'\fR
105 Adriano R. Ferreira \f(CW\*(C`<[email protected]>\*(C'\fR,
106 Sean M. Burke \f(CW\*(C`<[email protected]>\*(C'\fR