#
# This documentation was automatically generated by the
# make_params_pod.pl script in the release
# directory of the CVS repository.
#
# Edit that script instead of this document.
#

__END__

=head1 NAME

HTML::Mason::Params - Constructor parameter documentation

=head1 DESCRIPTION

Mason has a lot of objects, most of which accept parameters when
passed to their constructor.  However, since most Mason objects are
made by other Mason objects, rather than by end users, Mason has been
designed so that when one object contains another, the container
object can accept constructor params not only for itself, but also for
any of its contained objects.

This means that typically, you simply make a top level object such as
an ApacheHandler or Interp object, and pass it whatever parameters you
want to set for any Mason object.

Of course, many people simply configure Mason via their httpd.conf
file, and don't ever make a Mason object.

This document lists B<all> of the Mason parameters that are intended
to be used by end users.

=head1 PARAMETERS

=over 4

=item * allow_globals

An array of names of Perl variables that are allowed globally within components

Type:               list

Name in httpd.conf: MasonAllowGlobals

Belongs to:         L<HTML::Mason::Compiler|HTML::Mason::Compiler>

=item * apache_status_title

The title of the Apache::Status page

Type:               string

Default:            HTML::Mason status

Name in httpd.conf: MasonApacheStatusTitle

Belongs to:         L<HTML::Mason::ApacheHandler|HTML::Mason::ApacheHandler>

=item * args_method

Whether to use CGI.pm or Apache::Request for parsing the incoming HTTP request

Type:               string

Default:            mod_perl

Name in httpd.conf: MasonArgsMethod

Belongs to:         L<HTML::Mason::ApacheHandler|HTML::Mason::ApacheHandler>

=item * auto_send_headers

Whether HTTP headers should be auto-generated

Type:               boolean

Default:            1

Name in httpd.conf: MasonAutoSendHeaders

Belongs to:         L<HTML::Mason::Request::ApacheHandler|HTML::Mason::Request::ApacheHandler>

=item * autoflush

Whether output should be buffered or sent immediately

Type:               boolean

Default:            0

Name in httpd.conf: MasonAutoflush

Belongs to:         L<HTML::Mason::Request|HTML::Mason::Request>

=item * autohandler_name

The filename to use for Mason's 'autohandler' capability

Type:               string

Default:            autohandler

Name in httpd.conf: MasonAutohandlerName

Belongs to:         L<HTML::Mason::Interp|HTML::Mason::Interp>

=item * buffer_class

This class receives component output and dispatches it appropriately

Type:               string

Name in httpd.conf: MasonBufferClass

Belongs to:         L<HTML::Mason::Request|HTML::Mason::Request>

This object is created multiple times by its container.

=item * code_cache_max_size

The maximum size of the component code cache

Type:               string

Default:            10485760

Name in httpd.conf: MasonCodeCacheMaxSize

Belongs to:         L<HTML::Mason::Interp|HTML::Mason::Interp>

=item * comp_class

The class into which component objects will be blessed

Type:               string

Default:            HTML::Mason::Component

Name in httpd.conf: MasonCompClass

Belongs to:         L<HTML::Mason::Compiler::ToObject|HTML::Mason::Compiler::ToObject>

=item * comp_root

A string or array of arrays indicating the search path for component calls

Type:               list

Default:            filesystem root

Name in httpd.conf: MasonCompRoot

Belongs to:         L<HTML::Mason::Resolver::File|HTML::Mason::Resolver::File>

=item * compiler

A Compiler object for compiling components

Type:               object

Default:            HTML::Mason::Compiler::ToObject->new

Belongs to:         L<HTML::Mason::Interp|HTML::Mason::Interp>

This object is created only once by its container.

=item * compiler_class

This class is used to translate component source into code

Type:               string

Name in httpd.conf: MasonCompilerClass

Belongs to:         L<HTML::Mason::Interp|HTML::Mason::Interp>

This object is created only once by its container.

=item * data_cache_defaults

A hash of default parameters for Cache::Cache

Type:               hash

Name in httpd.conf: MasonDataCacheDefaults

Belongs to:         L<HTML::Mason::Request|HTML::Mason::Request>

=item * data_dir

A directory for storing cache files and other state information

Type:               string

Name in httpd.conf: MasonDataDir

Belongs to:         L<HTML::Mason::Interp|HTML::Mason::Interp>

=item * decline_dirs

Whether Mason should decline to handle requests for directories

Type:               boolean

Default:            1

Name in httpd.conf: MasonDeclineDirs

Belongs to:         L<HTML::Mason::ApacheHandler|HTML::Mason::ApacheHandler>

=item * default_escape_flags

Escape flags that will apply by default to all Mason tag output

Type:               string

Name in httpd.conf: MasonDefaultEscapeFlags

Belongs to:         L<HTML::Mason::Compiler|HTML::Mason::Compiler>

=item * dhandler_name

The filename to use for Mason's 'dhandler' capability

Type:               string

Default:            dhandler

Name in httpd.conf: MasonDhandlerName

Belongs to:         L<HTML::Mason::Request|HTML::Mason::Request>

=item * error_format

How error conditions are returned to the caller (brief, text, line or html)

Type:               string

Default:            text

Name in httpd.conf: MasonErrorFormat

Belongs to:         L<HTML::Mason::Request|HTML::Mason::Request>

=item * error_mode

How error conditions are manifest (output or fatal)

