AnonymousFox

//usr/share/man/man3/ExtUtils::Packlist.3pm

.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.13)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\" ========================================================================
.\"
.IX Title "inc::ExtUtils::Packlist 3"
.TH inc::ExtUtils::Packlist 3 "2018-10-12" "perl v5.10.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
ExtUtils::Packlist \- manage .packlist files
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 5
\&   use ExtUtils::Packlist;
\&   my ($pl) = ExtUtils::Packlist\->new(\*(Aq.packlist\*(Aq);
\&   $pl\->read(\*(Aq/an/old/.packlist\*(Aq);
\&   my @missing_files = $pl\->validate();
\&   $pl\->write(\*(Aq/a/new/.packlist\*(Aq);
\&
\&   $pl\->{\*(Aq/some/file/name\*(Aq}++;
\&      or
\&   $pl\->{\*(Aq/some/other/file/name\*(Aq} = { type => \*(Aqfile\*(Aq,
\&                                      from => \*(Aq/some/file\*(Aq };
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
ExtUtils::Packlist provides a standard way to manage .packlist files.
Functions are provided to read and write .packlist files.  The original
\&.packlist format is a simple list of absolute pathnames, one per line.  In
addition, this package supports an extended format, where as well as a filename
each line may contain a list of attributes in the form of a space separated
list of key=value pairs.  This is used by the installperl script to
differentiate between files and links, for example.
.SH "USAGE"
.IX Header "USAGE"
The hash reference returned by the \fInew()\fR function can be used to examine and
modify the contents of the .packlist.  Items may be added/deleted from the
\&.packlist by modifying the hash.  If the value associated with a hash key is a
scalar, the entry written to the .packlist by any subsequent \fIwrite()\fR will be a
simple filename.  If the value is a hash, the entry written will be the
filename followed by the key=value pairs from the hash.  Reading back the
\&.packlist will recreate the original entries.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.IP "\fInew()\fR" 4
.IX Item "new()"
This takes an optional parameter, the name of a .packlist.  If the file exists,
it will be opened and the contents of the file will be read.  The \fInew()\fR method
returns a reference to a hash.  This hash holds an entry for each line in the
\&.packlist.  In the case of old-style .packlists, the value associated with each
key is undef.  In the case of new-style .packlists, the value associated with
each key is a hash containing the key=value pairs following the filename in the
\&.packlist.
.IP "\fIread()\fR" 4
.IX Item "read()"
This takes an optional parameter, the name of the .packlist to be read.  If
no file is specified, the .packlist specified to \fInew()\fR will be read.  If the
\&.packlist does not exist, Carp::croak will be called.
.IP "\fIwrite()\fR" 4
.IX Item "write()"
This takes an optional parameter, the name of the .packlist to be written.  If
no file is specified, the .packlist specified to \fInew()\fR will be overwritten.
.IP "\fIvalidate()\fR" 4
.IX Item "validate()"
This checks that every file listed in the .packlist actually exists.  If an
argument which evaluates to true is given, any missing files will be removed
from the internal hash.  The return value is a list of the missing files, which
will be empty if they all exist.
.IP "\fIpacklist_file()\fR" 4
.IX Item "packlist_file()"
This returns the name of the associated .packlist file
.SH "EXAMPLE"
.IX Header "EXAMPLE"
Here's \f(CW\*(C`modrm\*(C'\fR, a little utility to cleanly remove an installed module.
.PP
.Vb 1
\&    #!/usr/local/bin/perl \-w
\&
\&    use strict;
\&    use IO::Dir;
\&    use ExtUtils::Packlist;
\&    use ExtUtils::Installed;
\&
\&    sub emptydir($) {
\&        my ($dir) = @_;
\&        my $dh = IO::Dir\->new($dir) || return(0);
\&        my @count = $dh\->read();
\&        $dh\->close();
\&        return(@count == 2 ? 1 : 0);
\&    }
\&
\&    # Find all the installed packages
\&    print("Finding all installed modules...\en");
\&    my $installed = ExtUtils::Installed\->new();
\&
\&    foreach my $module (grep(!/^Perl$/, $installed\->modules())) {
\&       my $version = $installed\->version($module) || "???";
\&       print("Found module $module Version $version\en");
\&       print("Do you want to delete $module? [n] ");
\&       my $r = <STDIN>; chomp($r);
\&       if ($r && $r =~ /^y/i) {
\&          # Remove all the files
\&          foreach my $file (sort($installed\->files($module))) {
\&             print("rm $file\en");
\&             unlink($file);
\&          }
\&          my $pf = $installed\->packlist($module)\->packlist_file();
\&          print("rm $pf\en");
\&          unlink($pf);
\&          foreach my $dir (sort($installed\->directory_tree($module))) {
\&             if (emptydir($dir)) {
\&                print("rmdir $dir\en");
\&                rmdir($dir);
\&             }
\&          }
\&       }
\&    }
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Alan Burlison <Alan.Burlison@uk.sun.com>