Debian Codegraph @

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