.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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" ''
.    ds C`
.    ds C'
'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 >0, 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.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Dist::Metadata::Archive 3pm"
.TH Dist::Metadata::Archive 3pm "2021-01-07" "perl v5.32.0" "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"
Dist::Metadata::Archive \- Base class for Dist::Metadata archive files
.SH "VERSION"
.IX Header "VERSION"
version 0.927
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  my $dist = Dist::Metadata\->new(file => $path_to_archive);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a subclass of Dist::Metadata::Dist
to enable determining the metadata from an archive file.
.PP
It is a base class for archive file formats:
.IP "\(bu" 4
Dist::Metadata::Tar
.IP "\(bu" 4
Dist::Metadata::Zip
.PP
It's not useful on it's own
and should be used from \*(L"new\*(R" in Dist::Metadata.
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
.Vb 1
\&  $dist = Dist::Metadata::Archive\->new(file => $path);
.Ve
.PP
Accepts a single \f(CW\*(C`file\*(C'\fR argument that should be a path to a file.
.PP
If called from this base class
\&\f(CW\*(C`new()\*(C'\fR will delegate to a subclass based on the filename
and return a blessed instance of that subclass.
.SS "archive"
.IX Subsection "archive"
Returns an object representing the archive file.
.SS "default_file_spec"
.IX Subsection "default_file_spec"
Returns \f(CW\*(C`Unix\*(C'\fR since most archive files are be in unix format.
.SS "determine_name_and_version"
.IX Subsection "determine_name_and_version"
Attempts to parse name and version from file name.
.SS "file"
.IX Subsection "file"
The \f(CW\*(C`file\*(C'\fR attribute passed to the constructor,
used to load \*(L"archive\*(R".
.SS "read_archive"
.IX Subsection "read_archive"
.Vb 1
\&  $dist\->read_archive($file);
.Ve
.PP
Returns a format-specific object representing the specified file.
.PP
This \fBmust\fR be defined by subclasses.
.SH "AUTHOR"
.IX Header "AUTHOR"
Randy Stauner <rwstauner@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2011 by Randy Stauner.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.