X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=pod%2Fperlmodlib.pod;h=c0a447ee77a12985d859d2a0862ea5d316dd076b;hb=91a462243ea69db634187747c3ddad662e832e86;hp=207bc1bd6405ad1d8a4fa04c50672f77f6a032a2;hpb=97a1d740bc3d862371168a73aa7c5fc749d8b2e3;p=p5sagit%2Fp5-mst-13.2.git diff --git a/pod/perlmodlib.pod b/pod/perlmodlib.pod index 207bc1b..c0a447e 100644 --- a/pod/perlmodlib.pod +++ b/pod/perlmodlib.pod @@ -47,18 +47,6 @@ The following pragmas are defined (and have their own documentation). =over 12 -=item assertions - -Select assertions in blocks of code - -=item assertions::activate - -Activate assertions - -=item assertions::compat - -Assertions for pre-5.9 versions of perl - =item attributes Get/set subroutine or variable attributes @@ -73,7 +61,7 @@ Postpone load of modules until a function is used =item base -Establish IS-A relationship with base classes at compile time +Establish an ISA relationship with base classes at compile time =item bigint @@ -115,6 +103,10 @@ Allows you to write your script in non-ascii or non-utf8 Warn on implicit encoding conversions +=item feature + +Enable new syntactic features + =item fields Compile-time class fields @@ -133,7 +125,7 @@ Use integer arithmetic instead of floating point =item less -Request less of something from the compiler +Request less of something =item lib @@ -143,6 +135,10 @@ Manipulate @INC at compile time Use and avoid POSIX locales for built-in operations +=item mro + +Method Resolution Order + =item open Set default PerlIO layers for input and output @@ -153,7 +149,11 @@ Restrict unsafe operations when compiling =item overload -Package for overloading perl operations +Package for overloading Perl operations + +=item parent + +Establish an ISA relationship with base classes at compile time =item re @@ -177,7 +177,7 @@ Predeclare sub names =item threads -Perl extension allowing use of interpreter based threads from perl +Perl interpreter-based threads =item threads::shared @@ -225,6 +225,18 @@ don't have the gdbm library. Provide framework for multiple DBMs +=item App::Prove + +Implements the C command. + +=item App::Prove::State + +State storage for the C command. + +=item Archive::Extract + +A generic archive extracting mechanism + =item Archive::Tar Module for manipulations of tar archives @@ -249,30 +261,6 @@ Split a package for autoloading The Perl Compiler -=item B::Asmdata - -Autogenerated data about Perl ops, used to generate bytecode - -=item B::Assembler - -Assemble Perl bytecode - -=item B::Bblock - -Walk basic blocks - -=item B::Bytecode - -Perl compiler's bytecode backend - -=item B::C - -Perl compiler's C backend - -=item B::CC - -Perl compiler's optimized C translation backend - =item B::Concise Walk Perl syntax tree, printing concise info about ops @@ -285,25 +273,17 @@ Walk Perl syntax tree, printing debug info about ops Perl compiler backend to produce perl code -=item B::Disassembler - -Disassemble Perl bytecode - =item B::Lint Perl lint -=item B::Showlex - -Show lexical variables used in functions or files - -=item B::Stackobj +=item B::Lint::Debug -Helper module for CC backend +Adds debugging stringification to B:: -=item B::Stash +=item B::Showlex -Show what stashes are loaded +Show lexical variables used in functions or files =item B::Terse @@ -317,10 +297,6 @@ Generates cross reference reports for Perl programs Benchmark running times of Perl code -=item ByteLoader - -Load byte compiled perl code - =item CGI Simple Common Gateway Interface Class @@ -357,18 +333,54 @@ Backward compatibility module for defunct CGI::Switch Internal utilities used by CGI module +=item CORE + +Pseudo-namespace for Perl's core routines + =item CPAN Query, download and build perl modules from CPAN sites +=item CPAN::API::HOWTO + +A recipe book for programming with CPAN.pm + =item CPAN::FirstTime Utility for CPAN::Config file Initialization +=item CPAN::Kwalify + +Interface between CPAN.pm and Kwalify.pm + =item CPAN::Nox Wrapper around CPAN.pm without using any XS module +=item CPAN::Version + +Utility functions to compare CPAN versions + +=item CPANPLUS + +API & CLI access to the CPAN mirrors + +=item CPANPLUS::Dist::Base + +Base class for custom distribution classes + +=item CPANPLUS::Dist::Sample + +Sample code to create your own Dist::* plugin + +=item CPANPLUS::Shell::Classic + +CPAN.pm emulation for CPANPLUS + +=item CPANPLUS::Shell::Default::Plugins::HOWTO + +Documentation on how to write your own plugins + =item Carp Warn of errors (from perspective of caller) @@ -385,6 +397,10 @@ Report the search path for a class's ISA tree Declare struct-like datatypes as Perl classes +=item Compress::Raw::Zlib + +Low-Level Interface to zlib compression library + =item Compress::Zlib Interface to zlib compression library @@ -399,12 +415,32 @@ Get pathname of current working directory =item DB -Programmatic interface to the Perl debugging API (draft, subject to +Programmatic interface to the Perl debugging API =item DBM_Filter Filter DBM keys/values +=item DBM_Filter::compress + +Filter for DBM_Filter + +=item DBM_Filter::encode + +Filter for DBM_Filter + +=item DBM_Filter::int32 + +Filter for DBM_Filter + +=item DBM_Filter::null + +Filter for DBM_Filter + +=item DBM_Filter::utf8 + +Filter for DBM_Filter + =item DB_File Perl5 access to Berkeley DB version 1.x @@ -417,9 +453,9 @@ Stringified perl data structures, suitable for both printing and C A Perl code profiler -=item Devel::PPPort +=item Devel::InnerPackage -Perl/Pollution/Portability +Find all the inner packages of a package =item Devel::Peek @@ -437,6 +473,10 @@ Modules that calculate message digests Perl interface to the MD5 Algorithm +=item Digest::SHA + +Perl extension for SHA-1/224/256/384/512 + =item Digest::base Digest base class @@ -497,6 +537,10 @@ Object Oriented Encoder Encode Implementation Base Class +=item Encode::GSM0338 + +ESTI GSM 03.38 Encoding + =item Encode::Guess Guesses encoding from data @@ -525,6 +569,10 @@ Internally used by Encode::KR MIME 'B' and 'Q' header encoding +=item Encode::MIME::Name + +Internally used by Encode + =item Encode::PerlIO A detailed document on Encode and PerlIO @@ -641,6 +689,10 @@ Methods to override UN*X behaviour in ExtUtils::MakeMaker DOS specific subclass of ExtUtils::MM_Unix +=item ExtUtils::MM_Darwin + +Special behaviors for OS X + =item ExtUtils::MM_MacOS Once produced Makefiles for MacOS Classic @@ -743,7 +795,7 @@ Load the C Fcntl.h defines =item File::Basename -Split a pathname into pieces +Parse file paths into directory, filename and suffix. =item File::CheckTree @@ -761,6 +813,10 @@ Copy files or filehandles DOS like globbing and then some +=item File::Fetch + +A generic file fetching mechanism + =item File::Find Traverse a directory tree. @@ -769,6 +825,10 @@ Traverse a directory tree. Perl extension for BSD glob routine +=item File::GlobMapper + +Extend File Glob to Allow Input and Output Files + =item File::Path Create or remove directory trees @@ -853,6 +913,10 @@ Process single-character switches with switch clustering A selection of general-utility hash subroutines +=item Hash::Util::FieldHash + +Support for Inside-Out Classes + =item I18N::Collate Compare 8-bit scalar data according to the current locale @@ -877,6 +941,26 @@ Query locale information Load various IO modules +=item IO::Compress::Base + +Base Class for IO::Compress modules + +=item IO::Compress::Deflate + +Write RFC 1950 files/buffers + +=item IO::Compress::Gzip + +Write RFC 1952 files/buffers + +=item IO::Compress::RawDeflate + +Write RFC 1951 files/buffers + +=item IO::Compress::Zip + +Write zip files/buffers + =item IO::Dir Supply object methods for directory handles @@ -917,10 +1001,46 @@ Object interface for AF_INET domain sockets Object interface for AF_UNIX domain sockets +=item IO::Uncompress::AnyInflate + +Uncompress zlib-based (zip, gzip) file/buffer + +=item IO::Uncompress::AnyUncompress + +Uncompress gzip, zip, bzip2 or lzop file/buffer + +=item IO::Uncompress::Base + +Base Class for IO::Uncompress modules + +=item IO::Uncompress::Gunzip + +Read RFC 1952 files/buffers + +=item IO::Uncompress::Inflate + +Read RFC 1950 files/buffers + +=item IO::Uncompress::RawInflate + +Read RFC 1951 files/buffers + +=item IO::Uncompress::Unzip + +Read zip files/buffers + =item IO::Zlib IO:: style interface to L +=item IPC::Cmd + +Finding and running system commands made easy + +=item IPC::Msg + +SysV Msg IPC object class + =item IPC::Open2 Open a process for both reading and writing @@ -929,17 +1049,17 @@ Open a process for both reading and writing Open a process for reading, writing, and error handling -=item IPC::SysV +=item IPC::Semaphore -SysV IPC constants +SysV Semaphore IPC object class -=item IPC::SysV::Msg +=item IPC::SharedMem -SysV Msg IPC object class +SysV Shared Memory IPC object class -=item IPC::SysV::Semaphore +=item IPC::SysV -SysV Semaphore IPC object class +System V IPC constants and system calls =item List::Util @@ -965,6 +1085,10 @@ ISO two letter codes for language identification (ISO 639) Framework for localization +=item Locale::Maketext::Simple + +Simple interface to Locale::Maketext::Lexicon + =item Locale::Maketext::TPJ13 Article about software localization @@ -973,11 +1097,27 @@ Article about software localization ISO codes for script identification (ISO 15924) +=item Log::Message + +A generic message storing mechanism; + +=item Log::Message::Config + +Configuration options for Log::Message + +=item Log::Message::Handlers + +Message handlers for Log::Message + +=item Log::Message::Item + +Message objects for Log::Message + =item MIME::Base64 Encoding and decoding of base64 strings -=item MIME::Base64::QuotedPrint +=item MIME::QuotedPrint Encoding and decoding of quoted-printable strings @@ -1045,10 +1185,130 @@ Glue to provide EXISTS for SDBM_File for Storable use Store Memoized data in Storable database +=item Module::Build + +Build and install Perl modules + +=item Module::Build::API + +API Reference for Module Authors + +=item Module::Build::Authoring + +Authoring Module::Build modules + +=item Module::Build::Base + +Default methods for Module::Build + +=item Module::Build::Compat + +Compatibility with ExtUtils::MakeMaker + +=item Module::Build::ConfigData + +Configuration for Module::Build + +=item Module::Build::Cookbook + +Examples of Module::Build Usage + +=item Module::Build::ModuleInfo + +Gather package and POD information from a perl module files + +=item Module::Build::Notes + +Configuration for $module_name + +=item Module::Build::PPMMaker + +Perl Package Manager file creation + +=item Module::Build::Platform::Amiga + +Builder class for Amiga platforms + +=item Module::Build::Platform::Default + +Stub class for unknown platforms + +=item Module::Build::Platform::EBCDIC + +Builder class for EBCDIC platforms + +=item Module::Build::Platform::MPEiX + +Builder class for MPEiX platforms + +=item Module::Build::Platform::MacOS + +Builder class for MacOS platforms + +=item Module::Build::Platform::RiscOS + +Builder class for RiscOS platforms + +=item Module::Build::Platform::Unix + +Builder class for Unix platforms + +=item Module::Build::Platform::VMS + +Builder class for VMS platforms + +=item Module::Build::Platform::VOS + +Builder class for VOS platforms + +=item Module::Build::Platform::Windows + +Builder class for Windows platforms + +=item Module::Build::Platform::aix + +Builder class for AIX platform + +=item Module::Build::Platform::cygwin + +Builder class for Cygwin platform + +=item Module::Build::Platform::darwin + +Builder class for Mac OS X platform + +=item Module::Build::Platform::os2 + +Builder class for OS/2 platform + +=item Module::Build::YAML + +Provides just enough YAML support so that Module::Build works even if YAML.pm is not installed + =item Module::CoreList What modules shipped with versions of perl +=item Module::Load + +Runtime require of both modules and files + +=item Module::Load::Conditional + +Looking up module information / loading at runtime + +=item Module::Loaded + +Mark modules as loaded or unloaded + +=item Module::Pluggable + +Automatically give your module the ability to have plugins + +=item Module::Pluggable::Object + +Automatically give your module the ability to have plugins + =item NDBM_File Tied access to ndbm files @@ -1133,6 +1393,14 @@ Disable named opcodes when compiling perl code Perl interface to IEEE Std 1003.1 +=item Package::Constants + +List all constants declared in a package + +=item Params::Check + +A generic input parsing/checking mechanism. + =item PerlIO On demand loader for PerlIO layers and root of PerlIO::* name space @@ -1157,6 +1425,10 @@ PerlIO layer for quoted-printable strings Check pod documents for syntax errors +=item Pod::Escapes + +For resolving Pod EE...E sequences + =item Pod::Find Find POD documents in directory trees @@ -1237,6 +1509,90 @@ Perl extension for converting Pod to old style Pod. Extract selected sections of POD from input +=item Pod::Simple + +Framework for parsing Pod + +=item Pod::Simple::Checker + +Check the Pod syntax of a document + +=item Pod::Simple::Debug + +Put Pod::Simple into trace/debug mode + +=item Pod::Simple::DumpAsText + +Dump Pod-parsing events as text + +=item Pod::Simple::DumpAsXML + +Turn Pod into XML + +=item Pod::Simple::HTML + +Convert Pod to HTML + +=item Pod::Simple::HTMLBatch + +Convert several Pod files to several HTML files + +=item Pod::Simple::LinkSection + +Represent "section" attributes of L codes + +=item Pod::Simple::Methody + +Turn Pod::Simple events into method calls + +=item Pod::Simple::PullParser + +A pull-parser interface to parsing Pod + +=item Pod::Simple::PullParserEndToken + +End-tokens from Pod::Simple::PullParser + +=item Pod::Simple::PullParserStartToken + +Start-tokens from Pod::Simple::PullParser + +=item Pod::Simple::PullParserTextToken + +Text-tokens from Pod::Simple::PullParser + +=item Pod::Simple::PullParserToken + +Tokens from Pod::Simple::PullParser + +=item Pod::Simple::RTF + +Format Pod as RTF + +=item Pod::Simple::Search + +Find POD documents in directory trees + +=item Pod::Simple::SimpleTree + +Parse Pod into a simple parse tree + +=item Pod::Simple::Subclassing + +Write a formatter as a Pod::Simple subclass + +=item Pod::Simple::Text + +Format Pod as plaintext + +=item Pod::Simple::TextContent + +Get the text content of Pod + +=item Pod::Simple::XMLOutStream + +Turn Pod into XML + =item Pod::Text Convert POD data to formatted ASCII text @@ -1309,6 +1665,122 @@ Try every conceivable way to get hostname Perl interface to the UNIX syslog(3) calls +=item Sys::Syslog::win32::Win32 + +Win32 support for Sys::Syslog + +=item TAP::Base + +Base class that provides common functionality to L and L + +=item TAP::Formatter::Color + +Run Perl test scripts with color + +=item TAP::Formatter::Console + +Harness output delegate for default console output + +=item TAP::Formatter::Console::ParallelSession + +Harness output delegate for parallel console output + +=item TAP::Formatter::Console::Session + +Harness output delegate for default console output + +=item TAP::Harness + +Run test scripts with statistics + +=item TAP::Parser + +Parse L output + +=item TAP::Parser::Aggregator + +Aggregate TAP::Parser results + +=item TAP::Parser::Grammar + +A grammar for the Test Anything Protocol. + +=item TAP::Parser::Iterator + +Internal TAP::Parser Iterator + +=item TAP::Parser::Iterator::Array + +Internal TAP::Parser Iterator + +=item TAP::Parser::Iterator::Process + +Internal TAP::Parser Iterator + +=item TAP::Parser::Iterator::Stream + +Internal TAP::Parser Iterator + +=item TAP::Parser::Multiplexer + +Multiplex multiple TAP::Parsers + +=item TAP::Parser::Result + +TAP::Parser output + +=item TAP::Parser::Result::Bailout + +Bailout result token. + +=item TAP::Parser::Result::Comment + +Comment result token. + +=item TAP::Parser::Result::Plan + +Plan result token. + +=item TAP::Parser::Result::Pragma + +TAP pragma token. + +=item TAP::Parser::Result::Test + +Test result token. + +=item TAP::Parser::Result::Unknown + +Unknown result token. + +=item TAP::Parser::Result::Version + +TAP syntax version token. + +=item TAP::Parser::Result::YAML + +YAML result token. + +=item TAP::Parser::Source + +Stream output from some source + +=item TAP::Parser::Source::Perl + +Stream Perl output + +=item TAP::Parser::Utils + +Internal TAP::Parser utilities + +=item TAP::Parser::YAMLish::Reader + +Read YAMLish data from iterator + +=item TAP::Parser::YAMLish::Writer + +Write YAMLish data + =item Term::ANSIColor Color screen output using ANSI escape sequences @@ -1325,6 +1797,10 @@ Perl word completion module Perl interface to various C packages. +=item Term::UI + +Term::ReadLine UI made easy + =item Test Provides a simple framework for writing test scripts @@ -1333,29 +1809,21 @@ Provides a simple framework for writing test scripts Backend for building test libraries -=item Test::Harness - -Run Perl standard test scripts with statistics - -=item Test::Harness::Assert +=item Test::Builder::Module -Simple assert +Base class for test modules -=item Test::Harness::Iterator +=item Test::Builder::Tester -Internal Test::Harness Iterator +Test testsuites that have been built with -=item Test::Harness::Point +=item Test::Builder::Tester::Color -Object for tracking a single test point +Turn on colour in Test::Builder::Tester -=item Test::Harness::Straps - -Detailed analysis of test results - -=item Test::Harness::TAP +=item Test::Harness -Documentation for the TAP format +Run Perl standard test scripts with statistics =item Test::More @@ -1383,7 +1851,7 @@ Parse text into an array of tokens or array of arrays =item Text::Soundex -Implementation of the Soundex Algorithm as Described by Knuth +Implementation of the soundex algorithm. =item Text::Tabs @@ -1405,14 +1873,6 @@ Thread-safe queues Thread-safe semaphores -=item Thread::Signal - -Start a thread which runs signal handlers reliably (for old code) - -=item Thread::Specific - -Thread-specific keys - =item Tie::Array Base class for tied arrays @@ -1429,6 +1889,10 @@ Base class definitions for tied handles Base class definitions for tied hashes +=item Tie::Hash::NamedCapture + +Named regexp capture buffers + =item Tie::Memoize Add data to hash when needed @@ -1453,6 +1917,14 @@ High resolution alarm, sleep, gettimeofday, interval timers Efficiently compute time from local and GMT time +=item Time::Piece + +Object Oriented time objects + +=item Time::Piece::Seconds + +A simple API to convert seconds to other date values + =item Time::gmtime By-name interface to Perl's built-in gmtime() function @@ -1489,6 +1961,18 @@ By-name interface to Perl's built-in getgr*() functions By-name interface to Perl's built-in getpw*() functions +=item Win32 + +Interfaces to some Win32 API Functions + +=item Win32API::File + +Low-level access to Win32 system API calls for files/dirs. + +=item Win32CORE + +Win32 CORE function stubs + =item XS::APItest Test the perl C API @@ -2428,8 +2912,8 @@ the module after __END__ either using AutoSplit or by saying: Does your module pass the 'empty subclass' test? If you say C<@SUBCLASS::ISA = qw(YOURCLASS);> your applications should be able to use SUBCLASS in exactly the same way as YOURCLASS. For example, -does your application still work if you change: C<$obj = new YOURCLASS;> -into: C<$obj = new SUBCLASS;> ? +does your application still work if you change: C<< $obj = YOURCLASS->new(); >> +into: C<< $obj = SUBCLASS->new(); >> ? Avoid keeping any state information in your packages. It makes it difficult for multiple other packages to use yours. Keep state