.\" -*- 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 "Module::Manifest::Skip 3pm"
.TH Module::Manifest::Skip 3pm 2024-03-07 "perl v5.38.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
Module::Manifest::Skip \- MANIFEST.SKIP Manangement for Modules
.SH SYNOPSIS
.IX Header "SYNOPSIS"
From the command line:
.PP
.Vb 1
\&    > perl \-MModule::Manifest::Skip=create
.Ve
.PP
From Perl:
.PP
.Vb 2
\&    use Module::Manifest::Skip;
\&    use IO::All;
\&
\&    my $mms = Module::Manifest::Skip\->new;
\&    # optional add and removes:
\&    $mms\->add(\*(Aq^foo\-bar$\*(Aq);
\&    $mms\->remove(\*(Aq^foo$\*(Aq);
\&    $mms\->remove(qr/\eQ\ebfoo\eb/);
\&    io(\*(AqMANIFEST.SKIP\*(Aq)\->print($mms\->text);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBNOTE:\fR This module is mostly intended for module packaging frameworks to
share a common, up-to-date \f(CW\*(C`MANIFEST.SKIP\*(C'\fR base. For example,
Module::Install::ManifestSkip, uses this module to get the actual SKIP
content. However this module may be useful for any module author.
.PP
CPAN module authors use a \f(CW\*(C`MANIFEST.SKIP\*(C'\fR file to exclude certain well known
files from getting put into a generated \f(CW\*(C`MANIFEST\*(C'\fR file, which would cause
them to go into the final distribution package.
.PP
The packaging tools try to automatically skip things for you, but if you
add one of your own entries, you have to add all the common ones yourself.
This module attempts to make all of this boring process as simple and
reliable as possible.
.PP
Module::Manifest::Skip can create or update a MANIFEST.SKIP file for you. You
can add your own entries, and it will leave them alone. You can even tell it
to \fBnot\fR skip certain entries that it normally skips, although this is
rarely needed.
.SH USAGE
.IX Header "USAGE"
Usually this module is called by other packaging modules. If you want this to
be used by Module::Install, then you would put this:
.PP
.Vb 1
\&    manifest_skip \*(Aqclean\*(Aq;
.Ve
.PP
in your \f(CW\*(C`Makefile.PL\*(C'\fR, and everything would be taken care of for you.
.PP
If you want to simply create a \f(CW\*(C`MANIFEST.SKIP\*(C'\fR file from the command line,
this handy syntax exists:
.PP
.Vb 1
\&    > perl \-MModule::Manifest::Skip=create
.Ve
.SH BEHAVIOR
.IX Header "BEHAVIOR"
This module ships with a share file called \f(CW\*(C`share/MANIFEST.SKIP\*(C'\fR. This is the
basis for all new MANIFEST.SKIP files. This module will look for an already
existing \f(CW\*(C`MANIFEST.SKIP\*(C'\fR file and take all the text before the first blank
line, and prepend it to the start of a new SKIP file. This allows you to put
your own personal section at the top, that will not be overwritten later.
.PP
It will then look for lines beginning with a dash followed by a space.
Like this:
.PP
.Vb 3
\&      \- \ebfoo\eb
\&      \- ^bar/
\&      \- ^baz$
.Ve
.PP
It will comment out each of these lines and any other lines that match the
text (after the '\- '). This allows you to override the default SKIPs.
.SH AUTHOR
.IX Header "AUTHOR"
Ingy döt Net <ingy@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2011\-2014. Ingy döt Net.
.PP
This program is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.
.PP
See <http://www.perl.com/perl/misc/Artistic.html>