SEARCH
NEW RPMS
DIRECTORIES
ABOUT
FAQ
VARIOUS
BLOG
DONATE


YUM REPOSITORY

 
 

MAN page from Fedora 6 perl-ExtUtils-MakeMaker-6.46-1.fc6.rf.noarch.rpm

inc::ExtUtils::Installed

Section: User Contributed Perl Documentation (3)
Updated: 2008-09-07
Index 

NAME

ExtUtils::Installed - Inventory management of installed modules 

SYNOPSIS

   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_usr_local = $inst->files("DBI", "all", "/usr/local");   my $all_dirs = $inst->directories("DBI");   my $dirs_below_usr_local = $inst->directory_tree("DBI", "prog");   my $packlist = $inst->packlist("DBI");
 

DESCRIPTION

ExtUtils::Installed provides a standard way to find out what core and modulefiles have been installed. It uses the information stored in .packlist filescreated during installation to provide this information. In addition itprovides facilities to classify the installed files and to extract directoryinformation from the .packlist files. 

USAGE

The new() function searches for all the installed .packlists on the system, andstores their contents. The .packlists can be queried with the functionsdescribed below. Where it searches by default is determined by the settings foundin %Config::Config, and what the value is of the PERL5LIB environment variable. 

FUNCTIONS

new()
This takes optional named parameters. Without parameters, thissearches for all the installed .packlists on the system usinginformation from %Config::Config and the default module searchpaths @INC. The packlists are read using theExtUtils::Packlist module.

If the named parameter "config_override" is specified,it should be a reference to a hash which contains all informationusually found in %Config::Config. For example, you can obtainthe configuration information for a separate perl installation andpass that in.

    my $yoda_cfg  = get_fake_config('yoda');    my $yoda_inst = ExtUtils::Installed->new(config_override=>$yoda_cfg);

Similarly, the parameter "inc_override" may be a reference to anarray which is used in place of the default module search pathsfrom @INC.

    use Config;    my @dirs = split(/\Q$Config{path_sep}\E/, $ENV{PERL5LIB});    my $p5libs = ExtUtils::Installed->new(inc_override=>\@dirs);

The parameter c<extra_libs> can be used to specify additional paths to search for installed modules. For instance

    my $installed = ExtUtils::Installed->new(extra_libs=>["/my/lib/path"]);

This should only be necessary if "/my/lib/path" is not in PERL5LIB.

modules()
This returns a list of the names of all the installed modules. The perl 'core'is given the special name 'Perl'.
files()
This takes one mandatory parameter, the name of a module. It returns a list ofall the filenames from the package. To obtain a list of core perl files, usethe module name 'Perl'. Additional parameters are allowed. The first is oneof the strings ``prog'', ``doc'' or ``all'', to select either just program files,just manual files or all files. The remaining parameters are a list ofdirectories. The filenames returned will be restricted to those under thespecified directories.
directories()
This takes one mandatory parameter, the name of a module. It returns a list ofall the directories from the package. Additional parameters are allowed. Thefirst is one of the strings ``prog'', ``doc'' or ``all'', to select either justprogram directories, just manual directories or all directories. The remainingparameters are a list of directories. The directories returned will berestricted to those under the specified directories. This method returns onlythe leaf directories that contain files from the specified module.
directory_tree()
This is identical in operation to directories(), except that it includes all theintermediate directories back up to the specified directories.
validate()
This takes one mandatory parameter, the name of a module. It checks that allthe files listed in the modules .packlist actually exist, and returns a list ofany missing files. If an optional second argument which evaluates to true isgiven any missing files will be removed from the .packlist
packlist()
This returns the ExtUtils::Packlist object for the specified module.
version()
This returns the version number for the specified module.
 

EXAMPLE

See the example in ExtUtils::Packlist. 

AUTHOR

Alan Burlison <Alan.BurlisonAATTuk.sun.com>


 

Index

NAME
SYNOPSIS
DESCRIPTION
USAGE
FUNCTIONS
EXAMPLE
AUTHOR

This document was created byman2html,using the manual pages.