MAN page from RedHat Other perl-5.004-0.1.i386.rpm

ExtUtils::Manifest

Section: Perl Programmers Reference Guide (3)
Updated: perl 5.004, patch 04
Index

NAME

ExtUtils::Manifest - utilities to write and check a MANIFEST file

SYNOPSIS

require ExtUtils::Manifest;

ExtUtils::Manifest::mkmanifest;

ExtUtils::Manifest::manicheck;

ExtUtils::Manifest::filecheck;

ExtUtils::Manifest::fullcheck;

ExtUtils::Manifest::skipcheck;

ExtUtild::Manifest::manifind();

ExtUtils::Manifest::maniread($file);

ExtUtils::Manifest::manicopy($read,$target,$how);

DESCRIPTION

Mkmanifest() writes all files in and below the current directory to afile named in the global variable $ExtUtils::Manifest::MANIFEST (whichdefaults to MANIFEST) in the current directory. It works similar to

    find . -print

but in doing so checks each line in an existing MANIFEST file andincludes any comments that are found in the existing MANIFEST filein the new one. Anything between white space and an end of line withina MANIFEST file is considered to be a comment. Filenames andcomments are seperated by one or more TAB characters in theoutput. All files that match any regular expression in a fileMANIFEST.SKIP (if such a file exists) are ignored.

Manicheck() checks if all the files within a MANIFEST in thecurrent directory really do exist. It only reports discrepancies andexits silently if MANIFEST and the tree below the current directoryare in sync.

Filecheck() finds files below the current directory that are notmentioned in the MANIFEST file. An optional file MANIFEST.SKIPwill be consulted. Any file matching a regular expression in such afile will not be reported as missing in the MANIFEST file.

Fullcheck() does both a manicheck() and a filecheck().

Skipcheck() lists all the files that are skipped due to yourMANIFEST.SKIP file.

Manifind() retruns a hash reference. The keys of the hash are thefiles found below the current directory.

Maniread($file) reads a named MANIFEST file (defaults toMANIFEST in the current directory) and returns a HASH referencewith files being the keys and comments being the values of the HASH.Blank lines and lines which start with # in the MANIFEST fileare discarded.

Manicopy($read,$target,$how) copies the files that are the keys inthe HASH %$read to the named target directory. The HASH reference$read is typically returned by the maniread() function. Thisfunction is useful for producing a directory tree identical to theintended distribution tree. The third parameter $how can be used tospecify a different methods of ``copying''. Valid values are cp,which actually copies the files, ln which creates hard links, andbest which mostly links the files but copies any symbolic link tomake a tree without any symbolic link. Best is the default.

MANIFEST.SKIP

The file MANIFEST.SKIP may contain regular expressions of files thatshould be ignored by mkmanifest() and filecheck(). The regularexpressions should appear one on each line. Blank lines and lineswhich start with # are skipped. Use \# if you need a regularexpression to start with a sharp character. A typical example:

    \bRCS\b    ^MANIFEST\.    ^Makefile$    ~$    \.html$    \.old$    ^blib/    ^MakeMaker-\d

EXPORT_OK

&mkmanifest, &manicheck, &filecheck, &fullcheck,&maniread, and &manicopy are exportable.

GLOBAL VARIABLES

$ExtUtils::Manifest::MANIFEST defaults to MANIFEST. Changing itresults in both a different MANIFEST and a differentMANIFEST.SKIP file. This is useful if you want to maintaindifferent distributions for different audiences (say a user versionand a developer version including RCS).

$ExtUtils::Manifest::Quiet defaults to 0. If set to a true value,all functions act silently.

DIAGNOSTICS

All diagnostic output is sent to STDERR.

Not in MANIFEST: file: is reported if a file is found, that is missing in the MANIFESTfile which is excluded by a regular expression in the fileMANIFEST.SKIP.
No such file: file: is reported if a file mentioned in a MANIFEST file does notexist.
MANIFEST: $!: is reported if MANIFEST could not be opened.
Added to MANIFEST: file: is reported by mkmanifest() if $Verbose is set and a file is addedto MANIFEST. $Verbose is set to 1 by default.

AUTHOR

Andreas Koenig <koenigAATTfranz.ww.TU-Berlin.DE>

This document was created byman2html,using the manual pages.