.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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::Create 3pm"
.TH Archive::Any::Create 3pm "2022-06-08" "perl v5.34.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"
Archive::Any::Create \- Abstract API to create archives (tar.gz and zip)
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Archive::Any::Create;
\&
\&  my $archive = Archive::Any::Create\->new;
\&
\&  $archive\->container(\*(Aqfoo\*(Aq);               # top\-level directory
\&  $archive\->add_file(\*(Aqbar.txt\*(Aq, $data);     # foo/bar.txt
\&  $archive\->add_file(\*(Aqbar/baz.txt\*(Aq, $data); # foo/bar/baz.txt
\&
\&  $archive\->write_file(\*(Aqfoo.tar.gz\*(Aq);
\&  $archive\->write_file(\*(Aqfoo.zip\*(Aq);
\&
\&  $archive\->write_filehandle(\e*STDOUT, \*(Aqtar.gz\*(Aq);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Archive::Any::Create is a wrapper module to create tar/tar.gz/zip
files with a single easy-to-use \s-1API.\s0
.SH "METHODS"
.IX Header "METHODS"
.IP "new" 4
.IX Item "new"
Create new Archive::Any::Create object. No parameters.
.IP "container($dir)" 4
.IX Item "container($dir)"
Specify a top-level directory (or folder) to contain multiple
files. Not necessary but recommended to create a good-manner archive
file.
.ie n .IP "add_file($file, $data)" 4
.el .IP "add_file($file, \f(CW$data\fR)" 4
.IX Item "add_file($file, $data)"
Add a file that contains \f(CW$data\fR as its content. \f(CW$file\fR can be a
file in the nested subdirectory.
.IP "write_file($filename)" 4
.IX Item "write_file($filename)"
Write an archive file named \f(CW$filename\fR. This method is DWIMmy, in
the sense that it automatically dispatches archiving module based on
its filename. So, \f(CW\*(C`$archive\->write_file("foo.tar.gz")\*(C'\fR will
create a tarball and \f(CW\*(C`$archive\->write_file("foo.zip")\*(C'\fR will
create a zip file with the same contents.
.ie n .IP "write_filehandle($fh, $format)" 4
.el .IP "write_filehandle($fh, \f(CW$format\fR)" 4
.IX Item "write_filehandle($fh, $format)"
Write an archive data stream into filehandle. \f(CW$format\fR is either,
\&\fItar\fR, \fItar.gz\fR or \fIzip\fR.
.SH "AUTHOR"
.IX Header "AUTHOR"
Tatsuhiko Miyagawa <miyagawa@bulknews.net>
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Archive::Any, Archive::Tar, Archive::Zip