home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _cddc048063975eda60367eba7d6e2905 < prev    next >
Encoding:
Text File  |  2000-03-23  |  5.6 KB  |  141 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>ExtUtils::Installed - Inventory management of installed modules</TITLE>
  5. <LINK REL="stylesheet" HREF="../../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> ExtUtils::Installed - Inventory management of installed modules</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <LI><A HREF="#usage">USAGE</A></LI>
  26.     <LI><A HREF="#functions">FUNCTIONS</A></LI>
  27.     <LI><A HREF="#example">EXAMPLE</A></LI>
  28.     <LI><A HREF="#author">AUTHOR</A></LI>
  29. </UL>
  30. <!-- INDEX END -->
  31.  
  32. <HR>
  33. <P>
  34. <H1><A NAME="name">NAME</A></H1>
  35. <P>ExtUtils::Installed - Inventory management of installed modules</P>
  36. <P>
  37. <HR>
  38. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  39. <UL>
  40. <LI>Linux</LI>
  41. <LI>Solaris</LI>
  42. <LI>Windows</LI>
  43. </UL>
  44. <HR>
  45. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  46. <PRE>
  47.    use ExtUtils::Installed;
  48.    my ($inst) = ExtUtils::Installed->new();
  49.    my (@modules) = $inst->modules();
  50.    my (@missing) = $inst->validate("DBI");
  51.    my $all_files = $inst->files("DBI");
  52.    my $files_below_usr_local = $inst->files("DBI", "all", "/usr/local");
  53.    my $all_dirs = $inst->directories("DBI");
  54.    my $dirs_below_usr_local = $inst->directory_tree("DBI", "prog");
  55.    my $packlist = $inst->packlist("DBI");</PRE>
  56. <P>
  57. <HR>
  58. <H1><A NAME="description">DESCRIPTION</A></H1>
  59. <P>ExtUtils::Installed  provides a standard way to find out what core and module
  60. files have been installed.  It uses the information stored in .packlist files
  61. created during installation to provide this information.  In addition it
  62. provides facilities to classify the installed files and to extract directory
  63. information from the .packlist files.</P>
  64. <P>
  65. <HR>
  66. <H1><A NAME="usage">USAGE</A></H1>
  67. <P>The <A HREF="#item_new"><CODE>new()</CODE></A> function searches for all the installed .packlists on the system, and
  68. stores their contents. The .packlists can be queried with the functions
  69. described below.</P>
  70. <P>
  71. <HR>
  72. <H1><A NAME="functions">FUNCTIONS</A></H1>
  73. <DL>
  74. <DT><STRONG><A NAME="item_new"><CODE>new()</CODE></A></STRONG><BR>
  75. <DD>
  76. This takes no parameters, and searches for all the installed .packlists on the
  77. system.  The packlists are read using the ExtUtils::packlist module.
  78. <P></P>
  79. <DT><STRONG><A NAME="item_modules"><CODE>modules()</CODE></A></STRONG><BR>
  80. <DD>
  81. This returns a list of the names of all the installed modules.  The perl 'core'
  82. is given the special name 'Perl'.
  83. <P></P>
  84. <DT><STRONG><A NAME="item_files"><CODE>files()</CODE></A></STRONG><BR>
  85. <DD>
  86. This takes one mandatory parameter, the name of a module.  It returns a list of
  87. all the filenames from the package.  To obtain a list of core perl files, use
  88. the module name 'Perl'.  Additional parameters are allowed.  The first is one
  89. of the strings ``prog'', ``man'' or ``all'', to select either just program files,
  90. just manual files or all files.  The remaining parameters are a list of
  91. directories. The filenames returned will be restricted to those under the
  92. specified directories.
  93. <P></P>
  94. <DT><STRONG><A NAME="item_directories"><CODE>directories()</CODE></A></STRONG><BR>
  95. <DD>
  96. This takes one mandatory parameter, the name of a module.  It returns a list of
  97. all the directories from the package.  Additional parameters are allowed.  The
  98. first is one of the strings ``prog'', ``man'' or ``all'', to select either just
  99. program directories, just manual directories or all directories.  The remaining
  100. parameters are a list of directories. The directories returned will be
  101. restricted to those under the specified directories.  This method returns only
  102. the leaf directories that contain files from the specified module.
  103. <P></P>
  104. <DT><STRONG><A NAME="item_directory_tree"><CODE>directory_tree()</CODE></A></STRONG><BR>
  105. <DD>
  106. This is identical in operation to directory(), except that it includes all the
  107. intermediate directories back up to the specified directories.
  108. <P></P>
  109. <DT><STRONG><A NAME="item_validate"><CODE>validate()</CODE></A></STRONG><BR>
  110. <DD>
  111. This takes one mandatory parameter, the name of a module.  It checks that all
  112. the files listed in the modules .packlist actually exist, and returns a list of
  113. any missing files.  If an optional second argument which evaluates to true is
  114. given any missing files will be removed from the .packlist
  115. <P></P>
  116. <DT><STRONG><A NAME="item_packlist"><CODE>packlist()</CODE></A></STRONG><BR>
  117. <DD>
  118. This returns the ExtUtils::Packlist object for the specified module.
  119. <P></P>
  120. <DT><STRONG><A NAME="item_version"><CODE>version()</CODE></A></STRONG><BR>
  121. <DD>
  122. This returns the version number for the specified module.
  123. <P></P></DL>
  124. <P>
  125. <HR>
  126. <H1><A NAME="example">EXAMPLE</A></H1>
  127. <P>See the example in <A HREF="../../lib/ExtUtils/Packlist.html">the ExtUtils::Packlist manpage</A>.</P>
  128. <P>
  129. <HR>
  130. <H1><A NAME="author">AUTHOR</A></H1>
  131. <P>Alan Burlison <<A HREF="mailto:Alan.Burlison@uk.sun.com">Alan.Burlison@uk.sun.com</A>></P>
  132. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  133. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  134. <STRONG><P CLASS=block> ExtUtils::Installed - Inventory management of installed modules</P></STRONG>
  135. </TD></TR>
  136. </TABLE>
  137.  
  138. </BODY>
  139.  
  140. </HTML>
  141.