.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" 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 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.
.\"
.\" 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::Tar::Streamed 3"
.TH Archive::Tar::Streamed 3 "2005-01-02" "perl v5.16.3" "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::Tar::Streamed \- Tar archives, non memory resident
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Archive::Tar::Streamed;
\&
\&  my $fh;
\&  open $fh,\*(Aq>\*(Aq,\*(Aq/home/myarch.tar\*(Aq or die "Couldn\*(Aqt create archive";
\&  binmode $fh;
\&  my $tar = Archive::Tar::Streamed\->new($fh);
\&  $tar\->add(\*(Aqfile1\*(Aq);
\&  $tar\->add(@files);
\&
\&  my $fh2l
\&  open $fh2,\*(Aq<\*(Aq,\*(Aqprevarch.tar\*(Aq or die "Couldn\*(Aqt open archive";
\&  binmode $fh;
\&  my $tar2 = Archive::Tar::Streamed\->new($fh2);
\&  my $fil = $tar2\->next;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The Archive::Tar module is a powerfull tool for manipulating archives from 
perl. However, most of the time, this module needs the entire archive to be
resident in memory. This renders the module per se, not to be directly usable
for very large archive (of the order of gigabytes).
.PP
Archive::Tar::Streamed provides a wrapper, which allows working with tar
archives on disk, with no need for the archive to be memory resident.
.PP
This module provides an alternative answer to the \s-1FAQ \s0\*(L"Isn't Archive::Tar 
heavier on memory than /bin/tar?\*(R". It also aims to be portable, and available
on platforms without a native tar.
.SS "add"
.IX Subsection "add"
This is a method call to add one or more files to an archive. These are written
to disk before the method returns.
.SS "next"
.IX Subsection "next"
This method is an iterator, which returns an Archive::Tar::File object
for the next file, or undef. undef indicates the end of the archive; any 
unexpected conditions result in throwing an exception.
.SH "BUGS"
.IX Header "BUGS"
Please use http://rt.cpan.org to report any bugs in this module
.SH "AUTHOR"
.IX Header "AUTHOR"
.Vb 2
\&        I. Williams
\&        bitumen@xemaps.com
.Ve
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.
.PP
The full text of the license can be found in the
\&\s-1LICENSE\s0 file included with this module.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Archive::Tar