.\" 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::Engine::Apache 3pm"
.TH Catalyst::Engine::Apache 3pm "2021-01-06" "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::Engine::Apache \- Catalyst Apache Engines
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
For example Apache configurations, see the documentation for the engine that
corresponds to your Apache version.
.PP
\&\f(CW\*(C`Catalyst::Engine::Apache::MP13\*(C'\fR  \- mod_perl 1.3x
.PP
\&\f(CW\*(C`Catalyst::Engine::Apache2::MP19\*(C'\fR \- mod_perl 1.99x
.PP
\&\f(CW\*(C`Catalyst::Engine::Apache2::MP20\*(C'\fR \- mod_perl 2.x
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
These classes provide mod_perl support for Catalyst.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS "$c\->engine\->apache"
.el .SS "\f(CW$c\fP\->engine\->apache"
.IX Subsection "$c->engine->apache"
Returns an \f(CW\*(C`Apache\*(C'\fR, \f(CW\*(C`Apache::RequestRec\*(C'\fR or \f(CW\*(C`Apache2::RequestRec\*(C'\fR object,
depending on your mod_perl version.  This method is also available as
\&\f(CW$c\fR\->apache.
.ie n .SS "$c\->engine\->return"
.el .SS "\f(CW$c\fP\->engine\->return"
.IX Subsection "$c->engine->return"
If you need to return something other than \s-1OK\s0 from the mod_perl handler,
you may set any other Apache constant in this method.  You should only use
this method if you know what you are doing or bad things may happen!
For example, to return \s-1DECLINED\s0 in mod_perl 2:
.PP
.Vb 2
\&    use Apache2::Const \-compile => qw(DECLINED);
\&    $c\->engine\->return( Apache2::Const::DECLINED );
.Ve
.SS "\s-1NOTES ABOUT LOCATIONMATCH\s0"
.IX Subsection "NOTES ABOUT LOCATIONMATCH"
The Apache engine tries to figure out the correct base path if your app is
running within a LocationMatch block.  For example:
.PP
.Vb 4
\&    <LocationMatch ^/match/(this|that)*>
\&        SetHandler          modperl
\&        PerlResponseHandler MyApp
\&    </LocationMatch>
.Ve
.PP
This will correctly set the base path to '/match/this/' or '/match/that/' depending
on which path was used for the request.
.PP
In some cases this may not be what you want, so you can disable this behavior
by adding this to your configuration:
.PP
.Vb 1
\&    PerlSetVar CatalystDisableLocationMatch 1
.Ve
.SS "\s-1NOTES ON\s0 NON-STANDARD \s-1PORTS\s0"
.IX Subsection "NOTES ON NON-STANDARD PORTS"
If you wish to run your site on a non-standard port you will need to use the
\&\f(CW\*(C`Port\*(C'\fR Apache config rather than \f(CW\*(C`Listen\*(C'\fR. This will result in the correct
port being added to urls created using \f(CW\*(C`uri_for\*(C'\fR.
.PP
.Vb 1
\&    Port 8080
.Ve
.SH "OVERLOADED METHODS"
.IX Header "OVERLOADED METHODS"
This class overloads some methods from \f(CW\*(C`Catalyst::Engine\*(C'\fR.
.IP "prepare_request($r)" 4
.IX Item "prepare_request($r)"
.PD 0
.IP "prepare_connection" 4
.IX Item "prepare_connection"
.IP "prepare_query_parameters" 4
.IX Item "prepare_query_parameters"
.IP "prepare_headers" 4
.IX Item "prepare_headers"
.IP "prepare_path" 4
.IX Item "prepare_path"
.IP "read_chunk" 4
.IX Item "read_chunk"
.IP "finalize_body" 4
.IX Item "finalize_body"
.IP "finalize_headers" 4
.IX Item "finalize_headers"
.IP "write" 4
.IX Item "write"
.PD
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Catalyst Catalyst::Engine.
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "\(bu" 4
Sebastian Riedel <sri@cpan.org>
.IP "\(bu" 4
Christian Hansen <ch@ngmedia.com>
.IP "\(bu" 4
Andy Grundman <andy@hybridized.org>
.IP "\(bu" 4
Tomas Doran <bobtfish@bobtfish.net>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2010 by The \*(L"\s-1AUTHORS\*(R".\s0
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.