.\" 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 "PerlIO::via::Bzip2 3"
.TH PerlIO::via::Bzip2 3 "2005-03-04" "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"
PerlIO::via::Bzip2 \- PerlIO layer for Bzip2 (de)compression
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&    use PerlIO::via::Bzip2;
\&    # or
\&    use PerlIO::via::Bzip2 level => 9; # Maximum compression
\&
\&    # Read a bzip2 compressed file from disk.
\&    open(my $fh, "<:via(Bzip2)", "compressed_file");
\&    my $uncompressed_data = <$fh>;
\&
\&    # Compress data on\-the\-fly to a bzip2 compressed file on disk.
\&    open(my $fh, ">:via(Bzip2)", "compressed_file");
\&    print {$fh} $uncompressed_data;
\&
\&    # Set compression level
\&    PerlIO::via::Bzip2\->level(5);
\&    open(my $fh, ">:via(Bzip2)", "compressed_file");
\&    print {$fh} $uncompressed_data;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module implements a PerlIO layer which will let you handle
bzip2 compressed files transparently.
.SS "Class Methods"
.IX Subsection "Class Methods"
.IP "level([$level])" 4
.IX Item "level([$level])"
level sets or returns the compression level of the bzip2 library.  It
ranges from 1 (least compression, most efficient memory use) to 9
(best compression, most memory usage).
.Sp
This parameter can also be set during using library import, using
\&\f(CW\*(C`use PerlIO::via::Bzip2 level => $level\*(C'\fR.
.SH "BUGS"
.IX Header "BUGS"
Using \fBbinmode()\fR on an opened file for compression will pop (remove)
the layer.
.SH "PREREQUISITES"
.IX Header "PREREQUISITES"
This module requires Compress::Bzip2 version 1.03.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
PerlIO::via, Compress::Bzip2
.SH "AUTHOR"
.IX Header "AUTHOR"
Arjen Laarhoven, <arjen@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2005 by Arjen Laarhoven
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.