Edit D:\app\Administrator\product\11.2.0\dbhome_1\perl\html\lib\ExtUtils\Manifest.html
<?xml version="1.0" ?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <title>ExtUtils::Manifest - utilities to write and check a MANIFEST file</title> <meta http-equiv="content-type" content="text/html; charset=utf-8" /> <link rev="made" href="mailto:" /> </head> <body style="background-color: white"> <table border="0" width="100%" cellspacing="0" cellpadding="3"> <tr><td class="block" style="background-color: #cccccc" valign="middle"> <big><strong><span class="block"> ExtUtils::Manifest - utilities to write and check a MANIFEST file</span></strong></big> </td></tr> </table> <!-- INDEX BEGIN --> <div name="index"> <p><a name="__index__"></a></p> <ul> <li><a href="#name">NAME</a></li> <li><a href="#synopsis">SYNOPSIS</a></li> <li><a href="#description">DESCRIPTION</a></li> <ul> <li><a href="#functions">Functions</a></li> <li><a href="#manifest">MANIFEST</a></li> <li><a href="#manifest_skip">MANIFEST.SKIP</a></li> <li><a href="#export_ok">EXPORT_OK</a></li> <li><a href="#global_variables">GLOBAL VARIABLES</a></li> </ul> <li><a href="#diagnostics">DIAGNOSTICS</a></li> <li><a href="#environment">ENVIRONMENT</a></li> <li><a href="#see_also">SEE ALSO</a></li> <li><a href="#author">AUTHOR</a></li> </ul> <hr name="index" /> </div> <!-- INDEX END --> <p> </p> <h1><a name="name">NAME</a></h1> <p>ExtUtils::Manifest - utilities to write and check a MANIFEST file</p> <p> </p> <hr /> <h1><a name="synopsis">SYNOPSIS</a></h1> <pre> use ExtUtils::Manifest qw(...funcs to import...);</pre> <pre> mkmanifest();</pre> <pre> my @missing_files = manicheck; my @skipped = skipcheck; my @extra_files = filecheck; my($missing, $extra) = fullcheck;</pre> <pre> my $found = manifind();</pre> <pre> my $manifest = maniread();</pre> <pre> manicopy($read,$target);</pre> <pre> maniadd({$file => $comment, ...});</pre> <p> </p> <hr /> <h1><a name="description">DESCRIPTION</a></h1> <p> </p> <h2><a name="functions">Functions</a></h2> <p>ExtUtils::Manifest exports no functions by default. The following are exported on request</p> <dl> <dt><strong><a name="mkmanifest" class="item">mkmanifest</a></strong> <dd> <pre> mkmanifest();</pre> </dd> <dd> <p>Writes all files in and below the current directory to your <em class="file">MANIFEST</em>. It works similar to</p> </dd> <dd> <pre> find . > MANIFEST</pre> </dd> <dd> <p>All files that match any regular expression in a file <em class="file">MANIFEST.SKIP</em> (if it exists) are ignored.</p> </dd> <dd> <p>Any existing <em class="file">MANIFEST</em> file will be saved as <em class="file">MANIFEST.bak</em>. Lines from the old <em class="file">MANIFEST</em> file is preserved, including any comments that are found in the existing <em class="file">MANIFEST</em> file in the new one.</p> </dd> <dt><strong><a name="manifind" class="item">manifind</a></strong> <dd> <pre> my $found = manifind();</pre> </dd> <dd> <p>returns a hash reference. The keys of the hash are the files found below the current directory.</p> </dd> <dt><strong><a name="manicheck" class="item">manicheck</a></strong> <dd> <pre> my @missing_files = manicheck();</pre> </dd> <dd> <p>checks if all the files within a <a href="#manifest"><code>MANIFEST</code></a> in the current directory really do exist. If <a href="#manifest"><code>MANIFEST</code></a> and the tree below the current directory are in sync it silently returns an empty list. Otherwise it returns a list of files which are listed in the <a href="#manifest"><code>MANIFEST</code></a> but missing from the directory, and by default also outputs these names to STDERR.</p> </dd> <dt><strong><a name="filecheck" class="item">filecheck</a></strong> <dd> <pre> my @extra_files = filecheck();</pre> </dd> <dd> <p>finds files below the current directory that are not mentioned in the <a href="#manifest"><code>MANIFEST</code></a> file. An optional file <code>MANIFEST.SKIP</code> will be consulted. Any file matching a regular expression in such a file will not be reported as missing in the <a href="#manifest"><code>MANIFEST</code></a> file. The list of any extraneous files found is returned, and by default also reported to STDERR.</p> </dd> <dt><strong><a name="fullcheck" class="item">fullcheck</a></strong> <dd> <pre> my($missing, $extra) = fullcheck();</pre> </dd> <dd> <p>does both a <a href="#manicheck"><code>manicheck()</code></a> and a <a href="#filecheck"><code>filecheck()</code></a>, returning then as two array refs.</p> </dd> <dt><strong><a name="skipcheck" class="item">skipcheck</a></strong> <dd> <pre> my @skipped = skipcheck();</pre> </dd> <dd> <p>lists all the files that are skipped due to your <code>MANIFEST.SKIP</code> file.</p> </dd> <dt><strong><a name="maniread" class="item">maniread</a></strong> <dd> <pre> my $manifest = maniread(); my $manifest = maniread($manifest_file);</pre> </dd> <dd> <p>reads a named <a href="#manifest"><code>MANIFEST</code></a> file (defaults to <a href="#manifest"><code>MANIFEST</code></a> in the current directory) and returns a HASH reference with files being the keys and comments being the values of the HASH. Blank lines and lines which start with <code>#</code> in the <a href="#manifest"><code>MANIFEST</code></a> file are discarded.</p> </dd> <dt><strong><a name="manicopy" class="item">manicopy</a></strong> <dd> <pre> manicopy(\%src, $dest_dir); manicopy(\%src, $dest_dir, $how);</pre> </dd> <dd> <p>Copies the files that are the keys in %src to the $dest_dir. %src is typically returned by the <a href="#maniread"><code>maniread()</code></a> function.</p> </dd> <dd> <pre> manicopy( maniread(), $dest_dir );</pre> </dd> <dd> <p>This function is useful for producing a directory tree identical to the intended distribution tree.</p> </dd> <dd> <p>$how can be used to specify a different methods of "copying". Valid values are <code>cp</code>, which actually copies the files, <code>ln</code> which creates hard links, and <code>best</code> which mostly links the files but copies any symbolic link to make a tree without any symbolic link. <code>cp</code> is the default.</p> </dd> <dt><strong><a name="maniadd" class="item">maniadd</a></strong> <dd> <pre> maniadd({ $file => $comment, ...});</pre> </dd> <dd> <p>Adds an entry to an existing <em class="file">MANIFEST</em> unless its already there.</p> </dd> <dd> <p>$file will be normalized (ie. Unixified). <strong>UNIMPLEMENTED</strong></p> </dd> </dl> <p> </p> <h2><a name="manifest">MANIFEST</a></h2> <p>A list of files in the distribution, one file per line. The MANIFEST always uses Unix filepath conventions even if you're not on Unix. This means <em class="file">foo/bar</em> style not <em class="file">foo\bar</em>.</p> <p>Anything between white space and an end of line within a <a href="#manifest"><code>MANIFEST</code></a> file is considered to be a comment. Any line beginning with # is also a comment.</p> <pre> # this a comment some/file some/other/file comment about some/file</pre> <p> </p> <h2><a name="manifest_skip">MANIFEST.SKIP</a></h2> <p>The file MANIFEST.SKIP may contain regular expressions of files that should be ignored by <a href="#mkmanifest"><code>mkmanifest()</code></a> and <a href="#filecheck"><code>filecheck()</code></a>. The regular expressions should appear one on each line. Blank lines and lines which start with <code>#</code> are skipped. Use <code>\#</code> if you need a regular expression to start with a <code>#</code>.</p> <p>For example:</p> <pre> # Version control files and dirs. \bRCS\b \bCVS\b ,v$ \B\.svn\b</pre> <pre> # Makemaker generated files and dirs. ^MANIFEST\. ^Makefile$ ^blib/ ^MakeMaker-\d</pre> <pre> # Temp, old and emacs backup files. ~$ \.old$ ^#.*#$ ^\.#</pre> <p>If no MANIFEST.SKIP file is found, a default set of skips will be used, similar to the example above. If you want nothing skipped, simply make an empty MANIFEST.SKIP file.</p> <p>In one's own MANIFEST.SKIP file, certain directives can be used to include the contents of other MANIFEST.SKIP files. At present two such directives are recognized.</p> <dl> <dt><strong><a name="include_default" class="item">#!include_default</a></strong> <dd> <p>This inserts the contents of the default MANIFEST.SKIP file</p> </dd> </li> <dt><strong><a name="include_path_to_another_manifest_skip" class="item">#!include /Path/to/another/manifest.skip</a></strong> <dd> <p>This inserts the contents of the specified external file</p> </dd> </li> </dl> <p>The included contents will be inserted into the MANIFEST.SKIP file in between <em>#!start included /path/to/manifest.skip</em> and <em>#!end included /path/to/manifest.skip</em> markers. The original MANIFEST.SKIP is saved as MANIFEST.SKIP.bak.</p> <p> </p> <h2><a name="export_ok">EXPORT_OK</a></h2> <p><a href="#mkmanifest"><code>&mkmanifest</code></a>, <a href="#manicheck"><code>&manicheck</code></a>, <a href="#filecheck"><code>&filecheck</code></a>, <a href="#fullcheck"><code>&fullcheck</code></a>, <a href="#maniread"><code>&maniread</code></a>, and <a href="#manicopy"><code>&manicopy</code></a> are exportable.</p> <p> </p> <h2><a name="global_variables">GLOBAL VARIABLES</a></h2> <p><code>$ExtUtils::Manifest::MANIFEST</code> defaults to <a href="#manifest"><code>MANIFEST</code></a>. Changing it results in both a different <a href="#manifest"><code>MANIFEST</code></a> and a different <code>MANIFEST.SKIP</code> file. This is useful if you want to maintain different distributions for different audiences (say a user version and a developer version including RCS).</p> <p><code>$ExtUtils::Manifest::Quiet</code> defaults to 0. If set to a true value, all functions act silently.</p> <p><code>$ExtUtils::Manifest::Debug</code> defaults to 0. If set to a true value, or if PERL_MM_MANIFEST_DEBUG is true, debugging output will be produced.</p> <p> </p> <hr /> <h1><a name="diagnostics">DIAGNOSTICS</a></h1> <p>All diagnostic output is sent to <code>STDERR</code>.</p> <dl> <dt><strong><a name="not_in_manifest_file" class="item"><code>Not in MANIFEST:</code> <em>file</em></a></strong> <dd> <p>is reported if a file is found which is not in <a href="#manifest"><code>MANIFEST</code></a>.</p> </dd> </li> <dt><strong><a name="skipping_file" class="item"><code>Skipping</code> <em>file</em></a></strong> <dd> <p>is reported if a file is skipped due to an entry in <code>MANIFEST.SKIP</code>.</p> </dd> </li> <dt><strong><a name="no_such_file_file" class="item"><code>No such file:</code> <em>file</em></a></strong> <dd> <p>is reported if a file mentioned in a <a href="#manifest"><code>MANIFEST</code></a> file does not exist.</p> </dd> </li> <dt><strong><a name="manifest3" class="item"><a href="#manifest"><code>MANIFEST:</code></a> <em>$!</em></a></strong> <dd> <p>is reported if <a href="#manifest"><code>MANIFEST</code></a> could not be opened.</p> </dd> </li> <dt><strong><a name="added_to_manifest_file" class="item"><code>Added to MANIFEST:</code> <em>file</em></a></strong> <dd> <p>is reported by <a href="#mkmanifest"><code>mkmanifest()</code></a> if $Verbose is set and a file is added to MANIFEST. $Verbose is set to 1 by default.</p> </dd> </li> </dl> <p> </p> <hr /> <h1><a name="environment">ENVIRONMENT</a></h1> <dl> <dt><strong><a name="perl_mm_manifest_debug" class="item"><strong>PERL_MM_MANIFEST_DEBUG</strong></a></strong> <dd> <p>Turns on debugging</p> </dd> </li> </dl> <p> </p> <hr /> <h1><a name="see_also">SEE ALSO</a></h1> <p><a href="file://C|\ADE\aime_smenon_perl_090715\perl\html/lib/ExtUtils/MakeMaker.html">the ExtUtils::MakeMaker manpage</a> which has handy targets for most of the functionality.</p> <p> </p> <hr /> <h1><a name="author">AUTHOR</a></h1> <p>Andreas Koenig <code>andreas.koenig@anima.de</code></p> <p>Maintained by Michael G Schwern <code>schwern@pobox.com</code> within the ExtUtils-MakeMaker package and, as a separate CPAN package, by Randy Kobes <code>r.kobes@uwinnipeg.ca</code>.</p> <table border="0" width="100%" cellspacing="0" cellpadding="3"> <tr><td class="block" style="background-color: #cccccc" valign="middle"> <big><strong><span class="block"> ExtUtils::Manifest - utilities to write and check a MANIFEST file</span></strong></big> </td></tr> </table> </body> </html>
Ms-Dos/Windows
Unix
Write backup
jsp File Browser version 1.2 by
www.vonloesch.de