Debian Codegraph @

upstream/opensuse-tumbleweed/man1/perlmodlib.1

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 "PERLMODLIB 1"
61 .TH PERLMODLIB 1 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 perlmodlib \- constructing new Perl modules and finding existing ones
68 .SH "THE PERL MODULE LIBRARY"
69 .IX Header "THE PERL MODULE LIBRARY"
70 Many modules are included in the Perl distribution. These are described
71 below, and all end in \fI.pm\fR. You may discover compiled library
72 files (usually ending in \fI.so\fR) or small pieces of modules to be
73 autoloaded (ending in \fI.al\fR); these were automatically generated
74 by the installation process. You may also discover files in the
75 library directory that end in either \fI.pl\fR or \fI.ph\fR. These are
76 old libraries supplied so that old programs that use them still
77 run. The \fI.pl\fR files will all eventually be converted into standard
78 modules, and the \fI.ph\fR files made by \fBh2ph\fR will probably end up
79 as extension modules made by \fBh2xs\fR. (Some \fI.ph\fR values may
80 already be available through the POSIX, Errno, or Fcntl modules.)
81 The \fBpl2pm\fR file in the distribution may help in your conversion,
82 but it\*(Aqs just a mechanical process and therefore far from bulletproof.
83 .SS "Pragmatic Modules"
84 .IX Subsection "Pragmatic Modules"
85 They work somewhat like compiler directives (pragmata) in that they
86 tend to affect the compilation of your program, and thus will usually
87 work well only when used within a \f(CW\*(C`use\*(C'\fR, or \f(CW\*(C`no\*(C'\fR. Most of these
88 are lexically scoped, so an inner BLOCK may countermand them
89 by saying:
90 .PP
91 .Vb 3
92 \& no integer;
93 \& no strict \*(Aqrefs\*(Aq;
94 \& no warnings;
95 .Ve
96 .PP
97 which lasts until the end of that BLOCK.
98 .PP
99 Some pragmas are lexically scoped\-\-typically those that affect the
100 \&\f(CW$^H\fR hints variable. Others affect the current package instead,
101 like \f(CW\*(C`use vars\*(C'\fR and \f(CW\*(C`use subs\*(C'\fR, which allow you to predeclare a
102 variables or subroutines within a particular \fIfile\fR rather than
103 just a block. Such declarations are effective for the entire file
104 for which they were declared. You cannot rescind them with \f(CW\*(C`no
105 vars\*(C'\fR or \f(CW\*(C`no subs\*(C'\fR.
106 .PP
107 The following pragmas are defined (and have their own documentation).
108 .IP attributes 12
109 .IX Item "attributes"
110 Get/set subroutine or variable attributes
111 .IP autodie 12
112 .IX Item "autodie"
113 Replace functions with ones that succeed or die with lexical scope
114 .IP autodie::exception 12
115 .IX Item "autodie::exception"
116 Exceptions from autodying functions.
117 .IP autodie::exception::system 12
118 .IX Item "autodie::exception::system"
119 Exceptions from autodying \fBsystem()\fR.
120 .IP autodie::hints 12
121 .IX Item "autodie::hints"
122 Provide hints about user subroutines to autodie
123 .IP autodie::skip 12
124 .IX Item "autodie::skip"
125 Skip a package when throwing autodie exceptions
126 .IP autouse 12
127 .IX Item "autouse"
128 Postpone load of modules until a function is used
129 .IP base 12
130 .IX Item "base"
131 Establish an ISA relationship with base classes at compile time
132 .IP bigfloat 12
133 .IX Item "bigfloat"
134 Transparent big floating point number support for Perl
135 .IP bigint 12
136 .IX Item "bigint"
137 Transparent big integer support for Perl
138 .IP bignum 12
139 .IX Item "bignum"
140 Transparent big number support for Perl
141 .IP bigrat 12
142 .IX Item "bigrat"
143 Transparent big rational number support for Perl
144 .IP blib 12
145 .IX Item "blib"
146 Use MakeMaker\*(Aqs uninstalled version of a package
147 .IP builtin 12
148 .IX Item "builtin"
149 Import built\-in utility functions
150 .IP bytes 12
151 .IX Item "bytes"
152 Expose the individual bytes of characters
153 .IP charnames 12
154 .IX Item "charnames"
155 Access to Unicode character names and named character sequences; also define character names
156 .IP constant 12
157 .IX Item "constant"
158 Declare constants
159 .IP deprecate 12
160 .IX Item "deprecate"
161 Perl pragma for deprecating the inclusion of a module in core
162 .IP diagnostics 12
163 .IX Item "diagnostics"
164 Produce verbose warning diagnostics
165 .IP encoding 12
166 .IX Item "encoding"
167 Allows you to write your script in non\-ASCII and non\-UTF\-8
168 .IP encoding::warnings 12
169 .IX Item "encoding::warnings"
170 Warn on implicit encoding conversions
171 .IP experimental 12
172 .IX Item "experimental"
173 Experimental features made easy
174 .IP feature 12
175 .IX Item "feature"
176 Enable new features
177 .IP fields 12
178 .IX Item "fields"
179 Compile\-time class fields
180 .IP filetest 12
181 .IX Item "filetest"
182 Control the filetest permission operators
183 .IP if 12
184 .IX Item "if"
185 \&\f(CW\*(C`use\*(C'\fR a Perl module if a condition holds
186 .IP integer 12
187 .IX Item "integer"
188 Use integer arithmetic instead of floating point
189 .IP less 12
190 .IX Item "less"
191 Request less of something
192 .IP lib 12
193 .IX Item "lib"
194 Manipulate \f(CW@INC\fR at compile time
195 .IP locale 12
196 .IX Item "locale"
197 Use or avoid POSIX locales for built\-in operations
198 .IP mro 12
199 .IX Item "mro"
200 Method Resolution Order
201 .IP ok 12
202 .IX Item "ok"
203 Alternative to Test::More::use_ok
204 .IP open 12
205 .IX Item "open"
206 Set default PerlIO layers for input and output
207 .IP ops 12
208 .IX Item "ops"
209 Restrict unsafe operations when compiling
210 .IP overload 12
211 .IX Item "overload"
212 Package for overloading Perl operations
213 .IP overloading 12
214 .IX Item "overloading"
215 Lexically control overloading
216 .IP parent 12
217 .IX Item "parent"
218 Establish an ISA relationship with base classes at compile time
219 .IP re 12
220 .IX Item "re"
221 Alter regular expression behaviour
222 .IP sigtrap 12
223 .IX Item "sigtrap"
224 Enable simple signal handling
225 .IP sort 12
226 .IX Item "sort"
227 Control \fBsort()\fR behaviour
228 .IP source::encoding 12
229 .IX Item "source::encoding"
230 Declare Perl source code encoding
231 .IP stable 12
232 .IX Item "stable"
233 Experimental features made easy, once we know they\*(Aqre stable
234 .IP strict 12
235 .IX Item "strict"
236 Restrict unsafe constructs
237 .IP subs 12
238 .IX Item "subs"
239 Predeclare subroutine names
240 .IP threads 12
241 .IX Item "threads"
242 Perl interpreter\-based threads
243 .IP threads::shared 12
244 .IX Item "threads::shared"
245 Perl extension for sharing data structures between threads
246 .IP utf8 12
247 .IX Item "utf8"
248 Enable/disable UTF\-8 (or UTF\-EBCDIC) in source code
249 .IP vars 12
250 .IX Item "vars"
251 Predeclare global variable names
252 .IP version 12
253 .IX Item "version"
254 Perl extension for Version Objects
255 .IP vmsish 12
256 .IX Item "vmsish"
257 Control VMS\-specific language features
258 .IP warnings 12
259 .IX Item "warnings"
260 Control optional warnings
261 .IP warnings::register 12
262 .IX Item "warnings::register"
263 Warnings import function
264 .SS "Standard Modules"
265 .IX Subsection "Standard Modules"
266 Standard, bundled modules are all expected to behave in a well\-defined
267 manner with respect to namespace pollution because they use the
268 Exporter module. See their own documentation for details.
269 .PP
270 It\*(Aqs possible that not all modules listed below are installed on your
271 system. For example, the GDBM_File module will not be installed if you
272 don\*(Aqt have the gdbm library.
273 .IP Amiga::ARexx 12
274 .IX Item "Amiga::ARexx"
275 Perl extension for ARexx support
276 .IP Amiga::Exec 12
277 .IX Item "Amiga::Exec"
278 Perl extension for low level amiga support
279 .IP AnyDBM_File 12
280 .IX Item "AnyDBM_File"
281 Provide framework for multiple DBMs
282 .IP App::Cpan 12
283 .IX Item "App::Cpan"
284 Easily interact with CPAN from the command line
285 .IP App::Prove 12
286 .IX Item "App::Prove"
287 Implements the \f(CW\*(C`prove\*(C'\fR command.
288 .IP App::Prove::State 12
289 .IX Item "App::Prove::State"
290 State storage for the \f(CW\*(C`prove\*(C'\fR command.
291 .IP App::Prove::State::Result 12
292 .IX Item "App::Prove::State::Result"
293 Individual test suite results.
294 .IP App::Prove::State::Result::Test 12
295 .IX Item "App::Prove::State::Result::Test"
296 Individual test results.
297 .IP Archive::Tar 12
298 .IX Item "Archive::Tar"
299 Module for manipulations of tar archives
300 .IP Archive::Tar::File 12
301 .IX Item "Archive::Tar::File"
302 A subclass for in\-memory extracted file from Archive::Tar
303 .IP Attribute::Handlers 12
304 .IX Item "Attribute::Handlers"
305 Simpler definition of attribute handlers
306 .IP AutoLoader 12
307 .IX Item "AutoLoader"
308 Load subroutines only on demand
309 .IP AutoSplit 12
310 .IX Item "AutoSplit"
311 Split a package for autoloading
312 .IP B 12
313 .IX Item "B"
314 The Perl Compiler Backend
315 .IP B::Concise 12
316 .IX Item "B::Concise"
317 Walk Perl syntax tree, printing concise info about ops
318 .IP B::Deparse 12
319 .IX Item "B::Deparse"
320 Perl compiler backend to produce perl code
321 .IP B::Op_private 12
322 .IX Item "B::Op_private"
323 OP op_private flag definitions
324 .IP B::Showlex 12
325 .IX Item "B::Showlex"
326 Show lexical variables used in functions or files
327 .IP B::Terse 12
328 .IX Item "B::Terse"
329 Walk Perl syntax tree, printing terse info about ops
330 .IP B::Xref 12
331 .IX Item "B::Xref"
332 Generates cross reference reports for Perl programs
333 .IP Benchmark 12
334 .IX Item "Benchmark"
335 Benchmark running times of Perl code
336 .ie n .IP """IO::Socket::IP""" 12
337 .el .IP \f(CWIO::Socket::IP\fR 12
338 .IX Item "IO::Socket::IP"
339 Family\-neutral IP socket supporting both IPv4 and IPv6
340 .ie n .IP """Socket""" 12
341 .el .IP \f(CWSocket\fR 12
342 .IX Item "Socket"
343 Networking constants and support functions
344 .ie n .IP """Test2::Tools::Refcount""" 12
345 .el .IP \f(CWTest2::Tools::Refcount\fR 12
346 .IX Item "Test2::Tools::Refcount"
347 Assert reference counts on objects
348 .IP CORE 12
349 .IX Item "CORE"
350 Namespace for Perl\*(Aqs core routines
351 .IP CPAN 12
352 .IX Item "CPAN"
353 Query, download and build perl modules from CPAN sites
354 .IP CPAN::API::HOWTO 12
355 .IX Item "CPAN::API::HOWTO"
356 A recipe book for programming with CPAN.pm
357 .IP CPAN::Debug 12
358 .IX Item "CPAN::Debug"
359 Internal debugging for CPAN.pm
360 .IP CPAN::Distroprefs 12
361 .IX Item "CPAN::Distroprefs"
362 Read and match distroprefs
363 .IP CPAN::FirstTime 12
364 .IX Item "CPAN::FirstTime"
365 Utility for CPAN::Config file Initialization
366 .IP CPAN::HandleConfig 12
367 .IX Item "CPAN::HandleConfig"
368 Internal configuration handling for CPAN.pm
369 .IP CPAN::Kwalify 12
370 .IX Item "CPAN::Kwalify"
371 Interface between CPAN.pm and Kwalify.pm
372 .IP CPAN::Meta 12
373 .IX Item "CPAN::Meta"
374 The distribution metadata for a CPAN dist
375 .IP CPAN::Meta::Converter 12
376 .IX Item "CPAN::Meta::Converter"
377 Convert CPAN distribution metadata structures
378 .IP CPAN::Meta::Feature 12
379 .IX Item "CPAN::Meta::Feature"
380 An optional feature provided by a CPAN distribution
381 .IP CPAN::Meta::History 12
382 .IX Item "CPAN::Meta::History"
383 History of CPAN Meta Spec changes
384 .IP CPAN::Meta::History::Meta_1_0 12
385 .IX Item "CPAN::Meta::History::Meta_1_0"
386 Version 1.0 metadata specification for META.yml
387 .IP CPAN::Meta::History::Meta_1_1 12
388 .IX Item "CPAN::Meta::History::Meta_1_1"
389 Version 1.1 metadata specification for META.yml
390 .IP CPAN::Meta::History::Meta_1_2 12
391 .IX Item "CPAN::Meta::History::Meta_1_2"
392 Version 1.2 metadata specification for META.yml
393 .IP CPAN::Meta::History::Meta_1_3 12
394 .IX Item "CPAN::Meta::History::Meta_1_3"
395 Version 1.3 metadata specification for META.yml
396 .IP CPAN::Meta::History::Meta_1_4 12
397 .IX Item "CPAN::Meta::History::Meta_1_4"
398 Version 1.4 metadata specification for META.yml
399 .IP CPAN::Meta::Merge 12
400 .IX Item "CPAN::Meta::Merge"
401 Merging CPAN Meta fragments
402 .IP CPAN::Meta::Prereqs 12
403 .IX Item "CPAN::Meta::Prereqs"
404 A set of distribution prerequisites by phase and type
405 .IP CPAN::Meta::Requirements 12
406 .IX Item "CPAN::Meta::Requirements"
407 A set of version requirements for a CPAN dist
408 .IP CPAN::Meta::Requirements::Range 12
409 .IX Item "CPAN::Meta::Requirements::Range"
410 A set of version requirements for a CPAN dist
411 .IP CPAN::Meta::Spec 12
412 .IX Item "CPAN::Meta::Spec"
413 Specification for CPAN distribution metadata
414 .IP CPAN::Meta::Validator 12
415 .IX Item "CPAN::Meta::Validator"
416 Validate CPAN distribution metadata structures
417 .IP CPAN::Meta::YAML 12
418 .IX Item "CPAN::Meta::YAML"
419 Read and write a subset of YAML for CPAN Meta files
420 .IP CPAN::Nox 12
421 .IX Item "CPAN::Nox"
422 Wrapper around CPAN.pm without using any XS module
423 .IP CPAN::Plugin 12
424 .IX Item "CPAN::Plugin"
425 Base class for CPAN shell extensions
426 .IP CPAN::Plugin::Specfile 12
427 .IX Item "CPAN::Plugin::Specfile"
428 Proof of concept implementation of a trivial CPAN::Plugin
429 .IP CPAN::Queue 12
430 .IX Item "CPAN::Queue"
431 Internal queue support for CPAN.pm
432 .IP CPAN::Tarzip 12
433 .IX Item "CPAN::Tarzip"
434 Internal handling of tar archives for CPAN.pm
435 .IP CPAN::Version 12
436 .IX Item "CPAN::Version"
437 Utility functions to compare CPAN versions
438 .IP Carp 12
439 .IX Item "Carp"
440 Alternative warn and die for modules
441 .IP Class::Struct 12
442 .IX Item "Class::Struct"
443 Declare struct\-like datatypes as Perl classes
444 .IP Compress::Raw::Bzip2 12
445 .IX Item "Compress::Raw::Bzip2"
446 Low\-Level Interface to bzip2 compression library
447 .IP Compress::Raw::Zlib 12
448 .IX Item "Compress::Raw::Zlib"
449 Low\-Level Interface to zlib or zlib\-ng compression library
450 .IP Compress::Zlib 12
451 .IX Item "Compress::Zlib"
452 Interface to zlib compression library
453 .IP Config 12
454 .IX Item "Config"
455 Access Perl configuration information
456 .IP Config::Extensions 12
457 .IX Item "Config::Extensions"
458 Hash lookup of which core extensions were built.
459 .IP Config::Perl::V 12
460 .IX Item "Config::Perl::V"
461 Structured data retrieval of perl \-V output
462 .IP Cwd 12
463 .IX Item "Cwd"
464 Get pathname of current working directory
465 .IP DB 12
466 .IX Item "DB"
467 Programmatic interface to the Perl debugging API
468 .IP DBM_Filter 12
469 .IX Item "DBM_Filter"
470 Filter DBM keys/values
471 .IP DBM_Filter::compress 12
472 .IX Item "DBM_Filter::compress"
473 Filter for DBM_Filter
474 .IP DBM_Filter::encode 12
475 .IX Item "DBM_Filter::encode"
476 Filter for DBM_Filter
477 .IP DBM_Filter::int32 12
478 .IX Item "DBM_Filter::int32"
479 Filter for DBM_Filter
480 .IP DBM_Filter::null 12
481 .IX Item "DBM_Filter::null"
482 Filter for DBM_Filter
483 .IP DBM_Filter::utf8 12
484 .IX Item "DBM_Filter::utf8"
485 Filter for DBM_Filter
486 .IP DB_File 12
487 .IX Item "DB_File"
488 Perl5 access to Berkeley DB version 1.x
489 .IP Data::Dumper 12
490 .IX Item "Data::Dumper"
491 Stringified perl data structures, suitable for both printing and \f(CW\*(C`eval\*(C'\fR
492 .IP Devel::PPPort 12
493 .IX Item "Devel::PPPort"
494 Perl/Pollution/Portability
495 .IP Devel::Peek 12
496 .IX Item "Devel::Peek"
497 A data debugging tool for the XS programmer
498 .IP Devel::SelfStubber 12
499 .IX Item "Devel::SelfStubber"
500 Generate stubs for a SelfLoading module
501 .IP Digest 12
502 .IX Item "Digest"
503 Modules that calculate message digests
504 .IP Digest::MD5 12
505 .IX Item "Digest::MD5"
506 Perl interface to the MD5 Algorithm
507 .IP Digest::SHA 12
508 .IX Item "Digest::SHA"
509 Perl extension for SHA\-1/224/256/384/512
510 .IP Digest::base 12
511 .IX Item "Digest::base"
512 Digest base class
513 .IP Digest::file 12
514 .IX Item "Digest::file"
515 Calculate digests of files
516 .IP DirHandle 12
517 .IX Item "DirHandle"
518 (obsolete) supply object methods for directory handles
519 .IP Dumpvalue 12
520 .IX Item "Dumpvalue"
521 Provides screen dump of Perl data.
522 .IP DynaLoader 12
523 .IX Item "DynaLoader"
524 Dynamically load C libraries into Perl code
525 .IP Encode 12
526 .IX Item "Encode"
527 Character encodings in Perl
528 .IP Encode::Alias 12
529 .IX Item "Encode::Alias"
530 Alias definitions to encodings
531 .IP Encode::Byte 12
532 .IX Item "Encode::Byte"
533 Single Byte Encodings
534 .IP Encode::CJKConstants 12
535 .IX Item "Encode::CJKConstants"
536 Internally used by Encode::??::ISO_2022_*
537 .IP Encode::CN 12
538 .IX Item "Encode::CN"
539 China\-based Chinese Encodings
540 .IP Encode::CN::HZ 12
541 .IX Item "Encode::CN::HZ"
542 Internally used by Encode::CN
543 .IP Encode::Config 12
544 .IX Item "Encode::Config"
545 Internally used by Encode
546 .IP Encode::EBCDIC 12
547 .IX Item "Encode::EBCDIC"
548 EBCDIC Encodings
549 .IP Encode::Encoder 12
550 .IX Item "Encode::Encoder"
551 Object Oriented Encoder
552 .IP Encode::Encoding 12
553 .IX Item "Encode::Encoding"
554 Encode Implementation Base Class
555 .IP Encode::GSM0338 12
556 .IX Item "Encode::GSM0338"
557 ETSI GSM 03.38 Encoding
558 .IP Encode::Guess 12
559 .IX Item "Encode::Guess"
560 Guesses encoding from data
561 .IP Encode::JP 12
562 .IX Item "Encode::JP"
563 Japanese Encodings
564 .IP Encode::JP::H2Z 12
565 .IX Item "Encode::JP::H2Z"
566 Internally used by Encode::JP::2022_JP*
567 .IP Encode::JP::JIS7 12
568 .IX Item "Encode::JP::JIS7"
569 Internally used by Encode::JP
570 .IP Encode::KR 12
571 .IX Item "Encode::KR"
572 Korean Encodings
573 .IP Encode::KR::2022_KR 12
574 .IX Item "Encode::KR::2022_KR"
575 Internally used by Encode::KR
576 .IP Encode::MIME::Header 12
577 .IX Item "Encode::MIME::Header"
578 MIME encoding for an unstructured email header
579 .IP Encode::MIME::Name 12
580 .IX Item "Encode::MIME::Name"
581 Internally used by Encode
582 .IP Encode::PerlIO 12
583 .IX Item "Encode::PerlIO"
584 A detailed document on Encode and PerlIO
585 .IP Encode::Supported 12
586 .IX Item "Encode::Supported"
587 Encodings supported by Encode
588 .IP Encode::Symbol 12
589 .IX Item "Encode::Symbol"
590 Symbol Encodings
591 .IP Encode::TW 12
592 .IX Item "Encode::TW"
593 Taiwan\-based Chinese Encodings
594 .IP Encode::Unicode 12
595 .IX Item "Encode::Unicode"
596 Various Unicode Transformation Formats
597 .IP Encode::Unicode::UTF7 12
598 .IX Item "Encode::Unicode::UTF7"
599 UTF\-7 encoding
600 .IP English 12
601 .IX Item "English"
602 Use nice English (or awk) names for ugly punctuation variables
603 .IP Env 12
604 .IX Item "Env"
605 Perl module that imports environment variables as scalars or arrays
606 .IP Errno 12
607 .IX Item "Errno"
608 System errno constants
609 .IP Exporter 12
610 .IX Item "Exporter"
611 Implements default import method for modules
612 .IP Exporter::Heavy 12
613 .IX Item "Exporter::Heavy"
614 Exporter guts
615 .IP ExtUtils::CBuilder 12
616 .IX Item "ExtUtils::CBuilder"
617 Compile and link C code for Perl modules
618 .IP ExtUtils::CBuilder::Platform::Windows 12
619 .IX Item "ExtUtils::CBuilder::Platform::Windows"
620 Builder class for Windows platforms
621 .IP ExtUtils::Command 12
622 .IX Item "ExtUtils::Command"
623 Utilities to replace common UNIX commands in Makefiles etc.
624 .IP ExtUtils::Command::MM 12
625 .IX Item "ExtUtils::Command::MM"
626 Commands for the MM\*(Aqs to use in Makefiles
627 .IP ExtUtils::Constant 12
628 .IX Item "ExtUtils::Constant"
629 Generate XS code to import C header constants
630 .IP ExtUtils::Constant::Base 12
631 .IX Item "ExtUtils::Constant::Base"
632 Base class for ExtUtils::Constant objects
633 .IP ExtUtils::Constant::Utils 12
634 .IX Item "ExtUtils::Constant::Utils"
635 Helper functions for ExtUtils::Constant
636 .IP ExtUtils::Constant::XS 12
637 .IX Item "ExtUtils::Constant::XS"
638 Generate C code for XS modules\*(Aq constants.
639 .IP ExtUtils::Embed 12
640 .IX Item "ExtUtils::Embed"
641 Utilities for embedding Perl in C/C++ applications
642 .IP ExtUtils::Install 12
643 .IX Item "ExtUtils::Install"
644 Install files from here to there
645 .IP ExtUtils::Installed 12
646 .IX Item "ExtUtils::Installed"
647 Inventory management of installed modules
648 .IP ExtUtils::Liblist 12
649 .IX Item "ExtUtils::Liblist"
650 Determine libraries to use and how to use them
651 .IP ExtUtils::MM 12
652 .IX Item "ExtUtils::MM"
653 OS adjusted ExtUtils::MakeMaker subclass
654 .IP ExtUtils::MM_AIX 12
655 .IX Item "ExtUtils::MM_AIX"
656 AIX specific subclass of ExtUtils::MM_Unix
657 .IP ExtUtils::MM_Any 12
658 .IX Item "ExtUtils::MM_Any"
659 Platform\-agnostic MM methods
660 .IP ExtUtils::MM_BeOS 12
661 .IX Item "ExtUtils::MM_BeOS"
662 Methods to override UN*X behaviour in ExtUtils::MakeMaker
663 .IP ExtUtils::MM_Cygwin 12
664 .IX Item "ExtUtils::MM_Cygwin"
665 Methods to override UN*X behaviour in ExtUtils::MakeMaker
666 .IP ExtUtils::MM_DOS 12
667 .IX Item "ExtUtils::MM_DOS"
668 DOS specific subclass of ExtUtils::MM_Unix
669 .IP ExtUtils::MM_Darwin 12
670 .IX Item "ExtUtils::MM_Darwin"
671 Special behaviors for OS X
672 .IP ExtUtils::MM_MacOS 12
673 .IX Item "ExtUtils::MM_MacOS"
674 Once produced Makefiles for MacOS Classic
675 .IP ExtUtils::MM_NW5 12
676 .IX Item "ExtUtils::MM_NW5"
677 Methods to override UN*X behaviour in ExtUtils::MakeMaker
678 .IP ExtUtils::MM_OS2 12
679 .IX Item "ExtUtils::MM_OS2"
680 Methods to override UN*X behaviour in ExtUtils::MakeMaker
681 .IP ExtUtils::MM_OS390 12
682 .IX Item "ExtUtils::MM_OS390"
683 OS390 specific subclass of ExtUtils::MM_Unix
684 .IP ExtUtils::MM_QNX 12
685 .IX Item "ExtUtils::MM_QNX"
686 QNX specific subclass of ExtUtils::MM_Unix
687 .IP ExtUtils::MM_UWIN 12
688 .IX Item "ExtUtils::MM_UWIN"
689 U/WIN specific subclass of ExtUtils::MM_Unix
690 .IP ExtUtils::MM_Unix 12
691 .IX Item "ExtUtils::MM_Unix"
692 Methods used by ExtUtils::MakeMaker
693 .IP ExtUtils::MM_VMS 12
694 .IX Item "ExtUtils::MM_VMS"
695 Methods to override UN*X behaviour in ExtUtils::MakeMaker
696 .IP ExtUtils::MM_VOS 12
697 .IX Item "ExtUtils::MM_VOS"
698 VOS specific subclass of ExtUtils::MM_Unix
699 .IP ExtUtils::MM_Win32 12
700 .IX Item "ExtUtils::MM_Win32"
701 Methods to override UN*X behaviour in ExtUtils::MakeMaker
702 .IP ExtUtils::MM_Win95 12
703 .IX Item "ExtUtils::MM_Win95"
704 Method to customize MakeMaker for Win9X
705 .IP ExtUtils::MY 12
706 .IX Item "ExtUtils::MY"
707 ExtUtils::MakeMaker subclass for customization
708 .IP ExtUtils::MakeMaker 12
709 .IX Item "ExtUtils::MakeMaker"
710 Create a module Makefile
711 .IP ExtUtils::MakeMaker::Config 12
712 .IX Item "ExtUtils::MakeMaker::Config"
713 Wrapper around Config.pm
714 .IP ExtUtils::MakeMaker::FAQ 12
715 .IX Item "ExtUtils::MakeMaker::FAQ"
716 Frequently Asked Questions About MakeMaker
717 .IP ExtUtils::MakeMaker::Locale 12
718 .IX Item "ExtUtils::MakeMaker::Locale"
719 Bundled Encode::Locale
720 .IP ExtUtils::MakeMaker::Tutorial 12
721 .IX Item "ExtUtils::MakeMaker::Tutorial"
722 Writing a module with MakeMaker
723 .IP ExtUtils::Manifest 12
724 .IX Item "ExtUtils::Manifest"
725 Utilities to write and check a MANIFEST file
726 .IP ExtUtils::Miniperl 12
727 .IX Item "ExtUtils::Miniperl"
728 Write the C code for miniperlmain.c and perlmain.c
729 .IP ExtUtils::Mkbootstrap 12
730 .IX Item "ExtUtils::Mkbootstrap"
731 Make a bootstrap file for use by DynaLoader
732 .IP ExtUtils::Mksymlists 12
733 .IX Item "ExtUtils::Mksymlists"
734 Write linker options files for dynamic extension
735 .IP ExtUtils::PL2Bat 12
736 .IX Item "ExtUtils::PL2Bat"
737 Batch file creation to run perl scripts on Windows
738 .IP ExtUtils::Packlist 12
739 .IX Item "ExtUtils::Packlist"
740 Manage .packlist files
741 .IP ExtUtils::ParseXS 12
742 .IX Item "ExtUtils::ParseXS"
743 Converts Perl XS code into C code
744 .IP ExtUtils::ParseXS::Constants 12
745 .IX Item "ExtUtils::ParseXS::Constants"
746 Initialization values for some globals
747 .IP ExtUtils::ParseXS::Eval 12
748 .IX Item "ExtUtils::ParseXS::Eval"
749 Clean package to evaluate code in
750 .IP ExtUtils::ParseXS::Node 12
751 .IX Item "ExtUtils::ParseXS::Node"
752 Classes for nodes of an ExtUtils::ParseXS AST
753 .IP ExtUtils::ParseXS::Utilities 12
754 .IX Item "ExtUtils::ParseXS::Utilities"
755 Subroutines used with ExtUtils::ParseXS
756 .IP ExtUtils::Typemaps 12
757 .IX Item "ExtUtils::Typemaps"
758 Read/Write/Modify Perl/XS typemap files
759 .IP ExtUtils::Typemaps::Cmd 12
760 .IX Item "ExtUtils::Typemaps::Cmd"
761 Quick commands for handling typemaps
762 .IP ExtUtils::Typemaps::InputMap 12
763 .IX Item "ExtUtils::Typemaps::InputMap"
764 Entry in the INPUT section of a typemap
765 .IP ExtUtils::Typemaps::OutputMap 12
766 .IX Item "ExtUtils::Typemaps::OutputMap"
767 Entry in the OUTPUT section of a typemap
768 .IP ExtUtils::Typemaps::Type 12
769 .IX Item "ExtUtils::Typemaps::Type"
770 Entry in the TYPEMAP section of a typemap
771 .IP ExtUtils::XSSymSet 12
772 .IX Item "ExtUtils::XSSymSet"
773 Keep sets of symbol names palatable to the VMS linker
774 .IP ExtUtils::testlib 12
775 .IX Item "ExtUtils::testlib"
776 Add blib/* directories to \f(CW@INC\fR
777 .IP Fatal 12
778 .IX Item "Fatal"
779 Replace functions with equivalents which succeed or die
780 .IP Fcntl 12
781 .IX Item "Fcntl"
782 Various flag constants and helper functions from C\*(Aqs fcntl.h
783 .IP File::Basename 12
784 .IX Item "File::Basename"
785 Parse file paths into directory, filename and suffix.
786 .IP File::Compare 12
787 .IX Item "File::Compare"
788 Compare files or filehandles
789 .IP File::Copy 12
790 .IX Item "File::Copy"
791 Copy files or filehandles
792 .IP File::DosGlob 12
793 .IX Item "File::DosGlob"
794 DOS like globbing and then some
795 .IP File::Fetch 12
796 .IX Item "File::Fetch"
797 A generic file fetching mechanism
798 .IP File::Find 12
799 .IX Item "File::Find"
800 Traverse a directory tree.
801 .IP File::Glob 12
802 .IX Item "File::Glob"
803 Perl extension for BSD glob routine
804 .IP File::GlobMapper 12
805 .IX Item "File::GlobMapper"
806 Extend File Glob to Allow Input and Output Files
807 .IP File::Path 12
808 .IX Item "File::Path"
809 Create or remove directory trees
810 .IP File::Spec 12
811 .IX Item "File::Spec"
812 Portably perform operations on file names
813 .IP File::Spec::AmigaOS 12
814 .IX Item "File::Spec::AmigaOS"
815 File::Spec for AmigaOS
816 .IP File::Spec::Cygwin 12
817 .IX Item "File::Spec::Cygwin"
818 Methods for Cygwin file specs
819 .IP File::Spec::Epoc 12
820 .IX Item "File::Spec::Epoc"
821 Methods for Epoc file specs
822 .IP File::Spec::Functions 12
823 .IX Item "File::Spec::Functions"
824 Portably perform operations on file names
825 .IP File::Spec::Mac 12
826 .IX Item "File::Spec::Mac"
827 File::Spec for Mac OS (Classic)
828 .IP File::Spec::OS2 12
829 .IX Item "File::Spec::OS2"
830 Methods for OS/2 file specs
831 .IP File::Spec::Unix 12
832 .IX Item "File::Spec::Unix"
833 File::Spec for Unix, base for other File::Spec modules
834 .IP File::Spec::VMS 12
835 .IX Item "File::Spec::VMS"
836 Methods for VMS file specs
837 .IP File::Spec::Win32 12
838 .IX Item "File::Spec::Win32"
839 Methods for Win32 file specs
840 .IP File::Temp 12
841 .IX Item "File::Temp"
842 Return name and handle of a temporary file safely
843 .IP File::stat 12
844 .IX Item "File::stat"
845 By\-name interface to Perl\*(Aqs built\-in \fBstat()\fR functions
846 .IP FileCache 12
847 .IX Item "FileCache"
848 Keep more files open than the system permits
849 .IP FileHandle 12
850 .IX Item "FileHandle"
851 Supply object methods for filehandles
852 .IP Filter::Simple 12
853 .IX Item "Filter::Simple"
854 Simplified source filtering
855 .IP Filter::Util::Call 12
856 .IX Item "Filter::Util::Call"
857 Perl Source Filter Utility Module
858 .IP FindBin 12
859 .IX Item "FindBin"
860 Locate directory of original Perl script
861 .IP GDBM_File 12
862 .IX Item "GDBM_File"
863 Perl5 access to the gdbm library.
864 .IP Getopt::Long 12
865 .IX Item "Getopt::Long"
866 Extended processing of command line options
867 .IP Getopt::Long::Parser 12
868 .IX Item "Getopt::Long::Parser"
869 Getopt::Long object\-oriented interface
870 .IP Getopt::Std 12
871 .IX Item "Getopt::Std"
872 Process single\-character switches with switch clustering
873 .IP HTTP::Tiny 12
874 .IX Item "HTTP::Tiny"
875 A small, simple, correct HTTP/1.1 client
876 .IP Hash::Util 12
877 .IX Item "Hash::Util"
878 A selection of general\-utility hash subroutines
879 .IP Hash::Util::FieldHash 12
880 .IX Item "Hash::Util::FieldHash"
881 Support for Inside\-Out Classes
882 .IP I18N::Collate 12
883 .IX Item "I18N::Collate"
884 Compare 8\-bit scalar data according to the current locale
885 .IP I18N::LangTags 12
886 .IX Item "I18N::LangTags"
887 Functions for dealing with RFC3066\-style language tags
888 .IP I18N::LangTags::Detect 12
889 .IX Item "I18N::LangTags::Detect"
890 Detect the user\*(Aqs language preferences
891 .IP I18N::LangTags::List 12
892 .IX Item "I18N::LangTags::List"
893 Tags and names for human languages
894 .IP I18N::Langinfo 12
895 .IX Item "I18N::Langinfo"
896 Query locale information
897 .IP IO 12
898 .IX Item "IO"
899 Load various IO modules
900 .IP IO::Compress 12
901 .IX Item "IO::Compress"
902 Read/write compressed data in multiple formats
903 .IP IO::Compress::Base 12
904 .IX Item "IO::Compress::Base"
905 Base Class for IO::Compress modules
906 .IP IO::Compress::Bzip2 12
907 .IX Item "IO::Compress::Bzip2"
908 Write bzip2 files/buffers
909 .IP IO::Compress::Deflate 12
910 .IX Item "IO::Compress::Deflate"
911 Write RFC 1950 files/buffers
912 .IP IO::Compress::FAQ 12
913 .IX Item "IO::Compress::FAQ"
914 Frequently Asked Questions about IO::Compress
915 .IP IO::Compress::Gzip 12
916 .IX Item "IO::Compress::Gzip"
917 Write RFC 1952 files/buffers
918 .IP IO::Compress::RawDeflate 12
919 .IX Item "IO::Compress::RawDeflate"
920 Write RFC 1951 files/buffers
921 .IP IO::Compress::Zip 12
922 .IX Item "IO::Compress::Zip"
923 Write zip files/buffers
924 .IP IO::Dir 12
925 .IX Item "IO::Dir"
926 Supply object methods for directory handles
927 .IP IO::File 12
928 .IX Item "IO::File"
929 Supply object methods for filehandles
930 .IP IO::Handle 12
931 .IX Item "IO::Handle"
932 Supply object methods for I/O handles
933 .IP IO::Pipe 12
934 .IX Item "IO::Pipe"
935 Supply object methods for pipes
936 .IP IO::Poll 12
937 .IX Item "IO::Poll"
938 Object interface to system poll call
939 .IP IO::Seekable 12
940 .IX Item "IO::Seekable"
941 Supply seek based methods for I/O objects
942 .IP IO::Select 12
943 .IX Item "IO::Select"
944 OO interface to the \f(CW\*(C`select\*(C'\fR system call
945 .IP IO::Socket 12
946 .IX Item "IO::Socket"
947 Object interface to socket communications
948 .IP IO::Socket::INET 12
949 .IX Item "IO::Socket::INET"
950 Object interface for AF_INET domain sockets
951 .IP IO::Socket::UNIX 12
952 .IX Item "IO::Socket::UNIX"
953 Object interface for AF_UNIX domain sockets
954 .IP IO::Uncompress::AnyInflate 12
955 .IX Item "IO::Uncompress::AnyInflate"
956 Uncompress zlib\-based (zip, gzip) file/buffer
957 .IP IO::Uncompress::AnyUncompress 12
958 .IX Item "IO::Uncompress::AnyUncompress"
959 Uncompress gzip, zip, bzip2, zstd, xz, lzma, lzip, lzf or lzop file/buffer
960 .IP IO::Uncompress::Base 12
961 .IX Item "IO::Uncompress::Base"
962 Base Class for IO::Uncompress modules
963 .IP IO::Uncompress::Bunzip2 12
964 .IX Item "IO::Uncompress::Bunzip2"
965 Read bzip2 files/buffers
966 .IP IO::Uncompress::Gunzip 12
967 .IX Item "IO::Uncompress::Gunzip"
968 Read RFC 1952 files/buffers
969 .IP IO::Uncompress::Inflate 12
970 .IX Item "IO::Uncompress::Inflate"
971 Read RFC 1950 files/buffers
972 .IP IO::Uncompress::RawInflate 12
973 .IX Item "IO::Uncompress::RawInflate"
974 Read RFC 1951 files/buffers
975 .IP IO::Uncompress::Unzip 12
976 .IX Item "IO::Uncompress::Unzip"
977 Read zip files/buffers
978 .IP IO::Zlib 12
979 .IX Item "IO::Zlib"
980 IO:: style interface to Compress::Zlib
981 .IP IPC::Cmd 12
982 .IX Item "IPC::Cmd"
983 Finding and running system commands made easy
984 .IP IPC::Msg 12
985 .IX Item "IPC::Msg"
986 SysV Msg IPC object class
987 .IP IPC::Open2 12
988 .IX Item "IPC::Open2"
989 Open a process for both reading and writing using \fBopen2()\fR
990 .IP IPC::Open3 12
991 .IX Item "IPC::Open3"
992 Open a process for reading, writing, and error handling using \fBopen3()\fR
993 .IP IPC::Semaphore 12
994 .IX Item "IPC::Semaphore"
995 SysV Semaphore IPC object class
996 .IP IPC::SharedMem 12
997 .IX Item "IPC::SharedMem"
998 SysV Shared Memory IPC object class
999 .IP IPC::SysV 12
1000 .IX Item "IPC::SysV"
1001 System V IPC constants and system calls
1002 .IP Internals 12
1003 .IX Item "Internals"
1004 Reserved special namespace for internals related functions
1005 .IP JSON::PP 12
1006 .IX Item "JSON::PP"
1007 JSON::XS compatible pure\-Perl module.
1008 .IP JSON::PP::Boolean 12
1009 .IX Item "JSON::PP::Boolean"
1010 Dummy module providing JSON::PP::Boolean
1011 .IP List::Util 12
1012 .IX Item "List::Util"
1013 A selection of general\-utility list subroutines
1014 .IP List::Util::XS 12
1015 .IX Item "List::Util::XS"
1016 Indicate if List::Util was compiled with a C compiler
1017 .IP Locale::Maketext 12
1018 .IX Item "Locale::Maketext"
1019 Framework for localization
1020 .IP Locale::Maketext::Cookbook 12
1021 .IX Item "Locale::Maketext::Cookbook"
1022 Recipes for using Locale::Maketext
1023 .IP Locale::Maketext::Guts 12
1024 .IX Item "Locale::Maketext::Guts"
1025 Deprecated module to load Locale::Maketext utf8 code
1026 .IP Locale::Maketext::GutsLoader 12
1027 .IX Item "Locale::Maketext::GutsLoader"
1028 Deprecated module to load Locale::Maketext utf8 code
1029 .IP Locale::Maketext::Simple 12
1030 .IX Item "Locale::Maketext::Simple"
1031 Simple interface to Locale::Maketext::Lexicon
1032 .IP Locale::Maketext::TPJ13 12
1033 .IX Item "Locale::Maketext::TPJ13"
1034 Article about software localization
1035 .IP MIME::Base64 12
1036 .IX Item "MIME::Base64"
1037 Encoding and decoding of base64 strings
1038 .IP MIME::QuotedPrint 12
1039 .IX Item "MIME::QuotedPrint"
1040 Encoding and decoding of quoted\-printable strings
1041 .IP Math::BigFloat 12
1042 .IX Item "Math::BigFloat"
1043 Arbitrary size floating point math package
1044 .IP Math::BigInt 12
1045 .IX Item "Math::BigInt"
1046 Arbitrary size integer math package
1047 .IP Math::BigInt::Calc 12
1048 .IX Item "Math::BigInt::Calc"
1049 Pure Perl module to support Math::BigInt
1050 .IP Math::BigInt::FastCalc 12
1051 .IX Item "Math::BigInt::FastCalc"
1052 Math::BigInt::Calc with some XS for more speed
1053 .IP Math::BigInt::Lib 12
1054 .IX Item "Math::BigInt::Lib"
1055 Virtual parent class for Math::BigInt libraries
1056 .IP Math::BigRat 12
1057 .IX Item "Math::BigRat"
1058 Arbitrary size rational number math package
1059 .IP Math::Complex 12
1060 .IX Item "Math::Complex"
1061 Complex numbers and associated mathematical functions
1062 .IP Math::Trig 12
1063 .IX Item "Math::Trig"
1064 Trigonometric functions
1065 .IP Memoize 12
1066 .IX Item "Memoize"
1067 Make functions faster by trading space for time
1068 .IP Memoize::AnyDBM_File 12
1069 .IX Item "Memoize::AnyDBM_File"
1070 Glue to provide EXISTS for AnyDBM_File for Storable use
1071 .IP Memoize::Expire 12
1072 .IX Item "Memoize::Expire"
1073 Plug\-in module for automatic expiration of memoized values
1074 .IP Memoize::NDBM_File 12
1075 .IX Item "Memoize::NDBM_File"
1076 Glue to provide EXISTS for NDBM_File for Storable use
1077 .IP Memoize::SDBM_File 12
1078 .IX Item "Memoize::SDBM_File"
1079 DEPRECATED compatibility shim
1080 .IP Memoize::Storable 12
1081 .IX Item "Memoize::Storable"
1082 Store Memoized data in Storable database
1083 .IP Module::CoreList 12
1084 .IX Item "Module::CoreList"
1085 What modules shipped with versions of perl
1086 .IP Module::CoreList::Utils 12
1087 .IX Item "Module::CoreList::Utils"
1088 What utilities shipped with versions of perl
1089 .IP Module::Load 12
1090 .IX Item "Module::Load"
1091 Runtime require of both modules and files
1092 .IP Module::Load::Conditional 12
1093 .IX Item "Module::Load::Conditional"
1094 Looking up module information / loading at runtime
1095 .IP Module::Loaded 12
1096 .IX Item "Module::Loaded"
1097 Mark modules as loaded or unloaded
1098 .IP Module::Metadata 12
1099 .IX Item "Module::Metadata"
1100 Gather package and POD information from perl module files
1101 .IP NDBM_File 12
1102 .IX Item "NDBM_File"
1103 Tied access to ndbm files
1104 .IP NEXT 12
1105 .IX Item "NEXT"
1106 Provide a pseudo\-class NEXT (et al) that allows method redispatch
1107 .IP Net::Cmd 12
1108 .IX Item "Net::Cmd"
1109 Network Command class (as used by FTP, SMTP etc)
1110 .IP Net::Config 12
1111 .IX Item "Net::Config"
1112 Local configuration data for libnet
1113 .IP Net::Domain 12
1114 .IX Item "Net::Domain"
1115 Attempt to evaluate the current host\*(Aqs internet name and domain
1116 .IP Net::FTP 12
1117 .IX Item "Net::FTP"
1118 FTP Client class
1119 .IP Net::FTP::dataconn 12
1120 .IX Item "Net::FTP::dataconn"
1121 FTP Client data connection class
1122 .IP Net::NNTP 12
1123 .IX Item "Net::NNTP"
1124 NNTP Client class
1125 .IP Net::Netrc 12
1126 .IX Item "Net::Netrc"
1127 OO interface to users netrc file
1128 .IP Net::POP3 12
1129 .IX Item "Net::POP3"
1130 Post Office Protocol 3 Client class (RFC1939)
1131 .IP Net::Ping 12
1132 .IX Item "Net::Ping"
1133 Check a remote host for reachability
1134 .IP Net::SMTP 12
1135 .IX Item "Net::SMTP"
1136 Simple Mail Transfer Protocol Client
1137 .IP Net::Time 12
1138 .IX Item "Net::Time"
1139 Time and daytime network client interface
1140 .IP Net::hostent 12
1141 .IX Item "Net::hostent"
1142 By\-name interface to Perl\*(Aqs built\-in gethost*() functions
1143 .IP Net::libnetFAQ 12
1144 .IX Item "Net::libnetFAQ"
1145 Libnet Frequently Asked Questions
1146 .IP Net::netent 12
1147 .IX Item "Net::netent"
1148 By\-name interface to Perl\*(Aqs built\-in getnet*() functions
1149 .IP Net::protoent 12
1150 .IX Item "Net::protoent"
1151 By\-name interface to Perl\*(Aqs built\-in getproto*() functions
1152 .IP Net::servent 12
1153 .IX Item "Net::servent"
1154 By\-name interface to Perl\*(Aqs built\-in getserv*() functions
1155 .IP O 12
1156 .IX Item "O"
1157 Generic interface to Perl Compiler backends
1158 .IP ODBM_File 12
1159 .IX Item "ODBM_File"
1160 Tied access to odbm files
1161 .IP Opcode 12
1162 .IX Item "Opcode"
1163 Disable named opcodes when compiling perl code
1164 .IP POSIX 12
1165 .IX Item "POSIX"
1166 Perl interface to IEEE Std 1003.1
1167 .IP Params::Check 12
1168 .IX Item "Params::Check"
1169 A generic input parsing/checking mechanism.
1170 .IP Parse::CPAN::Meta 12
1171 .IX Item "Parse::CPAN::Meta"
1172 Parse META.yml and META.json CPAN metadata files
1173 .IP Perl::OSType 12
1174 .IX Item "Perl::OSType"
1175 Map Perl operating system names to generic types
1176 .IP PerlIO 12
1177 .IX Item "PerlIO"
1178 On demand loader for PerlIO layers and root of PerlIO::* name space
1179 .IP PerlIO::encoding 12
1180 .IX Item "PerlIO::encoding"
1181 Encoding layer
1182 .IP PerlIO::mmap 12
1183 .IX Item "PerlIO::mmap"
1184 Memory mapped IO
1185 .IP PerlIO::scalar 12
1186 .IX Item "PerlIO::scalar"
1187 In\-memory IO, scalar IO
1188 .IP PerlIO::via 12
1189 .IX Item "PerlIO::via"
1190 Helper class for PerlIO layers implemented in perl
1191 .IP PerlIO::via::QuotedPrint 12
1192 .IX Item "PerlIO::via::QuotedPrint"
1193 PerlIO layer for quoted\-printable strings
1194 .IP Pod::Checker 12
1195 .IX Item "Pod::Checker"
1196 Check pod documents for syntax errors
1197 .IP Pod::Escapes 12
1198 .IX Item "Pod::Escapes"
1199 For resolving Pod E<...> sequences
1200 .IP Pod::Functions 12
1201 .IX Item "Pod::Functions"
1202 Group Perl\*(Aqs functions a la perlfunc.pod
1203 .IP Pod::Html 12
1204 .IX Item "Pod::Html"
1205 Module to convert pod files to HTML
1206 .IP Pod::Html::Util 12
1207 .IX Item "Pod::Html::Util"
1208 Helper functions for Pod\-Html
1209 .IP Pod::Man 12
1210 .IX Item "Pod::Man"
1211 Convert POD data to formatted *roff input
1212 .IP Pod::ParseLink 12
1213 .IX Item "Pod::ParseLink"
1214 Parse an L<> formatting code in POD text
1215 .IP Pod::Perldoc 12
1216 .IX Item "Pod::Perldoc"
1217 Look up Perl documentation in Pod format.
1218 .IP Pod::Perldoc::BaseTo 12
1219 .IX Item "Pod::Perldoc::BaseTo"
1220 Base for Pod::Perldoc formatters
1221 .IP Pod::Perldoc::GetOptsOO 12
1222 .IX Item "Pod::Perldoc::GetOptsOO"
1223 Customized option parser for Pod::Perldoc
1224 .IP Pod::Perldoc::ToANSI 12
1225 .IX Item "Pod::Perldoc::ToANSI"
1226 Render Pod with ANSI color escapes
1227 .IP Pod::Perldoc::ToChecker 12
1228 .IX Item "Pod::Perldoc::ToChecker"
1229 Let Perldoc check Pod for errors
1230 .IP Pod::Perldoc::ToMan 12
1231 .IX Item "Pod::Perldoc::ToMan"
1232 Let Perldoc render Pod as man pages
1233 .IP Pod::Perldoc::ToNroff 12
1234 .IX Item "Pod::Perldoc::ToNroff"
1235 Let Perldoc convert Pod to nroff
1236 .IP Pod::Perldoc::ToPod 12
1237 .IX Item "Pod::Perldoc::ToPod"
1238 Let Perldoc render Pod as ... Pod!
1239 .IP Pod::Perldoc::ToRtf 12
1240 .IX Item "Pod::Perldoc::ToRtf"
1241 Let Perldoc render Pod as RTF
1242 .IP Pod::Perldoc::ToTerm 12
1243 .IX Item "Pod::Perldoc::ToTerm"
1244 Render Pod with terminal escapes
1245 .IP Pod::Perldoc::ToText 12
1246 .IX Item "Pod::Perldoc::ToText"
1247 Let Perldoc render Pod as plaintext
1248 .IP Pod::Perldoc::ToTk 12
1249 .IX Item "Pod::Perldoc::ToTk"
1250 Let Perldoc use Tk::Pod to render Pod
1251 .IP Pod::Perldoc::ToXml 12
1252 .IX Item "Pod::Perldoc::ToXml"
1253 Let Perldoc render Pod as XML
1254 .IP Pod::Simple 12
1255 .IX Item "Pod::Simple"
1256 Framework for parsing Pod
1257 .IP Pod::Simple::Checker 12
1258 .IX Item "Pod::Simple::Checker"
1259 Check the Pod syntax of a document
1260 .IP Pod::Simple::Debug 12
1261 .IX Item "Pod::Simple::Debug"
1262 Put Pod::Simple into trace/debug mode
1263 .IP Pod::Simple::DumpAsText 12
1264 .IX Item "Pod::Simple::DumpAsText"
1265 Dump Pod\-parsing events as text
1266 .IP Pod::Simple::DumpAsXML 12
1267 .IX Item "Pod::Simple::DumpAsXML"
1268 Turn Pod into XML
1269 .IP Pod::Simple::HTML 12
1270 .IX Item "Pod::Simple::HTML"
1271 Convert Pod to HTML
1272 .IP Pod::Simple::HTMLBatch 12
1273 .IX Item "Pod::Simple::HTMLBatch"
1274 Convert several Pod files to several HTML files
1275 .IP Pod::Simple::JustPod 12
1276 .IX Item "Pod::Simple::JustPod"
1277 Just the Pod, the whole Pod, and nothing but the Pod
1278 .IP Pod::Simple::LinkSection 12
1279 .IX Item "Pod::Simple::LinkSection"
1280 Represent "section" attributes of L codes
1281 .IP Pod::Simple::Methody 12
1282 .IX Item "Pod::Simple::Methody"
1283 Turn Pod::Simple events into method calls
1284 .IP Pod::Simple::PullParser 12
1285 .IX Item "Pod::Simple::PullParser"
1286 A pull\-parser interface to parsing Pod
1287 .IP Pod::Simple::PullParserEndToken 12
1288 .IX Item "Pod::Simple::PullParserEndToken"
1289 End\-tokens from Pod::Simple::PullParser
1290 .IP Pod::Simple::PullParserStartToken 12
1291 .IX Item "Pod::Simple::PullParserStartToken"
1292 Start\-tokens from Pod::Simple::PullParser
1293 .IP Pod::Simple::PullParserTextToken 12
1294 .IX Item "Pod::Simple::PullParserTextToken"
1295 Text\-tokens from Pod::Simple::PullParser
1296 .IP Pod::Simple::PullParserToken 12
1297 .IX Item "Pod::Simple::PullParserToken"
1298 Tokens from Pod::Simple::PullParser
1299 .IP Pod::Simple::RTF 12
1300 .IX Item "Pod::Simple::RTF"
1301 Format Pod as RTF
1302 .IP Pod::Simple::Search 12
1303 .IX Item "Pod::Simple::Search"
1304 Find POD documents in directory trees
1305 .IP Pod::Simple::SimpleTree 12
1306 .IX Item "Pod::Simple::SimpleTree"
1307 Parse Pod into a simple parse tree
1308 .IP Pod::Simple::Subclassing 12
1309 .IX Item "Pod::Simple::Subclassing"
1310 Write a formatter as a Pod::Simple subclass
1311 .IP Pod::Simple::Text 12
1312 .IX Item "Pod::Simple::Text"
1313 Format Pod as plaintext
1314 .IP Pod::Simple::TextContent 12
1315 .IX Item "Pod::Simple::TextContent"
1316 Get the text content of Pod
1317 .IP Pod::Simple::XHTML 12
1318 .IX Item "Pod::Simple::XHTML"
1319 Format Pod as validating XHTML
1320 .IP Pod::Simple::XMLOutStream 12
1321 .IX Item "Pod::Simple::XMLOutStream"
1322 Turn Pod into XML
1323 .IP Pod::Text 12
1324 .IX Item "Pod::Text"
1325 Convert POD data to formatted text
1326 .IP Pod::Text::Color 12
1327 .IX Item "Pod::Text::Color"
1328 Convert POD data to formatted color ASCII text
1329 .IP Pod::Text::Overstrike 12
1330 .IX Item "Pod::Text::Overstrike"
1331 Convert POD data to formatted overstrike text
1332 .IP Pod::Text::Termcap 12
1333 .IX Item "Pod::Text::Termcap"
1334 Convert POD data to ASCII text with format escapes
1335 .IP Pod::Usage 12
1336 .IX Item "Pod::Usage"
1337 Extracts POD documentation and shows usage information
1338 .IP SDBM_File 12
1339 .IX Item "SDBM_File"
1340 Tied access to sdbm files
1341 .IP Safe 12
1342 .IX Item "Safe"
1343 Compile and execute code in restricted compartments
1344 .IP Scalar::List::Utils 12
1345 .IX Item "Scalar::List::Utils"
1346 A distribution of general\-utility subroutines
1347 .IP Scalar::Util 12
1348 .IX Item "Scalar::Util"
1349 A selection of general\-utility scalar subroutines
1350 .IP Search::Dict 12
1351 .IX Item "Search::Dict"
1352 Look \- search for key in dictionary file
1353 .IP SelectSaver 12
1354 .IX Item "SelectSaver"
1355 Save and restore selected file handle
1356 .IP SelfLoader 12
1357 .IX Item "SelfLoader"
1358 Load functions only on demand
1359 .IP Storable 12
1360 .IX Item "Storable"
1361 Persistence for Perl data structures
1362 .IP Sub::Util 12
1363 .IX Item "Sub::Util"
1364 A selection of utility subroutines for subs and CODE references
1365 .IP Symbol 12
1366 .IX Item "Symbol"
1367 Manipulate Perl symbols and their names
1368 .IP Sys::Hostname 12
1369 .IX Item "Sys::Hostname"
1370 Try every conceivable way to get hostname
1371 .IP Sys::Syslog 12
1372 .IX Item "Sys::Syslog"
1373 Perl interface to the UNIX \fBsyslog\fR\|(3) calls
1374 .IP Sys::Syslog::Win32 12
1375 .IX Item "Sys::Syslog::Win32"
1376 Win32 support for Sys::Syslog
1377 .IP TAP::Base 12
1378 .IX Item "TAP::Base"
1379 Base class that provides common functionality to TAP::Parser
1380 .IP TAP::Formatter::Base 12
1381 .IX Item "TAP::Formatter::Base"
1382 Base class for harness output delegates
1383 .IP TAP::Formatter::Color 12
1384 .IX Item "TAP::Formatter::Color"
1385 Run Perl test scripts with color
1386 .IP TAP::Formatter::Console 12
1387 .IX Item "TAP::Formatter::Console"
1388 Harness output delegate for default console output
1389 .IP TAP::Formatter::Console::ParallelSession 12
1390 .IX Item "TAP::Formatter::Console::ParallelSession"
1391 Harness output delegate for parallel console output
1392 .IP TAP::Formatter::Console::Session 12
1393 .IX Item "TAP::Formatter::Console::Session"
1394 Harness output delegate for default console output
1395 .IP TAP::Formatter::File 12
1396 .IX Item "TAP::Formatter::File"
1397 Harness output delegate for file output
1398 .IP TAP::Formatter::File::Session 12
1399 .IX Item "TAP::Formatter::File::Session"
1400 Harness output delegate for file output
1401 .IP TAP::Formatter::Session 12
1402 .IX Item "TAP::Formatter::Session"
1403 Abstract base class for harness output delegate
1404 .IP TAP::Harness 12
1405 .IX Item "TAP::Harness"
1406 Run test scripts with statistics
1407 .IP TAP::Harness::Env 12
1408 .IX Item "TAP::Harness::Env"
1409 Parsing harness related environmental variables where appropriate
1410 .IP TAP::Object 12
1411 .IX Item "TAP::Object"
1412 Base class that provides common functionality to all \f(CW\*(C`TAP::*\*(C'\fR modules
1413 .IP TAP::Parser 12
1414 .IX Item "TAP::Parser"
1415 Parse TAP output
1416 .IP TAP::Parser::Aggregator 12
1417 .IX Item "TAP::Parser::Aggregator"
1418 Aggregate TAP::Parser results
1419 .IP TAP::Parser::Grammar 12
1420 .IX Item "TAP::Parser::Grammar"
1421 A grammar for the Test Anything Protocol.
1422 .IP TAP::Parser::Iterator 12
1423 .IX Item "TAP::Parser::Iterator"
1424 Base class for TAP source iterators
1425 .IP TAP::Parser::Iterator::Array 12
1426 .IX Item "TAP::Parser::Iterator::Array"
1427 Iterator for array\-based TAP sources
1428 .IP TAP::Parser::Iterator::Process 12
1429 .IX Item "TAP::Parser::Iterator::Process"
1430 Iterator for process\-based TAP sources
1431 .IP TAP::Parser::Iterator::Stream 12
1432 .IX Item "TAP::Parser::Iterator::Stream"
1433 Iterator for filehandle\-based TAP sources
1434 .IP TAP::Parser::IteratorFactory 12
1435 .IX Item "TAP::Parser::IteratorFactory"
1436 Figures out which SourceHandler objects to use for a given Source
1437 .IP TAP::Parser::Multiplexer 12
1438 .IX Item "TAP::Parser::Multiplexer"
1439 Multiplex multiple TAP::Parsers
1440 .IP TAP::Parser::Result 12
1441 .IX Item "TAP::Parser::Result"
1442 Base class for TAP::Parser output objects
1443 .IP TAP::Parser::Result::Bailout 12
1444 .IX Item "TAP::Parser::Result::Bailout"
1445 Bailout result token.
1446 .IP TAP::Parser::Result::Comment 12
1447 .IX Item "TAP::Parser::Result::Comment"
1448 Comment result token.
1449 .IP TAP::Parser::Result::Plan 12
1450 .IX Item "TAP::Parser::Result::Plan"
1451 Plan result token.
1452 .IP TAP::Parser::Result::Pragma 12
1453 .IX Item "TAP::Parser::Result::Pragma"
1454 TAP pragma token.
1455 .IP TAP::Parser::Result::Test 12
1456 .IX Item "TAP::Parser::Result::Test"
1457 Test result token.
1458 .IP TAP::Parser::Result::Unknown 12
1459 .IX Item "TAP::Parser::Result::Unknown"
1460 Unknown result token.
1461 .IP TAP::Parser::Result::Version 12
1462 .IX Item "TAP::Parser::Result::Version"
1463 TAP syntax version token.
1464 .IP TAP::Parser::Result::YAML 12
1465 .IX Item "TAP::Parser::Result::YAML"
1466 YAML result token.
1467 .IP TAP::Parser::ResultFactory 12
1468 .IX Item "TAP::Parser::ResultFactory"
1469 Factory for creating TAP::Parser output objects
1470 .IP TAP::Parser::Scheduler 12
1471 .IX Item "TAP::Parser::Scheduler"
1472 Schedule tests during parallel testing
1473 .IP TAP::Parser::Scheduler::Job 12
1474 .IX Item "TAP::Parser::Scheduler::Job"
1475 A single testing job.
1476 .IP TAP::Parser::Scheduler::Spinner 12
1477 .IX Item "TAP::Parser::Scheduler::Spinner"
1478 A no\-op job.
1479 .IP TAP::Parser::Source 12
1480 .IX Item "TAP::Parser::Source"
1481 A TAP source & meta data about it
1482 .IP TAP::Parser::SourceHandler 12
1483 .IX Item "TAP::Parser::SourceHandler"
1484 Base class for different TAP source handlers
1485 .IP TAP::Parser::SourceHandler::Executable 12
1486 .IX Item "TAP::Parser::SourceHandler::Executable"
1487 Stream output from an executable TAP source
1488 .IP TAP::Parser::SourceHandler::File 12
1489 .IX Item "TAP::Parser::SourceHandler::File"
1490 Stream TAP from a text file.
1491 .IP TAP::Parser::SourceHandler::Handle 12
1492 .IX Item "TAP::Parser::SourceHandler::Handle"
1493 Stream TAP from an IO::Handle or a GLOB.
1494 .IP TAP::Parser::SourceHandler::Perl 12
1495 .IX Item "TAP::Parser::SourceHandler::Perl"
1496 Stream TAP from a Perl executable
1497 .IP TAP::Parser::SourceHandler::RawTAP 12
1498 .IX Item "TAP::Parser::SourceHandler::RawTAP"
1499 Stream output from raw TAP in a scalar/array ref.
1500 .IP TAP::Parser::YAMLish::Reader 12
1501 .IX Item "TAP::Parser::YAMLish::Reader"
1502 Read YAMLish data from iterator
1503 .IP TAP::Parser::YAMLish::Writer 12
1504 .IX Item "TAP::Parser::YAMLish::Writer"
1505 Write YAMLish data
1506 .IP Term::ANSIColor 12
1507 .IX Item "Term::ANSIColor"
1508 Color screen output using ANSI escape sequences
1509 .IP Term::Cap 12
1510 .IX Item "Term::Cap"
1511 Perl termcap interface
1512 .IP Term::Complete 12
1513 .IX Item "Term::Complete"
1514 Perl word completion module
1515 .IP Term::ReadLine 12
1516 .IX Item "Term::ReadLine"
1517 Perl interface to various \f(CW\*(C`readline\*(C'\fR packages.
1518 .IP Term::Table 12
1519 .IX Item "Term::Table"
1520 Format a header and rows into a table
1521 .IP Term::Table::Cell 12
1522 .IX Item "Term::Table::Cell"
1523 Representation of a cell in a table.
1524 .IP Term::Table::CellStack 12
1525 .IX Item "Term::Table::CellStack"
1526 Combine several cells into one (vertical)
1527 .IP Term::Table::HashBase 12
1528 .IX Item "Term::Table::HashBase"
1529 Build hash based classes.
1530 .IP Term::Table::LineBreak 12
1531 .IX Item "Term::Table::LineBreak"
1532 Break up lines for use in tables.
1533 .IP Term::Table::Util 12
1534 .IX Item "Term::Table::Util"
1535 Utilities for Term::Table.
1536 .IP Test 12
1537 .IX Item "Test"
1538 Provides a simple framework for writing test scripts
1539 .IP Test2 12
1540 .IX Item "Test2"
1541 Framework for writing test tools that all work together.
1542 .IP Test2::API 12
1543 .IX Item "Test2::API"
1544 Primary interface for writing Test2 based testing tools.
1545 .IP Test2::API::Breakage 12
1546 .IX Item "Test2::API::Breakage"
1547 What breaks at what version
1548 .IP Test2::API::Context 12
1549 .IX Item "Test2::API::Context"
1550 Object to represent a testing context.
1551 .IP Test2::API::Instance 12
1552 .IX Item "Test2::API::Instance"
1553 Object used by Test2::API under the hood
1554 .IP Test2::API::InterceptResult 12
1555 .IX Item "Test2::API::InterceptResult"
1556 Representation of a list of events.
1557 .IP Test2::API::InterceptResult::Event 12
1558 .IX Item "Test2::API::InterceptResult::Event"
1559 Representation of an event for use in
1560 .IP Test2::API::InterceptResult::Hub 12
1561 .IX Item "Test2::API::InterceptResult::Hub"
1562 Hub used by InterceptResult.
1563 .IP Test2::API::InterceptResult::Squasher 12
1564 .IX Item "Test2::API::InterceptResult::Squasher"
1565 Encapsulation of the algorithm that
1566 .IP Test2::API::Stack 12
1567 .IX Item "Test2::API::Stack"
1568 Object to manage a stack of Test2::Hub
1569 .IP Test2::AsyncSubtest 12
1570 .IX Item "Test2::AsyncSubtest"
1571 Object representing an async subtest.
1572 .IP Test2::AsyncSubtest::Event::Attach 12
1573 .IX Item "Test2::AsyncSubtest::Event::Attach"
1574 Event to attach a subtest to the parent.
1575 .IP Test2::AsyncSubtest::Event::Detach 12
1576 .IX Item "Test2::AsyncSubtest::Event::Detach"
1577 Event to detach a subtest from the parent.
1578 .IP Test2::AsyncSubtest::Hub 12
1579 .IX Item "Test2::AsyncSubtest::Hub"
1580 Hub used by async subtests.
1581 .IP Test2::Bundle 12
1582 .IX Item "Test2::Bundle"
1583 Documentation for bundles.
1584 .IP Test2::Bundle::Extended 12
1585 .IX Item "Test2::Bundle::Extended"
1586 Old name for Test2::V0
1587 .IP Test2::Bundle::More 12
1588 .IX Item "Test2::Bundle::More"
1589 ALMOST a drop\-in replacement for Test::More.
1590 .IP Test2::Bundle::Simple 12
1591 .IX Item "Test2::Bundle::Simple"
1592 ALMOST a drop\-in replacement for Test::Simple.
1593 .IP Test2::Compare 12
1594 .IX Item "Test2::Compare"
1595 Test2 extension for writing deep comparison tools.
1596 .IP Test2::Compare::Array 12
1597 .IX Item "Test2::Compare::Array"
1598 Internal representation of an array comparison.
1599 .IP Test2::Compare::Bag 12
1600 .IX Item "Test2::Compare::Bag"
1601 Internal representation of a bag comparison.
1602 .IP Test2::Compare::Base 12
1603 .IX Item "Test2::Compare::Base"
1604 Base class for comparison classes.
1605 .IP Test2::Compare::Bool 12
1606 .IX Item "Test2::Compare::Bool"
1607 Compare two values as booleans
1608 .IP Test2::Compare::Custom 12
1609 .IX Item "Test2::Compare::Custom"
1610 Custom field check for comparisons.
1611 .IP Test2::Compare::DeepRef 12
1612 .IX Item "Test2::Compare::DeepRef"
1613 Ref comparison
1614 .IP Test2::Compare::Delta 12
1615 .IX Item "Test2::Compare::Delta"
1616 Representation of differences between nested data
1617 .IP Test2::Compare::Event 12
1618 .IX Item "Test2::Compare::Event"
1619 Event specific Object subclass.
1620 .IP Test2::Compare::EventMeta 12
1621 .IX Item "Test2::Compare::EventMeta"
1622 Meta class for events in deep comparisons
1623 .IP Test2::Compare::Float 12
1624 .IX Item "Test2::Compare::Float"
1625 Compare two values as numbers with tolerance.
1626 .IP Test2::Compare::Hash 12
1627 .IX Item "Test2::Compare::Hash"
1628 Representation of a hash in a deep comparison.
1629 .IP Test2::Compare::Isa 12
1630 .IX Item "Test2::Compare::Isa"
1631 Check if the value is an instance of the class.
1632 .IP Test2::Compare::Meta 12
1633 .IX Item "Test2::Compare::Meta"
1634 Check library for meta\-checks
1635 .IP Test2::Compare::Negatable 12
1636 .IX Item "Test2::Compare::Negatable"
1637 Poor mans \*(Aqrole\*(Aq for compare objects that can be negated.
1638 .IP Test2::Compare::Number 12
1639 .IX Item "Test2::Compare::Number"
1640 Compare two values as numbers
1641 .IP Test2::Compare::Object 12
1642 .IX Item "Test2::Compare::Object"
1643 Representation of an object during deep
1644 .IP Test2::Compare::OrderedSubset 12
1645 .IX Item "Test2::Compare::OrderedSubset"
1646 Internal representation of an ordered subset.
1647 .IP Test2::Compare::Pattern 12
1648 .IX Item "Test2::Compare::Pattern"
1649 Use a pattern to validate values in a deep
1650 .IP Test2::Compare::Ref 12
1651 .IX Item "Test2::Compare::Ref"
1652 Ref comparison
1653 .IP Test2::Compare::Regex 12
1654 .IX Item "Test2::Compare::Regex"
1655 Regex direct comparison
1656 .IP Test2::Compare::Scalar 12
1657 .IX Item "Test2::Compare::Scalar"
1658 Representation of a Scalar Ref in deep
1659 .IP Test2::Compare::Set 12
1660 .IX Item "Test2::Compare::Set"
1661 Allows a field to be matched against a set of
1662 .IP Test2::Compare::String 12
1663 .IX Item "Test2::Compare::String"
1664 Compare two values as strings
1665 .IP Test2::Compare::Undef 12
1666 .IX Item "Test2::Compare::Undef"
1667 Check that something is undefined
1668 .IP Test2::Compare::Wildcard 12
1669 .IX Item "Test2::Compare::Wildcard"
1670 Placeholder check.
1671 .IP Test2::Env 12
1672 .IX Item "Test2::Env"
1673 Documentation for environment variables used or set by Test2.
1674 .IP Test2::Event 12
1675 .IX Item "Test2::Event"
1676 Base class for events
1677 .IP Test2::Event::Bail 12
1678 .IX Item "Test2::Event::Bail"
1679 Bailout!
1680 .IP Test2::Event::Diag 12
1681 .IX Item "Test2::Event::Diag"
1682 Diag event type
1683 .IP Test2::Event::Encoding 12
1684 .IX Item "Test2::Event::Encoding"
1685 Set the encoding for the output stream
1686 .IP Test2::Event::Exception 12
1687 .IX Item "Test2::Event::Exception"
1688 Exception event
1689 .IP Test2::Event::Fail 12
1690 .IX Item "Test2::Event::Fail"
1691 Event for a simple failed assertion
1692 .IP Test2::Event::Generic 12
1693 .IX Item "Test2::Event::Generic"
1694 Generic event type.
1695 .IP Test2::Event::Note 12
1696 .IX Item "Test2::Event::Note"
1697 Note event type
1698 .IP Test2::Event::Ok 12
1699 .IX Item "Test2::Event::Ok"
1700 Ok event type
1701 .IP Test2::Event::Pass 12
1702 .IX Item "Test2::Event::Pass"
1703 Event for a simple passing assertion
1704 .IP Test2::Event::Plan 12
1705 .IX Item "Test2::Event::Plan"
1706 The event of a plan
1707 .IP Test2::Event::Skip 12
1708 .IX Item "Test2::Event::Skip"
1709 Skip event type
1710 .IP Test2::Event::Subtest 12
1711 .IX Item "Test2::Event::Subtest"
1712 Event for subtest types
1713 .IP Test2::Event::TAP::Version 12
1714 .IX Item "Test2::Event::TAP::Version"
1715 Event for TAP version.
1716 .IP Test2::Event::V2 12
1717 .IX Item "Test2::Event::V2"
1718 Second generation event.
1719 .IP Test2::Event::Waiting 12
1720 .IX Item "Test2::Event::Waiting"
1721 Tell all procs/threads it is time to be done
1722 .IP Test2::EventFacet 12
1723 .IX Item "Test2::EventFacet"
1724 Base class for all event facets.
1725 .IP Test2::EventFacet::About 12
1726 .IX Item "Test2::EventFacet::About"
1727 Facet with event details.
1728 .IP Test2::EventFacet::Amnesty 12
1729 .IX Item "Test2::EventFacet::Amnesty"
1730 Facet for assertion amnesty.
1731 .IP Test2::EventFacet::Assert 12
1732 .IX Item "Test2::EventFacet::Assert"
1733 Facet representing an assertion.
1734 .IP Test2::EventFacet::Control 12
1735 .IX Item "Test2::EventFacet::Control"
1736 Facet for hub actions and behaviors.
1737 .IP Test2::EventFacet::Error 12
1738 .IX Item "Test2::EventFacet::Error"
1739 Facet for errors that need to be shown.
1740 .IP Test2::EventFacet::Hub 12
1741 .IX Item "Test2::EventFacet::Hub"
1742 Facet for the hubs an event passes through.
1743 .IP Test2::EventFacet::Info 12
1744 .IX Item "Test2::EventFacet::Info"
1745 Facet for information a developer might care about.
1746 .IP Test2::EventFacet::Info::Table 12
1747 .IX Item "Test2::EventFacet::Info::Table"
1748 Intermediary representation of a table.
1749 .IP Test2::EventFacet::Meta 12
1750 .IX Item "Test2::EventFacet::Meta"
1751 Facet for meta\-data
1752 .IP Test2::EventFacet::Parent 12
1753 .IX Item "Test2::EventFacet::Parent"
1754 Facet for events contains other events
1755 .IP Test2::EventFacet::Plan 12
1756 .IX Item "Test2::EventFacet::Plan"
1757 Facet for setting the plan
1758 .IP Test2::EventFacet::Render 12
1759 .IX Item "Test2::EventFacet::Render"
1760 Facet that dictates how to render an event.
1761 .IP Test2::EventFacet::Trace 12
1762 .IX Item "Test2::EventFacet::Trace"
1763 Debug information for events
1764 .IP Test2::Formatter 12
1765 .IX Item "Test2::Formatter"
1766 Namespace for formatters.
1767 .IP Test2::Formatter::TAP 12
1768 .IX Item "Test2::Formatter::TAP"
1769 Standard TAP formatter
1770 .IP Test2::Hub 12
1771 .IX Item "Test2::Hub"
1772 The conduit through which all events flow.
1773 .IP Test2::Hub::Interceptor 12
1774 .IX Item "Test2::Hub::Interceptor"
1775 Hub used by interceptor to grab results.
1776 .IP Test2::Hub::Interceptor::Terminator 12
1777 .IX Item "Test2::Hub::Interceptor::Terminator"
1778 Exception class used by
1779 .IP Test2::Hub::Subtest 12
1780 .IX Item "Test2::Hub::Subtest"
1781 Hub used by subtests
1782 .IP Test2::IPC 12
1783 .IX Item "Test2::IPC"
1784 Turn on IPC for threading or forking support.
1785 .IP Test2::IPC::Driver 12
1786 .IX Item "Test2::IPC::Driver"
1787 Base class for Test2 IPC drivers.
1788 .IP Test2::IPC::Driver::Files 12
1789 .IX Item "Test2::IPC::Driver::Files"
1790 Temp dir + Files concurrency model.
1791 .IP Test2::Manual 12
1792 .IX Item "Test2::Manual"
1793 Documentation hub for Test2 and Test2\-Suite.
1794 .IP Test2::Manual::Anatomy 12
1795 .IX Item "Test2::Manual::Anatomy"
1796 The hub for documentation of the inner workings of
1797 .IP Test2::Manual::Anatomy::API 12
1798 .IX Item "Test2::Manual::Anatomy::API"
1799 Internals documentation for the API.
1800 .IP Test2::Manual::Anatomy::Context 12
1801 .IX Item "Test2::Manual::Anatomy::Context"
1802 Internals documentation for the Context
1803 .IP Test2::Manual::Anatomy::EndToEnd 12
1804 .IX Item "Test2::Manual::Anatomy::EndToEnd"
1805 Overview of Test2 from load to finish.
1806 .IP Test2::Manual::Anatomy::Event 12
1807 .IX Item "Test2::Manual::Anatomy::Event"
1808 The internals of events
1809 .IP Test2::Manual::Anatomy::Hubs 12
1810 .IX Item "Test2::Manual::Anatomy::Hubs"
1811 Internals documentation for the hub stack, and
1812 .IP Test2::Manual::Anatomy::IPC 12
1813 .IX Item "Test2::Manual::Anatomy::IPC"
1814 Manual for the IPC system.
1815 .IP Test2::Manual::Anatomy::Utilities 12
1816 .IX Item "Test2::Manual::Anatomy::Utilities"
1817 Overview of utilities for Test2.
1818 .IP Test2::Manual::Concurrency 12
1819 .IX Item "Test2::Manual::Concurrency"
1820 Documentation for Concurrency support.
1821 .IP Test2::Manual::Contributing 12
1822 .IX Item "Test2::Manual::Contributing"
1823 How to contribute to the Test2 project.
1824 .IP Test2::Manual::Testing 12
1825 .IX Item "Test2::Manual::Testing"
1826 Hub for documentation about writing tests with Test2.
1827 .IP Test2::Manual::Testing::Introduction 12
1828 .IX Item "Test2::Manual::Testing::Introduction"
1829 Introduction to testing with Test2.
1830 .IP Test2::Manual::Testing::Migrating 12
1831 .IX Item "Test2::Manual::Testing::Migrating"
1832 How to migrate existing tests from
1833 .IP Test2::Manual::Testing::Planning 12
1834 .IX Item "Test2::Manual::Testing::Planning"
1835 The many ways to set a plan.
1836 .IP Test2::Manual::Testing::Todo 12
1837 .IX Item "Test2::Manual::Testing::Todo"
1838 Tutorial for marking tests as TODO.
1839 .IP Test2::Manual::Tooling 12
1840 .IX Item "Test2::Manual::Tooling"
1841 Manual page for tool authors.
1842 .IP Test2::Manual::Tooling::FirstTool 12
1843 .IX Item "Test2::Manual::Tooling::FirstTool"
1844 Write your first tool with Test2.
1845 .IP Test2::Manual::Tooling::Formatter 12
1846 .IX Item "Test2::Manual::Tooling::Formatter"
1847 How to write a custom formatter, in our
1848 .IP Test2::Manual::Tooling::Nesting 12
1849 .IX Item "Test2::Manual::Tooling::Nesting"
1850 Tutorial for using other tools within your
1851 .IP Test2::Manual::Tooling::Plugin::TestExit 12
1852 .IX Item "Test2::Manual::Tooling::Plugin::TestExit"
1853 How to safely add pre\-exit
1854 .IP Test2::Manual::Tooling::Plugin::TestingDone 12
1855 .IX Item "Test2::Manual::Tooling::Plugin::TestingDone"
1856 Run code when the test file is
1857 .IP Test2::Manual::Tooling::Plugin::ToolCompletes 12
1858 .IX Item "Test2::Manual::Tooling::Plugin::ToolCompletes"
1859 How to add behaviors that occur
1860 .IP Test2::Manual::Tooling::Plugin::ToolStarts 12
1861 .IX Item "Test2::Manual::Tooling::Plugin::ToolStarts"
1862 How to add behaviors that occur
1863 .IP Test2::Manual::Tooling::Subtest 12
1864 .IX Item "Test2::Manual::Tooling::Subtest"
1865 How to implement a tool that makes use of
1866 .IP Test2::Manual::Tooling::TestBuilder 12
1867 .IX Item "Test2::Manual::Tooling::TestBuilder"
1868 This section maps Test::Builder methods
1869 .IP Test2::Manual::Tooling::Testing 12
1870 .IX Item "Test2::Manual::Tooling::Testing"
1871 Tutorial on how to test your testing tools.
1872 .IP Test2::Mock 12
1873 .IX Item "Test2::Mock"
1874 Module for managing mocked classes and instances.
1875 .IP Test2::Plugin 12
1876 .IX Item "Test2::Plugin"
1877 Documentation for plugins
1878 .IP Test2::Plugin::BailOnFail 12
1879 .IX Item "Test2::Plugin::BailOnFail"
1880 Automatically bail out of testing on the first test
1881 .IP Test2::Plugin::DieOnFail 12
1882 .IX Item "Test2::Plugin::DieOnFail"
1883 Automatically die on the first test failure.
1884 .IP Test2::Plugin::ExitSummary 12
1885 .IX Item "Test2::Plugin::ExitSummary"
1886 Add extra diagnostics on failure at the end of the
1887 .IP Test2::Plugin::SRand 12
1888 .IX Item "Test2::Plugin::SRand"
1889 Control the random seed for more controlled test
1890 .IP Test2::Plugin::Times 12
1891 .IX Item "Test2::Plugin::Times"
1892 Output timing data at the end of the test.
1893 .IP Test2::Plugin::UTF8 12
1894 .IX Item "Test2::Plugin::UTF8"
1895 Test2 plugin to test with utf8.
1896 .IP Test2::Require 12
1897 .IX Item "Test2::Require"
1898 Base class and documentation for skip\-unless type test
1899 .IP Test2::Require::AuthorTesting 12
1900 .IX Item "Test2::Require::AuthorTesting"
1901 Only run a test when the AUTHOR_TESTING
1902 .IP Test2::Require::AutomatedTesting 12
1903 .IX Item "Test2::Require::AutomatedTesting"
1904 Only run a test when the AUTOMATED_TESTING
1905 .IP Test2::Require::EnvVar 12
1906 .IX Item "Test2::Require::EnvVar"
1907 Only run a test when a specific environment variable
1908 .IP Test2::Require::ExtendedTesting 12
1909 .IX Item "Test2::Require::ExtendedTesting"
1910 Only run a test when the EXTENDED_TESTING
1911 .IP Test2::Require::Fork 12
1912 .IX Item "Test2::Require::Fork"
1913 Skip a test file unless the system supports forking
1914 .IP Test2::Require::Module 12
1915 .IX Item "Test2::Require::Module"
1916 Skip tests if certain packages are not installed, or
1917 .IP Test2::Require::NonInteractiveTesting 12
1918 .IX Item "Test2::Require::NonInteractiveTesting"
1919 Only run a test when the NONINTERACTIVE_TESTING
1920 .IP Test2::Require::Perl 12
1921 .IX Item "Test2::Require::Perl"
1922 Skip the test unless the necessary version of Perl is
1923 .IP Test2::Require::RealFork 12
1924 .IX Item "Test2::Require::RealFork"
1925 Skip a test file unless the system supports true
1926 .IP Test2::Require::ReleaseTesting 12
1927 .IX Item "Test2::Require::ReleaseTesting"
1928 Only run a test when the RELEASE_TESTING
1929 .IP Test2::Require::Threads 12
1930 .IX Item "Test2::Require::Threads"
1931 Skip a test file unless the system supports threading
1932 .IP Test2::Suite 12
1933 .IX Item "Test2::Suite"
1934 Distribution with a rich set of tools built upon the Test2
1935 .IP Test2::Todo 12
1936 .IX Item "Test2::Todo"
1937 TODO extension for Test2.
1938 .IP Test2::Tools 12
1939 .IX Item "Test2::Tools"
1940 Documentation for Tools.
1941 .IP Test2::Tools::AsyncSubtest 12
1942 .IX Item "Test2::Tools::AsyncSubtest"
1943 Tools for writing async subtests.
1944 .IP Test2::Tools::Basic 12
1945 .IX Item "Test2::Tools::Basic"
1946 Test2 implementation of the basic testing tools.
1947 .IP Test2::Tools::Class 12
1948 .IX Item "Test2::Tools::Class"
1949 Test2 implementation of the tools for testing classes.
1950 .IP Test2::Tools::ClassicCompare 12
1951 .IX Item "Test2::Tools::ClassicCompare"
1952 Classic (Test::More style) comparison tools.
1953 .IP Test2::Tools::Compare 12
1954 .IX Item "Test2::Tools::Compare"
1955 Tools for comparing deep data structures.
1956 .IP Test2::Tools::Defer 12
1957 .IX Item "Test2::Tools::Defer"
1958 Write tests that get executed at a later time
1959 .IP Test2::Tools::Encoding 12
1960 .IX Item "Test2::Tools::Encoding"
1961 Tools for managing the encoding of Test2 based
1962 .IP Test2::Tools::Event 12
1963 .IX Item "Test2::Tools::Event"
1964 Tools for generating test events.
1965 .IP Test2::Tools::Exception 12
1966 .IX Item "Test2::Tools::Exception"
1967 Test2 based tools for checking exceptions
1968 .IP Test2::Tools::Exports 12
1969 .IX Item "Test2::Tools::Exports"
1970 Tools for validating exporters.
1971 .IP Test2::Tools::GenTemp 12
1972 .IX Item "Test2::Tools::GenTemp"
1973 Tool for generating a populated temp directory.
1974 .IP Test2::Tools::Grab 12
1975 .IX Item "Test2::Tools::Grab"
1976 Temporarily intercept all events without adding a scope
1977 .IP Test2::Tools::Mock 12
1978 .IX Item "Test2::Tools::Mock"
1979 Class/Instance mocking for Test2.
1980 .IP Test2::Tools::Ref 12
1981 .IX Item "Test2::Tools::Ref"
1982 Tools for validating references.
1983 .IP Test2::Tools::Spec 12
1984 .IX Item "Test2::Tools::Spec"
1985 RSPEC implementation on top of Test2::Workflow
1986 .IP Test2::Tools::Subtest 12
1987 .IX Item "Test2::Tools::Subtest"
1988 Tools for writing subtests
1989 .IP Test2::Tools::Target 12
1990 .IX Item "Test2::Tools::Target"
1991 Alias the testing target package.
1992 .IP Test2::Tools::Tester 12
1993 .IX Item "Test2::Tools::Tester"
1994 Tools to help you test other testing tools.
1995 .IP Test2::Tools::Tiny 12
1996 .IX Item "Test2::Tools::Tiny"
1997 Tiny set of tools for unfortunate souls who cannot use
1998 .IP Test2::Tools::Warnings 12
1999 .IX Item "Test2::Tools::Warnings"
2000 Tools to verify warnings.
2001 .IP Test2::Transition 12
2002 .IX Item "Test2::Transition"
2003 Transition notes when upgrading to Test2
2004 .IP Test2::Util 12
2005 .IX Item "Test2::Util"
2006 Tools used by Test2 and friends.
2007 .IP Test2::Util::ExternalMeta 12
2008 .IX Item "Test2::Util::ExternalMeta"
2009 Allow third party tools to safely attach meta\-data
2010 .IP Test2::Util::Facets2Legacy 12
2011 .IX Item "Test2::Util::Facets2Legacy"
2012 Convert facet data to the legacy event API.
2013 .IP Test2::Util::Grabber 12
2014 .IX Item "Test2::Util::Grabber"
2015 Object used to temporarily intercept all events.
2016 .IP Test2::Util::Guard 12
2017 .IX Item "Test2::Util::Guard"
2018 Inline copy of Scope::Guard
2019 .IP Test2::Util::HashBase 12
2020 .IX Item "Test2::Util::HashBase"
2021 Build hash based classes.
2022 .IP Test2::Util::Importer 12
2023 .IX Item "Test2::Util::Importer"
2024 Inline copy of Importer.
2025 .IP Test2::Util::Ref 12
2026 .IX Item "Test2::Util::Ref"
2027 Tools for inspecting or manipulating references.
2028 .IP Test2::Util::Sig 12
2029 .IX Item "Test2::Util::Sig"
2030 Signal tools used by Test2 and friends.
2031 .IP Test2::Util::Stash 12
2032 .IX Item "Test2::Util::Stash"
2033 Utilities for manipulating stashes and globs.
2034 .IP Test2::Util::Sub 12
2035 .IX Item "Test2::Util::Sub"
2036 Tools for inspecting and manipulating subs.
2037 .IP Test2::Util::Table 12
2038 .IX Item "Test2::Util::Table"
2039 Format a header and rows into a table
2040 .IP Test2::Util::Table::LineBreak 12
2041 .IX Item "Test2::Util::Table::LineBreak"
2042 Break up lines for use in tables.
2043 .IP Test2::Util::Times 12
2044 .IX Item "Test2::Util::Times"
2045 Format timing/benchmark information.
2046 .IP Test2::Util::Trace 12
2047 .IX Item "Test2::Util::Trace"
2048 Legacy wrapper for Test2::EventFacet::Trace.
2049 .IP Test2::V0 12
2050 .IX Item "Test2::V0"
2051 0Th edition of the Test2 recommended bundle.
2052 .IP Test2::Workflow 12
2053 .IX Item "Test2::Workflow"
2054 A test workflow is a way of structuring tests using
2055 .IP Test2::Workflow::BlockBase 12
2056 .IX Item "Test2::Workflow::BlockBase"
2057 Base class for all workflow blocks.
2058 .IP Test2::Workflow::Build 12
2059 .IX Item "Test2::Workflow::Build"
2060 Represents a build in progress.
2061 .IP Test2::Workflow::Runner 12
2062 .IX Item "Test2::Workflow::Runner"
2063 Runs the workflows.
2064 .IP Test2::Workflow::Task 12
2065 .IX Item "Test2::Workflow::Task"
2066 Encapsulation of a Task
2067 .IP Test2::Workflow::Task::Action 12
2068 .IX Item "Test2::Workflow::Task::Action"
2069 Encapsulation of an action.
2070 .IP Test2::Workflow::Task::Group 12
2071 .IX Item "Test2::Workflow::Task::Group"
2072 Encapsulation of a group (describe).
2073 .IP Test::Builder 12
2074 .IX Item "Test::Builder"
2075 Backend for building test libraries
2076 .IP Test::Builder::Formatter 12
2077 .IX Item "Test::Builder::Formatter"
2078 Test::Builder subclass of Test2::Formatter::TAP
2079 .IP Test::Builder::Module 12
2080 .IX Item "Test::Builder::Module"
2081 Base class for test modules
2082 .IP Test::Builder::Tester 12
2083 .IX Item "Test::Builder::Tester"
2084 Test testsuites that have been built with
2085 .IP Test::Builder::Tester::Color 12
2086 .IX Item "Test::Builder::Tester::Color"
2087 Turn on colour in Test::Builder::Tester
2088 .IP Test::Builder::TodoDiag 12
2089 .IX Item "Test::Builder::TodoDiag"
2090 Test::Builder subclass of Test2::Event::Diag
2091 .IP Test::Harness 12
2092 .IX Item "Test::Harness"
2093 Run Perl standard test scripts with statistics
2094 .IP Test::Harness::Beyond 12
2095 .IX Item "Test::Harness::Beyond"
2096 Beyond make test
2097 .IP Test::More 12
2098 .IX Item "Test::More"
2099 Yet another framework for writing test scripts
2100 .IP Test::Simple 12
2101 .IX Item "Test::Simple"
2102 Basic utilities for writing tests.
2103 .IP Test::Tester 12
2104 .IX Item "Test::Tester"
2105 Ease testing test modules built with Test::Builder
2106 .IP Test::Tester::Capture 12
2107 .IX Item "Test::Tester::Capture"
2108 Help testing test modules built with Test::Builder
2109 .IP Test::Tester::CaptureRunner 12
2110 .IX Item "Test::Tester::CaptureRunner"
2111 Help testing test modules built with Test::Builder
2112 .IP Test::Tutorial 12
2113 .IX Item "Test::Tutorial"
2114 A tutorial about writing really basic tests
2115 .IP Test::use::ok 12
2116 .IX Item "Test::use::ok"
2117 Alternative to Test::More::use_ok
2118 .IP Text::Abbrev 12
2119 .IX Item "Text::Abbrev"
2120 Abbrev \- create an abbreviation table from a list
2121 .IP Text::Balanced 12
2122 .IX Item "Text::Balanced"
2123 Extract delimited text sequences from strings.
2124 .IP Text::ParseWords 12
2125 .IX Item "Text::ParseWords"
2126 Parse text into an array of tokens or array of arrays
2127 .IP Text::Tabs 12
2128 .IX Item "Text::Tabs"
2129 Expand and unexpand tabs like unix \fBexpand\fR\|(1) and \fBunexpand\fR\|(1)
2130 .IP Text::Wrap 12
2131 .IX Item "Text::Wrap"
2132 Line wrapping to form simple paragraphs
2133 .IP Thread 12
2134 .IX Item "Thread"
2135 Manipulate threads in Perl (for old code only)
2136 .IP Thread::Queue 12
2137 .IX Item "Thread::Queue"
2138 Thread\-safe queues
2139 .IP Thread::Semaphore 12
2140 .IX Item "Thread::Semaphore"
2141 Thread\-safe semaphores
2142 .IP Tie::Array 12
2143 .IX Item "Tie::Array"
2144 Base class for tied arrays
2145 .IP Tie::File 12
2146 .IX Item "Tie::File"
2147 Access the lines of a disk file via a Perl array
2148 .IP Tie::Handle 12
2149 .IX Item "Tie::Handle"
2150 Base class definitions for tied handles
2151 .IP Tie::Hash 12
2152 .IX Item "Tie::Hash"
2153 Base class definitions for tied hashes
2154 .IP Tie::Hash::NamedCapture 12
2155 .IX Item "Tie::Hash::NamedCapture"
2156 Named regexp capture buffers
2157 .IP Tie::Memoize 12
2158 .IX Item "Tie::Memoize"
2159 Add data to hash when needed
2160 .IP Tie::RefHash 12
2161 .IX Item "Tie::RefHash"
2162 Use references as hash keys
2163 .IP Tie::Scalar 12
2164 .IX Item "Tie::Scalar"
2165 Base class definitions for tied scalars
2166 .IP Tie::StdHandle 12
2167 .IX Item "Tie::StdHandle"
2168 Base class definitions for tied handles
2169 .IP Tie::SubstrHash 12
2170 .IX Item "Tie::SubstrHash"
2171 Fixed\-table\-size, fixed\-key\-length hashing
2172 .IP Time::HiRes 12
2173 .IX Item "Time::HiRes"
2174 High resolution alarm, sleep, gettimeofday, interval timers
2175 .IP Time::Local 12
2176 .IX Item "Time::Local"
2177 Efficiently compute time from local and GMT time
2178 .IP Time::Piece 12
2179 .IX Item "Time::Piece"
2180 Object Oriented time objects
2181 .IP Time::Seconds 12
2182 .IX Item "Time::Seconds"
2183 A simple API to convert seconds to other date values
2184 .IP Time::gmtime 12
2185 .IX Item "Time::gmtime"
2186 By\-name interface to Perl\*(Aqs built\-in \fBgmtime()\fR function
2187 .IP Time::localtime 12
2188 .IX Item "Time::localtime"
2189 By\-name interface to Perl\*(Aqs built\-in \fBlocaltime()\fR function
2190 .IP Time::tm 12
2191 .IX Item "Time::tm"
2192 Internal object used by Time::gmtime and Time::localtime
2193 .IP UNIVERSAL 12
2194 .IX Item "UNIVERSAL"
2195 Base class for ALL classes (blessed references)
2196 .IP Unicode::Collate 12
2197 .IX Item "Unicode::Collate"
2198 Unicode Collation Algorithm
2199 .IP Unicode::Collate::CJK::Big5 12
2200 .IX Item "Unicode::Collate::CJK::Big5"
2201 Weighting CJK Unified Ideographs
2202 .IP Unicode::Collate::CJK::GB2312 12
2203 .IX Item "Unicode::Collate::CJK::GB2312"
2204 Weighting CJK Unified Ideographs
2205 .IP Unicode::Collate::CJK::JISX0208 12
2206 .IX Item "Unicode::Collate::CJK::JISX0208"
2207 Weighting JIS KANJI for Unicode::Collate
2208 .IP Unicode::Collate::CJK::Korean 12
2209 .IX Item "Unicode::Collate::CJK::Korean"
2210 Weighting CJK Unified Ideographs
2211 .IP Unicode::Collate::CJK::Pinyin 12
2212 .IX Item "Unicode::Collate::CJK::Pinyin"
2213 Weighting CJK Unified Ideographs
2214 .IP Unicode::Collate::CJK::Stroke 12
2215 .IX Item "Unicode::Collate::CJK::Stroke"
2216 Weighting CJK Unified Ideographs
2217 .IP Unicode::Collate::CJK::Zhuyin 12
2218 .IX Item "Unicode::Collate::CJK::Zhuyin"
2219 Weighting CJK Unified Ideographs
2220 .IP Unicode::Collate::Locale 12
2221 .IX Item "Unicode::Collate::Locale"
2222 Linguistic tailoring for DUCET via Unicode::Collate
2223 .IP Unicode::Normalize 12
2224 .IX Item "Unicode::Normalize"
2225 Unicode Normalization Forms
2226 .IP Unicode::UCD 12
2227 .IX Item "Unicode::UCD"
2228 Unicode character database
2229 .IP User::grent 12
2230 .IX Item "User::grent"
2231 By\-name interface to Perl\*(Aqs built\-in getgr*() functions
2232 .IP User::pwent 12
2233 .IX Item "User::pwent"
2234 By\-name interface to Perl\*(Aqs built\-in getpw*() functions
2235 .IP VMS::DCLsym 12
2236 .IX Item "VMS::DCLsym"
2237 Perl extension to manipulate DCL symbols
2238 .IP VMS::Filespec 12
2239 .IX Item "VMS::Filespec"
2240 Convert between VMS and Unix file specification syntax
2241 .IP VMS::Stdio 12
2242 .IX Item "VMS::Stdio"
2243 Standard I/O functions via VMS extensions
2244 .IP Win32 12
2245 .IX Item "Win32"
2246 Interfaces to some Win32 API Functions
2247 .IP Win32API::File 12
2248 .IX Item "Win32API::File"
2249 Low\-level access to Win32 system API calls for files/dirs.
2250 .IP Win32CORE 12
2251 .IX Item "Win32CORE"
2252 Win32 CORE function stubs
2253 .IP XS::APItest 12
2254 .IX Item "XS::APItest"
2255 Test the perl C API
2256 .IP XS::Typemap 12
2257 .IX Item "XS::Typemap"
2258 Module to test the XS typemaps distributed with perl
2259 .IP XSLoader 12
2260 .IX Item "XSLoader"
2261 Dynamically load C libraries into Perl code
2262 .IP autodie::Scope::Guard 12
2263 .IX Item "autodie::Scope::Guard"
2264 Wrapper class for calling subs at end of scope
2265 .IP autodie::Scope::GuardStack 12
2266 .IX Item "autodie::Scope::GuardStack"
2267 Hook stack for managing scopes via %^H
2268 .IP autodie::Util 12
2269 .IX Item "autodie::Util"
2270 Internal Utility subroutines for autodie and Fatal
2271 .IP version::Internals 12
2272 .IX Item "version::Internals"
2273 Perl extension for Version Objects
2274 .PP
2275 To find out \fIall\fR modules installed on your system, including
2276 those without documentation or outside the standard release,
2277 just use the following command (under the default win32 shell,
2278 double quotes should be used instead of single quotes).
2279 .PP
2280 .Vb 3
2281 \& % perl \-MFile::Find=find \-MFile::Spec::Functions \-Tlwe \e
2282 \& \*(Aqfind { wanted => sub { print canonpath $_ if /\e.pm\ez/ },
2283 \& no_chdir => 1 }, @INC\*(Aq
2284 .Ve
2285 .PP
2286 (The \-T is here to prevent \f(CW@INC\fR from being populated by \f(CW\*(C`PERL5LIB\*(C'\fR,
2287 \&\f(CW\*(C`PERLLIB\*(C'\fR, and \f(CW\*(C`PERL_USE_UNSAFE_INC\*(C'\fR.)
2288 They should all have their own documentation installed and accessible
2289 via your system \fBman\fR\|(1) command. If you do not have a \fBfind\fR
2290 program, you can use the Perl \fBfind2perl\fR program instead, which
2291 generates Perl code as output you can run through perl. If you
2292 have a \fBman\fR program but it doesn\*(Aqt find your modules, you\*(Aqll have
2293 to fix your manpath. See perl for details. If you have no
2294 system \fBman\fR command, you might try the \fBperldoc\fR program.
2295 .PP
2296 Note also that the command \f(CW\*(C`perldoc perllocal\*(C'\fR gives you a (possibly
2297 incomplete) list of the modules that have been further installed on
2298 your system. (The perllocal.pod file is updated by the standard MakeMaker
2299 install process.)
2300 .SS "Extension Modules"
2301 .IX Subsection "Extension Modules"
2302 Extension modules are written in C (or a mix of Perl and C). They
2303 are usually dynamically loaded into Perl if and when you need them,
2304 but may also be linked in statically. Supported extension modules
2305 include Socket, Fcntl, and POSIX.
2306 .PP
2307 Many popular C extension modules do not come bundled (at least, not
2308 completely) due to their sizes, volatility, or simply lack of time
2309 for adequate testing and configuration across the multitude of
2310 platforms on which Perl was beta\-tested. You are encouraged to
2311 look for them on CPAN (described below), or using web search engines
2312 like Google or DuckDuckGo.
2313 .SH CPAN
2314 .IX Header "CPAN"
2315 CPAN stands for Comprehensive Perl Archive Network; it\*(Aqs a globally
2316 replicated trove of Perl materials, including documentation, style
2317 guides, tricks and traps, alternate ports to non\-Unix systems and
2318 occasional binary distributions for these. Search engines for
2319 CPAN can be found at https://www.cpan.org/
2320 .PP
2321 Most importantly, CPAN includes around a thousand unbundled modules,
2322 some of which require a C compiler to build. Major categories of
2323 modules are:
2324 .IP \(bu 4
2325 Language Extensions and Documentation Tools
2326 .IP \(bu 4
2327 Development Support
2328 .IP \(bu 4
2329 Operating System Interfaces
2330 .IP \(bu 4
2331 Networking, Device Control (modems) and InterProcess Communication
2332 .IP \(bu 4
2333 Data Types and Data Type Utilities
2334 .IP \(bu 4
2335 Database Interfaces
2336 .IP \(bu 4
2337 User Interfaces
2338 .IP \(bu 4
2339 Interfaces to / Emulations of Other Programming Languages
2340 .IP \(bu 4
2341 File Names, File Systems and File Locking (see also File Handles)
2342 .IP \(bu 4
2343 String Processing, Language Text Processing, Parsing, and Searching
2344 .IP \(bu 4
2345 Option, Argument, Parameter, and Configuration File Processing
2346 .IP \(bu 4
2347 Internationalization and Locale
2348 .IP \(bu 4
2349 Authentication, Security, and Encryption
2350 .IP \(bu 4
2351 World Wide Web, HTML, HTTP, CGI, MIME
2352 .IP \(bu 4
2353 Server and Daemon Utilities
2354 .IP \(bu 4
2355 Archiving and Compression
2356 .IP \(bu 4
2357 Images, Pixmap and Bitmap Manipulation, Drawing, and Graphing
2358 .IP \(bu 4
2359 Mail and Usenet News
2360 .IP \(bu 4
2361 Control Flow Utilities (callbacks and exceptions etc)
2362 .IP \(bu 4
2363 File Handle and Input/Output Stream Utilities
2364 .IP \(bu 4
2365 Miscellaneous Modules
2366 .PP
2367 You can find the CPAN online at <https://www.cpan.org/>
2368 .SH "Modules: Creation, Use, and Abuse"
2369 .IX Header "Modules: Creation, Use, and Abuse"
2370 (The following section is borrowed directly from Tim Bunce\*(Aqs modules
2371 file, available at your nearest CPAN site.)
2372 .PP
2373 Perl implements a class using a package, but the presence of a
2374 package doesn\*(Aqt imply the presence of a class. A package is just a
2375 namespace. A class is a package that provides subroutines that can be
2376 used as methods. A method is just a subroutine that expects, as its
2377 first argument, either the name of a package (for "static" methods),
2378 or a reference to something (for "virtual" methods).
2379 .PP
2380 A module is a file that (by convention) provides a class of the same
2381 name (sans the .pm), plus an import method in that class that can be
2382 called to fetch exported symbols. This module may implement some of
2383 its methods by loading dynamic C or C++ objects, but that should be
2384 totally transparent to the user of the module. Likewise, the module
2385 might set up an AUTOLOAD function to slurp in subroutine definitions on
2386 demand, but this is also transparent. Only the \fI.pm\fR file is required to
2387 exist. See perlsub, perlobj, and AutoLoader for details about
2388 the AUTOLOAD mechanism.
2389 .SS "Guidelines for Module Creation"
2390 .IX Subsection "Guidelines for Module Creation"
2391 .IP \(bu 4
2392 Do similar modules already exist in some form?
2393 .Sp
2394 If so, please try to reuse the existing modules either in whole or
2395 by inheriting useful features into a new class. If this is not
2396 practical try to get together with the module authors to work on
2397 extending or enhancing the functionality of the existing modules.
2398 A perfect example is the plethora of packages in perl4 for dealing
2399 with command line options.
2400 .Sp
2401 If you are writing a module to expand an already existing set of
2402 modules, please coordinate with the author of the package. It
2403 helps if you follow the same naming scheme and module interaction
2404 scheme as the original author.
2405 .IP \(bu 4
2406 Try to design the new module to be easy to extend and reuse.
2407 .Sp
2408 Try to \f(CW\*(C`use warnings;\*(C'\fR (or \f(CW\*(C`use warnings qw(...);\*(C'\fR).
2409 Remember that you can add \f(CW\*(C`no warnings qw(...);\*(C'\fR to individual blocks
2410 of code that need less warnings.
2411 .Sp
2412 Use blessed references. Use the two argument form of bless to bless
2413 into the class name given as the first parameter of the constructor,
2414 e.g.,:
2415 .Sp
2416 .Vb 4
2417 \& sub new {
2418 \& my $class = shift;
2419 \& return bless {}, $class;
2420 \& }
2421 .Ve
2422 .Sp
2423 or even this if you\*(Aqd like it to be used as either a static
2424 or a virtual method.
2425 .Sp
2426 .Vb 5
2427 \& sub new {
2428 \& my $self = shift;
2429 \& my $class = ref($self) || $self;
2430 \& return bless {}, $class;
2431 \& }
2432 .Ve
2433 .Sp
2434 Pass arrays as references so more parameters can be added later
2435 (it\*(Aqs also faster). Convert functions into methods where
2436 appropriate. Split large methods into smaller more flexible ones.
2437 Inherit methods from other modules if appropriate.
2438 .Sp
2439 Avoid class name tests like: \f(CW\*(C`die "Invalid" unless ref $ref eq \*(AqFOO\*(Aq\*(C'\fR.
2440 Generally you can delete the \f(CW\*(C`eq \*(AqFOO\*(Aq\*(C'\fR part with no harm at all.
2441 Let the objects look after themselves! Generally, avoid hard\-wired
2442 class names as far as possible.
2443 .Sp
2444 Avoid \f(CW\*(C`$r\->Class::func()\*(C'\fR where using \f(CW\*(C`@ISA=qw(... Class ...)\*(C'\fR and
2445 \&\f(CW\*(C`$r\->func()\*(C'\fR would work.
2446 .Sp
2447 Use autosplit so little used or newly added functions won\*(Aqt be a
2448 burden to programs that don\*(Aqt use them. Add test functions to
2449 the module after _\|_END_\|_ either using AutoSplit or by saying:
2450 .Sp
2451 .Vb 1
2452 \& eval join(\*(Aq\*(Aq,<main::DATA>) || die $@ unless caller();
2453 .Ve
2454 .Sp
2455 Does your module pass the \*(Aqempty subclass\*(Aq test? If you say
2456 \&\f(CW\*(C`@SUBCLASS::ISA = qw(YOURCLASS);\*(C'\fR your applications should be able
2457 to use SUBCLASS in exactly the same way as YOURCLASS. For example,
2458 does your application still work if you change: \f(CW\*(C`$obj = YOURCLASS\->new();\*(C'\fR
2459 into: \f(CW\*(C`$obj = SUBCLASS\->new();\*(C'\fR ?
2460 .Sp
2461 Avoid keeping any state information in your packages. It makes it
2462 difficult for multiple other packages to use yours. Keep state
2463 information in objects.
2464 .Sp
2465 Always use \fB\-w\fR.
2466 .Sp
2467 Try to \f(CW\*(C`use strict;\*(C'\fR (or \f(CW\*(C`use strict qw(...);\*(C'\fR).
2468 Remember that you can add \f(CW\*(C`no strict qw(...);\*(C'\fR to individual blocks
2469 of code that need less strictness.
2470 .Sp
2471 Always use \fB\-w\fR.
2472 .Sp
2473 Follow the guidelines in perlstyle.
2474 .Sp
2475 Always use \fB\-w\fR.
2476 .IP \(bu 4
2477 Some simple style guidelines
2478 .Sp
2479 The perlstyle manual supplied with Perl has many helpful points.
2480 .Sp
2481 Coding style is a matter of personal taste. Many people evolve their
2482 style over several years as they learn what helps them write and
2483 maintain good code. Here\*(Aqs one set of assorted suggestions that
2484 seem to be widely used by experienced developers:
2485 .Sp
2486 Use underscores to separate words. It is generally easier to read
2487 \&\f(CW$var_names_like_this\fR than \f(CW$VarNamesLikeThis\fR, especially for
2488 non\-native speakers of English. It\*(Aqs also a simple rule that works
2489 consistently with VAR_NAMES_LIKE_THIS.
2490 .Sp
2491 Package/Module names are an exception to this rule. Perl informally
2492 reserves lowercase module names for \*(Aqpragma\*(Aq modules like integer
2493 and strict. Other modules normally begin with a capital letter and
2494 use mixed case with no underscores (need to be short and portable).
2495 .Sp
2496 You may find it helpful to use letter case to indicate the scope
2497 or nature of a variable. For example:
2498 .Sp
2499 .Vb 3
2500 \& $ALL_CAPS_HERE constants only (beware clashes with Perl vars)
2501 \& $Some_Caps_Here package\-wide global/static
2502 \& $no_caps_here function scope my() or local() variables
2503 .Ve
2504 .Sp
2505 Function and method names seem to work best as all lowercase.
2506 e.g., \f(CW\*(C`$obj\->as_string()\*(C'\fR.
2507 .Sp
2508 You can use a leading underscore to indicate that a variable or
2509 function should not be used outside the package that defined it.
2510 .IP \(bu 4
2511 Select what to export.
2512 .Sp
2513 Do NOT export method names!
2514 .Sp
2515 Do NOT export anything else by default without a good reason!
2516 .Sp
2517 Exports pollute the namespace of the module user. If you must
2518 export try to use \f(CW@EXPORT_OK\fR in preference to \f(CW@EXPORT\fR and avoid
2519 short or common names to reduce the risk of name clashes.
2520 .Sp
2521 Generally anything not exported is still accessible from outside the
2522 module using the ModuleName::item_name (or \f(CW\*(C`$blessed_ref\->method\*(C'\fR)
2523 syntax. By convention you can use a leading underscore on names to
2524 indicate informally that they are \*(Aqinternal\*(Aq and not for public use.
2525 .Sp
2526 (It is actually possible to get private functions by saying:
2527 \&\f(CW\*(C`my $subref = sub { ... }; &$subref;\*(C'\fR. But there\*(Aqs no way to call that
2528 directly as a method, because a method must have a name in the symbol
2529 table.)
2530 .Sp
2531 As a general rule, if the module is trying to be object oriented
2532 then export nothing. If it\*(Aqs just a collection of functions then
2533 \&\f(CW@EXPORT_OK\fR anything but use \f(CW@EXPORT\fR with caution.
2534 .IP \(bu 4
2535 Select a name for the module.
2536 .Sp
2537 This name should be as descriptive, accurate, and complete as
2538 possible. Avoid any risk of ambiguity. Always try to use two or
2539 more whole words. Generally the name should reflect what is special
2540 about what the module does rather than how it does it. Please use
2541 nested module names to group informally or categorize a module.
2542 There should be a very good reason for a module not to have a nested name.
2543 Module names should begin with a capital letter.
2544 .Sp
2545 Having 57 modules all called Sort will not make life easy for anyone
2546 (though having 23 called Sort::Quick is only marginally better :\-).
2547 Imagine someone trying to install your module alongside many others.
2548 .Sp
2549 If you are developing a suite of related modules/classes it\*(Aqs good
2550 practice to use nested classes with a common prefix as this will
2551 avoid namespace clashes. For example: Xyz::Control, Xyz::View,
2552 Xyz::Model etc. Use the modules in this list as a naming guide.
2553 .Sp
2554 If adding a new module to a set, follow the original author\*(Aqs
2555 standards for naming modules and the interface to methods in
2556 those modules.
2557 .Sp
2558 If developing modules for private internal or project specific use,
2559 that will never be released to the public, then you should ensure
2560 that their names will not clash with any future public module. You
2561 can do this either by using the reserved Local::* category or by
2562 using a category name that includes an underscore like Foo_Corp::*.
2563 .Sp
2564 To be portable each component of a module name should be limited to
2565 11 characters. If it might be used on MS\-DOS then try to ensure each is
2566 unique in the first 8 characters. Nested modules make this easier.
2567 .Sp
2568 For additional guidance on the naming of modules, please consult:
2569 .Sp
2570 .Vb 1
2571 \& https://pause.perl.org/pause/query?ACTION=pause_namingmodules
2572 .Ve
2573 .Sp
2574 or send mail to the <module\[email protected]> mailing list.
2575 .IP \(bu 4
2576 Have you got it right?
2577 .Sp
2578 How do you know that you\*(Aqve made the right decisions? Have you
2579 picked an interface design that will cause problems later? Have
2580 you picked the most appropriate name? Do you have any questions?
2581 .Sp
2582 The best way to know for sure, and pick up many helpful suggestions,
2583 is to ask someone who knows. The <module\[email protected]> mailing list
2584 is useful for this purpose; it\*(Aqs also accessible via news interface as
2585 perl.module\-authors at nntp.perl.org.
2586 .Sp
2587 All you need to do is post a short summary of the module, its
2588 purpose and interfaces. A few lines on each of the main methods is
2589 probably enough. (If you post the whole module it might be ignored
2590 by busy people \- generally the very people you want to read it!)
2591 .Sp
2592 Don\*(Aqt worry about posting if you can\*(Aqt say when the module will be
2593 ready \- just say so in the message. It might be worth inviting
2594 others to help you, they may be able to complete it for you!
2595 .IP \(bu 4
2596 README and other Additional Files.
2597 .Sp
2598 It\*(Aqs well known that software developers usually fully document the
2599 software they write. If, however, the world is in urgent need of
2600 your software and there is not enough time to write the full
2601 documentation please at least provide a README file containing:
2602 .RS 4
2603 .IP \(bu 10
2604 A description of the module/package/extension etc.
2605 .IP \(bu 10
2606 A copyright notice \- see below.
2607 .IP \(bu 10
2608 Prerequisites \- what else you may need to have.
2609 .IP \(bu 10
2610 How to build it \- possible changes to Makefile.PL etc.
2611 .IP \(bu 10
2612 How to install it.
2613 .IP \(bu 10
2614 Recent changes in this release, especially incompatibilities
2615 .IP \(bu 10
2616 Changes / enhancements you plan to make in the future.
2617 .RE
2618 .RS 4
2619 .Sp
2620 If the README file seems to be getting too large you may wish to
2621 split out some of the sections into separate files: INSTALL,
2622 Copying, ToDo etc.
2623 .IP \(bu 4
2624 Adding a Copyright Notice.
2625 .Sp
2626 How you choose to license your work is a personal decision.
2627 The general mechanism is to assert your Copyright and then make
2628 a declaration of how others may copy/use/modify your work.
2629 .Sp
2630 Perl, for example, is supplied with two types of licence: The GNU GPL
2631 and The Artistic Licence (see the files README, Copying, and Artistic,
2632 or perlgpl and perlartistic). Larry has good reasons for NOT
2633 just using the GNU GPL.
2634 .Sp
2635 My personal recommendation, out of respect for Larry, Perl, and the
2636 Perl community at large is to state something simply like:
2637 .Sp
2638 .Vb 3
2639 \& Copyright (c) 1995 Your Name. All rights reserved.
2640 \& This program is free software; you can redistribute it and/or
2641 \& modify it under the same terms as Perl itself.
2642 .Ve
2643 .Sp
2644 This statement should at least appear in the README file. You may
2645 also wish to include it in a Copying file and your source files.
2646 Remember to include the other words in addition to the Copyright.
2647 .IP \(bu 4
2648 Give the module a version/issue/release number.
2649 .Sp
2650 To be fully compatible with the Exporter and MakeMaker modules you
2651 should store your module\*(Aqs version number in a non\-my package
2652 variable called \f(CW$VERSION\fR. This should be a positive floating point
2653 number with at least two digits after the decimal (i.e., hundredths,
2654 e.g., \f(CW\*(C`$VERSION = "0.01"\*(C'\fR). Don\*(Aqt use a "1.3.2" style version.
2655 See Exporter for details.
2656 .Sp
2657 It may be handy to add a function or method to retrieve the number.
2658 Use the number in announcements and archive file names when
2659 releasing the module (ModuleName\-1.02.tar.Z).
2660 See perldoc ExtUtils::MakeMaker.pm for details.
2661 .IP \(bu 4
2662 How to release and distribute a module.
2663 .Sp
2664 If possible, register the module with CPAN. Follow the instructions
2665 and links on:
2666 .Sp
2667 .Vb 1
2668 \& https://www.cpan.org/modules/04pause.html
2669 .Ve
2670 .Sp
2671 and upload to:
2672 .Sp
2673 .Vb 1
2674 \& https://pause.perl.org/
2675 .Ve
2676 .Sp
2677 and notify <[email protected]>. This will allow anyone to install
2678 your module using the \f(CW\*(C`cpan\*(C'\fR tool distributed with Perl.
2679 .Sp
2680 By using the WWW interface you can ask the Upload Server to mirror
2681 your modules from your ftp or WWW site into your own directory on
2682 CPAN!
2683 .IP \(bu 4
2684 Take care when changing a released module.
2685 .Sp
2686 Always strive to remain compatible with previous released versions.
2687 Otherwise try to add a mechanism to revert to the
2688 old behavior if people rely on it. Document incompatible changes.
2689 .RE
2690 .RS 4
2691 .RE
2692 .SS "Guidelines for Converting Perl 4 Library Scripts into Modules"
2693 .IX Subsection "Guidelines for Converting Perl 4 Library Scripts into Modules"
2694 .IP \(bu 4
2695 There is no requirement to convert anything.
2696 .Sp
2697 If it ain\*(Aqt broke, don\*(Aqt fix it! Perl 4 library scripts should
2698 continue to work with no problems. You may need to make some minor
2699 changes (like escaping non\-array @\*(Aqs in double quoted strings) but
2700 there is no need to convert a .pl file into a Module for just that.
2701 .IP \(bu 4
2702 Consider the implications.
2703 .Sp
2704 All Perl applications that make use of the script will need to
2705 be changed (slightly) if the script is converted into a module. Is
2706 it worth it unless you plan to make other changes at the same time?
2707 .IP \(bu 4
2708 Make the most of the opportunity.
2709 .Sp
2710 If you are going to convert the script to a module you can use the
2711 opportunity to redesign the interface. The guidelines for module
2712 creation above include many of the issues you should consider.
2713 .IP \(bu 4
2714 The pl2pm utility will get you started.
2715 .Sp
2716 This utility will read *.pl files (given as parameters) and write
2717 corresponding *.pm files. The pl2pm utilities does the following:
2718 .RS 4
2719 .IP \(bu 10
2720 Adds the standard Module prologue lines
2721 .IP \(bu 10
2722 Converts package specifiers from \*(Aq to ::
2723 .IP \(bu 10
2724 Converts die(...) to croak(...)
2725 .IP \(bu 10
2726 Several other minor changes
2727 .RE
2728 .RS 4
2729 .Sp
2730 Being a mechanical process pl2pm is not bullet proof. The converted
2731 code will need careful checking, especially any package statements.
2732 Don\*(Aqt delete the original .pl file till the new .pm one works!
2733 .RE
2734 .SS "Guidelines for Reusing Application Code"
2735 .IX Subsection "Guidelines for Reusing Application Code"
2736 .IP \(bu 4
2737 Complete applications rarely belong in the Perl Module Library.
2738 .IP \(bu 4
2739 Many applications contain some Perl code that could be reused.
2740 .Sp
2741 Help save the world! Share your code in a form that makes it easy
2742 to reuse.
2743 .IP \(bu 4
2744 Break\-out the reusable code into one or more separate module files.
2745 .IP \(bu 4
2746 Take the opportunity to reconsider and redesign the interfaces.
2747 .IP \(bu 4
2748 In some cases the \*(Aqapplication\*(Aq can then be reduced to a small
2749 .Sp
2750 fragment of code built on top of the reusable modules. In these cases
2751 the application could invoked as:
2752 .Sp
2753 .Vb 3
2754 \& % perl \-e \*(Aquse Module::Name; method(@ARGV)\*(Aq ...
2755 \&or
2756 \& % perl \-mModule::Name ... (in perl5.002 or higher)
2757 .Ve
2758 .SH NOTE
2759 .IX Header "NOTE"
2760 Perl does not enforce private and public parts of its modules as you may
2761 have been used to in other languages like C++, Ada, or Modula\-17. Perl
2762 doesn\*(Aqt have an infatuation with enforced privacy. It would prefer
2763 that you stayed out of its living room because you weren\*(Aqt invited, not
2764 because it has a shotgun.
2765 .PP
2766 The module and its user have a contract, part of which is common law,
2767 and part of which is "written". Part of the common law contract is
2768 that a module doesn\*(Aqt pollute any namespace it wasn\*(Aqt asked to. The
2769 written contract for the module (A.K.A. documentation) may make other
2770 provisions. But then you know when you \f(CW\*(C`use RedefineTheWorld\*(C'\fR that
2771 you\*(Aqre redefining the world and willing to take the consequences.