[perl5.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}) {
    local $^W;
    *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;
    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;
    if (! chmod(  $mode | ( $mode & 0100 ? 0111 : 0 ),  $_  )) {
       unlink $dstFile;
       return;
    }
    1;
}

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

    require ExtUtils::Manifest;

    ExtUtils::Manifest::mkmanifest;

    ExtUtils::Manifest::manicheck;

    ExtUtils::Manifest::filecheck;

    ExtUtils::Manifest::fullcheck;

    ExtUtils::Manifest::skipcheck;

    ExtUtils::Manifest::manifind();

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

    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 separated 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() returns 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.

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