.\" -*- 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 "Dist::Zilla::Plugin::GatherDir::Template 3pm"
.TH Dist::Zilla::Plugin::GatherDir::Template 3pm 2024-05-26 "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
Dist::Zilla::Plugin::GatherDir::Template \- gather all the files in a directory and use them as templates
.SH VERSION
.IX Header "VERSION"
version 6.032
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This is a subclass of the GatherDir
plugin.  It works just like its parent class, except that each
gathered file is processed through Text::Template.
.PP
The variables \f(CW$plugin\fR and \f(CW$dist\fR will be provided to the
template, set to the GatherDir::Template plugin and the Dist::Zilla
object, respectively.
.PP
It is meant to be used when minting dists with \f(CW\*(C`dzil new\*(C'\fR, but could be used
in building existing dists, too.
.SH "PERL VERSION"
.IX Header "PERL VERSION"
This module should work on any version of perl still receiving updates from
the Perl 5 Porters.  This means it should work on any version of perl
released in the last two to three years.  (That is, if the most recently
released version is v5.40, then this module should work on both v5.40 and
v5.38.)
.PP
Although it may work on older versions of perl, no guarantee is made that the
minimum required version will not be increased.  The version may be increased
for any reason, and there is no promise that patches will be accepted to
lower the minimum required perl.
.SH ATTRIBUTES
.IX Header "ATTRIBUTES"
.SS rename
.IX Subsection "rename"
Use this to rename files while they are being gathered.  This is a list of
key/value pairs, specified thus:
.PP
.Vb 3
\&    [GatherDir::Template]
\&    rename.DISTNAME = $dist\->name =~ s/...//r
\&    rename.DISTVER  = $dist\->version
.Ve
.PP
This example will replace the tokens \f(CW\*(C`DISTNAME\*(C'\fR and \f(CW\*(C`DISTVER\*(C'\fR with the
expressions they are associated with. These expressions will be treated as
though they were miniature Text::Template sections, and hence will receive the
same variables that the file itself receives, i.e. \f(CW$dist\fR and \f(CW$plugin\fR.
.SH AUTHOR
.IX Header "AUTHOR"
Ricardo SIGNES 😏 <cpan@semiotic.systems>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2024 by Ricardo SIGNES.
.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.