.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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 "IO::Compress::Bzip2 3perl"
.TH IO::Compress::Bzip2 3perl "2023-11-25" "perl v5.36.0" "Perl Programmers Reference Guide"
.\" 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"
IO::Compress::Bzip2 \- Write bzip2 files/buffers
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use IO::Compress::Bzip2 qw(bzip2 $Bzip2Error) ;
\&
\&    my $status = bzip2 $input => $output [,OPTS]
\&        or die "bzip2 failed: $Bzip2Error\en";
\&
\&    my $z = IO::Compress::Bzip2\->new( $output [,OPTS] )
\&        or die "bzip2 failed: $Bzip2Error\en";
\&
\&    $z\->print($string);
\&    $z\->printf($format, $string);
\&    $z\->write($string);
\&    $z\->syswrite($string [, $length, $offset]);
\&    $z\->flush();
\&    $z\->tell();
\&    $z\->eof();
\&    $z\->seek($position, $whence);
\&    $z\->binmode();
\&    $z\->fileno();
\&    $z\->opened();
\&    $z\->autoflush();
\&    $z\->input_line_number();
\&    $z\->newStream( [OPTS] );
\&
\&    $z\->close() ;
\&
\&    $Bzip2Error ;
\&
\&    # IO::File mode
\&
\&    print $z $string;
\&    printf $z $format, $string;
\&    tell $z
\&    eof $z
\&    seek $z, $position, $whence
\&    binmode $z
\&    fileno $z
\&    close $z ;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module provides a Perl interface that allows writing bzip2
compressed data to files or buffer.
.PP
For reading bzip2 files/buffers, see the companion module
IO::Uncompress::Bunzip2.
.SH "Functional Interface"
.IX Header "Functional Interface"
A top-level function, \f(CW\*(C`bzip2\*(C'\fR, is provided to carry out
\&\*(L"one-shot\*(R" compression between buffers and/or files. For finer
control over the compression process, see the \*(L"\s-1OO\s0 Interface\*(R"
section.
.PP
.Vb 1
\&    use IO::Compress::Bzip2 qw(bzip2 $Bzip2Error) ;
\&
\&    bzip2 $input_filename_or_reference => $output_filename_or_reference [,OPTS]
\&        or die "bzip2 failed: $Bzip2Error\en";
.Ve
.PP
The functional interface needs Perl5.005 or better.
.ie n .SS "bzip2 $input_filename_or_reference => $output_filename_or_reference [, \s-1OPTS\s0]"
.el .SS "bzip2 \f(CW$input_filename_or_reference\fP => \f(CW$output_filename_or_reference\fP [, \s-1OPTS\s0]"
.IX Subsection "bzip2 $input_filename_or_reference => $output_filename_or_reference [, OPTS]"
\&\f(CW\*(C`bzip2\*(C'\fR expects at least two parameters,
\&\f(CW$input_filename_or_reference\fR and \f(CW$output_filename_or_reference\fR
and zero or more optional parameters (see \*(L"Optional Parameters\*(R")
.PP
\fIThe \f(CI$input_filename_or_reference\fI parameter\fR
.IX Subsection "The $input_filename_or_reference parameter"
.PP
The parameter, \f(CW$input_filename_or_reference\fR, is used to define the
source of the uncompressed data.
.PP
It can take one of the following forms:
.IP "A filename" 5
.IX Item "A filename"
If the \f(CW$input_filename_or_reference\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_filename_or_reference\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_filename_or_reference\fR is a scalar reference, the input data
will be read from \f(CW$$input_filename_or_reference\fR.
.IP "An array reference" 5
.IX Item "An array reference"
If \f(CW$input_filename_or_reference\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 compressed.
.IP "An Input FileGlob string" 5
.IX Item "An Input FileGlob string"
If \f(CW$input_filename_or_reference\fR is a string that is delimited by the
characters \*(L"<\*(R" and \*(L">\*(R" \f(CW\*(C`bzip2\*(C'\fR will assume that it is an
\&\fIinput fileglob string\fR. The input is the list of files that match the
fileglob.
.Sp
See File::GlobMapper for more details.
.PP
If the \f(CW$input_filename_or_reference\fR parameter is any other type,
\&\f(CW\*(C`undef\*(C'\fR will be returned.
.PP
\fIThe \f(CI$output_filename_or_reference\fI parameter\fR
.IX Subsection "The $output_filename_or_reference parameter"
.PP
The parameter \f(CW$output_filename_or_reference\fR is used to control the
destination of the compressed data. This parameter can take one of
these forms.
.IP "A filename" 5
.IX Item "A filename"
If the \f(CW$output_filename_or_reference\fR parameter is a simple scalar, it is
assumed to be a filename.  This file will be opened for writing and the
compressed data will be written to it.
.IP "A filehandle" 5
.IX Item "A filehandle"
If the \f(CW$output_filename_or_reference\fR parameter is a filehandle, the
compressed 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_filename_or_reference\fR is a scalar reference, the
compressed data will be stored in \f(CW$$output_filename_or_reference\fR.
.IP "An Array Reference" 5
.IX Item "An Array Reference"
If \f(CW$output_filename_or_reference\fR is an array reference,
the compressed data will be pushed onto the array.
.IP "An Output FileGlob" 5
.IX Item "An Output FileGlob"
If \f(CW$output_filename_or_reference\fR is a string that is delimited by the
characters \*(L"<\*(R" and \*(L">\*(R" \f(CW\*(C`bzip2\*(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_filename_or_reference\fR is an fileglob string,
\&\f(CW$input_filename_or_reference\fR must also be a fileglob string. Anything
else is an error.
.Sp
See File::GlobMapper for more details.
.PP
If the \f(CW$output_filename_or_reference\fR parameter is any other type,
\&\f(CW\*(C`undef\*(C'\fR will be returned.
.SS "Notes"
.IX Subsection "Notes"
When \f(CW$input_filename_or_reference\fR maps to multiple files/buffers and
\&\f(CW$output_filename_or_reference\fR is a single
file/buffer the input files/buffers will be stored
in \f(CW$output_filename_or_reference\fR as a concatenated series of compressed data streams.
.SS "Optional Parameters"
.IX Subsection "Optional Parameters"
The optional parameters for the one-shot function \f(CW\*(C`bzip2\*(C'\fR
are (for the most part) identical to those used with the \s-1OO\s0 interface defined in the
\&\*(L"Constructor Options\*(R" section. The exceptions are listed 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`bzip2\*(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`bzip2\*(C'\fR has
completed.
.Sp
This parameter defaults to 0.
.ie n .IP """BinModeIn => 0|1""" 5
.el .IP "\f(CWBinModeIn => 0|1\fR" 5
.IX Item "BinModeIn => 0|1"
This option is now a no-op. All files will be read in binmode.
.ie n .IP """Append => 0|1""" 5
.el .IP "\f(CWAppend => 0|1\fR" 5
.IX Item "Append => 0|1"
The behaviour of this option is dependent on the type of output data
stream.
.RS 5
.IP "\(bu" 5
A Buffer
.Sp
If \f(CW\*(C`Append\*(C'\fR is enabled, all compressed data will be append to the end of
the output buffer. Otherwise the output buffer will be cleared before any
compressed data is written to it.
.IP "\(bu" 5
A Filename
.Sp
If \f(CW\*(C`Append\*(C'\fR is enabled, the file will be opened in append mode. Otherwise
the contents of the file, if any, will be truncated before any compressed
data is written to it.
.IP "\(bu" 5
A Filehandle
.Sp
If \f(CW\*(C`Append\*(C'\fR is enabled, the filehandle will be positioned to the end of
the file via a call to \f(CW\*(C`seek\*(C'\fR before any compressed data is
written to it.  Otherwise the file pointer will not be moved.
.RE
.RS 5
.Sp
When \f(CW\*(C`Append\*(C'\fR is specified, and set to true, it will \fIappend\fR all compressed
data to the output data stream.
.Sp
So when the output is a filehandle it will carry out a seek to the eof
before writing any compressed data. If the output is a filename, it will be opened for
appending. If the output is a buffer, all compressed data will be
appended to the existing buffer.
.Sp
Conversely when \f(CW\*(C`Append\*(C'\fR is not specified, or it is present and is set to
false, it will operate as follows.
.Sp
When the output is a filename, it will truncate the contents of the file
before writing any compressed data. If the output is a filehandle
its position will not be changed. If the output is a buffer, it will be
wiped before any compressed data is output.
.Sp
Defaults to 0.
.RE
.SS "Examples"
.IX Subsection "Examples"
Here are a few example that show the capabilities of the module.
.PP
\fIStreaming\fR
.IX Subsection "Streaming"
.PP
This very simple command line example demonstrates the streaming capabilities of the module.
The code reads data from \s-1STDIN,\s0 compresses it, and writes the compressed data to \s-1STDOUT.\s0
.PP
.Vb 1
\&    $ echo hello world | perl \-MIO::Compress::Bzip2=bzip2 \-e \*(Aqbzip2 \e*STDIN => \e*STDOUT\*(Aq >output.bz2
.Ve
.PP
The special filename \*(L"\-\*(R" can be used as a standin for both \f(CW\*(C`\e*STDIN\*(C'\fR and \f(CW\*(C`\e*STDOUT\*(C'\fR,
so the above can be rewritten as
.PP
.Vb 1
\&    $ echo hello world | perl \-MIO::Compress::Bzip2=bzip2 \-e \*(Aqbzip2 "\-" => "\-"\*(Aq >output.bz2
.Ve
.PP
\fICompressing a file from the filesystem\fR
.IX Subsection "Compressing a file from the filesystem"
.PP
To read the contents of the file \f(CW\*(C`file1.txt\*(C'\fR and write the compressed
data to the file \f(CW\*(C`file1.txt.bz2\*(C'\fR.
.PP
.Vb 3
\&    use strict ;
\&    use warnings ;
\&    use IO::Compress::Bzip2 qw(bzip2 $Bzip2Error) ;
\&
\&    my $input = "file1.txt";
\&    bzip2 $input => "$input.bz2"
\&        or die "bzip2 failed: $Bzip2Error\en";
.Ve
.PP
\fIReading from a Filehandle and writing to an in-memory buffer\fR
.IX Subsection "Reading from a Filehandle and writing to an in-memory buffer"
.PP
To read from an existing Perl filehandle, \f(CW$input\fR, and write the
compressed data to a buffer, \f(CW$buffer\fR.
.PP
.Vb 4
\&    use strict ;
\&    use warnings ;
\&    use IO::Compress::Bzip2 qw(bzip2 $Bzip2Error) ;
\&    use IO::File ;
\&
\&    my $input = IO::File\->new( "<file1.txt" )
\&        or die "Cannot open \*(Aqfile1.txt\*(Aq: $!\en" ;
\&    my $buffer ;
\&    bzip2 $input => \e$buffer
\&        or die "bzip2 failed: $Bzip2Error\en";
.Ve
.PP
\fICompressing multiple files\fR
.IX Subsection "Compressing multiple files"
.PP
To compress all files in the directory \*(L"/my/home\*(R" that match \*(L"*.txt\*(R"
and store the compressed data in the same directory
.PP
.Vb 3
\&    use strict ;
\&    use warnings ;
\&    use IO::Compress::Bzip2 qw(bzip2 $Bzip2Error) ;
\&
\&    bzip2 \*(Aq</my/home/*.txt>\*(Aq => \*(Aq<*.bz2>\*(Aq
\&        or die "bzip2 failed: $Bzip2Error\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::Compress::Bzip2 qw(bzip2 $Bzip2Error) ;
\&
\&    for my $input ( glob "/my/home/*.txt" )
\&    {
\&        my $output = "$input.bz2" ;
\&        bzip2 $input => $output
\&            or die "Error compressing \*(Aq$input\*(Aq: $Bzip2Error\en";
\&    }
.Ve
.SH "OO Interface"
.IX Header "OO Interface"
.SS "Constructor"
.IX Subsection "Constructor"
The format of the constructor for \f(CW\*(C`IO::Compress::Bzip2\*(C'\fR is shown below
.PP
.Vb 2
\&    my $z = IO::Compress::Bzip2\->new( $output [,OPTS] )
\&        or die "IO::Compress::Bzip2 failed: $Bzip2Error\en";
.Ve
.PP
It returns an \f(CW\*(C`IO::Compress::Bzip2\*(C'\fR object on success and undef on failure.
The variable \f(CW$Bzip2Error\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::Compress::Bzip2 can be used exactly like an IO::File filehandle.
This means that all normal output file operations can be carried out
with \f(CW$z\fR.
For example, to write to a compressed file/buffer you can use either of
these forms
.PP
.Vb 2
\&    $z\->print("hello world\en");
\&    print $z "hello world\en";
.Ve
.PP
The mandatory parameter \f(CW$output\fR is used to control the destination
of the compressed 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 compressed 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 compressed 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 compressed data will be stored
in \f(CW$$output\fR.
.PP
If the \f(CW$output\fR parameter is any other type, \f(CW\*(C`IO::Compress::Bzip2\*(C'\fR::new will
return undef.
.SS "Constructor Options"
.IX Subsection "Constructor Options"
\&\f(CW\*(C`OPTS\*(C'\fR is any combination of zero or more 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$output\fR parameter is a filehandle. If
specified, and the value is true, it will result in the \f(CW$output\fR being
closed once either the \f(CW\*(C`close\*(C'\fR method is called or the \f(CW\*(C`IO::Compress::Bzip2\*(C'\fR
object is destroyed.
.Sp
This parameter defaults to 0.
.ie n .IP """Append => 0|1""" 5
.el .IP "\f(CWAppend => 0|1\fR" 5
.IX Item "Append => 0|1"
Opens \f(CW$output\fR in append mode.
.Sp
The behaviour of this option is dependent on the type of \f(CW$output\fR.
.RS 5
.IP "\(bu" 5
A Buffer
.Sp
If \f(CW$output\fR is a buffer and \f(CW\*(C`Append\*(C'\fR is enabled, all compressed data
will be append to the end of \f(CW$output\fR. Otherwise \f(CW$output\fR will be
cleared before any data is written to it.
.IP "\(bu" 5
A Filename
.Sp
If \f(CW$output\fR is a filename and \f(CW\*(C`Append\*(C'\fR is enabled, the file will be
opened in append mode. Otherwise the contents of the file, if any, will be
truncated before any compressed data is written to it.
.IP "\(bu" 5
A Filehandle
.Sp
If \f(CW$output\fR is a filehandle, the file pointer will be positioned to the
end of the file via a call to \f(CW\*(C`seek\*(C'\fR before any compressed data is written
to it.  Otherwise the file pointer will not be moved.
.RE
.RS 5
.Sp
This parameter defaults to 0.
.RE
.ie n .IP """BlockSize100K => number""" 5
.el .IP "\f(CWBlockSize100K => number\fR" 5
.IX Item "BlockSize100K => number"
Specify the number of 100K blocks bzip2 uses during compression.
.Sp
Valid values are from 1 to 9, where 9 is best compression.
.Sp
The default is 1.
.ie n .IP """WorkFactor => number""" 5
.el .IP "\f(CWWorkFactor => number\fR" 5
.IX Item "WorkFactor => number"
Specifies how much effort bzip2 should take before resorting to a slower
fallback compression algorithm.
.Sp
Valid values range from 0 to 250, where 0 means use the default value 30.
.Sp
The default is 0.
.ie n .IP """Strict => 0|1""" 5
.el .IP "\f(CWStrict => 0|1\fR" 5
.IX Item "Strict => 0|1"
This is a placeholder option.
.SS "Examples"
.IX Subsection "Examples"
\&\s-1TODO\s0
.SH "Methods"
.IX Header "Methods"
.SS "print"
.IX Subsection "print"
Usage is
.PP
.Vb 2
\&    $z\->print($data)
\&    print $z $data
.Ve
.PP
Compresses and outputs the contents of the \f(CW$data\fR parameter. This
has the same behaviour as the \f(CW\*(C`print\*(C'\fR built-in.
.PP
Returns true if successful.
.SS "printf"
.IX Subsection "printf"
Usage is
.PP
.Vb 2
\&    $z\->printf($format, $data)
\&    printf $z $format, $data
.Ve
.PP
Compresses and outputs the contents of the \f(CW$data\fR parameter.
.PP
Returns true if successful.
.SS "syswrite"
.IX Subsection "syswrite"
Usage is
.PP
.Vb 3
\&    $z\->syswrite $data
\&    $z\->syswrite $data, $length
\&    $z\->syswrite $data, $length, $offset
.Ve
.PP
Compresses and outputs the contents of the \f(CW$data\fR parameter.
.PP
Returns the number of uncompressed bytes written, or \f(CW\*(C`undef\*(C'\fR if
unsuccessful.
.SS "write"
.IX Subsection "write"
Usage is
.PP
.Vb 3
\&    $z\->write $data
\&    $z\->write $data, $length
\&    $z\->write $data, $length, $offset
.Ve
.PP
Compresses and outputs the contents of the \f(CW$data\fR parameter.
.PP
Returns the number of uncompressed bytes written, or \f(CW\*(C`undef\*(C'\fR if
unsuccessful.
.SS "flush"
.IX Subsection "flush"
Usage is
.PP
.Vb 1
\&    $z\->flush;
.Ve
.PP
Flushes any pending compressed data to the output file/buffer.
.PP
\&\s-1TODO\s0
.PP
Returns true on success.
.SS "tell"
.IX Subsection "tell"
Usage is
.PP
.Vb 2
\&    $z\->tell()
\&    tell $z
.Ve
.PP
Returns the uncompressed file offset.
.SS "eof"
.IX Subsection "eof"
Usage is
.PP
.Vb 2
\&    $z\->eof();
\&    eof($z);
.Ve
.PP
Returns true if the \f(CW\*(C`close\*(C'\fR method has been called.
.SS "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 output file/buffer.
It is a fatal error to attempt to seek backward.
.PP
Empty parts of the file/buffer will have \s-1NULL\s0 (0x00) bytes written to them.
.PP
The \f(CW$whence\fR parameter takes one the usual values, namely \s-1SEEK_SET,
SEEK_CUR\s0 or \s-1SEEK_END.\s0
.PP
Returns 1 on success, 0 on failure.
.SS "binmode"
.IX Subsection "binmode"
Usage is
.PP
.Vb 2
\&    $z\->binmode
\&    binmode $z ;
.Ve
.PP
This is a noop provided for completeness.
.SS "opened"
.IX Subsection "opened"
.Vb 1
\&    $z\->opened()
.Ve
.PP
Returns true if the object currently refers to a opened file/buffer.
.SS "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.
.SS "input_line_number"
.IX Subsection "input_line_number"
.Vb 2
\&    $z\->input_line_number()
\&    $z\->input_line_number(EXPR)
.Ve
.PP
This method always returns \f(CW\*(C`undef\*(C'\fR when compressing.
.SS "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 associated with a buffer, this method will return
\&\f(CW\*(C`undef\*(C'\fR.
.SS "close"
.IX Subsection "close"
.Vb 2
\&    $z\->close() ;
\&    close $z ;
.Ve
.PP
Flushes any pending compressed data and then closes the output file/buffer.
.PP
For most versions of Perl this method will be automatically invoked if
the IO::Compress::Bzip2 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::Compress::Bzip2
object was created, and the object is associated with a file, the
underlying file will also be closed.
.SS "newStream([\s-1OPTS\s0])"
.IX Subsection "newStream([OPTS])"
Usage is
.PP
.Vb 1
\&    $z\->newStream( [OPTS] )
.Ve
.PP
Closes the current compressed data stream and starts a new one.
.PP
\&\s-1OPTS\s0 consists of any of the options that are available when creating
the \f(CW$z\fR object.
.PP
See the \*(L"Constructor Options\*(R" section for more details.
.SH "Importing"
.IX Header "Importing"
No symbolic constants are required by IO::Compress::Bzip2 at present.
.IP ":all" 5
.IX Item ":all"
Imports \f(CW\*(C`bzip2\*(C'\fR and \f(CW$Bzip2Error\fR.
Same as doing this
.Sp
.Vb 1
\&    use IO::Compress::Bzip2 qw(bzip2 $Bzip2Error) ;
.Ve
.SH "EXAMPLES"
.IX Header "EXAMPLES"
.SS "Apache::GZip Revisited"
.IX Subsection "Apache::GZip Revisited"
See IO::Compress::FAQ
.SS "Working with Net::FTP"
.IX Subsection "Working with Net::FTP"
See IO::Compress::FAQ
.SH "SUPPORT"
.IX Header "SUPPORT"
General feedback/questions/bug reports should be sent to
<https://github.com/pmqs/IO\-Compress/issues> (preferred) or
<https://rt.cpan.org/Public/Dist/Display.html?Name=IO\-Compress>.
.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::Uncompress::Bunzip2, IO::Compress::Lzma, IO::Uncompress::UnLzma, IO::Compress::Xz, IO::Uncompress::UnXz, IO::Compress::Lzip, IO::Uncompress::UnLzip, IO::Compress::Lzop, IO::Uncompress::UnLzop, IO::Compress::Lzf, IO::Uncompress::UnLzf, IO::Compress::Zstd, IO::Uncompress::UnZstd, IO::Uncompress::AnyInflate, IO::Uncompress::AnyUncompress
.PP
IO::Compress::FAQ
.PP
File::GlobMapper, Archive::Zip,
Archive::Tar,
IO::Zlib
.PP
The primary site for the bzip2 program is <https://sourceware.org/bzip2/>.
.PP
See the module Compress::Bzip2
.SH "AUTHOR"
.IX Header "AUTHOR"
This module was written by Paul Marquess, \f(CW\*(C`pmqs@cpan.org\*(C'\fR.
.SH "MODIFICATION HISTORY"
.IX Header "MODIFICATION HISTORY"
See the Changes file.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (c) 2005\-2022 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.