[p5sagit/p5-mst-13.2.git] / lib / ExtUtils / Manifest.pm

package ExtUtils::Manifest;

require Exporter;
use Config;
use File::Find;
use File::Copy 'copy';
use Carp;
use strict;

use vars qw($VERSION @ISA @EXPORT_OK
	    $Is_VMS $Debug $Verbose $Quiet $MANIFEST $found);

$VERSION = substr(q$Revision: 1.33 $, 10);
@ISA=('Exporter');
@EXPORT_OK = ('mkmanifest', 'manicheck', 'fullcheck', 'filecheck', 
	      'skipcheck', 'maniread', 'manicopy');

$Is_VMS = $^O eq 'VMS';
if ($Is_VMS) { require File::Basename }

$Debug = 0;
$Verbose = 1;
$Quiet = 0;
$MANIFEST = 'MANIFEST';

# Really cool fix from Ilya :)
unless (defined $Config{d_link}) {
    *ln = \&cp;
}

sub mkmanifest {
    my $manimiss = 0;
    my $read = maniread() or $manimiss++;
    $read = {} if $manimiss;
    local *M;
    rename $MANIFEST, "$MANIFEST.bak" unless $manimiss;
    open M, ">$MANIFEST" or die "Could not open $MANIFEST: $!";
    my $matches = _maniskip();
    my $found = manifind();
    my($key,$val,$file,%all);
    %all = (%$found, %$read);
    $all{$MANIFEST} = ($Is_VMS ? "$MANIFEST\t\t" : '') . 'This list of files'
        if $manimiss; # add new MANIFEST to known file list
    foreach $file (sort keys %all) {
	next if &$matches($file);
	if ($Verbose){
	    warn "Added to $MANIFEST: $file\n" unless exists $read->{$file};
	}
	my $text = $all{$file};
	($file,$text) = split(/\s+/,$text,2) if $Is_VMS && $text;
	my $tabs = (5 - (length($file)+1)/8);
	$tabs = 1 if $tabs < 1;
	$tabs = 0 unless $text;
	print M $file, "\t" x $tabs, $text, "\n";
    }
    close M;
}

sub manifind {
    local $found = {};
    find(sub {return if -d $_;
	      (my $name = $File::Find::name) =~ s|./||;
	      warn "Debug: diskfile $name\n" if $Debug;
	      $name  =~ s#(.*)\.$#\L$1# if $Is_VMS;
	      $found->{$name} = "";}, ".");
    $found;
}

sub fullcheck {
    _manicheck(3);
}

sub manicheck {
    return @{(_manicheck(1))[0]};
}

sub filecheck {
    return @{(_manicheck(2))[1]};
}

sub skipcheck {
    _manicheck(6);
}

sub _manicheck {
    my($arg) = @_;
    my $read = maniread();
    my $found = manifind();
    my $file;
    my(@missfile,@missentry);
    if ($arg & 1){
	foreach $file (sort keys %$read){
	    warn "Debug: manicheck checking from $MANIFEST $file\n" if $Debug;
	    unless ( exists $found->{$file} ) {
		warn "No such file: $file\n" unless $Quiet;
		push @missfile, $file;
	    }
	}
    }
    if ($arg & 2){
	$read ||= {};
	my $matches = _maniskip();
	my $skipwarn = $arg & 4;
	foreach $file (sort keys %$found){
	    if (&$matches($file)){
		warn "Skipping $file\n" if $skipwarn;
		next;
	    }
	    warn "Debug: manicheck checking from disk $file\n" if $Debug;
	    unless ( exists $read->{$file} ) {
		warn "Not in $MANIFEST: $file\n" unless $Quiet;
		push @missentry, $file;
	    }
	}
    }
    (\@missfile,\@missentry);
}

