.\" 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 3pm"
.TH Dist::Zilla 3pm "2020-11-04" "perl v5.30.3" "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 \- distribution builder; installer not included!
.SH "VERSION"
.IX Header "VERSION"
version 6.017
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Dist::Zilla builds distributions of code to be uploaded to the \s-1CPAN.\s0 In this
respect, it is like ExtUtils::MakeMaker, Module::Build, or
Module::Install. Unlike those tools, however, it is not also a system for
installing code that has been downloaded from the \s-1CPAN.\s0 Since it's only run by
authors, and is meant to be run on a repository checkout rather than on
published, released code, it can do much more than those tools, and is free to
make much more ludicrous demands in terms of prerequisites.
.PP
If you have access to the web, you can learn more and find an interactive
tutorial at \fBdzil.org \fR. If not, try
Dist::Zilla::Tutorial.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
.SS "name"
.IX Subsection "name"
The name attribute (which is required) gives the name of the distribution to be
built. This is usually the name of the distribution's main module, with the
double colons (\f(CW\*(C`::\*(C'\fR) replaced with dashes. For example: \f(CW\*(C`Dist\-Zilla\*(C'\fR.
.SS "version"
.IX Subsection "version"
This is the version of the distribution to be created.
.SS "release_status"
.IX Subsection "release_status"
This attribute sets the release status to one of the
CPAN::META::Spec
values: 'stable', 'testing' or 'unstable'.
.PP
If the \f(CW$ENV{RELEASE_STATUS}\fR environment variable exists, its value will
be used as the release status.
.PP
For backwards compatibility, if \f(CW$ENV{RELEASE_STATUS}\fR does not exist and
the \f(CW$ENV{TRIAL}\fR variable is true, the release status will be 'testing'.
.PP
Otherwise, the release status will be set from a
ReleaseStatusProvider, if one
has been configured.
.PP
For backwards compatibility, setting \f(CW\*(C`is_trial\*(C'\fR true in \fIdist.ini\fR is
equivalent to using a \f(CW\*(C`ReleaseStatusProvider\*(C'\fR. If \f(CW\*(C`is_trial\*(C'\fR is false,
it has no effect.
.PP
Only \fBone\fR \f(CW\*(C`ReleaseStatusProvider\*(C'\fR may be used.
.PP
If no providers are used, the release status defaults to 'stable' unless there
is an \*(L"_\*(R" character in the version, in which case, it defaults to 'testing'.
.SS "abstract"
.IX Subsection "abstract"
This is a one-line summary of the distribution. If none is given, one will be
looked for in the \*(L"main_module\*(R" of the dist.
.SS "main_module"
.IX Subsection "main_module"
This is the module where Dist::Zilla might look for various defaults, like
the distribution abstract. By default, it's derived from the distribution
name. If your distribution is Foo-Bar, and \fIlib/Foo/Bar.pm\fR exists,
that's the main_module. Otherwise, it's the shortest-named module in the
distribution. This may change!
.PP
You can override the default by specifying the file path explicitly,
ie:
.PP
.Vb 1
\& main_module = lib/Foo/Bar.pm
.Ve
.SS "license"
.IX Subsection "license"
This is the Software::License object for this dist's
license and copyright.
.PP
It will be created automatically, if possible, with the
\&\f(CW\*(C`copyright_holder\*(C'\fR and \f(CW\*(C`copyright_year\*(C'\fR attributes. If necessary, it will
try to guess the license from the \s-1POD\s0 of the dist's main module.
.PP
A better option is to set the \f(CW\*(C`license\*(C'\fR name in the dist's config to something
understandable, like \f(CW\*(C`Perl_5\*(C'\fR.
.SS "authors"
.IX Subsection "authors"
This is an arrayref of author strings, like this:
.PP
.Vb 4
\& [
\& \*(AqRicardo Signes \*(Aq,
\& \*(AqX. Ample, Jr \*(Aq,
\& ]
.Ve
.PP
This is likely to change at some point in the near future.
.SS "files"
.IX Subsection "files"
This is an arrayref of objects implementing Dist::Zilla::Role::File that
will, if left in this arrayref, be built into the dist.
.PP
Non-core code should avoid altering this arrayref, but sometimes there is not
other way to change the list of files. In the future, the representation used
for storing files \fBwill be changed\fR.
.SS "root"
.IX Subsection "root"
This is the root directory of the dist, as a Path::Tiny. It will
nearly always be the current working directory in which \f(CW\*(C`dzil\*(C'\fR was run.
.SS "is_trial"
.IX Subsection "is_trial"
This attribute tells us whether or not the dist will be a trial release,
i.e. whether it has \f(CW\*(C`release_status\*(C'\fR 'testing' or 'unstable'.
.PP
Do not set this directly, it will be derived from \f(CW\*(C`release_status\*(C'\fR.
.SS "plugins"
.IX Subsection "plugins"
This is an arrayref of plugins that have been plugged into this Dist::Zilla
object.
.PP
Non-core code \fBmust not\fR alter this arrayref. Public access to this attribute
\&\fBmay go away\fR in the future.
.SS "distmeta"
.IX Subsection "distmeta"
This is a hashref containing the metadata about this distribution that will be
stored in \s-1META\s0.yml or \s-1META\s0.json. You should not alter the metadata in this
hash; use a MetaProvider plugin instead.
.SS "prereqs"
.IX Subsection "prereqs"
This is a Dist::Zilla::Prereqs object, which is a thin layer atop
CPAN::Meta::Prereqs, and describes the distribution's prerequisites.
.SS "logger"
.IX Subsection "logger"
This attribute stores a Log::Dispatchouli::Proxy object, used to log
messages. By default, a proxy to the dist's Chrome is
taken.
.PP
The following methods are delegated from the Dist::Zilla object to the logger:
.IP "\(bu" 4
log
.IP "\(bu" 4
log_debug
.IP "\(bu" 4
log_fatal
.SH "METHODS"
.IX Header "METHODS"
.SS "register_prereqs"
.IX Subsection "register_prereqs"
Allows registration of prerequisites; delegates to
\&\*(L"register_prereqs\*(R" in Dist::Zilla::Prereqs via our \*(L"prereqs\*(R" attribute.
.SS "plugin_named"
.IX Subsection "plugin_named"
.Vb 1
\& my $plugin = $zilla\->plugin_named( $plugin_name );
.Ve
.SS "plugins_with"
.IX Subsection "plugins_with"
.Vb 1
\& my $roles = $zilla\->plugins_with( \-SomeRole );
.Ve
.PP
This method returns an arrayref containing all the Dist::Zilla object's plugins
that perform the named role. If the given role name begins with a dash, the
dash is replaced with \*(L"Dist::Zilla::Role::\*(R"
.SS "find_files"
.IX Subsection "find_files"
.Vb 1
\& my $files = $zilla\->find_files( $finder_name );
.Ve
.PP
This method will look for a
FileFinder\-performing plugin with the given
name and return the result of calling \f(CW\*(C`find_files\*(C'\fR on it. If no plugin can be
found, an exception will be raised.
.SS "stash_named"
.IX Subsection "stash_named"
.Vb 1
\& my $stash = $zilla\->stash_named( $name );
.Ve
.PP
This method will return the stash with the given name, or undef if none exists.
It looks for a local stash (for this dist) first, then falls back to a global
stash (from the user's global configuration).
.SH "STABILITY PROMISE"
.IX Header "STABILITY PROMISE"
None.
.PP
I will try not to break things within any major release. Minor releases are
not extensively tested before release. In major releases, anything goes,
although I will try to publish a complete list of known breaking changes in any
major release.
.PP
If Dist::Zilla was a tool, it would have yellow and black stripes and there
would be no \s-1UL\s0
certification on it.
It is nasty, brutish, and large.
.SH "SUPPORT"
.IX Header "SUPPORT"
There are usually people on \f(CW\*(C`irc.perl.org\*(C'\fR in \f(CW\*(C`#distzilla\*(C'\fR, even if they're
idling.
.PP
The Dist::Zilla website has several valuable resources for
learning to use Dist::Zilla.
.PP
There is a mailing list to discuss Dist::Zilla. You can join the
list or browse the
archives .
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\(bu" 4
In the Dist::Zilla distribution:
.RS 4
.IP "\(bu" 4
Plugin bundles:
\&\f(CW@Basic\fR,
\&\f(CW@Filter\fR.
.IP "\(bu" 4
Major plugins:
GatherDir,
Prereqs,
AutoPrereqs,
MetaYAML,
MetaJSON,
\&...
.RE
.RS 4
.RE
.IP "\(bu" 4
On the \s-1CPAN:\s0
.RS 4
.IP "\(bu" 4
Search for plugins:
.IP "\(bu" 4
Search for plugin bundles:
.RE
.RS 4
.RE
.SH "AUTHOR"
.IX Header "AUTHOR"
Ricardo \s-1SIGNES\s0 😏
.SH "CONTRIBUTORS"
.IX Header "CONTRIBUTORS"
.IP "\(bu" 4
Ævar Arnfjörð Bjarmason
.IP "\(bu" 4
Alastair McGowan-Douglas
.IP "\(bu" 4
Alceu Rodrigues de Freitas Junior
.IP "\(bu" 4
Alexei Znamensky
.IP "\(bu" 4
Alex Vandiver
.IP "\(bu" 4
ambs
.IP "\(bu" 4
Andrew Rodland
.IP "\(bu" 4
Andy Jack
.IP "\(bu" 4
Apocalypse
.IP "\(bu" 4
ben hengst
.IP "\(bu" 4
Bernardo Rechea
.IP "\(bu" 4
Brian Fraser
.IP "\(bu" 4
Caleb Cushing
.IP "\(bu" 4
Chase Whitener
.IP "\(bu" 4
Chisel
.IP "\(bu" 4
Christian Walde
.IP "\(bu" 4
Christopher Bottoms
.IP "\(bu" 4
Christopher J. Madsen
.IP "\(bu" 4
Chris Weyl
.IP "\(bu" 4
Cory G Watson
.IP "\(bu" 4
csjewell
.IP "\(bu" 4
Curtis Brandt
.IP "\(bu" 4
Dagfinn Ilmari Mannsåker
.IP "\(bu" 4
Damien KRotkine
.IP "\(bu" 4
Dan Book
.IP "\(bu" 4
Daniel Böhmer
.IP "\(bu" 4
Danijel Tasov
.IP "\(bu" 4
Dave Lambley
.IP "\(bu" 4
Dave O'Neill
.IP "\(bu" 4
Dave Rolsky
.IP "\(bu" 4
David E. Wheeler
.IP "\(bu" 4
David Golden
.IP "\(bu" 4
David H. Adler
.IP "\(bu" 4
David Steinbrunner
.IP "\(bu" 4
David Zurborg
.IP "\(bu" 4
Davor Cubranic
.IP "\(bu" 4
Dimitar Petrov
.IP "\(bu" 4
Doug Bell
.IP "\(bu" 4
Doug Bell
.IP "\(bu" 4
Erik Carlsson
.IP "\(bu" 4
Fayland Lam
.IP "\(bu" 4
Felix Ostmann
.IP "\(bu" 4
Florian Ragwitz
.IP "\(bu" 4
Fred Moyer
.IP "\(bu" 4
fREW Schmidt
.IP "\(bu" 4
gardnerm
.IP "\(bu" 4
Gianni Ceccarelli
.IP "\(bu" 4
Graham Barr
.IP "\(bu" 4
Graham Knop
.IP "\(bu" 4
Graham Ollis
.IP "\(bu" 4
Graham Ollis
.IP "\(bu" 4
Grzegorz Rożniecki
.IP "\(bu" 4
Håkon Hægland
.IP "\(bu" 4
Hans Dieter Pearcey
.IP "\(bu" 4
Hunter McMillen
.IP "\(bu" 4
Ivan Bessarabov
.IP "\(bu" 4
Jakob Voss
.IP "\(bu" 4
jantore
.IP "\(bu" 4
Jérôme Quelin
.IP "\(bu" 4
Jesse Luehrs
.IP "\(bu" 4
Jesse Vincent
.IP "\(bu" 4
\&\s-1JJ\s0 Merelo
.IP "\(bu" 4
John Napiorkowski
.IP "\(bu" 4
jonasbn
.IP "\(bu" 4
Jonathan C. Otsuka
.IP "\(bu" 4
Jonathan Rockway
.IP "\(bu" 4
Jonathan Scott Duff
.IP "\(bu" 4
Jonathan Yu
.IP "\(bu" 4
Karen Etheridge
.IP "\(bu" 4
Kent Fredric
.IP "\(bu" 4
Kent Fredric
.IP "\(bu" 4
Leon Timmermans
.IP "\(bu" 4
Lucas Theisen
.IP "\(bu" 4
Luc St-Louis
.IP "\(bu" 4
Marcel Gruenauer
.IP "\(bu" 4
Martin McGrath
.IP "\(bu" 4
Mary Ehlers
.IP "\(bu" 4
Mateu X Hunter
.IP "\(bu" 4
Matthew Horsfall
.IP "\(bu" 4
mauke
.IP "\(bu" 4
Michael Conrad
.IP "\(bu" 4
Michael G. Schwern
.IP "\(bu" 4
Michael Jemmeson
.IP "\(bu" 4
Mickey Nasriachi
.IP "\(bu" 4
Mike Doherty
.IP "\(bu" 4
Mohammad S Anwar
.IP "\(bu" 4
Moritz Onken
.IP "\(bu" 4
Neil Bowers
.IP "\(bu" 4
Nickolay Platonov
.IP "\(bu" 4
Nick Tonkin <1nickt@users.noreply.github.com>
.IP "\(bu" 4
nperez
.IP "\(bu" 4
Olivier Mengué
.IP "\(bu" 4
Paul Cochrane
.IP "\(bu" 4
Pedro Melo
.IP "\(bu" 4
perlancar (@pc\-office)
.IP "\(bu" 4
Philippe Bruhat (BooK)
.IP "\(bu" 4
Randy Stauner
.IP "\(bu" 4
Ricardo Signes
.IP "\(bu" 4
robertkrimen
.IP "\(bu" 4
Rob Hoelz
.IP "\(bu" 4
Robin Smidsrød
.IP "\(bu" 4
Roy Ivy \s-1III\s0
.IP "\(bu" 4
Shawn M Moore
.IP "\(bu" 4
Shlomi Fish
.IP "\(bu" 4
Smylers
.IP "\(bu" 4
Steffen Schwigon
.IP "\(bu" 4
Steven Haryanto
.IP "\(bu" 4
Tatsuhiko Miyagawa
.IP "\(bu" 4
Upasana Shukla
.IP "\(bu" 4
Vyacheslav Matjukhin
.IP "\(bu" 4
Yanick Champoux
.IP "\(bu" 4
Yuval Kogman
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2020 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.