--- /dev/null
+.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sh \" Subsection heading
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.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. | will give a
+.\" real vertical bar. \*(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-|\(bv\*(Tr
+.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\}
+.\"
+.\" If the F register is turned on, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.if \nF \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. nr % 0
+. rr F
+.\}
+.\"
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.hy 0
+.if n .na
+.\"
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
+.\" Fear. Run. Save yourself. No user-serviceable parts.
+. \" fudge factors for nroff and troff
+.if n \{\
+. ds #H 0
+. ds #V .8m
+. ds #F .3m
+. ds #[ \f1
+. ds #] \fP
+.\}
+.if t \{\
+. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
+. ds #V .6m
+. ds #F 0
+. ds #[ \&
+. ds #] \&
+.\}
+. \" simple accents for nroff and troff
+.if n \{\
+. ds ' \&
+. ds ` \&
+. ds ^ \&
+. ds , \&
+. ds ~ ~
+. ds /
+.\}
+.if t \{\
+. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
+. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
+. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
+. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
+. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
+. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
+.\}
+. \" troff and (daisy-wheel) nroff accents
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
+.ds ae a\h'-(\w'a'u*4/10)'e
+.ds Ae A\h'-(\w'A'u*4/10)'E
+. \" corrections for vroff
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
+. \" for low resolution devices (crt and lpr)
+.if \n(.H>23 .if \n(.V>19 \
+\{\
+. ds : e
+. ds 8 ss
+. ds o a
+. ds d- d\h'-1'\(ga
+. ds D- D\h'-1'\(hy
+. ds th \o'bp'
+. ds Th \o'LP'
+. ds ae ae
+. ds Ae AE
+.\}
+.rm #[ #] #H #V #F C
+.\" ========================================================================
+.\"
+.IX Title "IO::Uncompress::Bunzip2 3"
+.TH IO::Uncompress::Bunzip2 3 "2009-11-09" "perl v5.8.7" "User Contributed Perl Documentation"
+.SH "NAME"
+IO::Uncompress::Bunzip2 \- Read bzip2 files/buffers
+.SH "SYNOPSIS"
+.IX Header "SYNOPSIS"
+.Vb 1
+\& use IO::Uncompress::Bunzip2 qw(bunzip2 $Bunzip2Error) ;
+.Ve
+.PP
+.Vb 2
+\& my $status = bunzip2 $input => $output [,OPTS]
+\& or die "bunzip2 failed: $Bunzip2Error\en";
+.Ve
+.PP
+.Vb 2
+\& my $z = new IO::Uncompress::Bunzip2 $input [OPTS]
+\& or die "bunzip2 failed: $Bunzip2Error\en";
+.Ve
+.PP
+.Vb 7
+\& $status = $z\->read($buffer)
+\& $status = $z\->read($buffer, $length)
+\& $status = $z\->read($buffer, $length, $offset)
+\& $line = $z\->getline()
+\& $char = $z\->getc()
+\& $char = $z\->ungetc()
+\& $char = $z\->opened()
+.Ve
+.PP
+.Vb 9
+\& $data = $z\->trailingData()
+\& $status = $z\->nextStream()
+\& $data = $z\->getHeaderInfo()
+\& $z\->tell()
+\& $z\->seek($position, $whence)
+\& $z\->binmode()
+\& $z\->fileno()
+\& $z\->eof()
+\& $z\->close()
+.Ve
+.PP
+.Vb 1
+\& $Bunzip2Error ;
+.Ve
+.PP
+.Vb 1
+\& # IO::File mode
+.Ve
+.PP
+.Vb 10
+\& <$z>
+\& read($z, $buffer);
+\& read($z, $buffer, $length);
+\& read($z, $buffer, $length, $offset);
+\& tell($z)
+\& seek($z, $position, $whence)
+\& binmode($z)
+\& fileno($z)
+\& eof($z)
+\& close($z)
+.Ve
+.SH "DESCRIPTION"
+.IX Header "DESCRIPTION"
+This module provides a Perl interface that allows the reading of
+bzip2 files/buffers.
+.PP
+For writing bzip2 files/buffers, see the companion module IO::Compress::Bzip2.
+.SH "Functional Interface"
+.IX Header "Functional Interface"
+A top-level function, \f(CW\*(C`bunzip2\*(C'\fR, is provided to carry out
+\&\*(L"one\-shot\*(R" uncompression between buffers and/or files. For finer
+control over the uncompression process, see the \*(L"\s-1OO\s0 Interface\*(R"
+section.
+.PP
+.Vb 1
+\& use IO::Uncompress::Bunzip2 qw(bunzip2 $Bunzip2Error) ;
+.Ve
+.PP
+.Vb 2
+\& bunzip2 $input => $output [,OPTS]
+\& or die "bunzip2 failed: $Bunzip2Error\en";
+.Ve
+.PP
+The functional interface needs Perl5.005 or better.
+.ie n .Sh "bunzip2 $input\fP => \f(CW$output [, \s-1OPTS\s0]"
+.el .Sh "bunzip2 \f(CW$input\fP => \f(CW$output\fP [, \s-1OPTS\s0]"
+.IX Subsection "bunzip2 $input => $output [, OPTS]"
+\&\f(CW\*(C`bunzip2\*(C'\fR expects at least two parameters, \f(CW$input\fR and \f(CW$output\fR.
+.PP
+\fIThe \f(CI$input\fI parameter\fR
+.IX Subsection "The $input parameter"
+.PP
+The parameter, \f(CW$input\fR, is used to define the source of
+the compressed data.
+.PP
+It can take one of the following forms:
+.IP "A filename" 5
+.IX Item "A filename"
+If the \f(CW$input\fR parameter is a simple scalar, it is assumed to be a
+filename. This file will be opened for reading and the input data
+will be read from it.
+.IP "A filehandle" 5
+.IX Item "A filehandle"
+If the \f(CW$input\fR parameter is a filehandle, the input data will be
+read from it.
+The string '\-' can be used as an alias for standard input.
+.IP "A scalar reference" 5
+.IX Item "A scalar reference"
+If \f(CW$input\fR is a scalar reference, the input data will be read
+from \f(CW$$input\fR.
+.IP "An array reference" 5
+.IX Item "An array reference"
+If \f(CW$input\fR is an array reference, each element in the array must be a
+filename.
+.Sp
+The input data will be read from each file in turn.
+.Sp
+The complete array will be walked to ensure that it only
+contains valid filenames before any data is uncompressed.
+.IP "An Input FileGlob string" 5
+.IX Item "An Input FileGlob string"
+If \f(CW$input\fR is a string that is delimited by the characters \*(L"<\*(R" and \*(L">\*(R"
+\&\f(CW\*(C`bunzip2\*(C'\fR will assume that it is an \fIinput fileglob string\fR. The
+input is the list of files that match the fileglob.
+.Sp
+If the fileglob does not match any files ...
+.Sp
+See File::GlobMapper for more details.
+.PP
+If the \f(CW$input\fR parameter is any other type, \f(CW\*(C`undef\*(C'\fR will be returned.
+.PP
+\fIThe \f(CI$output\fI parameter\fR
+.IX Subsection "The $output parameter"
+.PP
+The parameter \f(CW$output\fR is used to control the destination of the
+uncompressed data. This parameter can take one of these forms.
+.IP "A filename" 5
+.IX Item "A filename"
+If the \f(CW$output\fR parameter is a simple scalar, it is assumed to be a
+filename. This file will be opened for writing and the uncompressed
+data will be written to it.
+.IP "A filehandle" 5
+.IX Item "A filehandle"
+If the \f(CW$output\fR parameter is a filehandle, the uncompressed data
+will be written to it.
+The string '\-' can be used as an alias for standard output.
+.IP "A scalar reference" 5
+.IX Item "A scalar reference"
+If \f(CW$output\fR is a scalar reference, the uncompressed data will be
+stored in \f(CW$$output\fR.
+.IP "An Array Reference" 5
+.IX Item "An Array Reference"
+If \f(CW$output\fR is an array reference, the uncompressed data will be
+pushed onto the array.
+.IP "An Output FileGlob" 5
+.IX Item "An Output FileGlob"
+If \f(CW$output\fR is a string that is delimited by the characters \*(L"<\*(R" and \*(L">\*(R"
+\&\f(CW\*(C`bunzip2\*(C'\fR will assume that it is an \fIoutput fileglob string\fR. The
+output is the list of files that match the fileglob.
+.Sp
+When \f(CW$output\fR is an fileglob string, \f(CW$input\fR must also be a fileglob
+string. Anything else is an error.
+.PP
+If the \f(CW$output\fR parameter is any other type, \f(CW\*(C`undef\*(C'\fR will be returned.
+.Sh "Notes"
+.IX Subsection "Notes"
+When \f(CW$input\fR maps to multiple compressed files/buffers and \f(CW$output\fR is
+a single file/buffer, after uncompression \f(CW$output\fR will contain a
+concatenation of all the uncompressed data from each of the input
+files/buffers.
+.Sh "Optional Parameters"
+.IX Subsection "Optional Parameters"
+Unless specified below, the optional parameters for \f(CW\*(C`bunzip2\*(C'\fR,
+\&\f(CW\*(C`OPTS\*(C'\fR, are the same as those used with the \s-1OO\s0 interface defined in the
+\&\*(L"Constructor Options\*(R" section below.
+.ie n .IP """AutoClose => 0|1""" 5
+.el .IP "\f(CWAutoClose => 0|1\fR" 5
+.IX Item "AutoClose => 0|1"
+This option applies to any input or output data streams to
+\&\f(CW\*(C`bunzip2\*(C'\fR that are filehandles.
+.Sp
+If \f(CW\*(C`AutoClose\*(C'\fR is specified, and the value is true, it will result in all
+input and/or output filehandles being closed once \f(CW\*(C`bunzip2\*(C'\fR has
+completed.
+.Sp
+This parameter defaults to 0.
+.ie n .IP """BinModeOut => 0|1""" 5
+.el .IP "\f(CWBinModeOut => 0|1\fR" 5
+.IX Item "BinModeOut => 0|1"
+When writing to a file or filehandle, set \f(CW\*(C`binmode\*(C'\fR before writing to the
+file.
+.Sp
+Defaults to 0.
+.ie n .IP """Append => 0|1""" 5
+.el .IP "\f(CWAppend => 0|1\fR" 5
+.IX Item "Append => 0|1"
+\&\s-1TODO\s0
+.ie n .IP """MultiStream => 0|1""" 5
+.el .IP "\f(CWMultiStream => 0|1\fR" 5
+.IX Item "MultiStream => 0|1"
+If the input file/buffer contains multiple compressed data streams, this
+option will uncompress the whole lot as a single data stream.
+.Sp
+Defaults to 0.
+.ie n .IP """TrailingData => $scalar""" 5
+.el .IP "\f(CWTrailingData => $scalar\fR" 5
+.IX Item "TrailingData => $scalar"
+Returns the data, if any, that is present immediately after the compressed
+data stream once uncompression is complete.
+.Sp
+This option can be used when there is useful information immediately
+following the compressed data stream, and you don't know the length of the
+compressed data stream.
+.Sp
+If the input is a buffer, \f(CW\*(C`trailingData\*(C'\fR will return everything from the
+end of the compressed data stream to the end of the buffer.
+.Sp
+If the input is a filehandle, \f(CW\*(C`trailingData\*(C'\fR will return the data that is
+left in the filehandle input buffer once the end of the compressed data
+stream has been reached. You can then use the filehandle to read the rest
+of the input file.
+.Sp
+Don't bother using \f(CW\*(C`trailingData\*(C'\fR if the input is a filename.
+.Sp
+If you know the length of the compressed data stream before you start
+uncompressing, you can avoid having to use \f(CW\*(C`trailingData\*(C'\fR by setting the
+\&\f(CW\*(C`InputLength\*(C'\fR option.
+.Sh "Examples"
+.IX Subsection "Examples"
+To read the contents of the file \f(CW\*(C`file1.txt.bz2\*(C'\fR and write the
+compressed data to the file \f(CW\*(C`file1.txt\*(C'\fR.
+.PP
+.Vb 3
+\& use strict ;
+\& use warnings ;
+\& use IO::Uncompress::Bunzip2 qw(bunzip2 $Bunzip2Error) ;
+.Ve
+.PP
+.Vb 4
+\& my $input = "file1.txt.bz2";
+\& my $output = "file1.txt";
+\& bunzip2 $input => $output
+\& or die "bunzip2 failed: $Bunzip2Error\en";
+.Ve
+.PP
+To read from an existing Perl filehandle, \f(CW$input\fR, and write the
+uncompressed data to a buffer, \f(CW$buffer\fR.
+.PP
+.Vb 4
+\& use strict ;
+\& use warnings ;
+\& use IO::Uncompress::Bunzip2 qw(bunzip2 $Bunzip2Error) ;
+\& use IO::File ;
+.Ve
+.PP
+.Vb 5
+\& my $input = new IO::File "<file1.txt.bz2"
+\& or die "Cannot open 'file1.txt.bz2': $!\en" ;
+\& my $buffer ;
+\& bunzip2 $input => \e$buffer
+\& or die "bunzip2 failed: $Bunzip2Error\en";
+.Ve
+.PP
+To uncompress all files in the directory \*(L"/my/home\*(R" that match \*(L"*.txt.bz2\*(R" and store the compressed data in the same directory
+.PP
+.Vb 3
+\& use strict ;
+\& use warnings ;
+\& use IO::Uncompress::Bunzip2 qw(bunzip2 $Bunzip2Error) ;
+.Ve
+.PP
+.Vb 2
+\& bunzip2 '</my/home/*.txt.bz2>' => '</my/home/#1.txt>'
+\& or die "bunzip2 failed: $Bunzip2Error\en";
+.Ve
+.PP
+and if you want to compress each file one at a time, this will do the trick
+.PP
+.Vb 3
+\& use strict ;
+\& use warnings ;
+\& use IO::Uncompress::Bunzip2 qw(bunzip2 $Bunzip2Error) ;
+.Ve
+.PP
+.Vb 7
+\& for my $input ( glob "/my/home/*.txt.bz2" )
+\& {
+\& my $output = $input;
+\& $output =~ s/.bz2// ;
+\& bunzip2 $input => $output
+\& or die "Error compressing '$input': $Bunzip2Error\en";
+\& }
+.Ve
+.SH "OO Interface"
+.IX Header "OO Interface"
+.Sh "Constructor"
+.IX Subsection "Constructor"
+The format of the constructor for IO::Uncompress::Bunzip2 is shown below
+.PP
+.Vb 2
+\& my $z = new IO::Uncompress::Bunzip2 $input [OPTS]
+\& or die "IO::Uncompress::Bunzip2 failed: $Bunzip2Error\en";
+.Ve
+.PP
+Returns an \f(CW\*(C`IO::Uncompress::Bunzip2\*(C'\fR object on success and undef on failure.
+The variable \f(CW$Bunzip2Error\fR will contain an error message on failure.
+.PP
+If you are running Perl 5.005 or better the object, \f(CW$z\fR, returned from
+IO::Uncompress::Bunzip2 can be used exactly like an IO::File filehandle.
+This means that all normal input file operations can be carried out with
+\&\f(CW$z\fR. For example, to read a line from a compressed file/buffer you can
+use either of these forms
+.PP
+.Vb 2
+\& $line = $z\->getline();
+\& $line = <$z>;
+.Ve
+.PP
+The mandatory parameter \f(CW$input\fR is used to determine the source of the
+compressed data. This parameter can take one of three forms.
+.IP "A filename" 5
+.IX Item "A filename"
+If the \f(CW$input\fR parameter is a scalar, it is assumed to be a filename. This
+file will be opened for reading and the compressed data will be read from it.
+.IP "A filehandle" 5
+.IX Item "A filehandle"
+If the \f(CW$input\fR parameter is a filehandle, the compressed data will be
+read from it.
+The string '\-' can be used as an alias for standard input.
+.IP "A scalar reference" 5
+.IX Item "A scalar reference"
+If \f(CW$input\fR is a scalar reference, the compressed data will be read from
+\&\f(CW$$output\fR.
+.Sh "Constructor Options"
+.IX Subsection "Constructor Options"
+The option names defined below are case insensitive and can be optionally
+prefixed by a '\-'. So all of the following are valid
+.PP
+.Vb 4
+\& \-AutoClose
+\& \-autoclose
+\& AUTOCLOSE
+\& autoclose
+.Ve
+.PP
+\&\s-1OPTS\s0 is a combination of the following options:
+.ie n .IP """AutoClose => 0|1""" 5
+.el .IP "\f(CWAutoClose => 0|1\fR" 5
+.IX Item "AutoClose => 0|1"
+This option is only valid when the \f(CW$input\fR parameter is a filehandle. If
+specified, and the value is true, it will result in the file being closed once
+either the \f(CW\*(C`close\*(C'\fR method is called or the IO::Uncompress::Bunzip2 object is
+destroyed.
+.Sp
+This parameter defaults to 0.
+.ie n .IP """MultiStream => 0|1""" 5
+.el .IP "\f(CWMultiStream => 0|1\fR" 5
+.IX Item "MultiStream => 0|1"
+Allows multiple concatenated compressed streams to be treated as a single
+compressed stream. Decompression will stop once either the end of the
+file/buffer is reached, an error is encountered (premature eof, corrupt
+compressed data) or the end of a stream is not immediately followed by the
+start of another stream.
+.Sp
+This parameter defaults to 0.
+.ie n .IP """Prime => $string""" 5
+.el .IP "\f(CWPrime => $string\fR" 5
+.IX Item "Prime => $string"
+This option will uncompress the contents of \f(CW$string\fR before processing the
+input file/buffer.
+.Sp
+This option can be useful when the compressed data is embedded in another
+file/data structure and it is not possible to work out where the compressed
+data begins without having to read the first few bytes. If this is the
+case, the uncompression can be \fIprimed\fR with these bytes using this
+option.
+.ie n .IP """Transparent => 0|1""" 5
+.el .IP "\f(CWTransparent => 0|1\fR" 5
+.IX Item "Transparent => 0|1"
+If this option is set and the input file/buffer is not compressed data,
+the module will allow reading of it anyway.
+.Sp
+In addition, if the input file/buffer does contain compressed data and
+there is non-compressed data immediately following it, setting this option
+will make this module treat the whole file/bufffer as a single data stream.
+.Sp
+This option defaults to 1.
+.ie n .IP """BlockSize => $num""" 5
+.el .IP "\f(CWBlockSize => $num\fR" 5
+.IX Item "BlockSize => $num"
+When reading the compressed input data, IO::Uncompress::Bunzip2 will read it in
+blocks of \f(CW$num\fR bytes.
+.Sp
+This option defaults to 4096.
+.ie n .IP """InputLength => $size""" 5
+.el .IP "\f(CWInputLength => $size\fR" 5
+.IX Item "InputLength => $size"
+When present this option will limit the number of compressed bytes read
+from the input file/buffer to \f(CW$size\fR. This option can be used in the
+situation where there is useful data directly after the compressed data
+stream and you know beforehand the exact length of the compressed data
+stream.
+.Sp
+This option is mostly used when reading from a filehandle, in which case
+the file pointer will be left pointing to the first byte directly after the
+compressed data stream.
+.Sp
+This option defaults to off.
+.ie n .IP """Append => 0|1""" 5
+.el .IP "\f(CWAppend => 0|1\fR" 5
+.IX Item "Append => 0|1"
+This option controls what the \f(CW\*(C`read\*(C'\fR method does with uncompressed data.
+.Sp
+If set to 1, all uncompressed data will be appended to the output parameter
+of the \f(CW\*(C`read\*(C'\fR method.
+.Sp
+If set to 0, the contents of the output parameter of the \f(CW\*(C`read\*(C'\fR method
+will be overwritten by the uncompressed data.
+.Sp
+Defaults to 0.
+.ie n .IP """Strict => 0|1""" 5
+.el .IP "\f(CWStrict => 0|1\fR" 5
+.IX Item "Strict => 0|1"
+This option is a no\-op.
+.ie n .IP """Small => 0|1""" 5
+.el .IP "\f(CWSmall => 0|1\fR" 5
+.IX Item "Small => 0|1"
+When non-zero this options will make bzip2 use a decompression algorithm
+that uses less memory at the expense of increasing the amount of time
+taken for decompression.
+.Sp
+Default is 0.
+.Sh "Examples"
+.IX Subsection "Examples"
+\&\s-1TODO\s0
+.SH "Methods"
+.IX Header "Methods"
+.Sh "read"
+.IX Subsection "read"
+Usage is
+.PP
+.Vb 1
+\& $status = $z\->read($buffer)
+.Ve
+.PP
+Reads a block of compressed data (the size the the compressed block is
+determined by the \f(CW\*(C`Buffer\*(C'\fR option in the constructor), uncompresses it and
+writes any uncompressed data into \f(CW$buffer\fR. If the \f(CW\*(C`Append\*(C'\fR parameter is
+set in the constructor, the uncompressed data will be appended to the
+\&\f(CW$buffer\fR parameter. Otherwise \f(CW$buffer\fR will be overwritten.
+.PP
+Returns the number of uncompressed bytes written to \f(CW$buffer\fR, zero if eof
+or a negative number on error.
+.Sh "read"
+.IX Subsection "read"
+Usage is
+.PP
+.Vb 2
+\& $status = $z\->read($buffer, $length)
+\& $status = $z\->read($buffer, $length, $offset)
+.Ve
+.PP
+.Vb 2
+\& $status = read($z, $buffer, $length)
+\& $status = read($z, $buffer, $length, $offset)
+.Ve
+.PP
+Attempt to read \f(CW$length\fR bytes of uncompressed data into \f(CW$buffer\fR.
+.PP
+The main difference between this form of the \f(CW\*(C`read\*(C'\fR method and the
+previous one, is that this one will attempt to return \fIexactly\fR \f(CW$length\fR
+bytes. The only circumstances that this function will not is if end-of-file
+or an \s-1IO\s0 error is encountered.
+.PP
+Returns the number of uncompressed bytes written to \f(CW$buffer\fR, zero if eof
+or a negative number on error.
+.Sh "getline"
+.IX Subsection "getline"
+Usage is
+.PP
+.Vb 2
+\& $line = $z\->getline()
+\& $line = <$z>
+.Ve
+.PP
+Reads a single line.
+.PP
+This method fully supports the use of of the variable \f(CW$/\fR (or
+\&\f(CW$INPUT_RECORD_SEPARATOR\fR or \f(CW$RS\fR when \f(CW\*(C`English\*(C'\fR is in use) to
+determine what constitutes an end of line. Paragraph mode, record mode and
+file slurp mode are all supported.
+.Sh "getc"
+.IX Subsection "getc"
+Usage is
+.PP
+.Vb 1
+\& $char = $z\->getc()
+.Ve
+.PP
+Read a single character.
+.Sh "ungetc"
+.IX Subsection "ungetc"
+Usage is
+.PP
+.Vb 1
+\& $char = $z\->ungetc($string)
+.Ve
+.Sh "getHeaderInfo"
+.IX Subsection "getHeaderInfo"
+Usage is
+.PP
+.Vb 2
+\& $hdr = $z\->getHeaderInfo();
+\& @hdrs = $z\->getHeaderInfo();
+.Ve
+.PP
+This method returns either a hash reference (in scalar context) or a list
+or hash references (in array context) that contains information about each
+of the header fields in the compressed data stream(s).
+.Sh "tell"
+.IX Subsection "tell"
+Usage is
+.PP
+.Vb 2
+\& $z\->tell()
+\& tell $z
+.Ve
+.PP
+Returns the uncompressed file offset.
+.Sh "eof"
+.IX Subsection "eof"
+Usage is
+.PP
+.Vb 2
+\& $z\->eof();
+\& eof($z);
+.Ve
+.PP
+Returns true if the end of the compressed input stream has been reached.
+.Sh "seek"
+.IX Subsection "seek"
+.Vb 2
+\& $z\->seek($position, $whence);
+\& seek($z, $position, $whence);
+.Ve
+.PP
+Provides a sub-set of the \f(CW\*(C`seek\*(C'\fR functionality, with the restriction
+that it is only legal to seek forward in the input file/buffer.
+It is a fatal error to attempt to seek backward.
+.PP
+The \f(CW$whence\fR parameter takes one the usual values, namely \s-1SEEK_SET\s0,
+\&\s-1SEEK_CUR\s0 or \s-1SEEK_END\s0.
+.PP
+Returns 1 on success, 0 on failure.
+.Sh "binmode"
+.IX Subsection "binmode"
+Usage is
+.PP
+.Vb 2
+\& $z\->binmode
+\& binmode $z ;
+.Ve
+.PP
+This is a noop provided for completeness.
+.Sh "opened"
+.IX Subsection "opened"
+.Vb 1
+\& $z\->opened()
+.Ve
+.PP
+Returns true if the object currently refers to a opened file/buffer.
+.Sh "autoflush"
+.IX Subsection "autoflush"
+.Vb 2
+\& my $prev = $z\->autoflush()
+\& my $prev = $z\->autoflush(EXPR)
+.Ve
+.PP
+If the \f(CW$z\fR object is associated with a file or a filehandle, this method
+returns the current autoflush setting for the underlying filehandle. If
+\&\f(CW\*(C`EXPR\*(C'\fR is present, and is non\-zero, it will enable flushing after every
+write/print operation.
+.PP
+If \f(CW$z\fR is associated with a buffer, this method has no effect and always
+returns \f(CW\*(C`undef\*(C'\fR.
+.PP
+\&\fBNote\fR that the special variable \f(CW$|\fR \fBcannot\fR be used to set or
+retrieve the autoflush setting.
+.Sh "input_line_number"
+.IX Subsection "input_line_number"
+.Vb 2
+\& $z\->input_line_number()
+\& $z\->input_line_number(EXPR)
+.Ve
+.PP
+Returns the current uncompressed line number. If \f(CW\*(C`EXPR\*(C'\fR is present it has
+the effect of setting the line number. Note that setting the line number
+does not change the current position within the file/buffer being read.
+.PP
+The contents of \f(CW$/\fR are used to to determine what constitutes a line
+terminator.
+.Sh "fileno"
+.IX Subsection "fileno"
+.Vb 2
+\& $z\->fileno()
+\& fileno($z)
+.Ve
+.PP
+If the \f(CW$z\fR object is associated with a file or a filehandle, \f(CW\*(C`fileno\*(C'\fR
+will return the underlying file descriptor. Once the \f(CW\*(C`close\*(C'\fR method is
+called \f(CW\*(C`fileno\*(C'\fR will return \f(CW\*(C`undef\*(C'\fR.
+.PP
+If the \f(CW$z\fR object is is associated with a buffer, this method will return
+\&\f(CW\*(C`undef\*(C'\fR.
+.Sh "close"
+.IX Subsection "close"
+.Vb 2
+\& $z\->close() ;
+\& close $z ;
+.Ve
+.PP
+Closes the output file/buffer.
+.PP
+For most versions of Perl this method will be automatically invoked if
+the IO::Uncompress::Bunzip2 object is destroyed (either explicitly or by the
+variable with the reference to the object going out of scope). The
+exceptions are Perl versions 5.005 through 5.00504 and 5.8.0. In
+these cases, the \f(CW\*(C`close\*(C'\fR method will be called automatically, but
+not until global destruction of all live objects when the program is
+terminating.
+.PP
+Therefore, if you want your scripts to be able to run on all versions
+of Perl, you should call \f(CW\*(C`close\*(C'\fR explicitly and not rely on automatic
+closing.
+.PP
+Returns true on success, otherwise 0.
+.PP
+If the \f(CW\*(C`AutoClose\*(C'\fR option has been enabled when the IO::Uncompress::Bunzip2
+object was created, and the object is associated with a file, the
+underlying file will also be closed.
+.Sh "nextStream"
+.IX Subsection "nextStream"
+Usage is
+.PP
+.Vb 1
+\& my $status = $z\->nextStream();
+.Ve
+.PP
+Skips to the next compressed data stream in the input file/buffer. If a new
+compressed data stream is found, the eof marker will be cleared and \f(CW$.\fR
+will be reset to 0.
+.PP
+Returns 1 if a new stream was found, 0 if none was found, and \-1 if an
+error was encountered.
+.Sh "trailingData"
+.IX Subsection "trailingData"
+Usage is
+.PP
+.Vb 1
+\& my $data = $z\->trailingData();
+.Ve
+.PP
+Returns the data, if any, that is present immediately after the compressed
+data stream once uncompression is complete. It only makes sense to call
+this method once the end of the compressed data stream has been
+encountered.
+.PP
+This option can be used when there is useful information immediately
+following the compressed data stream, and you don't know the length of the
+compressed data stream.
+.PP
+If the input is a buffer, \f(CW\*(C`trailingData\*(C'\fR will return everything from the
+end of the compressed data stream to the end of the buffer.
+.PP
+If the input is a filehandle, \f(CW\*(C`trailingData\*(C'\fR will return the data that is
+left in the filehandle input buffer once the end of the compressed data
+stream has been reached. You can then use the filehandle to read the rest
+of the input file.
+.PP
+Don't bother using \f(CW\*(C`trailingData\*(C'\fR if the input is a filename.
+.PP
+If you know the length of the compressed data stream before you start
+uncompressing, you can avoid having to use \f(CW\*(C`trailingData\*(C'\fR by setting the
+\&\f(CW\*(C`InputLength\*(C'\fR option in the constructor.
+.SH "Importing"
+.IX Header "Importing"
+No symbolic constants are required by this IO::Uncompress::Bunzip2 at present.
+.IP ":all" 5
+.IX Item ":all"
+Imports \f(CW\*(C`bunzip2\*(C'\fR and \f(CW$Bunzip2Error\fR.
+Same as doing this
+.Sp
+.Vb 1
+\& use IO::Uncompress::Bunzip2 qw(bunzip2 $Bunzip2Error) ;
+.Ve
+.SH "EXAMPLES"
+.IX Header "EXAMPLES"
+.Sh "Working with Net::FTP"
+.IX Subsection "Working with Net::FTP"
+See IO::Uncompress::Bunzip2::FAQ
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+Compress::Zlib, IO::Compress::Gzip, IO::Uncompress::Gunzip, IO::Compress::Deflate, IO::Uncompress::Inflate, IO::Compress::RawDeflate, IO::Uncompress::RawInflate, IO::Compress::Bzip2, IO::Compress::Lzop, IO::Uncompress::UnLzop, IO::Compress::Lzf, IO::Uncompress::UnLzf, IO::Uncompress::AnyInflate, IO::Uncompress::AnyUncompress
+.PP
+Compress::Zlib::FAQ
+.PP
+File::GlobMapper, Archive::Zip,
+Archive::Tar,
+IO::Zlib
+.PP
+The primary site for the bzip2 program is \fIhttp://www.bzip.org\fR.
+.PP
+See the module Compress::Bzip2
+.SH "AUTHOR"
+.IX Header "AUTHOR"
+This module was written by Paul Marquess, \fIpmqs@cpan.org\fR.
+.SH "MODIFICATION HISTORY"
+.IX Header "MODIFICATION HISTORY"
+See the Changes file.
+.SH "COPYRIGHT AND LICENSE"
+.IX Header "COPYRIGHT AND LICENSE"
+Copyright (c) 2005\-2008 Paul Marquess. All rights reserved.
+.PP
+This program is free software; you can redistribute it and/or
+modify it under the same terms as Perl itself.
projects / catagits/Gitalist.git / blobdiff