sub maniread {
    my ($mfile) = @_;
    $mfile ||= $MANIFEST;
    my $read = {};
    local *M;
    unless (open M, $mfile){
	warn "$mfile: $!";
	return $read;
    }
    while (<M>){
	chomp;
	next if /^#/;
	if ($Is_VMS) {
	    my($file)= /^(\S+)/;
	    next unless $file;
	    my($base,$dir) = File::Basename::fileparse($file);
	    # Resolve illegal file specifications in the same way as tar
	    $dir =~ tr/./_/;
	    my(@pieces) = split(/\./,$base);
	    if (@pieces > 2) { $base = shift(@pieces) . '.' . join('_',@pieces); }
	    my $okfile = "$dir$base";
	    warn "Debug: Illegal name $file changed to $okfile\n" if $Debug;
	    $read->{"\L$okfile"}=$_;
	}
	else { /^(\S+)\s*(.*)/ and $read->{$1}=$2; }
    }
    close M;
    $read;
}

# returns an anonymous sub that decides if an argument matches
sub _maniskip {
    my ($mfile) = @_;
    my $matches = sub {0};
    my @skip ;
    $mfile ||= "$MANIFEST.SKIP";
    local *M;
    return $matches unless -f $mfile;
    open M, $mfile or return $matches;
    while (<M>){
	chomp;
	next if /^#/;
	next if /^\s*$/;
	push @skip, $_;
    }
    close M;
    my $opts = $Is_VMS ? 'oi ' : 'o ';
    my $sub = "\$matches = "
	. "sub { my(\$arg)=\@_; return 1 if "
	. join (" || ",  (map {s!/!\\/!g; "\$arg =~ m/$_/$opts"} @skip), 0)
	. " }";
    eval $sub;
    print "Debug: $sub\n" if $Debug;
    $matches;
}

sub manicopy {
    my($read,$target,$how)=@_;
    croak "manicopy() called without target argument" unless defined $target;
    $how ||= 'cp';
    require File::Path;
    require File::Basename;
    my(%dirs,$file);
    $target = VMS::Filespec::unixify($target) if $Is_VMS;
    umask 0 unless $Is_VMS;
    File::Path::mkpath([ $target ],1,$Is_VMS ? undef : 0755);
    foreach $file (keys %$read){
	$file = VMS::Filespec::unixify($file) if $Is_VMS;
	if ($file =~ m!/!) { # Ilya, that hurts, I fear, or maybe not?
	    my $dir = File::Basename::dirname($file);
	    $dir = VMS::Filespec::unixify($dir) if $Is_VMS;
	    File::Path::mkpath(["$target/$dir"],1,$Is_VMS ? undef : 0755);
	}
	cp_if_diff($file, "$target/$file", $how);
    }
}

sub cp_if_diff {
    my($from, $to, $how)=@_;
    -f $from or carp "$0: $from not found";
    my($diff) = 0;
    local(*F,*T);
    open(F,$from) or croak "Can't read $from: $!\n";
    if (open(T,$to)) {
	while (<F>) { $diff++,last if $_ ne <T>; }
	$diff++ unless eof(T);
	close T;
    }
    else { $diff++; }
    close F;
    if ($diff) {
	if (-e $to) {
	    unlink($to) or confess "unlink $to: $!";
	}
      STRICT_SWITCH: {
	    best($from,$to), last STRICT_SWITCH if $how eq 'best';
	    cp($from,$to), last STRICT_SWITCH if $how eq 'cp';
	    ln($from,$to), last STRICT_SWITCH if $how eq 'ln';
	    croak("ExtUtils::Manifest::cp_if_diff " .
		  "called with illegal how argument [$how]. " .
		  "Legal values are 'best', 'cp', and 'ln'.");
	}
    }
}

sub cp {
    my ($srcFile, $dstFile) = @_;
    my ($perm,$access,$mod) = (stat $srcFile)[2,8,9];
    copy($srcFile,$dstFile);
    utime $access, $mod + ($Is_VMS ? 1 : 0), $dstFile;
    # chmod a+rX-w,go-w
    chmod(  0444 | ( $perm & 0111 ? 0111 : 0 ),  $dstFile );
}

sub ln {
    my ($srcFile, $dstFile) = @_;
    return &cp if $Is_VMS;
    link($srcFile, $dstFile);
    local($_) = $dstFile; # chmod a+r,go-w+X (except "X" only applies to u=x)
    my $mode= 0444 | (stat)[2] & 0700;
    chmod(  $mode | ( $mode & 0100 ? 0111 : 0 ),  $_  );
}

