Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Module::CoreList::Utils.3pm

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