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