sub best {
    my ($srcFile, $dstFile) = @_;
    if (-l $srcFile) {
	cp($srcFile, $dstFile);
    } else {
	ln($srcFile, $dstFile) or cp($srcFile, $dstFile);
    }
}

1;

__END__

=head1 NAME

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

=head1 SYNOPSIS

C<require ExtUtils::Manifest;>

C<ExtUtils::Manifest::mkmanifest;>

C<ExtUtils::Manifest::manicheck;>

C<ExtUtils::Manifest::filecheck;>

C<ExtUtils::Manifest::fullcheck;>

C<ExtUtils::Manifest::skipcheck;>

C<ExtUtild::Manifest::manifind();>

C<ExtUtils::Manifest::maniread($file);>

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

=head1 DESCRIPTION

Mkmanifest() writes all files in and below the current directory to a
file named in the global variable $ExtUtils::Manifest::MANIFEST (which
defaults to C<MANIFEST>) in the current directory. It works similar to

    find . -print

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

Manicheck() checks if all the files within a C<MANIFEST> in the
current directory really do exist. It only reports discrepancies and
exits silently if MANIFEST and the tree below the current directory
are in sync.

Filecheck() finds files below the current directory that are not
mentioned in the C<MANIFEST> file. An optional file C<MANIFEST.SKIP>
will be consulted. Any file matching a regular expression in such a
file will not be reported as missing in the C<MANIFEST> file.

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

Skipcheck() lists all the files that are skipped due to your
C<MANIFEST.SKIP> file.

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

