.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 "Dist::Zilla::Plugin::MetaProvides::Package 3pm"
.TH Dist::Zilla::Plugin::MetaProvides::Package 3pm "2020-04-12" "perl v5.30.0" "User Contributed Perl Documentation"
.\" 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"
Dist::Zilla::Plugin::MetaProvides::Package \- Extract namespaces/version from traditional packages for provides
.SH "VERSION"
.IX Header "VERSION"
version 2.004003
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
In your \f(CW\*(C`dist.ini\*(C'\fR:
.PP
.Vb 1
\&    [MetaProvides::Package]
\&
\&    ; This is the (optional) default: This forces any package versions
\&    ; added in the "provides" metadata to use the \*(Aqversion\*(Aq
\&    ; specified by dzil.
\&    ;
\&    ; Set it to 0 to force packages own versions to be respected. ( You probably don\*(Aqt want this )
\&    inherit_version = 1
\&
\&    ; This is also the (optional) default: This forces any package without
\&    ; a version declaration to use the \*(Aqversion\*(Aq specified by default.
\&    ;
\&    ; Set it to 0 to allow packages to have no versions
\&    inherit_missing = 1
\&
\&    ; This is the (optional) default: This being true discovers any [MetaNoIndex]
\&    ; plugins to also further exclude packages from the provides map.
\&    ;
\&    ; Set it to 0 if for some weird reason you don\*(Aqt want this.
\&    meta_noindex    = 1
\&
\&    ; This is the (optional) default: Packages named _Foo::Bar or Foo::_Bar are not indexed.
\&    ; Set this to 1 to enable indexing of similarly named packages.
\&    include_underscores = 0
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a \f(CW\*(C`Dist::Zilla\*(C'\fR Plugin that populates the \f(CW\*(C`provides\*(C'\fR
property of \f(CW\*(C`META.json\*(C'\fR and \f(CW\*(C`META.yml\*(C'\fR by absorbing it from your shipped modules,
in a manner similar to how \f(CW\*(C`PAUSE\*(C'\fR itself does it.
.PP
This allows you to easily create an authoritative index of what module provides what
version in advance of \f(CW\*(C`PAUSE\*(C'\fR indexing it, which \f(CW\*(C`PAUSE\*(C'\fR in turn will take verbatim.
.SH "CONSUMED ROLES"
.IX Header "CONSUMED ROLES"
.SS "Dist::Zilla::Role::MetaProvider::Provider"
.IX Subsection "Dist::Zilla::Role::MetaProvider::Provider"
.SH "ROLE SATISFYING METHODS"
.IX Header "ROLE SATISFYING METHODS"
.ie n .SS """provides"""
.el .SS "\f(CWprovides\fP"
.IX Subsection "provides"
A conformant function to the Dist::Zilla::Role::MetaProvider::Provider Role.
.PP
\fIsignature: \f(CI$plugin\fI\->\f(BIprovides()\fI\fR
.IX Subsection "signature: $plugin->provides()"
.PP
\fIreturns: Array of Dist::Zilla::MetaProvides::ProvideRecord\fR
.IX Subsection "returns: Array of Dist::Zilla::MetaProvides::ProvideRecord"
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.ie n .SS """include_underscores"""
.el .SS "\f(CWinclude_underscores\fP"
.IX Subsection "include_underscores"
This attribute controls automatic skipping of packages.
.PP
By default, \f(CW\*(C`MetaProvides::Package\*(C'\fR skips packages matching the following regular expression:
.PP
.Vb 1
\&  qr/(\eA|::)_/
.Ve
.PP
Setting this attribute to a \f(CW\*(C`true\*(C'\fR value will avoid skipping these packages.
.PP
This feature was added in \f(CW\*(C`2.004001\-TRIAL\*(C'\fR
.ie n .SS """finder"""
.el .SS "\f(CWfinder\fP"
.IX Subsection "finder"
This attribute, if specified will
.IP "\(bu" 4
Override the \f(CW\*(C`FileFinder\*(C'\fR used to find files containing packages
.IP "\(bu" 4
Inhibit autovivification of the \f(CW\*(C`.pm\*(C'\fR file finder
.PP
This parameter may be specified multiple times to aggregate a list of finders
.SH "OPTIONS INHERITED FROM Dist::Zilla::Role::MetaProvider::Provider"
.IX Header "OPTIONS INHERITED FROM Dist::Zilla::Role::MetaProvider::Provider"
.ie n .SS """inherit_version"""
.el .SS "\f(CWinherit_version\fP"
.IX Subsection "inherit_version"
How do you want existing versions ( Versions hard-coded into files before running this plug-in )to be processed?
.IP "\(bu" 4
\&\s-1DEFAULT:\s0 inherit_version = 1
.Sp
Ignore anything you find in a file, and just probe \f(CW\*(C`DZIL\->version()\*(C'\fR for a value. This is a sane default and most will want this.
.IP "\(bu" 4
inherit_version = 0
.Sp
Use this option if you actually want to use hard-coded values in your files and use the versions parsed out of them.
.ie n .SS """inherit_missing"""
.el .SS "\f(CWinherit_missing\fP"
.IX Subsection "inherit_missing"
In the event you are using the aforementioned \f(CW\*(C`"inherit_version" = 0\*(C'\fR, this determines how to behave when encountering a
module with no version defined.
.IP "\(bu" 4
\&\s-1DEFAULT:\s0 inherit_missing = 1
.Sp
When a module has no version, probe \f(CW\*(C`DZIL\->version()\*(C'\fR for an answer. This is what you want if you want to have some
files with fixed versions, and others to just automatically be maintained by Dist::Zilla.
.IP "\(bu" 4
inherit_missing = 0
.Sp
When a module has no version, emit a versionless record in the final metadata.
.ie n .SS """meta_noindex"""
.el .SS "\f(CWmeta_noindex\fP"
.IX Subsection "meta_noindex"
This is a utility for people who are also using \f(CW\*(C`MetaNoIndex\*(C'\fR,
so that its settings can be used to eliminate items from the 'provides' list.
.IP "\(bu" 4
meta_noindex = 0
.Sp
With this set, any \f(CW\*(C`MetaNoIndex\*(C'\fR plugins are ignored.
.IP "\(bu" 4
\&\s-1DEFAULT:\s0 meta_noindex = 1
.Sp
When a module meets the criteria provided to \f(CW\*(C`MetaNoIndex\*(C'\fR,
eliminate it from the metadata shipped to Dist::Zilla.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\(bu" 4
Dist::Zilla::Plugin::MetaProvides
.SH "AUTHOR"
.IX Header "AUTHOR"
Kent Fredric <kentnl@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2017 by Kent Fredric <kentfredric@gmail.com>.
.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.