22

✏️ Editing: Canary::Stability.3pm

.\" 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 "Stability 3"
.TH Stability 3 "2019-04-22" "perl v5.26.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"
Canary::Stability \- canary to check perl compatibility for schmorp's modules
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& # in Makefile.PL
\& use Canary::Stability DISTNAME => 2001, MINIMUM_PERL_VERSION;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module is used by Schmorp's modules during configuration stage to
test the installed perl for compatibility with his modules.
.PP
It's not, at this stage, meant as a tool for other module authors,
although in principle nothing prevents them from subscribing to the same
ideas.
.PP
See the \fIMakefile.PL\fR in Coro or AnyEvent for usage examples.
.SH "ENVIRONMENT VARIABLES"
.IX Header "ENVIRONMENT VARIABLES"
.ie n .IP """PERL_CANARY_STABILITY_NOPROMPT=1""" 4
.el .IP "\f(CWPERL_CANARY_STABILITY_NOPROMPT=1\fR" 4
.IX Item "PERL_CANARY_STABILITY_NOPROMPT=1"
Do not prompt the user on alert messages.
.ie n .IP """PERL_CANARY_STABILITY_COLOUR=0""" 4
.el .IP "\f(CWPERL_CANARY_STABILITY_COLOUR=0\fR" 4
.IX Item "PERL_CANARY_STABILITY_COLOUR=0"
Disable use of colour.
.ie n .IP """PERL_CANARY_STABILITY_COLOUR=1""" 4
.el .IP "\f(CWPERL_CANARY_STABILITY_COLOUR=1\fR" 4
.IX Item "PERL_CANARY_STABILITY_COLOUR=1"
Force use of colour.
.ie n .IP """PERL_CANARY_STABILITY_DISABLE=1""" 4
.el .IP "\f(CWPERL_CANARY_STABILITY_DISABLE=1\fR" 4
.IX Item "PERL_CANARY_STABILITY_DISABLE=1"
Disable this modules functionality completely.
.ie n .IP """AUTOMATED_TESTING=1""" 4
.el .IP "\f(CWAUTOMATED_TESTING=1\fR" 4
.IX Item "AUTOMATED_TESTING=1"
When this variable is set to a true value and the perl minimum version
requirement is not met, the module will exit, which should skip testing
under automated testing environments.
.Sp
This is done to avoid false failure or success reports when the chances of
success are already quite low and the failures are not supported by the
author.
.SH "AUTHOR"
.IX Header "AUTHOR"
.Vb 2
\& Marc Lehmann <schmorp@schmorp.de>
\& http://software.schmorp.de/pkg/Canary\-Stability.html
.Ve

MR SKB