.\" -*- 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::Role::ArchiveBuilder 3pm" .TH Dist::Zilla::Role::ArchiveBuilder 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::Role::ArchiveBuilder \- something that builds archives .SH VERSION .IX Header "VERSION" version 6.032 .SH DESCRIPTION .IX Header "DESCRIPTION" Plugins implementing this role have their \f(CW\*(C`build_archive\*(C'\fR method called when it is time to build the archive. .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 METHODS .IX Header "METHODS" .SS build_archive .IX Subsection "build_archive" This method takes three arguments, and returns a Path::Tiny instance containing the path to the archive. .IP archive_basename 4 .IX Item "archive_basename" This is the name of the archive (including \f(CW\*(C`\-TRIAL\*(C'\fR if appropriate) without the format extension (that is the \f(CW\*(C`.tar.gz\*(C'\fR part). The plugin implementing this role should add the appropriate full path including extension as the returned Path::Tiny instance. Not including the extension allows the plugin to choose its own format. .IP built_in 4 .IX Item "built_in" This is a Path::Tiny where the distribution has been built. .IP dist_basename 4 .IX Item "dist_basename" This method will return the dist's basename (e.g. \f(CW\*(C`Dist\-Name\-1.01\*(C'\fR as a Path::Tiny. The basename is used as the top-level directory in the tarball. It does not include \f(CW\*(C`\-TRIAL\*(C'\fR, even if building a trial dist. .SH AUTHOR .IX Header "AUTHOR" Ricardo SIGNES 😏 .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.