Type:               string

Default:            fatal

Name in httpd.conf: MasonErrorMode

Belongs to:         L<HTML::Mason::Request|HTML::Mason::Request>

=item * ignore_warnings_expr

A regular expression describing Perl warning messages to ignore

Type:               regex

Default:            qr/Subroutine .* redefined/i

Name in httpd.conf: MasonIgnoreWarningsExpr

Belongs to:         L<HTML::Mason::Interp|HTML::Mason::Interp>

=item * in_package

The package in which component execution will take place

Type:               string

Default:            HTML::Mason::Commands

Name in httpd.conf: MasonInPackage

Belongs to:         L<HTML::Mason::Compiler::ToObject|HTML::Mason::Compiler::ToObject>

=item * interp

A Mason interpreter for processing components

Type:               object

Default:            HTML::Mason::Interp->new

Belongs to:         L<HTML::Mason::ApacheHandler|HTML::Mason::ApacheHandler>

This object is created only once by its container.

=item * interp_class

The interp class coordinates multiple objects to handle request execution

Type:               string

Name in httpd.conf: MasonInterpClass

Belongs to:         L<HTML::Mason::ApacheHandler|HTML::Mason::ApacheHandler>

This object is created only once by its container.

=item * lexer

A Lexer object that will scan component text during compilation

Type:               object

Default:            HTML::Mason::Lexer->new

Belongs to:         L<HTML::Mason::Compiler|HTML::Mason::Compiler>

This object is created only once by its container.

=item * lexer_class

This class generates compiler events based on the components source

Type:               string

Name in httpd.conf: MasonLexerClass

Belongs to:         L<HTML::Mason::Compiler|HTML::Mason::Compiler>

This object is created only once by its container.

=item * max_recurse

The maximum recursion depth for component, inheritance, and request stack

Type:               string

Default:            32

Name in httpd.conf: MasonMaxRecurse

Belongs to:         L<HTML::Mason::Request|HTML::Mason::Request>

=item * out_method

A subroutine or scalar reference through which all output will pass

Type:               code

Default:            sub { print STDOUT grep {defined} @_ }

Name in httpd.conf: MasonOutMethod

Belongs to:         L<HTML::Mason::Request|HTML::Mason::Request>

=item * postamble

A chunk of Perl code to add to the end of each compiled component

Type:               string

Name in httpd.conf: MasonPostamble

Belongs to:         L<HTML::Mason::Compiler::ToObject|HTML::Mason::Compiler::ToObject>

=item * postprocess_perl

A subroutine through which all Perl code will be sent during compilation

Type:               code

Name in httpd.conf: MasonPostprocessPerl

Belongs to:         L<HTML::Mason::Compiler|HTML::Mason::Compiler>

=item * postprocess_text

A subroutine through which all plain text will be sent during compilation

Type:               code

Name in httpd.conf: MasonPostprocessText

Belongs to:         L<HTML::Mason::Compiler|HTML::Mason::Compiler>

=item * preamble

A chunk of Perl code to add to the beginning of each compiled component

Type:               string

Name in httpd.conf: MasonPreamble

Belongs to:         L<HTML::Mason::Compiler::ToObject|HTML::Mason::Compiler::ToObject>

=item * preloads

A list of components to load immediately when creating the Interpreter

Type:               list

Name in httpd.conf: MasonPreloads

Belongs to:         L<HTML::Mason::Interp|HTML::Mason::Interp>

=item * preprocess

A subroutine through which all component text will be sent during compilation

Type:               code

Name in httpd.conf: MasonPreprocess

Belongs to:         L<HTML::Mason::Compiler|HTML::Mason::Compiler>

=item * request_class

Objects returned by make_request are members of this class

Type:               string

Name in httpd.conf: MasonRequestClass

Belongs to:         L<HTML::Mason::Interp|HTML::Mason::Interp>

This object is created multiple times by its container.

=item * resolver

A Resolver object for fetching components from storage

Type:               object

Default:            HTML::Mason::Resolver::File->new

Belongs to:         L<HTML::Mason::Interp|HTML::Mason::Interp>

This object is created only once by its container.

=item * resolver_class

This class is expected to return component information based on a component path

Type:               string

Name in httpd.conf: MasonResolverClass

Belongs to:         L<HTML::Mason::Interp|HTML::Mason::Interp>

This object is created only once by its container.

=item * static_source

When true, we only compile source files once

Type:               boolean

Default:            0

Name in httpd.conf: MasonStaticSource

Belongs to:         L<HTML::Mason::Interp|HTML::Mason::Interp>

=item * subcomp_class

The class into which subcomponent objects will be blessed

Type:               string

Default:            HTML::Mason::Component::Subcomponent

Name in httpd.conf: MasonSubcompClass

Belongs to:         L<HTML::Mason::Compiler::ToObject|HTML::Mason::Compiler::ToObject>

=item * use_object_files

Whether to cache component objects on disk

Type:               boolean

Default:            1

Name in httpd.conf: MasonUseObjectFiles

Belongs to:         L<HTML::Mason::Interp|HTML::Mason::Interp>

=item * use_strict

Whether to turn on Perl's 'strict' pragma in components

Type:               boolean

Default:            1

Name in httpd.conf: MasonUseStrict

Belongs to:         L<HTML::Mason::Compiler::ToObject|HTML::Mason::Compiler::ToObject>

=back

=cut
