.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" 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 "Archive::Any::Plugin 3pm"
.TH Archive::Any::Plugin 3pm "2019-07-20" "perl v5.28.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"
Archive::Any::Plugin \- Anatomy of an Archive::Any plugin.
.SH "VERSION"
.IX Header "VERSION"
version 0.0946
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
Explains what is required for a working plugin to Archive::Any.
.SH "PLUGINS"
.IX Header "PLUGINS"
Archive::Any requires that your plugin define three methods, all of which are
passed the absolute filename of the file.  This module uses the source of
Archive::Any::Plugin::Tar as an example.
.IP "\fBSubclass Archive::Any::Plugin\fR" 4
.IX Item "Subclass Archive::Any::Plugin"
.Vb 1
\& use base \*(AqArchive::Any::Plugin\*(Aq;
.Ve
.IP "\fBcan_handle\fR" 4
.IX Item "can_handle"
This returns an array of mime types that the plugin can handle.
.Sp
.Vb 7
\& sub can_handle {
\&    return(
\&           \*(Aqapplication/x\-tar\*(Aq,
\&           \*(Aqapplication/x\-gtar\*(Aq,
\&           \*(Aqapplication/x\-gzip\*(Aq,
\&          );
\& }
.Ve
.IP "\fBfiles\fR" 4
.IX Item "files"
Return a list of items inside the archive.
.Sp
.Vb 5
\& sub files {
\&    my( $self, $file ) = @_;
\&    my $t = Archive::Tar\->new( $file );
\&    return $t\->list_files;
\& }
.Ve
.IP "\fBextract\fR" 4
.IX Item "extract"
This method should extract the contents of \f(CW$file\fR to the current directory.
Archive::Any::Plugin handles negotiating directories for you.
.Sp
.Vb 2
\& sub extract {
\&    my ( $self, $file ) = @_;
\&
\&    my $t = Archive::Tar\->new( $file );
\&    return $t\->extract;
\& }
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Archive::Any
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "\(bu" 4
Clint Moore
.IP "\(bu" 4
Michael G Schwern (author emeritus)
.IP "\(bu" 4
Olaf Alders (current maintainer)
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2016 by Michael G Schwern, Clint Moore, Olaf Alders.
.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.