.\" Automatically generated by Pod::Man 4.09 (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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Dist::Zilla::Plugin::MetaNoIndex 3pm"
.TH Dist::Zilla::Plugin::MetaNoIndex 3pm "2018-05-07" "perl v5.26.2" "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::MetaNoIndex \- Stop CPAN from indexing stuff
.SH "VERSION"
.IX Header "VERSION"
version 6.012
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
In your \fIdist.ini\fR:
.PP
.Vb 1
\&  [MetaNoIndex]
\&
\&  directory = t/author
\&  directory = examples
\&
\&  file = lib/Foo.pm
\&
\&  package = My::Module
\&
\&  namespace = My::Module
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This plugin allows you to prevent \s-1PAUSE/CPAN\s0 from indexing files you don't
want indexed. This is useful if you build test classes or example classes
that are used for those purposes only, and are not part of the distribution.
It does this by adding a \f(CW\*(C`no_index\*(C'\fR block to your \fI\s-1META\s0.json\fR (or
\&\fI\s-1META\s0.yml\fR) file in your distribution.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.SS "directories"
.IX Subsection "directories"
Exclude folders and everything in them, for example: \fIauthor.t\fR
.PP
Aliases: \f(CW\*(C`folder\*(C'\fR, \f(CW\*(C`dir\*(C'\fR, \f(CW\*(C`directory\*(C'\fR
.SS "files"
.IX Subsection "files"
Exclude a specific file, for example: \fIlib/Foo.pm\fR
.PP
Alias: \f(CW\*(C`file\*(C'\fR
.SS "packages"
.IX Subsection "packages"
Exclude by package name, for example: \f(CW\*(C`My::Package\*(C'\fR
.PP
Aliases: \f(CW\*(C`class\*(C'\fR, \f(CW\*(C`module\*(C'\fR, \f(CW\*(C`package\*(C'\fR
.SS "namespaces"
.IX Subsection "namespaces"
Exclude everything under a specific namespace, for example: \f(CW\*(C`My::Package\*(C'\fR
.PP
Alias: \f(CW\*(C`namespace\*(C'\fR
.PP
\&\fB\s-1NOTE:\s0\fR This will not exclude the package \f(CW\*(C`My::Package\*(C'\fR, only everything
under it like \f(CW\*(C`My::Package::Foo\*(C'\fR.
.SH "METHODS"
.IX Header "METHODS"
.SS "metadata"
.IX Subsection "metadata"
Returns a reference to a hash containing the distribution's no_index metadata.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Dist::Zilla roles: MetaProvider.
.SH "AUTHOR"
.IX Header "AUTHOR"
Ricardo \s-1SIGNES\s0 😏 <rjbs@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2018 by Ricardo \s-1SIGNES.\s0
.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.