| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" ======================================================================== |
| 56 |
.\" |
| 57 |
.IX Title "Module::CoreList 3perl" |
| 58 |
.TH Module::CoreList 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide" |
| 59 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 60 |
.\" way too many mistakes in technical documents. |
| 61 |
.if n .ad l |
| 62 |
.nh |
| 63 |
.SH NAME |
| 64 |
Module::CoreList \- what modules shipped with versions of perl |
| 65 |
.SH SYNOPSIS |
| 66 |
.IX Header "SYNOPSIS" |
| 67 |
.Vb 1 |
| 68 |
\& use Module::CoreList; |
| 69 |
\& |
| 70 |
\& print $Module::CoreList::version{5.00503}{CPAN}; # prints 1.48 |
| 71 |
\& |
| 72 |
\& print Module::CoreList\->first_release(\*(AqFile::Spec\*(Aq); |
| 73 |
\& # prints 5.00405 |
| 74 |
\& |
| 75 |
\& print Module::CoreList\->first_release_by_date(\*(AqFile::Spec\*(Aq); |
| 76 |
\& # prints 5.005 |
| 77 |
\& |
| 78 |
\& print Module::CoreList\->first_release(\*(AqFile::Spec\*(Aq, 0.82); |
| 79 |
\& # prints 5.006001 |
| 80 |
\& |
| 81 |
\& if (Module::CoreList::is_core(\*(AqFile::Spec\*(Aq)) { |
| 82 |
\& print "File::Spec is a core module\en"; |
| 83 |
\& } |
| 84 |
\& |
| 85 |
\& print join \*(Aq, \*(Aq, Module::CoreList\->find_modules(qr/Data/); |
| 86 |
\& # prints \*(AqData::Dumper\*(Aq |
| 87 |
\& print join \*(Aq, \*(Aq, |
| 88 |
\& Module::CoreList\->find_modules(qr/test::h.*::.*s/i, 5.008008); |
| 89 |
\& # prints \*(AqTest::Harness::Assert, Test::Harness::Straps\*(Aq |
| 90 |
\& |
| 91 |
\& print join ", ", @{ $Module::CoreList::families{5.005} }; |
| 92 |
\& # prints "5.005, 5.00503, 5.00504" |
| 93 |
.Ve |
| 94 |
.SH DESCRIPTION |
| 95 |
.IX Header "DESCRIPTION" |
| 96 |
Module::CoreList provides information on which core and dual-life modules shipped |
| 97 |
with each version of perl. |
| 98 |
.PP |
| 99 |
It provides a number of mechanisms for querying this information. |
| 100 |
.PP |
| 101 |
There is a utility called corelist provided with this module |
| 102 |
which is a convenient way of querying from the command-line. |
| 103 |
.PP |
| 104 |
There is a functional programming API available for programmers to query |
| 105 |
information. |
| 106 |
.PP |
| 107 |
Programmers may also query the contained hash structures to find relevant |
| 108 |
information. |
| 109 |
.SH "FUNCTIONS API" |
| 110 |
.IX Header "FUNCTIONS API" |
| 111 |
These are the functions that are available, they may either be called as functions or class methods: |
| 112 |
.PP |
| 113 |
.Vb 1 |
| 114 |
\& Module::CoreList::first_release(\*(AqFile::Spec\*(Aq); # as a function |
| 115 |
\& |
| 116 |
\& Module::CoreList\->first_release(\*(AqFile::Spec\*(Aq); # class method |
| 117 |
.Ve |
| 118 |
.ie n .IP "first_release( MODULE )" 4 |
| 119 |
.el .IP "\f(CWfirst_release( MODULE )\fR" 4 |
| 120 |
.IX Item "first_release( MODULE )" |
| 121 |
Behaviour since version 2.11 |
| 122 |
.Sp |
| 123 |
Requires a MODULE name as an argument, returns the perl version when that module first |
| 124 |
appeared in core as ordered by perl version number or undef ( in scalar context ) |
| 125 |
or an empty list ( in list context ) if that module is not in core. |
| 126 |
.ie n .IP "first_release_by_date( MODULE )" 4 |
| 127 |
.el .IP "\f(CWfirst_release_by_date( MODULE )\fR" 4 |
| 128 |
.IX Item "first_release_by_date( MODULE )" |
| 129 |
Requires a MODULE name as an argument, returns the perl version when that module first |
| 130 |
appeared in core as ordered by release date or undef ( in scalar context ) |
| 131 |
or an empty list ( in list context ) if that module is not in core. |
| 132 |
.ie n .IP """find_modules( REGEX, [ LIST OF PERLS ] )""" 4 |
| 133 |
.el .IP "\f(CWfind_modules( REGEX, [ LIST OF PERLS ] )\fR" 4 |
| 134 |
.IX Item "find_modules( REGEX, [ LIST OF PERLS ] )" |
| 135 |
Takes a regex as an argument, returns a list of modules that match the regex given. |
| 136 |
If only a regex is provided applies to all modules in all perl versions. Optionally |
| 137 |
you may provide a list of perl versions to limit the regex search. |
| 138 |
.ie n .IP "find_version( PERL_VERSION )" 4 |
| 139 |
.el .IP "\f(CWfind_version( PERL_VERSION )\fR" 4 |
| 140 |
.IX Item "find_version( PERL_VERSION )" |
| 141 |
Takes a perl version as an argument. Upon successful completion, returns a |
| 142 |
reference to a hash. Each element of that hash has a key which is the name of |
| 143 |
a module (\fIe.g.,\fR 'File::Path') shipped with that version of perl and a value |
| 144 |
which is the version number (\fIe.g.,\fR '2.09') of that module which shipped |
| 145 |
with that version of perl . Returns \f(CW\*(C`undef\*(C'\fR otherwise. |
| 146 |
.ie n .IP """is_core( MODULE, [ MODULE_VERSION, [ PERL_VERSION ] ] )""" 4 |
| 147 |
.el .IP "\f(CWis_core( MODULE, [ MODULE_VERSION, [ PERL_VERSION ] ] )\fR" 4 |
| 148 |
.IX Item "is_core( MODULE, [ MODULE_VERSION, [ PERL_VERSION ] ] )" |
| 149 |
Available in version 2.99 and above. |
| 150 |
.Sp |
| 151 |
Returns true if MODULE was bundled with the specified version of Perl. |
| 152 |
You can optionally specify a minimum version of the module, |
| 153 |
and can also specify a version of Perl. |
| 154 |
If a version of Perl isn't specified, |
| 155 |
\&\f(CWis_core()\fR will use the numeric version of Perl that is running (ie \f(CW$]\fR). |
| 156 |
.Sp |
| 157 |
If you want to specify the version of Perl, but don't care about |
| 158 |
the version of the module, pass \f(CW\*(C`undef\*(C'\fR for the module version: |
| 159 |
.ie n .IP """is_deprecated( MODULE, PERL_VERSION )""" 4 |
| 160 |
.el .IP "\f(CWis_deprecated( MODULE, PERL_VERSION )\fR" 4 |
| 161 |
.IX Item "is_deprecated( MODULE, PERL_VERSION )" |
| 162 |
Available in version 2.22 and above. |
| 163 |
.Sp |
| 164 |
Returns true if MODULE is marked as deprecated in PERL_VERSION. If PERL_VERSION is |
| 165 |
omitted, it defaults to the current version of Perl. |
| 166 |
.ie n .IP "deprecated_in( MODULE )" 4 |
| 167 |
.el .IP "\f(CWdeprecated_in( MODULE )\fR" 4 |
| 168 |
.IX Item "deprecated_in( MODULE )" |
| 169 |
Available in version 2.77 and above. |
| 170 |
.Sp |
| 171 |
Returns the first perl version where the MODULE was marked as deprecated. Returns \f(CW\*(C`undef\*(C'\fR |
| 172 |
if the MODULE has not been marked as deprecated. |
| 173 |
.ie n .IP "removed_from( MODULE )" 4 |
| 174 |
.el .IP "\f(CWremoved_from( MODULE )\fR" 4 |
| 175 |
.IX Item "removed_from( MODULE )" |
| 176 |
Available in version 2.32 and above |
| 177 |
.Sp |
| 178 |
Takes a module name as an argument, returns the first perl version where that module |
| 179 |
was removed from core. Returns undef if the given module was never in core or remains |
| 180 |
in core. |
| 181 |
.ie n .IP "removed_from_by_date( MODULE )" 4 |
| 182 |
.el .IP "\f(CWremoved_from_by_date( MODULE )\fR" 4 |
| 183 |
.IX Item "removed_from_by_date( MODULE )" |
| 184 |
Available in version 2.32 and above |
| 185 |
.Sp |
| 186 |
Takes a module name as an argument, returns the first perl version by release date where that module |
| 187 |
was removed from core. Returns undef if the given module was never in core or remains |
| 188 |
in core. |
| 189 |
.ie n .IP """changes_between( PERL_VERSION, PERL_VERSION )""" 4 |
| 190 |
.el .IP "\f(CWchanges_between( PERL_VERSION, PERL_VERSION )\fR" 4 |
| 191 |
.IX Item "changes_between( PERL_VERSION, PERL_VERSION )" |
| 192 |
Available in version 2.66 and above. |
| 193 |
.Sp |
| 194 |
Given two perl versions, this returns a list of pairs describing the changes in |
| 195 |
core module content between them. The list is suitable for storing in a hash. |
| 196 |
The keys are library names and the values are hashrefs. Each hashref has an |
| 197 |
entry for one or both of \f(CW\*(C`left\*(C'\fR and \f(CW\*(C`right\*(C'\fR, giving the versions of the |
| 198 |
library in each of the left and right perl distributions. |
| 199 |
.Sp |
| 200 |
For example, it might return these data (among others) for the difference |
| 201 |
between 5.008000 and 5.008001: |
| 202 |
.Sp |
| 203 |
.Vb 4 |
| 204 |
\& \*(AqPod::ParseLink\*(Aq => { left => \*(Aq1.05\*(Aq, right => \*(Aq1.06\*(Aq }, |
| 205 |
\& \*(AqPod::ParseUtils\*(Aq => { left => \*(Aq0.22\*(Aq, right => \*(Aq0.3\*(Aq }, |
| 206 |
\& \*(AqPod::Perldoc\*(Aq => { right => \*(Aq3.10\*(Aq }, |
| 207 |
\& \*(AqPod::Perldoc::BaseTo\*(Aq => { right => undef }, |
| 208 |
.Ve |
| 209 |
.Sp |
| 210 |
This shows us two libraries being updated and two being added, one of which has |
| 211 |
an undefined version in the right-hand side version. |
| 212 |
.SH "DATA STRUCTURES" |
| 213 |
.IX Header "DATA STRUCTURES" |
| 214 |
These are the hash data structures that are available: |
| 215 |
.ie n .IP %Module::CoreList::version 4 |
| 216 |
.el .IP \f(CW%Module::CoreList::version\fR 4 |
| 217 |
.IX Item "%Module::CoreList::version" |
| 218 |
A hash of hashes that is keyed on perl version as indicated |
| 219 |
in $]. The second level hash is module => version pairs. |
| 220 |
.Sp |
| 221 |
Note, it is possible for the version of a module to be unspecified, |
| 222 |
whereby the value is \f(CW\*(C`undef\*(C'\fR, so use \f(CW\*(C`exists $version{$foo}{$bar}\*(C'\fR if |
| 223 |
that's what you're testing for. |
| 224 |
.Sp |
| 225 |
Starting with 2.10, the special module name \f(CW\*(C`Unicode\*(C'\fR refers to the version of |
| 226 |
the Unicode Character Database bundled with Perl. |
| 227 |
.ie n .IP %Module::CoreList::delta 4 |
| 228 |
.el .IP \f(CW%Module::CoreList::delta\fR 4 |
| 229 |
.IX Item "%Module::CoreList::delta" |
| 230 |
Available in version 3.00 and above. |
| 231 |
.Sp |
| 232 |
It is a hash of hashes that is keyed on perl version. Each keyed hash will have the |
| 233 |
following keys: |
| 234 |
.Sp |
| 235 |
.Vb 3 |
| 236 |
\& delta_from \- a previous perl version that the changes are based on |
| 237 |
\& changed \- a hash of module/versions that have changed |
| 238 |
\& removed \- a hash of modules that have been removed |
| 239 |
.Ve |
| 240 |
.ie n .IP %Module::CoreList::released 4 |
| 241 |
.el .IP \f(CW%Module::CoreList::released\fR 4 |
| 242 |
.IX Item "%Module::CoreList::released" |
| 243 |
Keyed on perl version this contains ISO |
| 244 |
formatted versions of the release dates, as gleaned from perlhist. |
| 245 |
.ie n .IP %Module::CoreList::families 4 |
| 246 |
.el .IP \f(CW%Module::CoreList::families\fR 4 |
| 247 |
.IX Item "%Module::CoreList::families" |
| 248 |
New, in 1.96, a hash that |
| 249 |
clusters known perl releases by their major versions. |
| 250 |
.ie n .IP %Module::CoreList::deprecated 4 |
| 251 |
.el .IP \f(CW%Module::CoreList::deprecated\fR 4 |
| 252 |
.IX Item "%Module::CoreList::deprecated" |
| 253 |
A hash of hashes keyed on perl version and on module name. |
| 254 |
If a module is defined it indicates that that module is |
| 255 |
deprecated in that perl version and is scheduled for removal |
| 256 |
from core at some future point. |
| 257 |
.ie n .IP %Module::CoreList::upstream 4 |
| 258 |
.el .IP \f(CW%Module::CoreList::upstream\fR 4 |
| 259 |
.IX Item "%Module::CoreList::upstream" |
| 260 |
A hash that contains information on where patches should be directed |
| 261 |
for each core module. |
| 262 |
.Sp |
| 263 |
UPSTREAM indicates where patches should go. \f(CW\*(C`undef\*(C'\fR implies |
| 264 |
that this hasn't been discussed for the module at hand. |
| 265 |
\&\f(CW\*(C`blead\*(C'\fR indicates that the copy of the module in the blead |
| 266 |
sources is to be considered canonical, \f(CW\*(C`cpan\*(C'\fR means that the |
| 267 |
module on CPAN is to be patched first. \f(CW\*(C`first\-come\*(C'\fR means |
| 268 |
that blead can be patched freely if it is in sync with the |
| 269 |
latest release on CPAN. |
| 270 |
.ie n .IP %Module::CoreList::bug_tracker 4 |
| 271 |
.el .IP \f(CW%Module::CoreList::bug_tracker\fR 4 |
| 272 |
.IX Item "%Module::CoreList::bug_tracker" |
| 273 |
A hash that contains information on the appropriate bug tracker |
| 274 |
for each core module. |
| 275 |
.Sp |
| 276 |
BUGS is an email or url to post bug reports. For modules with |
| 277 |
UPSTREAM => 'blead', use <mailto:perl5\[email protected]>. rt.cpan.org |
| 278 |
appears to automatically provide a URL for CPAN modules; any value |
| 279 |
given here overrides the default: |
| 280 |
<http://rt.cpan.org/Public/Dist/Display.html?Name=$ModuleName> |
| 281 |
.SH CAVEATS |
| 282 |
.IX Header "CAVEATS" |
| 283 |
Module::CoreList currently covers the 5.000, 5.001, 5.002, 5.003_07, |
| 284 |
5.004, 5.004_05, 5.005, 5.005_03, 5.005_04 and 5.7.3 releases of perl. |
| 285 |
.PP |
| 286 |
All stable releases of perl since 5.6.0 are covered. |
| 287 |
.PP |
| 288 |
All development releases of perl since 5.9.0 are covered. |
| 289 |
.SH HISTORY |
| 290 |
.IX Header "HISTORY" |
| 291 |
Moved to Changes file. |
| 292 |
.SH AUTHOR |
| 293 |
.IX Header "AUTHOR" |
| 294 |
Richard Clamp <[email protected]> |
| 295 |
.PP |
| 296 |
Currently maintained by the perl 5 porters <perl5\[email protected]>. |
| 297 |
.SH LICENSE |
| 298 |
.IX Header "LICENSE" |
| 299 |
Copyright (C) 2002\-2009 Richard Clamp. All Rights Reserved. |
| 300 |
.PP |
| 301 |
This module is free software; you can redistribute it and/or modify it |
| 302 |
under the same terms as Perl itself. |
| 303 |
.SH "SEE ALSO" |
| 304 |
.IX Header "SEE ALSO" |
| 305 |
corelist, Module::Info, perl, <http://perlpunks.de/corelist> |