Debian Codegraph @

upstream/opensuse-tumbleweed/man3/CPAN::Meta::Feature.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::Meta::Feature 3pm"
61 .TH CPAN::Meta::Feature 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 CPAN::Meta::Feature \- an optional feature provided by a CPAN distribution
68 .SH VERSION
69 .IX Header "VERSION"
70 version 2.150010
71 .SH DESCRIPTION
72 .IX Header "DESCRIPTION"
73 A CPAN::Meta::Feature object describes an optional feature offered by a CPAN
74 distribution and specified in the distribution\*(Aqs \fIMETA.json\fR (or \fIMETA.yml\fR)
75 file.
76 .PP
77 For the most part, this class will only be used when operating on the result of
78 the \f(CW\*(C`feature\*(C'\fR or \f(CW\*(C`features\*(C'\fR methods on a CPAN::Meta object.
79 .SH METHODS
80 .IX Header "METHODS"
81 .SS new
82 .IX Subsection "new"
83 .Vb 1
84 \& my $feature = CPAN::Meta::Feature\->new( $identifier => \e%spec );
85 .Ve
86 .PP
87 This returns a new Feature object. The \f(CW%spec\fR argument to the constructor
88 should be the same as the value of the \f(CW\*(C`optional_feature\*(C'\fR entry in the
89 distmeta. It must contain entries for \f(CW\*(C`description\*(C'\fR and \f(CW\*(C`prereqs\*(C'\fR.
90 .SS identifier
91 .IX Subsection "identifier"
92 This method returns the feature\*(Aqs identifier.
93 .SS description
94 .IX Subsection "description"
95 This method returns the feature\*(Aqs long description.
96 .SS prereqs
97 .IX Subsection "prereqs"
98 This method returns the feature\*(Aqs prerequisites as a CPAN::Meta::Prereqs
99 object.
100 .SH BUGS
101 .IX Header "BUGS"
102 Please report any bugs or feature using the CPAN Request Tracker.
103 Bugs can be submitted through the web interface at
104 <http://rt.cpan.org/Dist/Display.html?Queue=CPAN\-Meta>
105 .PP
106 When submitting a bug or request, please include a test\-file or a patch to an
107 existing test\-file that illustrates the bug or desired feature.
108 .SH AUTHORS
109 .IX Header "AUTHORS"
110 .IP \(bu 4
111 David Golden <[email protected]>
112 .IP \(bu 4
113 Ricardo Signes <[email protected]>
114 .IP \(bu 4
115 Adam Kennedy <[email protected]>
116 .SH "COPYRIGHT AND LICENSE"
117 .IX Header "COPYRIGHT AND LICENSE"
118 This software is copyright (c) 2010 by David Golden, Ricardo Signes, Adam Kennedy and Contributors.
119 .PP
120 This is free software; you can redistribute it and/or modify it under
121 the same terms as the Perl 5 programming language system itself.