Debian Codegraph @

upstream/debian-unstable/man3/CPAN::Plugin.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 "CPAN::Plugin 3perl"
58 .TH CPAN::Plugin 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 CPAN::Plugin \- Base class for CPAN shell extensions
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 2
68 \& package CPAN::Plugin::Flurb;
69 \& use parent \*(AqCPAN::Plugin\*(Aq;
70 \&
71 \& sub post_test {
72 \& my ($self, $distribution_object) = @_;
73 \& $self = $self\->new (distribution_object => $distribution_object);
74 \& ...;
75 \& }
76 .Ve
77 .SH DESCRIPTION
78 .IX Header "DESCRIPTION"
79 .SS "Alpha Status"
80 .IX Subsection "Alpha Status"
81 The plugin system in the CPAN shell was introduced in version 2.07 and
82 is still considered experimental.
83 .SS "How Plugins work?"
84 .IX Subsection "How Plugins work?"
85 See "Plugin support" in CPAN.
86 .SH METHODS
87 .IX Header "METHODS"
88 .SS plugin_requires
89 .IX Subsection "plugin_requires"
90 returns list of packages given plugin requires for functionality.
91 This list is evaluated using \f(CW\*(C`CPAN\->use_inst\*(C'\fR method.
92 .SS distribution_object
93 .IX Subsection "distribution_object"
94 Get current distribution object.
95 .SS distribution
96 .IX Subsection "distribution"
97 .SS distribution_info
98 .IX Subsection "distribution_info"
99 .SS build_dir
100 .IX Subsection "build_dir"
101 Simple delegatees for misc parameters derived from distribution
102 .SS is_xs
103 .IX Subsection "is_xs"
104 Predicate to detect whether package contains XS.
105 .SH AUTHOR
106 .IX Header "AUTHOR"
107 Branislav Zahradnik <[email protected]>