perlfunc
root
<P>
ExtUtils::Installed - Inventory management of installed modules
<P>
<HR>
<P>
<PRE> use ExtUtils::Installed;
my ($inst) = ExtUtils::Installed->new();
my (@modules) = $inst->modules();
my (@missing) = $inst->validate("DBI");
my $all_files = $inst->files("DBI");
my $files_below_us
<P>
ExtUtils::Installed provides a standard way to find out what core and
module files have been installed. It uses the information stored in
.packlist files created during installation to provide this information. In
addition it provides facilities to classify the installed files and to
extract directory information from the .packlist files.
<P>
<HR>
<H1><A NAME="USAGE">USAGE</A></H1>
<P>
The
<CODE>new()</CODE> function searches for all
the installed .packlists on the system, and stores their contents. The
.packlists can be queried with the functions described below.
<P>
<HR>
<H1><A NAME="FUNCTIONS">FUNCTIONS</A></H1>
<DL>
<DT><STRONG><A NAME="item_new">new()</A></STRONG><P>
<DD>
This takes no parameters, and searches for all the installed .packlists on
the system. The packlists are read using the ExtUtils::packlist module.
<P><DT><STRONG><A NAME="item_modules">modules()</A></STRONG><P>
<DD>
This returns a list of the names of all the installed modules. The perl
'core' is given the special name 'Perl'.
<P><DT><STRONG><A NAME="item_files">files()</A></STRONG><P>
<DD>
This takes one mandatory parameter, the name of a module. It returns a list
of all the filenames from the package. To obtain a list of core perl files,
use the module name 'Perl'. Additional parameters are allowed. The first is
one of the strings ``prog'', ``man'' or ``all'', to select either just
program files, just manual files or all files. The remaining parameters are
a list of directories. The filenames returned will be restricted to those
under the specified directories.
<P><DT><STRONG><A NAME="item_directories">directories()</A></STRONG><P>
<DD>
This takes one mandatory parameter, the name of a module. It returns a list
of all the directories from the package. Additional parameters are allowed.
The first is one of the strings ``prog'', ``man'' or ``all'', to select
either just program directories, just manual directories or all
directories. The remaining parameters are a list of directories. The
directories returned will be restricted to those under the specified
directories. This method returns only the leaf directories that contain
files from the specified module.
<P><DT><STRONG><A NAME="item_directory_tree">directory_tree()</A></STRONG><P>
<DD>
This is identical in operation to
<CODE>directory(),</CODE> except that
it includes all the intermediate directories back up to the specified
directories.
<P><DT><STRONG><A NAME="item_validate">validate()</A></STRONG><P>
<DD>
This takes one mandatory parameter, the name of a module. It checks that
all the files listed in the modules .packlist actually exist, and returns a
list of any missing files. If an optional second argument which evaluates
to true is given any missing files will be removed from the .packlist
<P><DT><STRONG><A NAME="item_packlist">packlist()</A></STRONG><P>
<DD>
This returns the ExtUtils::Packlist object for the specified module.
<P><DT><STRONG><A NAME="item_version">version()</A></STRONG><P>
<DD>
This returns the version number for the specified module.
</DL>
<P>
<HR>
<H1><A NAME="EXAMPLE">EXAMPLE</A></H1>
<P>
See the example in [perlman:ExtUtils::Packlist|Packlist].
<P>
<HR>
<H1><A NAME="AUTHOR">AUTHOR</A></H1>
<P>
Alan Burlison <<A
HREF="mailto:Alan.Burlison@uk.sun.com">Alan.Burlison@uk.sun.com</A>>
<HR>