.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "CPAN::Meta::Feature 3pm"
.TH CPAN::Meta::Feature 3pm 2023-11-28 "perl v5.38.2" "Perl Programmers Reference Guide"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
CPAN::Meta::Feature \- an optional feature provided by a CPAN distribution
.SH VERSION
.IX Header "VERSION"
version 2.150010
.SH DESCRIPTION
.IX Header "DESCRIPTION"
A CPAN::Meta::Feature object describes an optional feature offered by a CPAN
distribution and specified in the distribution's \fIMETA.json\fR (or \fIMETA.yml\fR)
file.
.PP
For the most part, this class will only be used when operating on the result of
the \f(CW\*(C`feature\*(C'\fR or \f(CW\*(C`features\*(C'\fR methods on a CPAN::Meta object.
.SH METHODS
.IX Header "METHODS"
.SS new
.IX Subsection "new"
.Vb 1
\&  my $feature = CPAN::Meta::Feature\->new( $identifier => \e%spec );
.Ve
.PP
This returns a new Feature object.  The \f(CW%spec\fR argument to the constructor
should be the same as the value of the \f(CW\*(C`optional_feature\*(C'\fR entry in the
distmeta.  It must contain entries for \f(CW\*(C`description\*(C'\fR and \f(CW\*(C`prereqs\*(C'\fR.
.SS identifier
.IX Subsection "identifier"
This method returns the feature's identifier.
.SS description
.IX Subsection "description"
This method returns the feature's long description.
.SS prereqs
.IX Subsection "prereqs"
This method returns the feature's prerequisites as a CPAN::Meta::Prereqs
object.
.SH BUGS
.IX Header "BUGS"
Please report any bugs or feature using the CPAN Request Tracker.
Bugs can be submitted through the web interface at
<http://rt.cpan.org/Dist/Display.html?Queue=CPAN\-Meta>
.PP
When submitting a bug or request, please include a test-file or a patch to an
existing test-file that illustrates the bug or desired feature.
.SH AUTHORS
.IX Header "AUTHORS"
.IP \(bu 4
David Golden <dagolden@cpan.org>
.IP \(bu 4
Ricardo Signes <rjbs@cpan.org>
.IP \(bu 4
Adam Kennedy <adamk@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2010 by David Golden, Ricardo Signes, Adam Kennedy and Contributors.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.