Maniread($file) reads a named C<MANIFEST> file (defaults to
C<MANIFEST> 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 C<#> in the C<MANIFEST> file
are discarded.

I<Manicopy($read,$target,$how)> copies the files that are the keys in
the HASH I<%$read> to the named target directory. The HASH reference
I<$read> is typically returned by the maniread() function. This
function is useful for producing a directory tree identical to the
intended distribution tree. The third parameter $how can be used to
specify a different methods of "copying". Valid values are C<cp>,
which actually copies the files, C<ln> which creates hard links, and
C<best> which mostly links the files but copies any symbolic link to
make a tree without any symbolic link. Best is the default.

=head1 MANIFEST.SKIP

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

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

=head1 EXPORT_OK

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

=head1 GLOBAL VARIABLES

C<$ExtUtils::Manifest::MANIFEST> defaults to C<MANIFEST>. Changing it
results in both a different C<MANIFEST> and a different
C<MANIFEST.SKIP> file. This is useful if you want to maintain
different distributions for different audiences (say a user version
and a developer version including RCS).

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

=head1 DIAGNOSTICS

All diagnostic output is sent to C<STDERR>.

=over

=item C<Not in MANIFEST:> I<file>

is reported if a file is found, that is missing in the C<MANIFEST>
file which is excluded by a regular expression in the file
C<MANIFEST.SKIP>.

=item C<No such file:> I<file>

is reported if a file mentioned in a C<MANIFEST> file does not
exist.

=item C<MANIFEST:> I<$!>

is reported if C<MANIFEST> could not be opened.

=item C<Added to MANIFEST:> I<file>

is reported by mkmanifest() if $Verbose is set and a file is added
to MANIFEST. $Verbose is set to 1 by default.

=back

=head1 SEE ALSO

L<ExtUtils::MakeMaker> which has handy targets for most of the functionality.

=head1 AUTHOR

Andreas Koenig <F<koenig@franz.ww.TU-Berlin.DE>>

=cut
Commit	Line	Data
005c1a0e	1	package ExtUtils::Manifest;
005c1a0e	2
005c1a0e	3	require Exporter;
8e07c86e	4	use Config;
005c1a0e	5	use File::Find;
79dd614e	6	use File::Copy 'copy';
005c1a0e	7	use Carp;
8a1da95f	8	use strict;
8a1da95f	9
9607fc9c	10	use vars qw($VERSION @ISA @EXPORT_OK
9607fc9c	11	$Is_VMS $Debug $Verbose $Quiet $MANIFEST $found);
8a1da95f	12
15a074ca	13	$VERSION = substr(q$Revision: 1.33 $, 10);
8a1da95f	14	@ISA=('Exporter');
	15	@EXPORT_OK = ('mkmanifest', 'manicheck', 'fullcheck', 'filecheck',
	16	'skipcheck', 'maniread', 'manicopy');
005c1a0e	17
79dd614e	18	$Is_VMS = $^O eq 'VMS';
9607fc9c	19	if ($Is_VMS) { require File::Basename }
005c1a0e	20
9607fc9c	21	$Debug = 0;
9607fc9c	22	$Verbose = 1;
005c1a0e	23	$Quiet = 0;
cb1a09d0	24	$MANIFEST = 'MANIFEST';
cb1a09d0	25
4e68a208	26	# Really cool fix from Ilya :)
	27	unless (defined $Config{d_link}) {
	28	*ln = \&cp;
	29	}
	30
005c1a0e	31	sub mkmanifest {
	32	my $manimiss = 0;
	33	my $read = maniread() or $manimiss++;
	34	$read = {} if $manimiss;
864a5fa8	35	local *M;
cb1a09d0	36	rename $MANIFEST, "$MANIFEST.bak" unless $manimiss;
cb1a09d0	37	open M, ">$MANIFEST" or die "Could not open $MANIFEST: $!";
005c1a0e	38	my $matches = _maniskip();
	39	my $found = manifind();
	40	my($key,$val,$file,%all);
f1387719	41	%all = (%$found, %$read);
84876ac5	42	$all{$MANIFEST} = ($Is_VMS ? "$MANIFEST\t\t" : '') . 'This list of files'
84876ac5	43	if $manimiss; # add new MANIFEST to known file list
005c1a0e	44	foreach $file (sort keys %all) {
	45	next if &$matches($file);
	46	if ($Verbose){
cb1a09d0	47	warn "Added to $MANIFEST: $file\n" unless exists $read->{$file};
005c1a0e	48	}
8e07c86e	49	my $text = $all{$file};
84876ac5	50	($file,$text) = split(/\s+/,$text,2) if $Is_VMS && $text;
005c1a0e	51	my $tabs = (5 - (length($file)+1)/8);
005c1a0e	52	$tabs = 1 if $tabs < 1;
8e07c86e	53	$tabs = 0 unless $text;
8e07c86e	54	print M $file, "\t" x $tabs, $text, "\n";
005c1a0e	55	}
	56	close M;
	57	}
	58
	59	sub manifind {
	60	local $found = {};
4633a7c4	61	find(sub {return if -d $_;
005c1a0e	62	(my $name = $File::Find::name) =~ s\|./\|\|;
005c1a0e	63	warn "Debug: diskfile $name\n" if $Debug;
8e07c86e	64	$name =~ s#(.*)\.$#\L$1# if $Is_VMS;
005c1a0e	65	$found->{$name} = "";}, ".");
	66	$found;
	67	}
	68
	69	sub fullcheck {
	70	_manicheck(3);
	71	}
	72
	73	sub manicheck {
	74	return @{(_manicheck(1))[0]};
	75	}
	76
	77	sub filecheck {
	78	return @{(_manicheck(2))[1]};
	79	}
	80
8e07c86e	81	sub skipcheck {
	82	_manicheck(6);
	83	}
	84
005c1a0e	85	sub _manicheck {
	86	my($arg) = @_;
	87	my $read = maniread();
15a074ca	88	my $found = manifind();
005c1a0e	89	my $file;
	90	my(@missfile,@missentry);
	91	if ($arg & 1){
005c1a0e	92	foreach $file (sort keys %$read){
cb1a09d0	93	warn "Debug: manicheck checking from $MANIFEST $file\n" if $Debug;
005c1a0e	94	unless ( exists $found->{$file} ) {
8e07c86e	95	warn "No such file: $file\n" unless $Quiet;
8e07c86e	96	push @missfile, $file;
005c1a0e	97	}
	98	}
	99	}
	100	if ($arg & 2){
	101	$read \|\|= {};
	102	my $matches = _maniskip();
8e07c86e	103	my $skipwarn = $arg & 4;
005c1a0e	104	foreach $file (sort keys %$found){
8e07c86e	105	if (&$matches($file)){
	106	warn "Skipping $file\n" if $skipwarn;
	107	next;
	108	}
005c1a0e	109	warn "Debug: manicheck checking from disk $file\n" if $Debug;
005c1a0e	110	unless ( exists $read->{$file} ) {
cb1a09d0	111	warn "Not in $MANIFEST: $file\n" unless $Quiet;
8e07c86e	112	push @missentry, $file;
005c1a0e	113	}
	114	}
	115	}
	116	(\@missfile,\@missentry);
	117	}
	118
	119	sub maniread {
	120	my ($mfile) = @_;
15a074ca	121	$mfile \|\|= $MANIFEST;
005c1a0e	122	my $read = {};
	123	local *M;
	124	unless (open M, $mfile){
	125	warn "$mfile: $!";
	126	return $read;
	127	}
	128	while (<M>){
	129	chomp;
15a074ca	130	next if /^#/;
9607fc9c	131	if ($Is_VMS) {
	132	my($file)= /^(\S+)/;
	133	next unless $file;
	134	my($base,$dir) = File::Basename::fileparse($file);
	135	# Resolve illegal file specifications in the same way as tar
	136	$dir =~ tr/./_/;
	137	my(@pieces) = split(/\./,$base);
	138	if (@pieces > 2) { $base = shift(@pieces) . '.' . join('_',@pieces); }
	139	my $okfile = "$dir$base";
	140	warn "Debug: Illegal name $file changed to $okfile\n" if $Debug;
	141	$read->{"\L$okfile"}=$_;
	142	}
	143	else { /^(\S+)\s(.)/ and $read->{$1}=$2; }
005c1a0e	144	}
	145	close M;
	146	$read;
	147	}
	148
	149	# returns an anonymous sub that decides if an argument matches
	150	sub _maniskip {
	151	my ($mfile) = @_;
	152	my $matches = sub {0};
	153	my @skip ;
15a074ca	154	$mfile \|\|= "$MANIFEST.SKIP";
005c1a0e	155	local *M;
	156	return $matches unless -f $mfile;
	157	open M, $mfile or return $matches;
	158	while (<M>){
	159	chomp;
15a074ca	160	next if /^#/;
005c1a0e	161	next if /^\s*$/;
	162	push @skip, $_;
	163	}
	164	close M;
8e07c86e	165	my $opts = $Is_VMS ? 'oi ' : 'o ';
005c1a0e	166	my $sub = "\$matches = "
005c1a0e	167	. "sub { my(\$arg)=\@_; return 1 if "
8e07c86e	168	. join (" \|\| ", (map {s!/!\\/!g; "\$arg =~ m/$_/$opts"} @skip), 0)
005c1a0e	169	. " }";
	170	eval $sub;
	171	print "Debug: $sub\n" if $Debug;
	172	$matches;
	173	}
	174
	175	sub manicopy {
8e07c86e	176	my($read,$target,$how)=@_;
005c1a0e	177	croak "manicopy() called without target argument" unless defined $target;
15a074ca	178	$how \|\|= 'cp';
005c1a0e	179	require File::Path;
	180	require File::Basename;
	181	my(%dirs,$file);
8e07c86e	182	$target = VMS::Filespec::unixify($target) if $Is_VMS;
84876ac5	183	umask 0 unless $Is_VMS;
84876ac5	184	File::Path::mkpath([ $target ],1,$Is_VMS ? undef : 0755);
005c1a0e	185	foreach $file (keys %$read){
8e07c86e	186	$file = VMS::Filespec::unixify($file) if $Is_VMS;
84876ac5	187	if ($file =~ m!/!) { # Ilya, that hurts, I fear, or maybe not?
	188	my $dir = File::Basename::dirname($file);
	189	$dir = VMS::Filespec::unixify($dir) if $Is_VMS;
	190	File::Path::mkpath(["$target/$dir"],1,$Is_VMS ? undef : 0755);
	191	}
9607fc9c	192	cp_if_diff($file, "$target/$file", $how);
005c1a0e	193	}
	194	}
	195
	196	sub cp_if_diff {
8a1da95f	197	my($from, $to, $how)=@_;
15a074ca	198	-f $from or carp "$0: $from not found";
8e07c86e	199	my($diff) = 0;
	200	local(F,T);
	201	open(F,$from) or croak "Can't read $from: $!\n";
	202	if (open(T,$to)) {
	203	while (<F>) { $diff++,last if $_ ne <T>; }
	204	$diff++ unless eof(T);
	205	close T;
	206	}
	207	else { $diff++; }
	208	close F;
	209	if ($diff) {
	210	if (-e $to) {
	211	unlink($to) or confess "unlink $to: $!";
	212	}
15a074ca	213	STRICT_SWITCH: {
	214	best($from,$to), last STRICT_SWITCH if $how eq 'best';
	215	cp($from,$to), last STRICT_SWITCH if $how eq 'cp';
	216	ln($from,$to), last STRICT_SWITCH if $how eq 'ln';
	217	croak("ExtUtils::Manifest::cp_if_diff " .
	218	"called with illegal how argument [$how]. " .
	219	"Legal values are 'best', 'cp', and 'ln'.");
	220	}
8e07c86e	221	}
	222	}
	223
8e07c86e	224	sub cp {
8e07c86e	225	my ($srcFile, $dstFile) = @_;
79dd614e	226	my ($perm,$access,$mod) = (stat $srcFile)[2,8,9];
79dd614e	227	copy($srcFile,$dstFile);
9607fc9c	228	utime $access, $mod + ($Is_VMS ? 1 : 0), $dstFile;
8e07c86e	229	# chmod a+rX-w,go-w
	230	chmod( 0444 \| ( $perm & 0111 ? 0111 : 0 ), $dstFile );
	231	}
	232
	233	sub ln {
	234	my ($srcFile, $dstFile) = @_;
9607fc9c	235	return &cp if $Is_VMS;
8e07c86e	236	link($srcFile, $dstFile);
	237	local($_) = $dstFile; # chmod a+r,go-w+X (except "X" only applies to u=x)
	238	my $mode= 0444 \| (stat)[2] & 0700;
	239	chmod( $mode \| ( $mode & 0100 ? 0111 : 0 ), $_ );
	240	}
	241
4633a7c4	242	sub best {
	243	my ($srcFile, $dstFile) = @_;
	244	if (-l $srcFile) {
	245	cp($srcFile, $dstFile);
	246	} else {
3dee4013	247	ln($srcFile, $dstFile) or cp($srcFile, $dstFile);
4633a7c4	248	}
	249	}
	250
005c1a0e	251	1;
79dd614e	252
	253	__END__
	254
	255	=head1 NAME
	256
	257	ExtUtils::Manifest - utilities to write and check a MANIFEST file
	258
	259	=head1 SYNOPSIS
	260
	261	C<require ExtUtils::Manifest;>
	262
	263	C<ExtUtils::Manifest::mkmanifest;>
	264
	265	C<ExtUtils::Manifest::manicheck;>
	266
	267	C<ExtUtils::Manifest::filecheck;>
	268
	269	C<ExtUtils::Manifest::fullcheck;>
	270
	271	C<ExtUtils::Manifest::skipcheck;>
	272
	273	C<ExtUtild::Manifest::manifind();>
	274
	275	C<ExtUtils::Manifest::maniread($file);>
	276
	277	C<ExtUtils::Manifest::manicopy($read,$target,$how);>
	278
	279	=head1 DESCRIPTION
	280
	281	Mkmanifest() writes all files in and below the current directory to a
	282	file named in the global variable $ExtUtils::Manifest::MANIFEST (which
	283	defaults to C<MANIFEST>) in the current directory. It works similar to
	284
	285	find . -print
	286
	287	but in doing so checks each line in an existing C<MANIFEST> file and
	288	includes any comments that are found in the existing C<MANIFEST> file
	289	in the new one. Anything between white space and an end of line within
	290	a C<MANIFEST> file is considered to be a comment. Filenames and
	291	comments are seperated by one or more TAB characters in the
	292	output. All files that match any regular expression in a file
	293	C<MANIFEST.SKIP> (if such a file exists) are ignored.
	294
f1387719	295	Manicheck() checks if all the files within a C<MANIFEST> in the
	296	current directory really do exist. It only reports discrepancies and
	297	exits silently if MANIFEST and the tree below the current directory
	298	are in sync.
79dd614e	299
	300	Filecheck() finds files below the current directory that are not
	301	mentioned in the C<MANIFEST> file. An optional file C<MANIFEST.SKIP>
	302	will be consulted. Any file matching a regular expression in such a
	303	file will not be reported as missing in the C<MANIFEST> file.
	304
	305	Fullcheck() does both a manicheck() and a filecheck().
	306
	307	Skipcheck() lists all the files that are skipped due to your
	308	C<MANIFEST.SKIP> file.
	309
	310	Manifind() retruns a hash reference. The keys of the hash are the
	311	files found below the current directory.
	312
	313	Maniread($file) reads a named C<MANIFEST> file (defaults to
	314	C<MANIFEST> in the current directory) and returns a HASH reference
	315	with files being the keys and comments being the values of the HASH.
15a074ca	316	Blank lines and lines which start with C<#> in the C<MANIFEST> file
15a074ca	317	are discarded.
79dd614e	318
	319	I<Manicopy($read,$target,$how)> copies the files that are the keys in
	320	the HASH I<%$read> to the named target directory. The HASH reference
	321	I<$read> is typically returned by the maniread() function. This
	322	function is useful for producing a directory tree identical to the
	323	intended distribution tree. The third parameter $how can be used to
	324	specify a different methods of "copying". Valid values are C<cp>,
	325	which actually copies the files, C<ln> which creates hard links, and
	326	C<best> which mostly links the files but copies any symbolic link to
	327	make a tree without any symbolic link. Best is the default.
	328
	329	=head1 MANIFEST.SKIP
	330
	331	The file MANIFEST.SKIP may contain regular expressions of files that
	332	should be ignored by mkmanifest() and filecheck(). The regular
15a074ca	333	expressions should appear one on each line. Blank lines and lines
	334	which start with C<#> are skipped. Use C<\#> if you need a regular
	335	expression to start with a sharp character. A typical example:
79dd614e	336
	337	\bRCS\b
	338	^MANIFEST\.
	339	^Makefile$
	340	~$
	341	\.html$
	342	\.old$
	343	^blib/
	344	^MakeMaker-\d
	345
	346	=head1 EXPORT_OK
	347
	348	C<&mkmanifest>, C<&manicheck>, C<&filecheck>, C<&fullcheck>,
	349	C<&maniread>, and C<&manicopy> are exportable.
	350
	351	=head1 GLOBAL VARIABLES
	352
	353	C<$ExtUtils::Manifest::MANIFEST> defaults to C<MANIFEST>. Changing it
	354	results in both a different C<MANIFEST> and a different
	355	C<MANIFEST.SKIP> file. This is useful if you want to maintain
	356	different distributions for different audiences (say a user version
	357	and a developer version including RCS).
	358
81ff29e3	359	C<$ExtUtils::Manifest::Quiet> defaults to 0. If set to a true value,
79dd614e	360	all functions act silently.
	361
	362	=head1 DIAGNOSTICS
	363
	364	All diagnostic output is sent to C<STDERR>.
	365
	366	=over
	367
	368	=item C<Not in MANIFEST:> I<file>
	369
	370	is reported if a file is found, that is missing in the C<MANIFEST>
	371	file which is excluded by a regular expression in the file
	372	C<MANIFEST.SKIP>.
	373
	374	=item C<No such file:> I<file>
	375
	376	is reported if a file mentioned in a C<MANIFEST> file does not
	377	exist.
	378
	379	=item C<MANIFEST:> I<$!>
	380
	381	is reported if C<MANIFEST> could not be opened.
	382
	383	=item C<Added to MANIFEST:> I<file>
	384
	385	is reported by mkmanifest() if $Verbose is set and a file is added
	386	to MANIFEST. $Verbose is set to 1 by default.
	387
	388	=back
	389
	390	=head1 SEE ALSO
	391
	392	L<ExtUtils::MakeMaker> which has handy targets for most of the functionality.
	393
	394	=head1 AUTHOR
	395
352854fa	396	Andreas Koenig <F<koenig@franz.ww.TU-Berlin.DE>>
79dd614e	397
79dd614e	398	=cut