Debian Codegraph @

upstream/debian-unstable/man3/Module::CoreList::Utils.3perl

raw
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::Utils 3perl"
58 .TH Module::CoreList::Utils 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::Utils \- what utilities shipped with versions of perl
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& use Module::CoreList::Utils;
69 \&
70 \& print $Module::CoreList::Utils::utilities{5.009003}{ptar}; # prints 1
71 \&
72 \& print Module::CoreList::Utils\->first_release(\*(Aqcorelist\*(Aq);
73 \& # prints 5.008009
74 \&
75 \& print Module::CoreList::Utils\->first_release_by_date(\*(Aqcorelist\*(Aq);
76 \& # prints 5.009002
77 .Ve
78 .SH DESCRIPTION
79 .IX Header "DESCRIPTION"
80 Module::CoreList::Utils provides information on which core and dual-life utilities shipped
81 with each version of perl.
82 .PP
83 It provides a number of mechanisms for querying this information.
84 .PP
85 There is a functional programming API available for programmers to query
86 information.
87 .PP
88 Programmers may also query the contained hash structure to find relevant
89 information.
90 .SH "FUNCTIONS API"
91 .IX Header "FUNCTIONS API"
92 These are the functions that are available, they may either be called as functions or class methods:
93 .PP
94 .Vb 1
95 \& Module::CoreList::Utils::first_release(\*(Aqcorelist\*(Aq); # as a function
96 \&
97 \& Module::CoreList::Utils\->first_release(\*(Aqcorelist\*(Aq); # class method
98 .Ve
99 .ie n .IP """utilities""" 4
100 .el .IP \f(CWutilities\fR 4
101 .IX Item "utilities"
102 Requires a perl version as an argument, returns a list of utilities that shipped with
103 that version of perl, or undef/empty list if that perl doesn't exist.
104 .ie n .IP "first_release( UTILITY )" 4
105 .el .IP "\f(CWfirst_release( UTILITY )\fR" 4
106 .IX Item "first_release( UTILITY )"
107 Requires a UTILITY name as an argument, returns the perl version when that utility first
108 appeared in core as ordered by perl version number or undef ( in scalar context )
109 or an empty list ( in list context ) if that utility is not in core.
110 .ie n .IP "first_release_by_date( UTILITY )" 4
111 .el .IP "\f(CWfirst_release_by_date( UTILITY )\fR" 4
112 .IX Item "first_release_by_date( UTILITY )"
113 Requires a UTILITY name as an argument, returns the perl version when that utility first
114 appeared in core as ordered by release date or undef ( in scalar context )
115 or an empty list ( in list context ) if that utility is not in core.
116 .ie n .IP "removed_from( UTILITY )" 4
117 .el .IP "\f(CWremoved_from( UTILITY )\fR" 4
118 .IX Item "removed_from( UTILITY )"
119 Takes a UTILITY name as an argument, returns the first perl version where that utility
120 was removed from core. Returns undef if the given utility was never in core or remains
121 in core.
122 .ie n .IP "removed_from_by_date( UTILITY )" 4
123 .el .IP "\f(CWremoved_from_by_date( UTILITY )\fR" 4
124 .IX Item "removed_from_by_date( UTILITY )"
125 Takes a UTILITY name as an argument, returns the first perl version by release date where that
126 utility was removed from core. Returns undef if the given utility was never in core or remains
127 in core.
128 .SH "DATA STRUCTURES"
129 .IX Header "DATA STRUCTURES"
130 These are the hash data structures that are available:
131 .ie n .IP %Module::CoreList::Utils::utilities 4
132 .el .IP \f(CW%Module::CoreList::Utils::utilities\fR 4
133 .IX Item "%Module::CoreList::Utils::utilities"
134 A hash of hashes that is keyed on perl version as indicated
135 in $]. The second level hash is utility / defined pairs.
136 .SH AUTHOR
137 .IX Header "AUTHOR"
138 Chris \f(CW\*(C`BinGOs\*(C'\fR Williams <[email protected]>
139 .PP
140 Currently maintained by the perl 5 porters <perl5\[email protected]>.
141 .PP
142 This module is the result of archaeology undertaken during QA Hackathon
143 in Lancaster, April 2013.
144 .SH LICENSE
145 .IX Header "LICENSE"
146 Copyright (C) 2013 Chris Williams. All Rights Reserved.
147 .PP
148 This module is free software; you can redistribute it and/or modify it
149 under the same terms as Perl itself.
150 .SH "SEE ALSO"
151 .IX Header "SEE ALSO"
152 corelist, Module::CoreList, perl, <http://perlpunks.de/corelist>