Debian Codegraph @

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