.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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 "Catalyst::Plugin::Compress 3pm"
.TH Catalyst::Plugin::Compress 3pm "2021-01-08" "perl v5.32.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"
Catalyst::Plugin::Compress \- Compress response
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    use Catalyst qw/Compress/;
.Ve
.PP
or
.PP
.Vb 4
\&    use Catalyst qw/
\&        Unicode
\&        Compress
\&    /;
.Ve
.PP
If you want to use this plugin with Catalyst::Plugin::Unicode.
.PP
Remember to specify compression_format with:
.PP
.Vb 3
\&    _\|_PACKAGE_\|_\->config(
\&        compression_format => $format,
\&    );
.Ve
.PP
\&\f(CW$format\fR can be either gzip bzip2 zlib or deflate.  bzip2 is \fB*only*\fR supported
by lynx and some other console text-browsers.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module combines Catalyst::Plugin::Deflate Catalyst::Plugin::Gzip
Catalyst::Plugin::Zlib into one.
.PP
It compress response to [gzip bzip2 zlib deflate] if client supports it.
.PP
\&\fB\s-1NOTE\s0\fR: If you want to use this module with Catalyst::Plugin::Unicode, You
\&\fB\s-1MUST\s0\fR load this plugin \fB\s-1AFTER\s0\fR Catalyst::Plugin::Unicode.
.PP
.Vb 4
\&    use Catalyst qw/
\&        Unicode
\&        Compress
\&    /;
.Ve
.PP
If you don't, You'll get error which is like:
.PP
[error] Caught exception in engine \*(L"Wide character in subroutine entry at
/usr/lib/perl5/site_perl/5.8.8/Compress/Zlib.pm line xxx.\*(R"
.SH "INTERNAL METHODS"
.IX Header "INTERNAL METHODS"
.SS "should_compress_response"
.IX Subsection "should_compress_response"
This method determine wether compressing the reponse using this plugin.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Catalyst.
.SH "AUTHOR"
.IX Header "AUTHOR"
Yiyi Hu \f(CW\*(C`yiyihu@gmail.com\*(C'\fR
.SH "LICENSE"
.IX Header "LICENSE"
This library is free software. You can redistribute it and/or modify it under
the same terms as perl itself.