mingw/html/lib/ExtUtils/Installed.html

   1 <?xml version="1.0" ?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5 <title>ExtUtils::Installed - Inventory management of installed modules</title>
   6 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
   7 <link rev="made" href="mailto:" />
   8 </head>
   9
  10 <body style="background-color: white">
  11 <table border="0" width="100%" cellspacing="0" cellpadding="3">
  12 <tr><td class="block" style="background-color: #cccccc" valign="middle">
  13 <big><strong><span class="block">&nbsp;ExtUtils::Installed - Inventory management of installed modules</span></strong></big>
  14 </td></tr>
  15 </table>
  16
  17 <p><a name="__index__"></a></p>
  18 <!-- INDEX BEGIN -->
  19
  20 <ul>
  21
  22         <li><a href="#name">NAME</a></li>
  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 </p>
  35 <h1><a name="name">NAME</a></h1>
  36 <p>ExtUtils::Installed - Inventory management of installed modules</p>
  37 <p>
  38 </p>
  39 <hr />
  40 <h1><a name="synopsis">SYNOPSIS</a></h1>
  41 <pre>
  42    use ExtUtils::Installed;
  43    my ($inst) = ExtUtils::Installed-&gt;new();
  44    my (@modules) = $inst-&gt;modules();
  45    my (@missing) = $inst-&gt;validate(&quot;DBI&quot;);
  46    my $all_files = $inst-&gt;files(&quot;DBI&quot;);
  47    my $files_below_usr_local = $inst-&gt;files(&quot;DBI&quot;, &quot;all&quot;, &quot;/usr/local&quot;);
  48    my $all_dirs = $inst-&gt;directories(&quot;DBI&quot;);
  49    my $dirs_below_usr_local = $inst-&gt;directory_tree(&quot;DBI&quot;, &quot;prog&quot;);
  50    my $packlist = $inst-&gt;packlist(&quot;DBI&quot;);</pre>
  51 <p>
  52 </p>
  53 <hr />
  54 <h1><a name="description">DESCRIPTION</a></h1>
  55 <p>ExtUtils::Installed  provides a standard way to find out what core and module
  56 files have been installed.  It uses the information stored in .packlist files
  57 created during installation to provide this information.  In addition it
  58 provides facilities to classify the installed files and to extract directory
  59 information from the .packlist files.</p>
  60 <p>
  61 </p>
  62 <hr />
  63 <h1><a name="usage">USAGE</a></h1>
  64 <p>The <a href="#item_new"><code>new()</code></a> function searches for all the installed .packlists on the system, and
  65 stores their contents. The .packlists can be queried with the functions
  66 described below.</p>
  67 <p>
  68 </p>
  69 <hr />
  70 <h1><a name="functions">FUNCTIONS</a></h1>
  71 <dl>
  72 <dt><strong><a name="item_new"><code>new()</code></a></strong>
  73
  74 <dd>
  75 <p>This takes no parameters, and searches for all the installed .packlists on the
  76 system.  The packlists are read using the ExtUtils::packlist module.</p>
  77 </dd>
  78 </li>
  79 <dt><strong><a name="item_modules"><code>modules()</code></a></strong>
  80
  81 <dd>
  82 <p>This returns a list of the names of all the installed modules.  The perl 'core'
  83 is given the special name 'Perl'.</p>
  84 </dd>
  85 </li>
  86 <dt><strong><a name="item_files"><code>files()</code></a></strong>
  87
  88 <dd>
  89 <p>This takes one mandatory parameter, the name of a module.  It returns a list of
  90 all the filenames from the package.  To obtain a list of core perl files, use
  91 the module name 'Perl'.  Additional parameters are allowed.  The first is one
  92 of the strings ``prog'', ``doc'' or ``all'', to select either just program files,
  93 just manual files or all files.  The remaining parameters are a list of
  94 directories. The filenames returned will be restricted to those under the
  95 specified directories.</p>
  96 </dd>
  97 </li>
  98 <dt><strong><a name="item_directories"><code>directories()</code></a></strong>
  99
 100 <dd>
 101 <p>This takes one mandatory parameter, the name of a module.  It returns a list of
 102 all the directories from the package.  Additional parameters are allowed.  The
 103 first is one of the strings ``prog'', ``doc'' or ``all'', to select either just
 104 program directories, just manual directories or all directories.  The remaining
 105 parameters are a list of directories. The directories returned will be
 106 restricted to those under the specified directories.  This method returns only
 107 the leaf directories that contain files from the specified module.</p>
 108 </dd>
 109 </li>
 110 <dt><strong><a name="item_directory_tree"><code>directory_tree()</code></a></strong>
 111
 112 <dd>
 113 <p>This is identical in operation to directories(), except that it includes all the
 114 intermediate directories back up to the specified directories.</p>
 115 </dd>
 116 </li>
 117 <dt><strong><a name="item_validate"><code>validate()</code></a></strong>
 118
 119 <dd>
 120 <p>This takes one mandatory parameter, the name of a module.  It checks that all
 121 the files listed in the modules .packlist actually exist, and returns a list of
 122 any missing files.  If an optional second argument which evaluates to true is
 123 given any missing files will be removed from the .packlist</p>
 124 </dd>
 125 </li>
 126 <dt><strong><a name="item_packlist"><code>packlist()</code></a></strong>
 127
 128 <dd>
 129 <p>This returns the ExtUtils::Packlist object for the specified module.</p>
 130 </dd>
 131 </li>
 132 <dt><strong><a name="item_version"><code>version()</code></a></strong>
 133
 134 <dd>
 135 <p>This returns the version number for the specified module.</p>
 136 </dd>
 137 </li>
 138 </dl>
 139 <p>
 140 </p>
 141 <hr />
 142 <h1><a name="example">EXAMPLE</a></h1>
 143 <p>See the example in <a href="file://C|\msysgit\mingw\html/lib/ExtUtils/Packlist.html">the ExtUtils::Packlist manpage</a>.</p>
 144 <p>
 145 </p>
 146 <hr />
 147 <h1><a name="author">AUTHOR</a></h1>
 148 <p>Alan Burlison &lt;<a href="mailto:Alan.Burlison@uk.sun.com">Alan.Burlison@uk.sun.com</a>&gt;</p>
 149 <table border="0" width="100%" cellspacing="0" cellpadding="3">
 150 <tr><td class="block" style="background-color: #cccccc" valign="middle">
 151 <big><strong><span class="block">&nbsp;ExtUtils::Installed - Inventory management of installed modules</span></strong></big>
 152 </td></tr>
 153 </table>
 154
 155 </body>
 156
 157 </html>