1HTML::Mason::Params(3)User Contributed Perl DocumentationHTML::Mason::Params(3)
2
3
4

NAME

6       HTML::Mason::Params - Mason configuration parameters
7

DESCRIPTION

9       This document lists all of the Mason configuration parameters that are
10       intended to be used by end users.
11

PERL AND APACHE NAMES

13       Each parameter has two names: a Perl version and an Apache version.
14       The Perl version uses "lowercase_with_underscores", while the Apache
15       version uses "StudlyCaps" with a "Mason" prefix. The conversion from
16       one version to the other is otherwise very predictable. For example,
17
18       ·   "autohandler_name" "<-->" "MasonAutohandlerName"
19
20       ·   "comp_root" "<-->" "MasonCompRoot"
21
22       ·   "data_cache_defaults" "<-->" "MasonDataCacheDefaults"
23
24       Where Apache Names Are Used
25
26       The Apache parameter names are used in the Apache configuration file in
27       an httpd-based configuration.
28
29       Where Perl Names Are Used
30
31       The Perl parameter names are used from Perl code, i.e. anywhere other
32       than the Apache configuration file. For example,
33
34       ·   In an custom wrapper-based configuraiton, you can pass most of
35           these parameters to the ApacheHandler constructor.
36
37       ·   In a standalone Mason script, you can pass most of these parameters
38           to the Interp constructor.
39
40       ·   When launching a subrequest, you can pass any of the
41           "HTML::Mason::Request" parameters to make_subrequest.
42

PARAMETERS

