Debian Codegraph @

upstream/debian-unstable/man1/perlmodlib.1

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