Fix pod/perlmodlib.PL (it wasn't generating a complete list
Rafael Garcia-Suarez [Sun, 15 Sep 2002 11:30:38 +0000 (11:30 +0000)]
of modules.) Regenerate pod/perlmodlib.pod. Add a warning :
not all modules listed in perlmodlib are necessarily installed.
Plus some corrections by Vincent Lefevre.

p4raw-id: //depot/perl@17906

lib/Term/ReadLine.pm
pod/perlmodlib.PL
pod/perlmodlib.pod

index 8c58694..477aa43 100644 (file)
@@ -1,7 +1,7 @@
 =head1 NAME
 
-Term::ReadLine - Perl interface to various C<readline> packages. If
-no real package is found, substitutes stubs instead of basic functions.
+Term::ReadLine - Perl interface to various C<readline> packages.
+If no real package is found, substitutes stubs instead of basic functions.
 
 =head1 SYNOPSIS
 
index 982adff..9c0f51f 100644 (file)
@@ -7,15 +7,22 @@ my (@pragma, @mod, @MANIFEST);
 
 open (MANIFEST, "../MANIFEST") or die $!;
 @MANIFEST = grep !m</(?:t|demo)/>, <MANIFEST>;
-push @MANIFEST, 'lib/Config.pm', 'lib/Errno.pm';
+push @MANIFEST, 'lib/Config.pod', 'lib/Errno.pm', 'lib/lib.pm',
+    'lib/DynaLoader.pm', 'lib/XSLoader.pm';
 
 for (@MANIFEST) {
      my $filename;
      next unless s|^lib/|| or m|^ext/|;
-     ($filename) = m|^(\S+)|;
+     my ($origfilename) = ($filename) = m|^(\S+)|;
      $filename =~ s|^[^/]+/|| if $filename =~ s|^ext/||;
      next unless $filename =~ m!\.p(m|od)$!;
-     next unless open (MOD, "../lib/$filename");
+     unless (open (MOD, "../lib/$filename")) {
+       unless (open (MOD, "../$origfilename")) {
+           warn "Couldn't open ../$origfilename: $!";
+           next;
+       }
+       $filename = $origfilename;
+     }
 
 
      my ($name, $thing);
@@ -37,7 +44,9 @@ for (@MANIFEST) {
      close MOD;
 
      my $perlname = $filename;
+     $perlname =~ s!^.*\b(ext|lib)/!!;
      $perlname =~ s!\.p(m|od)$!!;
+     $perlname =~ s!\b(\w+)/\1\b!$1!;
      $perlname =~ s!/!::!g;
 
      ($name, $thing) = split / --? /, $title, 2;
@@ -68,13 +77,11 @@ Generated by perlmodlib.PL -- DO NOT EDIT!
 
 perlmodlib - constructing new Perl modules and finding existing ones
 
-=head1 DESCRIPTION
-
 =head1 THE PERL MODULE LIBRARY
 
-Many modules are included the Perl distribution.  These are described
+Many modules are included in the Perl distribution.  These are described
 below, and all end in F<.pm>.  You may discover compiled library
-file (usually ending in F<.so>) or small pieces of modules to be
+files (usually ending in F<.so>) or small pieces of modules to be
 autoloaded (ending in F<.al>); these were automatically generated
 by the installation process.  You may also discover files in the
 library directory that end in either F<.pl> or F<.ph>.  These are
@@ -125,6 +132,10 @@ Standard, bundled modules are all expected to behave in a well-defined
 manner with respect to namespace pollution because they use the
 Exporter module.  See their own documentation for details.
 
+It's possible that not all modules listed below are installed on your
+system. For example, the GDBM_File module will not be installed if you
+don't have the gdbm library.
+
 =over 12
 
 EOF
@@ -160,7 +171,7 @@ completely) due to their sizes, volatility, or simply lack of time
 for adequate testing and configuration across the multitude of
 platforms on which Perl was beta-tested.  You are encouraged to
 look for them on CPAN (described below), or using web search engines
-like Alta Vista or Deja News.
+like Alta Vista or Google.
 
 =head1 CPAN
 
index 9a44bc4..c1e1a46 100644 (file)
@@ -5,13 +5,11 @@ Generated by perlmodlib.PL -- DO NOT EDIT!
 
 perlmodlib - constructing new Perl modules and finding existing ones
 
-=head1 DESCRIPTION
-
 =head1 THE PERL MODULE LIBRARY
 
-Many modules are included the Perl distribution.  These are described
+Many modules are included in the Perl distribution.  These are described
 below, and all end in F<.pm>.  You may discover compiled library
-file (usually ending in F<.so>) or small pieces of modules to be
+files (usually ending in F<.so>) or small pieces of modules to be
 autoloaded (ending in F<.al>); these were automatically generated
 by the installation process.  You may also discover files in the
 library directory that end in either F<.pl> or F<.ph>.  These are
@@ -67,7 +65,7 @@ Establish IS-A relationship with base class at compile time
 
 =item bigint
 
-Transparent big integer support for Perl
+Transparent BigInteger support for Perl
 
 =item bignum
 
@@ -75,7 +73,7 @@ Transparent BigNumber support for Perl
 
 =item bigrat
 
-Transparent BigNumber/BigRational support for Perl
+Transparent BigNumber/BigRationale support for Perl
 
 =item blib
 
@@ -121,6 +119,10 @@ Use integer arithmetic instead of floating point
 
 Request less of something from the compiler
 
+=item lib
+
+Manipulate @INC at compile time
+
 =item locale
 
 Use and avoid POSIX locales for built-in operations
@@ -161,6 +163,10 @@ Predeclare sub names
 
 Perl extension allowing use of interpreter based threads from perl
 
+=item threads::shared
+
+Perl extension for sharing data structures between threads
+
 =item utf8
 
 Enable/disable UTF-8 (or UTF-EBCDIC) in source code
@@ -189,6 +195,10 @@ Standard, bundled modules are all expected to behave in a well-defined
 manner with respect to namespace pollution because they use the
 Exporter module.  See their own documentation for details.
 
+It's possible that not all modules listed below are installed on your
+system. For example, the GDBM_File module will not be installed if you
+don't have the gdbm library.
+
 =over 12
 
 =item AnyDBM_File
@@ -363,6 +373,18 @@ Programmatic interface to the Perl debugging API (draft, subject to
 
 Perl5 access to Berkeley DB version 1.x
 
+=item Data::Dumper
+
+Stringified perl data structures, suitable for both printing and C<eval>
+
+=item Devel::DProf
+
+A Perl code profiler
+
+=item Devel::Peek
+
+A data debugging tool for the XS programmer
+
 =item Devel::SelfStubber
 
 Generate stubs for a SelfLoading module
@@ -371,6 +393,10 @@ Generate stubs for a SelfLoading module
 
 Modules that calculate message digests
 
+=item Digest::MD5
+
+Perl interface to the MD5 Algorithm
+
 =item DirHandle
 
 Supply object methods for directory handles
@@ -379,10 +405,98 @@ Supply object methods for directory handles
 
 Provides screen dump of Perl data.
 
+=item DynaLoader
+
+Dynamically load C libraries into Perl code
+
 =item Encode
 
 Character encodings
 
+=item Encode::Alias
+
+Alias definitions to encodings
+
+=item Encode::Byte
+
+Single Byte Encodings
+
+=item Encode::CJKConstants
+
+Internally used by Encode::??::ISO_2022_*
+
+=item Encode::CN
+
+China-based Chinese Encodings
+
+=item Encode::CN::HZ
+
+Internally used by Encode::CN
+
+=item Encode::Config
+
+Internally used by Encode
+
+=item Encode::EBCDIC
+
+EBCDIC Encodings
+
+=item Encode::Encoder
+
+Object Oriented Encoder
+
+=item Encode::Encoding
+
+Encode Implementation Base Class
+
+=item Encode::Guess
+
+Guesses encoding from data
+
+=item Encode::JP
+
+Japanese Encodings
+
+=item Encode::JP::H2Z
+
+Internally used by Encode::JP::2022_JP*
+
+=item Encode::JP::JIS7
+
+Internally used by Encode::JP
+
+=item Encode::KR
+
+Korean Encodings
+
+=item Encode::KR::2022_KR
+
+Internally used by Encode::KR
+
+=item Encode::MIME::Header
+
+MIME 'B' and 'Q' header encoding
+
+=item Encode::PerlIO
+
+A detailed document on Encode and PerlIO
+
+=item Encode::Supported
+
+Encodings supported by Encode
+
+=item Encode::Symbol
+
+Symbol Encodings
+
+=item Encode::TW
+
+Taiwan-based Chinese Encodings
+
+=item Encode::Unicode
+
+Various Unicode Transformation Formats
+
 =item English
 
 Use nice English (or awk) names for ugly punctuation variables
@@ -543,6 +657,10 @@ DOS like globbing and then some
 
 Traverse a directory tree.
 
+=item File::Glob
+
+Perl extension for BSD glob routine
+
 =item File::Path
 
 Create or remove directory trees
@@ -603,10 +721,18 @@ Supply object methods for filehandles
 
 Simplified source filtering
 
+=item Filter::Util::Call
+
+Perl Source Filter Utility Module
+
 =item FindBin
 
 Locate directory of original perl script
 
+=item GDBM_File
+
+Perl5 access to the gdbm library.
+
 =item Getopt::Long
 
 Extended processing of command line options
@@ -631,10 +757,54 @@ Functions for dealing with RFC3066-style language tags
 
 Tags and names for human languages
 
+=item I18N::Langinfo
+
+Query locale information
+
 =item IO
 
 Load various IO modules
 
+=item IO::Dir
+
+Supply object methods for directory handles
+
+=item IO::File
+
+Supply object methods for filehandles
+
+=item IO::Handle
+
+Supply object methods for I/O handles
+
+=item IO::Pipe
+
+Supply object methods for pipes
+
+=item IO::Poll
+
+Object interface to system poll call
+
+=item IO::Seekable
+
+Supply seek based methods for I/O objects
+
+=item IO::Select
+
+OO interface to the select system call
+
+=item IO::Socket
+
+Object interface to socket communications
+
+=item IO::Socket::INET
+
+Object interface for AF_INET domain sockets
+
+=item IO::Socket::UNIX
+
+Object interface for AF_UNIX domain sockets
+
 =item IPC::Open2
 
 Open a process for both reading and writing
@@ -643,6 +813,22 @@ Open a process for both reading and writing
 
 Open a process for reading, writing, and error handling
 
+=item IPC::SysV
+
+SysV IPC constants
+
+=item IPC::SysV::Msg
+
+SysV Msg IPC object class
+
+=item IPC::SysV::Semaphore
+
+SysV Semaphore IPC object class
+
+=item List::Util
+
+A selection of general-utility list subroutines
+
 =item Locale::Constants
 
 Constants for Locale codes
@@ -671,6 +857,14 @@ Article about software localization
 
 ISO codes for script identification (ISO 15924)
 
+=item MIME::Base64
+
+Encoding and decoding of base64 strings
+
+=item MIME::Base64::QuotedPrint
+
+Encoding and decoding of quoted-printable strings
+
 =item Math::BigFloat
 
 Arbitrary size floating point math package
@@ -683,9 +877,13 @@ Arbitrary size integer math package
 
 Pure Perl module to support Math::BigInt
 
+=item Math::BigInt::Scalar
+
+Pure Perl module to test Math::BigInt with scalars
+
 =item Math::BigRat
 
-Arbitrarily big rationals
+Arbitrarily big rationales
 
 =item Math::Complex
 
@@ -815,6 +1013,18 @@ Perl interface to IEEE Std 1003.1
 
 On demand loader for PerlIO layers and root of PerlIO::* name space
 
+=item PerlIO::encoding
+
+Encoding layer
+
+=item PerlIO::scalar
+
+Support module for in-memory IO.
+
+=item PerlIO::via
+
+Helper class for PerlIO layers implemented in perl
+
 =item PerlIO::via::QuotedPrint
 
 PerlIO layer for quoted-printable strings
@@ -895,6 +1105,10 @@ Tied access to sdbm files
 
 Compile and execute code in restricted compartments
 
+=item Scalar::Util
+
+A selection of general-utility scalar subroutines
+
 =item Search::Dict
 
 Search for key in dictionary file
@@ -927,6 +1141,14 @@ A switch statement for Perl
 
 Manipulate Perl symbols and their names
 
+=item Sys::Hostname
+
+Try every conceivable way to get hostname
+
+=item Sys::Syslog
+
+Perl interface to the UNIX syslog(3) calls
+
 =item Term::ANSIColor
 
 Color screen output using ANSI escape sequences
@@ -941,7 +1163,7 @@ Perl word completion module
 
 =item Term::ReadLine
 
-Perl interface to various C<readline> packages. If
+Perl interface to various C<readline> packages.
 
 =item Test
 
@@ -1015,6 +1237,14 @@ 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
@@ -1047,6 +1277,10 @@ Base class definitions for tied scalars
 
 Fixed-table-size, fixed-key-length hashing
 
+=item Time::HiRes
+
+High resolution alarm, sleep, gettimeofday, interval timers
+
 =item Time::Local
 
 Efficiently compute time from local and GMT time
@@ -1071,6 +1305,10 @@ Base class for ALL classes (blessed references)
 
 Unicode Collation Algorithm
 
+=item Unicode::Normalize
+
+Unicode Normalization Forms
+
 =item Unicode::UCD
 
 Unicode character database
@@ -1087,6 +1325,18 @@ By-name interface to Perl's built-in getpw*() functions
 
 Interfaces to some Win32 API Functions
 
+=item XS::APItest
+
+Test the perl C API
+
+=item XS::Typemap
+
+Module to test the XS typemaps distributed with perl
+
+=item XSLoader
+
+Dynamically load C libraries into Perl code
+
 =back
 
 To find out I<all> modules installed on your system, including
@@ -1115,7 +1365,7 @@ completely) due to their sizes, volatility, or simply lack of time
 for adequate testing and configuration across the multitude of
 platforms on which Perl was beta-tested.  You are encouraged to
 look for them on CPAN (described below), or using web search engines
-like Alta Vista or Deja News.
+like Alta Vista or Google.
 
 =head1 CPAN