.\" Automatically generated by Pod::Man 4.14 (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 .. .\" 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::Plugin::Prereqs 3pm" .TH Dist::Zilla::Plugin::Prereqs 3pm "2023-01-19" "perl v5.36.0" "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::Prereqs \- list simple prerequisites .SH "VERSION" .IX Header "VERSION" version 6.030 .SH "SYNOPSIS" .IX Header "SYNOPSIS" In your \fIdist.ini\fR: .PP .Vb 4 \& [Prereqs] \& Foo::Bar = 1.002 \& MRO::Compat = 10 \& Sub::Exporter = 0 .Ve .PP You can specify requirements for different phases and relationships with: .PP .Vb 3 \& [Prereqs] \& \-phase = test \& \-relationship = recommends \& \& Fitz::Fotz = 1.23 \& Text::SoundEx = 3 .Ve .PP Remember that if you load two Prereqs plugins, each will needs its own name, added like this: .PP .Vb 3 \& [Prereqs / PluginName] \& \-phase = test \& \-relationship = recommends \& \& Fitz::Fotz = 1.23 \& Text::SoundEx = 3 .Ve .PP If the name is the CamelCase concatenation of a phase and relationship (or just a relationship), it will set those parameters implicitly. If you use a custom name, but it does not specify the relationship, and you didn't specify either \f(CW\*(C`\-phase\*(C'\fR or \f(CW\*(C`\-relationship\*(C'\fR, it throws the error \f(CW\*(C`No \-phase or \-relationship specified\*(C'\fR. This is to prevent a typo that makes the name meaningless from slipping by unnoticed. .PP The example below is equivalent to the example above, except for the name of the resulting plugin: .PP .Vb 3 \& [Prereqs / TestRecommends] \& Fitz::Fotz = 1.23 \& Text::SoundEx = 3 .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module adds \*(L"fixed\*(R" prerequisites to your distribution. These are prereqs with a known, fixed minimum version that doesn't change based on platform or other conditions. .PP You can specify prerequisites for different phases and kinds of relationships. In \f(CW\*(C`RuntimeRequires\*(C'\fR, the phase is Runtime and the relationship is Requires. These are described in more detail in the CPAN::Meta specification. .PP The phases are: .IP "\(bu" 4 configure .IP "\(bu" 4 build .IP "\(bu" 4 test .IP "\(bu" 4 runtime .IP "\(bu" 4 develop .PP The relationship types are: .IP "\(bu" 4 requires .IP "\(bu" 4 recommends .IP "\(bu" 4 suggests .IP "\(bu" 4 conflicts .PP If the phase is omitted, it will default to \fIruntime\fR; thus, specifying \&\*(L"Prereqs / Recommends\*(R" in your dist.ini is equivalent to \fIRuntimeRecommends\fR. .PP Not all of these phases are useful for all tools, especially tools that only understand version 1.x CPAN::Meta files. .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 "SEE ALSO" .IX Header "SEE ALSO" .IP "\(bu" 4 Core Dist::Zilla plugins: \&\f(CW@Basic\fR, AutoPrereqs. .IP "\(bu" 4 The \s-1CPAN\s0 Meta specification: \*(L"\s-1PREREQUISITES\*(R"\s0 in CPAN::Meta. .SH "AUTHOR" .IX Header "AUTHOR" Ricardo \s-1SIGNES\s0 😏 .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2023 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.