local-lib5/man/man3/Module::CoreList.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "Module::CoreList 3"
 132 .TH Module::CoreList 3 "2009-11-20" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 Module::CoreList \- what modules shipped with versions of perl
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 1
 138 \& use Module::CoreList;
 139 .Ve
 140 .PP
 141 .Vb 1
 142 \& print $Module::CoreList::version{5.00503}{CPAN}; # prints 1.48
 143 .Ve
 144 .PP
 145 .Vb 3
 146 \& print Module::CoreList\->first_release('File::Spec');         # prints 5.00405
 147 \& print Module::CoreList\->first_release_by_date('File::Spec'); # prints 5.005
 148 \& print Module::CoreList\->first_release('File::Spec', 0.82);   # prints 5.006001
 149 .Ve
 150 .PP
 151 .Vb 4
 152 \& print join ', ', Module::CoreList\->find_modules(qr/Data/);
 153 \&    # prints 'Data::Dumper'
 154 \& print join ', ', Module::CoreList\->find_modules(qr/test::h.*::.*s/i, 5.008008);
 155 \&    # prints 'Test::Harness::Assert, Test::Harness::Straps'
 156 .Ve
 157 .PP
 158 .Vb 2
 159 \& print join ", ", @{ $Module::CoreList::families{5.005} };
 160 \&    # prints "5.005, 5.00503, 5.00504"
 161 .Ve
 162 .SH "DESCRIPTION"
 163 .IX Header "DESCRIPTION"
 164 Module::CoreList contains the hash of hashes
 165 \&\f(CW%Module::CoreList::version\fR, that is keyed on perl version as indicated
 166 in $].  The second level hash is module => version pairs.
 167 .PP
 168 Note, it is possible for the version of a module to be unspecified,
 169 whereby the value is undef, so use \f(CW\*(C`exists $version{$foo}{$bar}\*(C'\fR if
 170 that's what you're testing for.
 171 .PP
 172 It also contains \f(CW%Module::CoreList::released\fR hash, which has \s-1ISO\s0
 173 formatted versions of the release dates, as gleaned from perlhist.
 174 .PP
 175 New, in 1.96 is also the \f(CW%Module::CoreList::families\fR hash, which
 176 clusters known perl releases by their major versions.
 177 .PP
 178 Starting with 2.10, the special module name \f(CW\*(C`Unicode\*(C'\fR refers to the version of
 179 the Unicode Character Database bundled with Perl.
 180 .PP
 181 Since 2.11, \fIModule::CoreList::first_release()\fR returns the first release
 182 in the order of perl version numbers. If you want to get the earliest
 183 perl release instead, use \fIModule::CoreList::first_release_by_date()\fR.
 184 .PP
 185 New in 2.22, Module::CoreList::is_deprecated(\s-1MODULE\s0,PERL_VERSION) returns true
 186 if \s-1MODULE\s0 is marked as deprecated in \s-1PERL_VERSION\s0.  If \s-1PERL_VERSION\s0 is
 187 omitted, it defaults to the current version of Perl.
 188 .SH "CAVEATS"
 189 .IX Header "CAVEATS"
 190 Module::CoreList currently covers the 5.000, 5.001, 5.002, 5.003_07, 5.004,
 191 5.004_05, 5.005, 5.005_03, 5.005_04, 5.6.0, 5.6.1, 5.6.2, 5.7.3, 5.8.0, 5.8.1,
 192 5.8.2, 5.8.3, 5.8.4, 5.8.5, 5.8.6, 5.8.7, 5.8.8, 5.8.9, 5.9.0, 5.9.1, 5.9.2, 5.9.3,
 193 5.9.4, 5.9.5, 5.10.0, 5.10.1, 5.11.0, 5.11.1 and 5.11.2 releases of perl.
 194 .SH "HISTORY"
 195 .IX Header "HISTORY"
 196 Moved to Changes file.
 197 .SH "AUTHOR"
 198 .IX Header "AUTHOR"
 199 Richard Clamp <richardc@unixbeard.net>
 200 .PP
 201 Currently maintained by the perl 5 porters <perl5\-porters@perl.org>.
 202 .SH "COPYRIGHT"
 203 .IX Header "COPYRIGHT"
 204 Copyright (C) 2002\-2009 Richard Clamp.  All Rights Reserved.
 205 .PP
 206 This module is free software; you can redistribute it and/or modify it
 207 under the same terms as Perl itself.
 208 .SH "SEE ALSO"
 209 .IX Header "SEE ALSO"
 210 corelist, Module::Info, perl