From: Gurusamy Sarathy Date: Mon, 18 Oct 1999 05:09:22 +0000 (+0000) Subject: pod updates from Tom Christiansen X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=9e107c5991344ddf58aabfda297612992c5e63cb;p=p5sagit%2Fp5-mst-13.2.git pod updates from Tom Christiansen p4raw-id: //depot/perl@4404 --- diff --git a/lib/Pod/Man.pm b/lib/Pod/Man.pm index 0ed16b6..87de42e 100644 --- a/lib/Pod/Man.pm +++ b/lib/Pod/Man.pm @@ -992,7 +992,7 @@ Pod::Man is a module to convert documentation in the POD format (the preferred language for documenting Perl) into *roff input using the man macro set. The resulting *roff code is suitable for display on a terminal using nroff(1), normally via man(1), or printing using troff(1). It is -conventionally invoked using the driver script B, but it can also +conventionally invoked using the driver script B, but it can also be used directly. As a derived class from Pod::Parser, Pod::Man supports the same methods and @@ -1172,7 +1172,7 @@ B in Perl core. =head1 SEE ALSO -L, perlpod(1), pod2roff(1), nroff(1), troff(1), +L, perlpod(1), pod2man(1), nroff(1), troff(1), man(1), man(7) Ossanna, Joseph F., and Brian W. Kernighan. "Troff User's Manual," @@ -1181,7 +1181,7 @@ the best documentation of standard nroff(1) and troff(1). At the time of this writing, it's available at http://www.cs.bell-labs.com/cm/cs/cstr.html. The man page documenting the man macro set may be man(5) instead of man(7) -on your system. Also, please see pod2roff(1) for extensive documentation on +on your system. Also, please see pod2man(1) for extensive documentation on writing manual pages if you've not done it before and aren't familiar with the conventions. diff --git a/pod/perldelta.pod b/pod/perldelta.pod index 8b56750..78f2209 100644 --- a/pod/perldelta.pod +++ b/pod/perldelta.pod @@ -1027,7 +1027,8 @@ to Perl's debugging API. =item Devel::DProf -Devel::DProf, a Perl source code profiler has been added. See L. +Devel::DProf, a Perl source code profiler has been added. See +L and L. =item Dumpvalue diff --git a/pod/perlmodlib.pod b/pod/perlmodlib.pod index 99d31bd..e173ebb 100644 --- a/pod/perlmodlib.pod +++ b/pod/perlmodlib.pod @@ -48,15 +48,15 @@ The following pragmas are defined (and have their own documentation). =item attributes -set/get the attributes of a subroutine or variable +Get/set subroutine or variable attributes =item attrs -set/get attributes of a subroutine (obsolescent) +Set/get attributes of a subroutine (deprecated) =item autouse -postpone load of modules until a function is used +Postpone load of modules until a function is used =item base @@ -66,77 +66,81 @@ Establish IS-A relationship with base class at compile time Use MakeMaker's uninstalled version of a package +=item caller + +Inherit pragmatic attributes from caller's context + +=item charnames + +Define character names for C<\N{named}> string literal escape. + =item constant -declare constants +Declare constants =item diagnostics -Perl compiler pragma to force verbose warning diagnostics +Force verbose warning diagnostics =item fields -compile-time class fields +Declare a class's attribute fields at compile-time =item filetest -control the filetest permission operators +Control the filetest operators like C<-r>, C<-w> for AFS, etc. =item integer -compute arithmetic in integer instead of double +Compute arithmetic in integer instead of double =item less -perl pragma to request less of something from the compiler +Request less of something from the compiler (unimplemented) =item lib -manipulate @INC at compile time +Manipulate @INC at compile time =item locale -use and avoid POSIX locales for built-in operations +Use or avoid POSIX locales for built-in operations =item ops -restrict unsafe operations when compiling +Restrict unsafe operations when compiling =item overload -Package for overloading perl operations +Overload Perl operations =item re -alter regular expression behavior +Alter regular expression behavior =item sigtrap -enable simple signal handling +Enable simple signal handling =item strict -restrict unsafe constructs +Restrict unsafe constructs =item subs -predeclare sub names +Predeclare subroutine names =item utf8 -turn on UTF-8 and Unicode support +Turn on UTF-8 and Unicode support =item vars -predeclare global variable names +Predeclare global variable names (obsoleted by our()) =item warnings -control optional warnings - -=item vmsish - -control VMS-specific language features +Control optional warnings =back @@ -150,19 +154,19 @@ Exporter module. See their own documentation for details. =item AnyDBM_File -provide framework for multiple DBMs +Provide framework for multiple DBM libraries =item AutoLoader -load subroutines only on demand +Load subroutines only on demand =item AutoSplit -split a package for autoloading +Split a package for autoloading =item B -The Perl Compiler; See also L. +Guts of the Perl code generator (aka compiler) =item B::Asmdata @@ -194,7 +198,7 @@ Walk Perl syntax tree, printing debug info about ops =item B::Deparse -Perl compiler backend to produce perl code +Perl compiler backend to produce Perl code =item B::Disassembler @@ -202,7 +206,7 @@ Disassemble Perl bytecode =item B::Lint -Perl lint +Module to catch dubious constructs =item B::Showlex @@ -212,6 +216,8 @@ Show lexical variables used in functions or files Helper module for CC backend +B::Stash -- XXX NFI XXX + =item B::Terse Walk Perl syntax tree, printing terse info about ops @@ -222,11 +228,15 @@ Generates cross reference reports for Perl programs =item Benchmark -benchmark running times of code +Benchmark running times of code + +=item ByteLoader + +Load byte-compiled Perl code =item CGI -Simple Common Gateway Interface Class +Simple Common Gateway Interface class =item CGI::Apache @@ -244,6 +254,10 @@ Interface to Netscape Cookies CGI Interface for Fast CGI +=item CGI::Pretty + +Module to produce nicely formatted HTML code + =item CGI::Push Simple Interface to Server Push @@ -254,11 +268,11 @@ Try more than one constructors and return the first object available =item CPAN -query, download and build perl modules from CPAN sites +Query, download, and build Perl modules from CPAN sites =item CPAN::FirstTime -Utility for CPAN::Config file Initialization +Utility for CPAN::Config file initialization =item CPAN::Nox @@ -266,23 +280,27 @@ Wrapper around CPAN.pm without using any XS module =item Carp -warn of errors (from perspective of caller) +Act like warn/die from perspective of caller + +=item Carp::Heavy + +Carp guts =item Class::Struct -declare struct-like datatypes as Perl classes +Declare struct-like datatypes as Perl classes =item Config -access Perl configuration information +Access Perl configuration information =item Cwd -get pathname of current working directory +Get pathname of current working directory =item DB -programmatic interface to the Perl debugging API +Programmatic interface to the Perl debugging API (experimental) =item DB_File @@ -290,7 +308,11 @@ Perl5 access to Berkeley DB version 1.x =item Data::Dumper -stringified perl data structures, suitable for both printing and C +Serialize Perl data structures + +=item Devel::DProf + +A Perl execution profiler =item Devel::Peek @@ -298,15 +320,15 @@ A data debugging tool for the XS programmer =item Devel::SelfStubber -generate stubs for a SelfLoading module +Generate stubs for a SelfLoading module =item DirHandle -supply object methods for directory handles +Supply object methods for directory handles =item Dumpvalue -provides screen dump of Perl data. +Provide screen dump of Perl data =item DynaLoader @@ -314,31 +336,35 @@ Dynamically load C libraries into Perl code =item English -use nice English (or awk) names for ugly punctuation variables +Use English (or awk) names for ugly punctuation variables =item Env -perl module that imports environment variables +Access environment variables as regular ones =item Errno -System errno constants +Load the libc errno.h defines =item Exporter -Implements default import method for modules +Implement default import method for modules + +=item Exporter::Heavy + +Exporter guts =item ExtUtils::Command -utilities to replace common UNIX commands in Makefiles etc. +Utilities to replace common Unix commands in Makefiles etc. =item ExtUtils::Embed -Utilities for embedding Perl in C/C++ applications +Utilities for embedding Perl in C/C++ programs =item ExtUtils::Install -install files from here to there +Install files from here to there =item ExtUtils::Installed @@ -346,63 +372,69 @@ Inventory management of installed modules =item ExtUtils::Liblist -determine libraries to use and how to use them +Determine libraries to use and how to use them + +=item ExtUtils::MM_Cygwin + +Methods to override Unix behavior in ExtUtils::MakeMaker =item ExtUtils::MM_OS2 -methods to override UN*X behavior in ExtUtils::MakeMaker +Methods to override Unix behavior in ExtUtils::MakeMaker =item ExtUtils::MM_Unix -methods used by ExtUtils::MakeMaker +Methods used by ExtUtils::MakeMaker =item ExtUtils::MM_VMS -methods to override UN*X behavior in ExtUtils::MakeMaker +Methods to override Unix behavior in ExtUtils::MakeMaker =item ExtUtils::MM_Win32 -methods to override UN*X behavior in ExtUtils::MakeMaker +Methods to override Unix behavior in ExtUtils::MakeMaker =item ExtUtils::MakeMaker -create an extension Makefile +Create an extension Makefile =item ExtUtils::Manifest -utilities to write and check a MANIFEST file +Utilities to write and check a MANIFEST file -=item ExtUtils::Miniperl - -write the C code for perlmain.c +ExtUtils::Miniperl, writemain - Write the C code for perlmain.c =item ExtUtils::Mkbootstrap -make a bootstrap file for use by DynaLoader +Make a bootstrap file for use by DynaLoader =item ExtUtils::Mksymlists -write linker options files for dynamic extension +Write linker options files for dynamic extension =item ExtUtils::Packlist -manage .packlist files +Manage .packlist files =item ExtUtils::testlib -add blib/* directories to @INC +Add blib/* directories to @INC =item Fatal -replace functions with equivalents which succeed or die +Replace functions with equivalents which succeed or die =item Fcntl -load the C Fcntl.h defines +Load the libc fcntl.h defines =item File::Basename -split a pathname into pieces +Split a pathname into pieces + +=item File::CheckTree + +Run many filetest checks on a tree =item File::Compare @@ -414,23 +446,27 @@ Copy files or filehandles =item File::DosGlob -DOS like globbing and then some +DOS-like globbing and then some =item File::Find -traverse a file tree +Traverse a file tree + +=item File::Glob + +Perl extension for BSD filename globbing =item File::Path -create or remove a series of directories +Create or remove a series of directories =item File::Spec -portably perform operations on file names +Portably perform operations on file names =item File::Spec::Functions -portably perform operations on file names +Portably perform operations on file names =item File::Spec::Mac @@ -438,43 +474,43 @@ File::Spec for MacOS =item File::Spec::OS2 -methods for OS/2 file specs +Methods for OS/2 file specs =item File::Spec::Unix -methods used by File::Spec +Methods used by File::Spec =item File::Spec::VMS -methods for VMS file specs +Methods for VMS file specs =item File::Spec::Win32 -methods for Win32 file specs +Methods for Win32 file specs =item File::stat -by-name interface to Perl's built-in stat() functions +By-name interface to Perl's built-in stat() functions =item FileCache -keep more files open than the system permits +Keep more files open than the system permits =item FileHandle -supply object methods for filehandles +Supply object methods for filehandles =item FindBin -Locate directory of original perl script +Locate installation directory of running Perl program =item GDBM_File -Perl5 access to the gdbm library. +Access to the gdbm library =item Getopt::Long -extended processing of command line options +Extended processing of command line options =item Getopt::Std @@ -482,27 +518,27 @@ Process single-character switches with switch clustering =item I18N::Collate -compare 8-bit scalar data according to the current locale +Compare 8-bit scalar data according to current locale =item IO -load various IO modules +Front-end to load various IO modules =item IO::Dir -supply object methods for directory handles +Supply object methods for directory handles =item IO::File -supply object methods for filehandles +Supply object methods for filehandles =item IO::Handle -supply object methods for I/O handles +Supply object methods for I/O handles =item IO::Pipe -supply object methods for pipes +Supply object methods for pipes =item IO::Poll @@ -510,7 +546,7 @@ Object interface to system poll call =item IO::Seekable -supply seek based methods for I/O objects +Supply seek based methods for I/O objects =item IO::Select @@ -534,11 +570,11 @@ SysV Msg IPC object class =item IPC::Open2 -open a process for both reading and writing +Open a process for both reading and writing =item IPC::Open3 -open a process for reading, writing, and error handling +Open a process for reading, writing, and error handling =item IPC::Semaphore @@ -558,35 +594,31 @@ Arbitrary size integer math package =item Math::Complex -complex numbers and associated mathematical functions +Complex numbers and associated mathematical functions =item Math::Trig -trigonometric functions - -=item NDBM_File - -Tied access to ndbm files +Trigonometric functions =item Net::Ping -check a remote host for reachability +Check a remote host for reachability =item Net::hostent -by-name interface to Perl's built-in gethost*() functions +By-name interface to Perl's built-in gethost*() functions =item Net::netent -by-name interface to Perl's built-in getnet*() functions +By-name interface to Perl's built-in getnet*() functions =item Net::protoent -by-name interface to Perl's built-in getproto*() functions +By-name interface to Perl's built-in getproto*() functions =item Net::servent -by-name interface to Perl's built-in getserv*() functions +By-name interface to Perl's built-in getserv*() functions =item O @@ -594,19 +626,47 @@ Generic interface to Perl Compiler backends =item Opcode -Disable named opcodes when compiling perl code +Disable named opcodes when compiling Perl code =item POSIX Perl interface to IEEE Std 1003.1 +=item Pod::Checker + +Check pod documents for syntax errors + =item Pod::Html -module to convert pod files to HTML +Module to convert pod files to HTML + +=item Pod::InputObjects + +Manage POD objects + +=item Pod::Man + +Convert POD data to formatted *roff input + +=item Pod::Parser + +Base class for creating POD filters and translators + +=item Pod::Select + +Extract selected sections of POD from input =item Pod::Text -convert POD data to formatted ASCII text +Convert POD data to formatted ASCII text + +=item Pod::Text::Color + +Convert POD data to formatted color ASCII text + +=item Pod::Usage + +Print a usage message from embedded pod documentation =item SDBM_File @@ -618,27 +678,27 @@ Compile and execute code in restricted compartments =item Search::Dict -search for key in dictionary file +Search for key in dictionary file =item SelectSaver -save and restore selected file handle +Save and restore selected file handle =item SelfLoader -load functions only on demand +Load functions only on demand =item Shell -run shell commands transparently within perl +Run shell commands transparently within Perl =item Socket -load the C socket.h defines and structure manipulators +Load the libc socket.h defines and structure manipulators =item Symbol -manipulate Perl symbols and their names +Manipulate Perl symbols and their names =item Sys::Hostname @@ -646,85 +706,65 @@ Try every conceivable way to get hostname =item Sys::Syslog -Perl interface to the UNIX syslog(3) calls +Interface to the libc syslog(3) calls =item Term::Cap -Perl termcap interface +Termcap interface =item Term::Complete -Perl word completion module +Word completion module =item Term::ReadLine -Perl interface to various C packages. +Interface to various `readline' packages. =item Test -provides a simple framework for writing test scripts +Provides a simple framework for writing test scripts =item Test::Harness -run perl standard test scripts with statistics +Run Perl standard test scripts with statistics =item Text::Abbrev -create an abbreviation table from a list +Create an abbreviation table from a list =item Text::ParseWords -parse text into an array of tokens or array of arrays +Parse text into a list of tokens or array of arrays =item Text::Soundex -Implementation of the Soundex Algorithm as Described by Knuth +Implementation of the Soundex Algorithm as described by Knuth -=item Text::Tabs -- expand and unexpand tabs per the unix expand(1) and unexpand(1) +Text::Tabs -- expand and unexpand tabs per expand(1) and unexpand(1) =item Text::Wrap -line wrapping to form simple paragraphs - -=item Thread - -multithreading - -=item Thread::Queue - -thread-safe queues - -=item Thread::Semaphore - -thread-safe semaphores - -=item Thread::Signal - -Start a thread which runs signal handlers reliably - -=item Thread::Specific - -thread-specific keys +Line wrapping to form simple paragraphs =item Tie::Array -base class for tied arrays +Base class for tied arrays =item Tie::Handle -base class definitions for tied handles +Base class definitions for tied handles -=item Tie::Hash, Tie::StdHash +=item Tie::Hash -base class definitions for tied hashes +Base class definitions for tied hashes =item Tie::RefHash -use references as hash keys +Use references as hash keys -=item Tie::Scalar, Tie::StdScalar +=item Tie::Scalar -base class definitions for tied scalars +Base class definitions for tied scalars =item Tie::SubstrHash @@ -732,31 +772,31 @@ Fixed-table-size, fixed-key-length hashing =item Time::Local -efficiently compute time from local and GMT time +Efficiently compute time from local and GMT time =item Time::gmtime -by-name interface to Perl's built-in gmtime() function +By-name interface to Perl's built-in gmtime() function =item Time::localtime -by-name interface to Perl's built-in localtime() function +By-name interface to Perl's built-in localtime() function =item Time::tm -internal object used by Time::gmtime and Time::localtime +Internal object used by Time::gmtime and Time::localtime =item UNIVERSAL -base class for ALL classes (blessed references) +Base class for ALL classes (blessed references) =item User::grent -by-name interface to Perl's built-in getgr*() functions +By-name interface to Perl's built-in getgr*() functions =item User::pwent -by-name interface to Perl's built-in getpw*() functions +By-name interface to Perl's built-in getpw*() functions =back