44       allow_globals
45
46       * Perl name:           allow_globals
47       * Apache name:         MasonAllowGlobals
48       * Type in httpd.conf:  list
49       * Default:             []
50       * Belongs to:          "HTML::Mason::Compiler"
51
52       List of variable names, complete with prefix ("$@%"), that you intend
53       to use as globals in components.  Normally global variables are forbid‐
54       den by "strict", but any variable mentioned in this list is granted a
55       reprieve via a "use vars" statement. For example:
56
57           allow_globals => [qw($DBH %session)]
58
59       In a mod_perl environment, $r (the request object) is automatically
60       added to this list.
61
62       apache_status_title
63
64       * Perl name:           apache_status_title
65       * Apache name:         MasonApacheStatusTitle
66       * Type in httpd.conf:  string
67       * Default:             HTML::Mason status
68       * Belongs to:          "HTML::Mason::ApacheHandler"
69
70       Title that you want this ApacheHandler to appear as under Apache::Sta‐
71       tus.  Default is "HTML::Mason status".  This is useful if you create
72       more than one ApacheHandler object and want them all visible via
73       Apache::Status.
74
75       args_method
76
77       * Perl name:           args_method
78       * Apache name:         MasonArgsMethod
79       * Type in httpd.conf:  string
80       * Default:             mod_perl
81       * Belongs to:          "HTML::Mason::ApacheHandler"
82
83       Method to use for unpacking GET and POST arguments. The valid options
84       are 'CGI' and 'mod_perl'; these indicate that a "CGI.pm" or
85       "Apache::Request" object (respectively) will be created for the pur‐
86       poses of argument handling.
87
88       'mod_perl' is the default under mod_perl-1 and requires that you have
89       installed the "Apache::Request" package.  Under mod_perl-2, the default
90       is 'CGI' because "Apache2::Request" is still in development.
91
92       If args_method is 'mod_perl', the $r global is upgraded to an
93       Apache::Request object. This object inherits all Apache methods and
94       adds a few of its own, dealing with parameters and file uploads.  See
95       "Apache::Request" for more information.
96
97       If the args_method is 'CGI', the Mason request object ($m) will have a
98       method called "cgi_object" available.  This method returns the CGI
99       object used for argument processing.
100
101       While Mason will load "Apache::Request" or "CGI" as needed at runtime,
102       it is recommended that you preload the relevant module either in your
103       httpd.conf or handler.pl file, as this will save some memory.
104
105       auto_send_headers
106
107       * Perl name:           auto_send_headers
108       * Apache name:         MasonAutoSendHeaders
109       * Type in httpd.conf:  boolean
110       * Default:             1
111       * Belongs to:          "HTML::Mason::Request::ApacheHandler"
112
113       True or false, default is true.  Indicates whether Mason should auto‐
114       matically send HTTP headers before sending content back to the client.
115       If you set to false, you should call "$r->send_http_header" manually.
116
117       See the sending HTTP headers section of the developer's manual for more
118       details about the automatic header feature.
119
120       NOTE: This parameter has no effect under mod_perl-2, since calling
121       "$r->send_http_header" is no longer needed.
122
123       autoflush
124
125       * Perl name:           autoflush
126       * Apache name:         MasonAutoflush
127       * Type in httpd.conf:  boolean
128       * Default:             0
129       * Belongs to:          "HTML::Mason::Request"
130
131       True or false, default is false. Indicates whether to flush the output
132       buffer ("$m->flush_buffer") after every string is output. Turn on aut‐
133       oflush if you need to send partial output to the client, for example in
134       a progress meter.
135
136       As of Mason 1.3, autoflush will only work if enable_autoflush has been
137       set.  Components can be compiled more efficiently if they don't have to
138       check for autoflush. Before using autoflush you might consider whether
139       a few manual "$m->flush_buffer" calls would work nearly as well.
140
141       autohandler_name
142
143       * Perl name:           autohandler_name
144       * Apache name:         MasonAutohandlerName
145       * Type in httpd.conf:  string
146       * Default:             autohandler
147       * Belongs to:          "HTML::Mason::Interp"
148
149       File name used for autohandlers. Default is "autohandler".  If this is
150       set to an empty string ("") then autohandlers are turned off entirely.
151
152       buffer_preallocate_size
153
154       * Perl name:           buffer_preallocate_size
155       * Apache name:         MasonBufferPreallocateSize
156       * Type in httpd.conf:  string
157       * Default:             0
158       * Belongs to:          "HTML::Mason::Interp"
159
160       Number of bytes to preallocate in the output buffer for each request.
161       Defaults to 0. Setting this to, say, your maximum page size (or close
162       to it) can reduce the number of reallocations Perl performs as compo‐
163       nents add to the output buffer.
164
165       code_cache_max_size
166
167       * Perl name:           code_cache_max_size
168       * Apache name:         MasonCodeCacheMaxSize
169       * Type in httpd.conf:  string
170       * Default:             unlimited
171       * Belongs to:          "HTML::Mason::Interp"
172
173       Specifies the maximum number of components that should be held in the
174       in-memory code cache. The default is 'unlimited', meaning no components
175       will ever be discarded; Mason can perform certain optimizations in this
176       mode. Setting this to zero disables the code cache entirely. See the
177       code cache section of the administrator's manual for further details.
178
179       comp_class
180
181       * Perl name:           comp_class
182       * Apache name:         MasonCompClass
183       * Type in httpd.conf:  string
184       * Default:             HTML::Mason::Component
185       * Belongs to:          "HTML::Mason::Compiler::ToObject"
186
187       The class into which component objects are blessed.  This defaults to
188       HTML::Mason::Component.
189
190       comp_root
191
192       * Perl name:           comp_root
193       * Apache name:         MasonCompRoot
194       * Type in httpd.conf:  list
195       * Default:             Varies
196       * Belongs to:          "HTML::Mason::Interp"
197
198       The component root marks the top of your component hierarchy and
199       defines how component paths are translated into real file paths. For
200       example, if your component root is /usr/local/httpd/docs, a component
201       path of /products/index.html translates to the file
202       /usr/local/httpd/docs/products/index.html.
203
204       Under Apache and CGI, comp_root defaults to the server's document root.
205       In standalone mode comp_root defaults to the current working directory.
206
207       This parameter may be either a scalar or an array reference.  If it is
208       a scalar, it should be a filesystem path indicating the component root.
209       If it is an array reference, it should be of the following form:
210
211        [ [ foo => '/usr/local/foo' ],
212          [ bar => '/usr/local/bar' ] ]
213
214       This is an array of two-element array references, not a hash.  The
215       "keys" for each path must be unique and their "values" must be filesys‐
216       tem paths.  These paths will be searched in the provided order whenever
217       a component path is resolved. For example, given the above component
218       roots and a component path of /products/index.html, Mason would search
219       first for /usr/local/foo/products/index.html, then for
220       /usr/local/bar/products/index.html.
221
222       The keys are used in several ways. They help to distinguish component
223       caches and object files between different component roots, and they
224       appear in the "title()" of a component.
225
226       When you specify a single path for a component root, this is actually
227       translated into
228
229         [ [ MAIN => path ] ]
230
231       If you have turned on dynamic_comp_root, you may modify the component
232       root(s) of an interpreter between requests by calling
233       "$interp->comp_root" with a value. However, the path associated with
234       any given key may not change between requests. For example, if the ini‐
235       tial component root is
236
237        [ [ foo => '/usr/local/foo' ],
238          [ bar => '/usr/local/bar' ], ]
239
240       then it may not be changed to
241
242        [ [ foo => '/usr/local/bar' ],
243          [ bar => '/usr/local/baz' ],
244
245       but it may be changed to
246
247        [ [ foo   => '/usr/local/foo' ],
248          [ blarg => '/usr/local/blarg' ] ]
249
250       In other words, you may add or remove key/path pairs but not modify an
251       already-used key/path pair. The reason for this restriction is that the
252       interpreter maintains a component cache per key that would become
253       invalid if the associated paths were to change.
254
255       compiler_class
256
257       * Perl name:           compiler_class
258       * Apache name:         MasonCompilerClass
259       * Type in httpd.conf:  string
260       * Default:             HTML::Mason::Compiler::ToObject
261       * Belongs to:          "HTML::Mason::Interp"
262
263       The class to use when creating a compiler. Defaults to
264       HTML::Mason::Compiler.
265
266       data_cache_api
267
268       * Perl name:           data_cache_api
269       * Apache name:         MasonDataCacheApi
270       * Type in httpd.conf:  string
271       * Default:             1.1
272       * Belongs to:          "HTML::Mason::Request"
273
274       The "$m->cache" API to use. '1.1', the default, indicates the newer API
275       documented in this manual.  '1.0' indicates the old API documented in
276       1.0x and earlier. This compatibility layer is provided as a convenience
277       for users upgrading from older versions of Mason, but will not be sup‐
278       ported indefinitely.
279
280       data_cache_defaults
281
282       * Perl name:           data_cache_defaults
283       * Apache name:         MasonDataCacheDefaults
284       * Type in httpd.conf:  hash_list
285       * Default:             None
286       * Belongs to:          "HTML::Mason::Request"
287
288       A hash reference of default options to use for the "$m->cache" command.
289       For example, to use the "MemoryCache" implementation by default,
290
291           data_cache_defaults => {cache_class => 'MemoryCache'}
292
293       These settings are overriden by options given to particular "$m->cache"
294       calls.
295
296       data_dir
297
298       * Perl name:           data_dir
299       * Apache name:         MasonDataDir
300       * Type in httpd.conf:  string
301       * Default:             None
302       * Belongs to:          "HTML::Mason::Interp"
303
304       The data directory is a writable directory that Mason uses for various
305       features and optimizations: for example, component object files and
306       data cache files. Mason will create the directory on startup, if neces‐
307       sary, and set its permissions according to the web server User/Group.
308
309       Under Apache, data_dir defaults to a directory called "mason" under the
310       Apache server root. You will need to change this on certain systems
311       that assign a high-level server root such as /usr!
312
313       In non-Apache environments, data_dir has no default. If it is left
314       unspecified, Mason will not use object files, and the default data
315       cache class will be "MemoryCache" instead of "FileCache".
316
317       decline_dirs
318
319       * Perl name:           decline_dirs
320       * Apache name:         MasonDeclineDirs
321       * Type in httpd.conf:  boolean
322       * Default:             1
323       * Belongs to:          "HTML::Mason::ApacheHandler"
324
325       True or false, default is true. Indicates whether Mason should decline
326       directory requests, leaving Apache to serve up a directory index or a
327       "FORBIDDEN" error as appropriate. See the allowing directory requests
328       section of the administrator's manual for more information about han‐
329       dling directories with Mason.
330
331       default_escape_flags
332
333       * Perl name:           default_escape_flags
334       * Apache name:         MasonDefaultEscapeFlags
335       * Type in httpd.conf:  string
336       * Default:             []
337       * Belongs to:          "HTML::Mason::Compiler"
338
339       Escape flags to apply to all <% %> expressions by default. The current
340       valid flags are
341
342           h - escape for HTML ('<' => '&lt;', etc.)
343           u - escape for URL (':' => '%3A', etc.)
344
345       The developer can override default escape flags on a per-expression
346       basis; see the escaping expressions section of the developer's manual.
347
348       If you want to set multiple flags as the default, this should be given
349       as a reference to an array of flags.
350
351       define_args_hash
352
353       * Perl name:           define_args_hash
354       * Apache name:         MasonDefineArgsHash
355       * Type in httpd.conf:  string
356       * Default:             auto
357       * Belongs to:          "HTML::Mason::Compiler::ToObject"
358
359       One of "always", "auto", or "never".  This determines whether or not an
360       %ARGS hash is created in components.  If it is set to "always", one is
361       always defined.  If set to "never", it is never defined.
362
363       The default, "auto", will cause the hash to be defined only if some
364       part of the component contains the string "ARGS".  This is somewhat
365       crude, and may result in some false positives, but this is preferable
366       to false negatives.
367
368       Not defining the args hash means that we can avoid copying component
369       arguments, which can save memory and slightly improve execution speed.
370
371       dhandler_name
372
373       * Perl name:           dhandler_name
374       * Apache name:         MasonDhandlerName
375       * Type in httpd.conf:  string
376       * Default:             dhandler
377       * Belongs to:          "HTML::Mason::Request"
378
379       File name used for dhandlers. Default is "dhandler".  If this is set to
380       an empty string ("") then dhandlers are turned off entirely.
381
382       dynamic_comp_root
383
384       * Perl name:           dynamic_comp_root
385       * Apache name:         MasonDynamicCompRoot
386       * Type in httpd.conf:  boolean
387       * Default:             0
388       * Belongs to:          "HTML::Mason::Interp"
389
390       True or false, defaults to false. Indicates whether the comp_root can
391       be modified on this interpreter between requests. Mason can perform a
392       few optimizations with a fixed component root, so you should only set
393       this to true if you actually need it.
394
395       enable_autoflush
396
397       * Perl name:           enable_autoflush
398       * Apache name:         MasonEnableAutoflush
399       * Type in httpd.conf:  boolean
400       * Default:             1
401       * Belongs to:          "HTML::Mason::Compiler"
402
403       True or false, default is true. Indicates whether components are com‐
404       piled with support for autoflush. The component can be compiled to a
405       more efficient form if it does not have to check for autoflush mode, so
406       you should set this to 0 if you can.
407
408       error_format
409
410       * Perl name:           error_format
411       * Apache name:         MasonErrorFormat
412       * Type in httpd.conf:  string
413       * Default:             Varies
414       * Belongs to:          "HTML::Mason::Request"
415
416       Indicates how errors are formatted. The built-in choices are
417
418       ·   brief - just the error message with no trace information
419
420       ·   text - a multi-line text format
421
422       ·   line - a single-line text format, with different pieces of informa‐
423           tion separated by tabs (useful for log files)
424
425       ·   html - a fancy html format
426
427       The default format under Apache and CGI is either line or html depend‐
428       ing on whether the error mode is fatal or output, respectively. The
429       default for standalone mode is text.
430
431       The formats correspond to "HTML::Mason::Exception" methods named
432       as_format. You can define your own format by creating an appropriately
433       named method; for example, to define an "xml" format, create a method
434       "HTML::Mason::Exception::as_xml" patterned after one of the built-in
435       methods.
436
437       error_mode
438
439       * Perl name:           error_mode
440       * Apache name:         MasonErrorMode
441       * Type in httpd.conf:  string
442       * Default:             Varies
443       * Belongs to:          "HTML::Mason::Request"
444
445       Indicates how errors are returned to the caller.  The choices are
446       fatal, meaning die with the error, and output, meaning output the error
447       just like regular output.
448
449       The default under Apache and CGI is output, causing the error to be
450       displayed in the browser.  The default for standalone mode is fatal.
451
452       escape_flags
453
454       * Perl name:           escape_flags
455       * Apache name:         MasonEscapeFlags
456       * Type in httpd.conf:  hash_list
457       * Default:             None
458       * Belongs to:          "HTML::Mason::Interp"
459
460       A hash reference of escape flags to set for this object.  See the sec‐
461       tion on the set_escape method for more details.
462
463       ignore_warnings_expr
464
465       * Perl name:           ignore_warnings_expr
466       * Apache name:         MasonIgnoreWarningsExpr
467       * Type in httpd.conf:  regex
468       * Default:             qr/Subroutine .* redefined/i
469       * Belongs to:          "HTML::Mason::Interp"
470
471       Regular expression indicating which warnings to ignore when loading
472       components. Any warning that is not ignored will prevent the component
473       from being loaded and executed. For example:
474
475           ignore_warnings_expr =>
476               'Global symbol.*requires explicit package'
477
478       If set to undef, all warnings are heeded. If set to '.', warnings are
479       turned off completely as a specially optimized case.
480
481       By default, this is set to 'Subroutine .* redefined'.  This allows you
482       to declare global subroutines inside <%once> sections and not receive
483       an error when the component is reloaded.
484
485       in_package
486
487       * Perl name:           in_package
488       * Apache name:         MasonInPackage
489       * Type in httpd.conf:  string
490       * Default:             HTML::Mason::Commands
491       * Belongs to:          "HTML::Mason::Compiler::ToObject"
492
493       This is the package in which a component's code is executed.  For his‐
494       torical reasons, this defaults to "HTML::Mason::Commands".
495
496       interp_class
497
498       * Perl name:           interp_class
499       * Apache name:         MasonInterpClass
500       * Type in httpd.conf:  string
501       * Default:             HTML::Mason::Interp
502       * Belongs to:          "HTML::Mason::ApacheHandler"
503
504       The class to use when creating a interpreter. Defaults to
505       HTML::Mason::Interp.
506
507       lexer_class
508
509       * Perl name:           lexer_class
510       * Apache name:         MasonLexerClass
511       * Type in httpd.conf:  string
512       * Default:             HTML::Mason::Lexer
513       * Belongs to:          "HTML::Mason::Compiler"
514
515       The class to use when creating a lexer. Defaults to HTML::Mason::Lexer.
516
517       max_recurse
518
519       * Perl name:           max_recurse
520       * Apache name:         MasonMaxRecurse
521       * Type in httpd.conf:  string
522       * Default:             32
523       * Belongs to:          "HTML::Mason::Request"
524
525       The maximum recursion depth for the component stack, for the request
526       stack, and for the inheritance stack. An error is signalled if the max‐
527       imum is exceeded.  Default is 32.
528
529       object_file_extension
530
531       * Perl name:           object_file_extension
532       * Apache name:         MasonObjectFileExtension
533       * Type in httpd.conf:  string
534       * Default:             .obj
535       * Belongs to:          "HTML::Mason::Interp"
536
537       Extension to add to the end of object files. Default is ".obj".
538
539       out_method
540
541       * Perl name:           out_method
542       * Apache name:         MasonOutMethod
543       * Type in httpd.conf:  code
544       * Default:             Print to STDOUT
545       * Belongs to:          "HTML::Mason::Request"
546
547       Indicates where to send output. If out_method is a reference to a
548       scalar, output is appended to the scalar.  If out_method is a reference
549       to a subroutine, the subroutine is called with each output string. For
550       example, to send output to a file called "mason.out":
551
552           my $fh = new IO::File ">mason.out";
553           ...
554           out_method => sub { $fh->print($_[0]) }
555
556       By default, out_method prints to standard output. Under Apache, stan‐
557       dard output is redirected to "$r->print".
558
559       plugins
560
561       * Perl name:           plugins
562       * Apache name:         MasonPlugins
563       * Type in httpd.conf:  list
564       * Default:             []
565       * Belongs to:          "HTML::Mason::Request"
566
567       An array of plugins that will be called at various stages of request
568       processing.  Please see HTML::Mason::Plugin for details.
569
570       postamble
571
572       * Perl name:           postamble
573       * Apache name:         MasonPostamble
574       * Type in httpd.conf:  string
575       * Default:             None
576       * Belongs to:          "HTML::Mason::Compiler::ToObject"
577
578       Text given for this parameter is placed at the end of each component.
579       See also preamble.  The request will be available as $m in postamble
580       code.
581
582       postprocess_perl
583
584       * Perl name:           postprocess_perl
585       * Apache name:         MasonPostprocessPerl
586       * Type in httpd.conf:  code
587       * Default:             None
588       * Belongs to:          "HTML::Mason::Compiler"
589
590       Sub reference that is called to postprocess the Perl portion of a com‐
591       piled component, just before it is assembled into its final subroutine
592       form.  The sub is called with a single parameter, a scalar reference to
593       the Perl portion of the component.  The sub is expected to process the
594       string in-place. See also preprocess and postprocess_text.
595
596       postprocess_text
597
598       * Perl name:           postprocess_text
599       * Apache name:         MasonPostprocessText
600       * Type in httpd.conf:  code
601       * Default:             None
602       * Belongs to:          "HTML::Mason::Compiler"
603
604       Sub reference that is called to postprocess the text portion of a com‐
605       piled component, just before it is assembled into its final subroutine
606       form.  The sub is called with a single parameter, a scalar reference to
607       the text portion of the component.  The sub is expected to process the
608       string in-place. See also preprocess and postprocess_perl.
609
610       preamble
611
612       * Perl name:           preamble
613       * Apache name:         MasonPreamble
614       * Type in httpd.conf:  string
615       * Default:             None
616       * Belongs to:          "HTML::Mason::Compiler::ToObject"
617
618       Text given for this parameter is placed at the beginning of each compo‐
619       nent, but after the execution of any "<%once>" block. See also postam‐
620       ble. The request will be available as $m in preamble code.
621
622       preloads
623
624       * Perl name:           preloads
625       * Apache name:         MasonPreloads
626       * Type in httpd.conf:  list
627       * Default:             None
628       * Belongs to:          "HTML::Mason::Interp"
629
630       A list of component paths, optionally with glob wildcards, to load when
631       the interpreter initializes. e.g.
632
633           preloads => ['/foo/index.html','/bar/*.pl']
634
635       Default is the empty list.  For maximum performance, this should only
636       be used for components that are frequently viewed and rarely updated.
637       See the preloading components section of the administrator's manual for
638       further details.
639
640       As mentioned in the developer's manual, a component's "<%once>" section
641       is executed when it is loaded.  For preloaded components, this means
642       that this section will be executed before a Mason or Apache request
643       exist, so preloading a component that uses $m or $r in a "<%once>" sec‐
644       tion will fail.
645
646       preprocess
647
648       * Perl name:           preprocess
649       * Apache name:         MasonPreprocess
650       * Type in httpd.conf:  code
651       * Default:             None
652       * Belongs to:          "HTML::Mason::Compiler"
653
654       Sub reference that is called to preprocess each component before the
655       compiler does it's magic.  The sub is called with a single parameter, a
656       scalar reference to the script.  The sub is expected to process the
657       script in-place.   This is one way to extend the HTML::Mason syntax
658       with new tags, etc., although a much more flexible way is to subclass
659       the Lexer or Compiler class. See also postprocess_text and postpro‐
660       cess_perl.
661
662       request_class
663
664       * Perl name:           request_class
665       * Apache name:         MasonRequestClass
666       * Type in httpd.conf:  string
667       * Default:             HTML::Mason::Request
668       * Belongs to:          "HTML::Mason::Interp"
669
670       The class to use when creating requests. Defaults to
671       HTML::Mason::Request.
672
673       resolver_class
674
675       * Perl name:           resolver_class
676       * Apache name:         MasonResolverClass
677       * Type in httpd.conf:  string
678       * Default:             HTML::Mason::Resolver::File
679       * Belongs to:          "HTML::Mason::Interp"
680
681       The class to use when creating a resolver. Defaults to
682       HTML::Mason::Resolver::File.
683
684       static_source
685
686       * Perl name:           static_source
687       * Apache name:         MasonStaticSource
688       * Type in httpd.conf:  boolean
689       * Default:             0
690       * Belongs to:          "HTML::Mason::Interp"
691
692       True or false, default is false. When false, Mason checks the timestamp
693       of the component source file each time the component is used to see if
694       it has changed. This provides the instant feedback for source changes
695       that is expected for development.  However it does entail a file stat
696       for each component executed.
697
698       When true, Mason assumes that the component source tree is unchanging:
699       it will not check component source files to determine if the memory
700       cache or object file has expired.  This can save many file stats per
701       request. However, in order to get Mason to recognize a component source
702       change, you must flush the memory cache and remove object files.  See
703       static_source_touch_file for one easy way to arrange this.
704
705       We recommend turning this mode on in your production sites if possible,
706       if performance is of any concern.
707
708       static_source_touch_file
709
710       * Perl name:           static_source_touch_file
711       * Apache name:         MasonStaticSourceTouchFile
712       * Type in httpd.conf:  string
713       * Default:             None
714       * Belongs to:          "HTML::Mason::Interp"
715
716       Specifies a filename that Mason will check once at the beginning of of
717       every request. When the file timestamp changes, Mason will (1) clear
718       its in-memory component cache, and (2) remove object files if they have
719       not already been deleted by another process.
720
721       This provides a convenient way to implement static_source mode.  All
722       you need to do is make sure that a single file gets touched whenever
723       components change. For Mason's part, checking a single file at the
724       beginning of a request is much cheaper than checking every component
725       file when static_source=0.
726
727       subcomp_class
728
729       * Perl name:           subcomp_class
730       * Apache name:         MasonSubcompClass
731       * Type in httpd.conf:  string
732       * Default:             HTML::Mason::Component::Subcomponent
733       * Belongs to:          "HTML::Mason::Compiler::ToObject"
734
735       The class into which subcomponent objects are blessed.  This defaults
736       to HTML::Mason::Component::Subcomponent.
737
738       use_object_files
739
740       * Perl name:           use_object_files
741       * Apache name:         MasonUseObjectFiles
742       * Type in httpd.conf:  boolean
743       * Default:             1
744       * Belongs to:          "HTML::Mason::Interp"
745
746       True or false, default is true.  Specifies whether Mason creates object
747       files to save the results of component parsing. You may want to turn
748       off object files for disk space reasons, but otherwise this should be
749       left alone.
750
751       use_source_line_numbers
752
753       * Perl name:           use_source_line_numbers
754       * Apache name:         MasonUseSourceLineNumbers
755       * Type in httpd.conf:  boolean
756       * Default:             1
757       * Belongs to:          "HTML::Mason::Compiler"
758
759       True or false, default is true. Indicates whether component line num‐
760       bers that appear in error messages, stack traces, etc. are in terms of
761       the source file instead of the object file. Mason does this by insert‐
762       ing '#line' directives into compiled components.  While source line
763       numbers are more immediately helpful, object file line numbers may be
764       more appropriate for in-depth debugging sessions.
765
766       use_strict
767
768       * Perl name:           use_strict
769       * Apache name:         MasonUseStrict
770       * Type in httpd.conf:  boolean
771       * Default:             1
772       * Belongs to:          "HTML::Mason::Compiler::ToObject"
773
774       True or false, default is true. Indicates whether or not a given compo‐
775       nent should "use strict".
776
777
778
779perl v5.8.8                       2007-04-17            HTML::Mason::Params(3)
Impressum