1HTML::Mason::Params(3)User Contributed Perl DocumentationHTML::Mason::Params(3)
2
6 HTML::Mason::Params - Mason configuration parameters
7
9 This document lists all of the Mason configuration parameters that are
10 intended to be used by end users.
11
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 • "autohandler_name" "<-->" "MasonAutohandlerName"
19 • "comp_root" "<-->" "MasonCompRoot"
21 • "data_cache_defaults" "<-->" "MasonDataCacheDefaults"
23 Where Apache Names Are Used
25 The Apache parameter names are used in the Apache configuration file in
26 an httpd-based configuration.
27 Where Perl Names Are Used
29 The Perl parameter names are used from Perl code, i.e. anywhere other
30 than the Apache configuration file. For example,
31 • In an custom wrapper-based configuration, you can pass most of
33 these parameters to the ApacheHandler constructor.
34 • In a standalone Mason script, you can pass most of these parameters
36 to the Interp constructor.
37 • When launching a subrequest, you can pass any of the
39 "HTML::Mason::Request" parameters to make_subrequest.
40
42 allow_globals
43 • Perl name: allow_globals
44 • Apache name: MasonAllowGlobals
46 • Type in httpd.conf: list
48 • Default: []
50 • Belongs to: "HTML::Mason::Compiler"
52 List of variable names, complete with prefix ("$@%"), that you intend
54 to use as globals in components. Normally global variables are
55 forbidden by "strict", but any variable mentioned in this list is
56 granted a reprieve via a "use vars" statement. For example:
57 allow_globals => [qw($DBH %session)]
59 In a mod_perl environment, $r (the request object) is automatically
61 added to this list.
62 apache_status_title
64 • Perl name: apache_status_title
65 • Apache name: MasonApacheStatusTitle
67 • Type in httpd.conf: string
69 • Default: HTML::Mason status
71 • Belongs to: "HTML::Mason::ApacheHandler"
73 Title that you want this ApacheHandler to appear as under
75 Apache::Status. Default is "HTML::Mason status". This is useful if
76 you create more than one ApacheHandler object and want them all visible
77 via Apache::Status.
78 args_method
80 • Perl name: args_method
81 • Apache name: MasonArgsMethod
83 • Type in httpd.conf: string
85 • Default: mod_perl
87 • Belongs to: "HTML::Mason::ApacheHandler"
89 Method to use for unpacking GET and POST arguments. The valid options
91 are 'CGI' and 'mod_perl'; these indicate that a "CGI.pm" or
92 "Apache::Request" object (respectively) will be created for the
93 purposes of argument handling.
94 'mod_perl' is the default under mod_perl-1 and requires that you have
96 installed the "Apache::Request" package. Under mod_perl-2, the default
97 is 'CGI' because "Apache2::Request" is still in development.
98 If args_method is 'mod_perl', the $r global is upgraded to an
100 Apache::Request object. This object inherits all Apache methods and
101 adds a few of its own, dealing with parameters and file uploads. See
102 "Apache::Request" for more information.
103 If the args_method is 'CGI', the Mason request object ($m) will have a
105 method called "cgi_object" available. This method returns the CGI
106 object used for argument processing.
107 While Mason will load "Apache::Request" or "CGI" as needed at runtime,
109 it is recommended that you preload the relevant module either in your
110 httpd.conf or handler.pl file, as this will save some memory.
111 auto_send_headers
113 • Perl name: auto_send_headers
114 • Apache name: MasonAutoSendHeaders
116 • Type in httpd.conf: boolean
118 • Default: 1
120 • Belongs to: "HTML::Mason::Request::ApacheHandler"
122 True or false, default is true. Indicates whether Mason should
124 automatically send HTTP headers before sending content back to the
125 client. If you set to false, you should call "$r->send_http_header"
126 manually.
127 See the sending HTTP headers section of the developer's manual for more
129 details about the automatic header feature.
130 NOTE: This parameter has no effect under mod_perl-2, since calling
132 "$r->send_http_header" is no longer needed.
133 autoflush
135 • Perl name: autoflush
136 • Apache name: MasonAutoflush
138 • Type in httpd.conf: boolean
140 • Default: 0
142 • Belongs to: "HTML::Mason::Request"
144 True or false, default is false. Indicates whether to flush the output
146 buffer ("$m->flush_buffer") after every string is output. Turn on
147 autoflush if you need to send partial output to the client, for example
148 in a progress meter.
149 As of Mason 1.3, autoflush will only work if enable_autoflush has been
151 set. Components can be compiled more efficiently if they don't have to
152 check for autoflush. Before using autoflush you might consider whether
153 a few manual "$m->flush_buffer" calls would work nearly as well.
154 autohandler_name
156 • Perl name: autohandler_name
157 • Apache name: MasonAutohandlerName
159 • Type in httpd.conf: string
161 • Default: autohandler
163 • Belongs to: "HTML::Mason::Interp"
165 File name used for autohandlers. Default is "autohandler". If this is
167 set to an empty string ("") then autohandlers are turned off entirely.
168 buffer_preallocate_size
170 • Perl name: buffer_preallocate_size
171 • Apache name: MasonBufferPreallocateSize
173 • Type in httpd.conf: string
175 • Default: 0
177 • Belongs to: "HTML::Mason::Interp"
179 Number of bytes to preallocate in the output buffer for each request.
181 Defaults to 0. Setting this to, say, your maximum page size (or close
182 to it) can reduce the number of reallocations Perl performs as
183 components add to the output buffer.
184 code_cache_max_size
186 • Perl name: code_cache_max_size
187 • Apache name: MasonCodeCacheMaxSize
189 • Type in httpd.conf: string
191 • Default: unlimited
193 • Belongs to: "HTML::Mason::Interp"
195 Specifies the maximum number of components that should be held in the
197 in-memory code cache. The default is 'unlimited', meaning no components
198 will ever be discarded; Mason can perform certain optimizations in this
199 mode. Setting this to zero disables the code cache entirely. See the
200 code cache section of the administrator's manual for further details.
201 comp_class
203 • Perl name: comp_class
204 • Apache name: MasonCompClass
206 • Type in httpd.conf: string
208 • Default: HTML::Mason::Component
210 • Belongs to: "HTML::Mason::Compiler::ToObject"
212 The class into which component objects are blessed. This defaults to
214 HTML::Mason::Component.
215 comp_root
217 • Perl name: comp_root
218 • Apache name: MasonCompRoot
220 • Type in httpd.conf: list
222 • Default: Varies
224 • Belongs to: "HTML::Mason::Interp"
226 The component root marks the top of your component hierarchy and
228 defines how component paths are translated into real file paths. For
229 example, if your component root is /usr/local/httpd/docs, a component
230 path of /products/index.html translates to the file
231 /usr/local/httpd/docs/products/index.html.
232 Under Apache and CGI, comp_root defaults to the server's document root.
234 In standalone mode comp_root defaults to the current working directory.
235 This parameter may be either a scalar or an array reference. If it is
237 a scalar, it should be a filesystem path indicating the component root.
238 If it is an array reference, it should be of the following form:
239 [ [ foo => '/usr/local/foo' ],
241 [ bar => '/usr/local/bar' ] ]
242 This is an array of two-element array references, not a hash. The
244 "keys" for each path must be unique and their "values" must be
245 filesystem paths. These paths will be searched in the provided order
246 whenever a component path is resolved. For example, given the above
247 component roots and a component path of /products/index.html, Mason
248 would search first for /usr/local/foo/products/index.html, then for
249 /usr/local/bar/products/index.html.
250 The keys are used in several ways. They help to distinguish component
252 caches and object files between different component roots, and they
253 appear in the "title()" of a component.
254 When you specify a single path for a component root, this is actually
256 translated into
257 [ [ MAIN => path ] ]
259 If you have turned on dynamic_comp_root, you may modify the component
261 root(s) of an interpreter between requests by calling
262 "$interp->comp_root" with a value. However, the path associated with
263 any given key may not change between requests. For example, if the
264 initial component root is
265 [ [ foo => '/usr/local/foo' ],
267 [ bar => '/usr/local/bar' ], ]
268 then it may not be changed to
270 [ [ foo => '/usr/local/bar' ],
272 [ bar => '/usr/local/baz' ],
273 but it may be changed to
275 [ [ foo => '/usr/local/foo' ],
277 [ blarg => '/usr/local/blarg' ] ]
278 In other words, you may add or remove key/path pairs but not modify an
280 already-used key/path pair. The reason for this restriction is that the
281 interpreter maintains a component cache per key that would become
282 invalid if the associated paths were to change.
283 compiler_class
285 • Perl name: compiler_class
286 • Apache name: MasonCompilerClass
288 • Type in httpd.conf: string
290 • Default: HTML::Mason::Compiler::ToObject
292 • Belongs to: "HTML::Mason::Interp"
294 The class to use when creating a compiler. Defaults to
296 HTML::Mason::Compiler::ToObject.
297 component_error_handler
299 • Perl name: component_error_handler
300 • Apache name: MasonComponentErrorHandler
302 • Type in httpd.conf: code
304 • Default: sub { package HTML::Mason::Exceptions; use
306 warnings; use strict 'refs'; my($err) = @_; return unless $err; if
307 (UNIVERSAL::can($err, 'rethrow')) { $err->rethrow; } elsif (ref
308 $err) { die $err; } 'HTML::Mason::Exception'->throw('error', $err);
309 }
310 • Belongs to: "HTML::Mason::Request"
312 A code reference used to handle errors thrown during component
314 compilation or runtime. By default, this is a subroutine that turns
315 non-exception object errors in components into exceptions. If this
316 parameter is set to a false value, these errors are simply rethrown as-
317 is.
318 Turning exceptions into objects can be expensive, since this will cause
320 the generation of a stack trace for each error. If you are using
321 strings or unblessed references as exceptions in your code, you may
322 want to turn this off as a performance boost.
323 data_cache_api
325 • Perl name: data_cache_api
326 • Apache name: MasonDataCacheApi
328 • Type in httpd.conf: string
330 • Default: 1.1
332 • Belongs to: "HTML::Mason::Request"
334 The "$m->cache" API to use:
336 • '1.1', the default, indicates a "Cache::Cache" based API.
338 • 'chi' indicates a "CHI" based API.
340 • '1.0' indicates the custom cache API used in Mason 1.0x and
342 earlier. This compatibility layer is provided as a convenience for
343 users upgrading from older versions of Mason, but will not be
344 supported indefinitely.
345 data_cache_defaults
347 • Perl name: data_cache_defaults
348 • Apache name: MasonDataCacheDefaults
350 • Type in httpd.conf: hash_list
352 • Default: None
354 • Belongs to: "HTML::Mason::Request"
356 A hash reference of default options to use for the "$m->cache" command.
358 For example, to use Cache::Cache's "MemoryCache" implementation by
359 default:
360 data_cache_defaults => {cache_class => 'MemoryCache'}
362 To use the CHI "FastMmap" driver by default:
364 data_cache_api => 'CHI',
366 data_cache_defaults => {driver => 'FastMmap'},
367 These settings are overridden by options given to particular
369 "$m->cache" calls.
370 data_dir
372 • Perl name: data_dir
373 • Apache name: MasonDataDir
375 • Type in httpd.conf: string
377 • Default: None
379 • Belongs to: "HTML::Mason::Interp"
381 The data directory is a writable directory that Mason uses for various
383 features and optimizations: for example, component object files and
384 data cache files. Mason will create the directory on startup, if
385 necessary, and set its permissions according to the web server
386 User/Group.
387 Under Apache, data_dir defaults to a directory called "mason" under the
389 Apache server root. You will need to change this on certain systems
390 that assign a high-level server root such as /usr!
391 In non-Apache environments, data_dir has no default. If it is left
393 unspecified, Mason will not use object files, and the default data
394 cache class will be "MemoryCache" instead of "FileCache".
395 decline_dirs
397 • Perl name: decline_dirs
398 • Apache name: MasonDeclineDirs
400 • Type in httpd.conf: boolean
402 • Default: 1
404 • Belongs to: "HTML::Mason::ApacheHandler"
406 True or false, default is true. Indicates whether Mason should decline
408 directory requests, leaving Apache to serve up a directory index or a
409 "FORBIDDEN" error as appropriate. See the allowing directory requests
410 section of the administrator's manual for more information about
411 handling directories with Mason.
412 default_escape_flags
414 • Perl name: default_escape_flags
415 • Apache name: MasonDefaultEscapeFlags
417 • Type in httpd.conf: string
419 • Default: []
421 • Belongs to: "HTML::Mason::Compiler"
423 Escape flags to apply to all <% %> expressions by default. The current
425 valid flags are
426 h - escape for HTML ('<' => '<', etc.)
428 u - escape for URL (':' => '%3A', etc.)
429 The developer can override default escape flags on a per-expression
431 basis; see the escaping expressions section of the developer's manual.
432 If you want to set multiple flags as the default, this should be given
434 as a reference to an array of flags.
435 define_args_hash
437 • Perl name: define_args_hash
438 • Apache name: MasonDefineArgsHash
440 • Type in httpd.conf: string
442 • Default: auto
444 • Belongs to: "HTML::Mason::Compiler::ToObject"
446 One of "always", "auto", or "never". This determines whether or not an
448 %ARGS hash is created in components. If it is set to "always", one is
449 always defined. If set to "never", it is never defined.
450 The default, "auto", will cause the hash to be defined only if some
452 part of the component contains the string "ARGS". This is somewhat
453 crude, and may result in some false positives, but this is preferable
454 to false negatives.
455 Not defining the args hash means that we can avoid copying component
457 arguments, which can save memory and slightly improve execution speed.
458 dhandler_name
460 • Perl name: dhandler_name
461 • Apache name: MasonDhandlerName
463 • Type in httpd.conf: string
465 • Default: dhandler
467 • Belongs to: "HTML::Mason::Request"
469 File name used for dhandlers. Default is "dhandler". If this is set to
471 an empty string ("") then dhandlers are turned off entirely.
472 dynamic_comp_root
474 • Perl name: dynamic_comp_root
475 • Apache name: MasonDynamicCompRoot
477 • Type in httpd.conf: boolean
479 • Default: 0
481 • Belongs to: "HTML::Mason::Interp"
483 True or false, defaults to false. Indicates whether the comp_root can
485 be modified on this interpreter between requests. Mason can perform a
486 few optimizations with a fixed component root, so you should only set
487 this to true if you actually need it.
488 enable_autoflush
490 • Perl name: enable_autoflush
491 • Apache name: MasonEnableAutoflush
493 • Type in httpd.conf: boolean
495 • Default: 1
497 • Belongs to: "HTML::Mason::Compiler"
499 True or false, default is true. Indicates whether components are
501 compiled with support for autoflush. The component can be compiled to a
502 more efficient form if it does not have to check for autoflush mode, so
503 you should set this to 0 if you can.
504 error_format
506 • Perl name: error_format
507 • Apache name: MasonErrorFormat
509 • Type in httpd.conf: string
511 • Default: Varies
513 • Belongs to: "HTML::Mason::Request"
515 Indicates how errors are formatted. The built-in choices are
517 • brief - just the error message with no trace information
519 • text - a multi-line text format
521 • line - a single-line text format, with different pieces of
523 information separated by tabs (useful for log files)
524 • html - a fancy html format
526 The default format under Apache and CGI is either line or html
528 depending on whether the error mode is fatal or output, respectively.
529 The default for standalone mode is text.
530 The formats correspond to "HTML::Mason::Exception" methods named
532 as_format. You can define your own format by creating an appropriately
533 named method; for example, to define an "xml" format, create a method
534 "HTML::Mason::Exception::as_xml" patterned after one of the built-in
535 methods.
536 error_mode
538 • Perl name: error_mode
539 • Apache name: MasonErrorMode
541 • Type in httpd.conf: string
543 • Default: Varies
545 • Belongs to: "HTML::Mason::Request"
547 Indicates how errors are returned to the caller. The choices are
549 fatal, meaning die with the error, and output, meaning output the error
550 just like regular output.
551 The default under Apache and CGI is output, causing the error to be
553 displayed in the browser. The default for standalone mode is fatal.
554 escape_flags
556 • Perl name: escape_flags
557 • Apache name: MasonEscapeFlags
559 • Type in httpd.conf: hash_list
561 • Default: None
563 • Belongs to: "HTML::Mason::Interp"
565 A hash reference of escape flags to set for this object. See the
567 section on the set_escape method for more details.
568 ignore_warnings_expr
570 • Perl name: ignore_warnings_expr
571 • Apache name: MasonIgnoreWarningsExpr
573 • Type in httpd.conf: regex
575 • Default: qr/Subroutine .* redefined/i
577 • Belongs to: "HTML::Mason::Interp"
579 Regular expression indicating which warnings to ignore when loading
581 components. Any warning that is not ignored will prevent the component
582 from being loaded and executed. For example:
583 ignore_warnings_expr =>
585 'Global symbol.*requires explicit package'
586 If set to undef, all warnings are heeded. If set to '.', warnings are
588 turned off completely as a specially optimized case.
589 By default, this is set to 'Subroutine .* redefined'. This allows you
591 to declare global subroutines inside <%once> sections and not receive
592 an error when the component is reloaded.
593 in_package
595 • Perl name: in_package
596 • Apache name: MasonInPackage
598 • Type in httpd.conf: string
600 • Default: HTML::Mason::Commands
602 • Belongs to: "HTML::Mason::Compiler::ToObject"
604 This is the package in which a component's code is executed. For
606 historical reasons, this defaults to "HTML::Mason::Commands".
607 interp_class
609 • Perl name: interp_class
610 • Apache name: MasonInterpClass
612 • Type in httpd.conf: string
614 • Default: HTML::Mason::Interp
616 • Belongs to: "HTML::Mason::ApacheHandler"
618 The class to use when creating a interpreter. Defaults to
620 HTML::Mason::Interp.
621 lexer_class
623 • Perl name: lexer_class
624 • Apache name: MasonLexerClass
626 • Type in httpd.conf: string
628 • Default: HTML::Mason::Lexer
630 • Belongs to: "HTML::Mason::Compiler"
632 The class to use when creating a lexer. Defaults to HTML::Mason::Lexer.
634 max_recurse
636 • Perl name: max_recurse
637 • Apache name: MasonMaxRecurse
639 • Type in httpd.conf: string
641 • Default: 32
643 • Belongs to: "HTML::Mason::Request"
645 The maximum recursion depth for the component stack, for the request
647 stack, and for the inheritance stack. An error is signalled if the
648 maximum is exceeded. Default is 32.
649 named_component_subs
651 • Perl name: named_component_subs
652 • Apache name: MasonNamedComponentSubs
654 • Type in httpd.conf: boolean
656 • Default: 0
658 • Belongs to: "HTML::Mason::Compiler::ToObject"
660 When compiling a component, use uniquely named subroutines for the a
662 component's body, subcomponents, and methods. Doing this allows you to
663 effectively profile Mason components. Without this, all components
664 simply show up as __ANON__ or something similar in the profiler.
665 object_file_extension
667 • Perl name: object_file_extension
668 • Apache name: MasonObjectFileExtension
670 • Type in httpd.conf: string
672 • Default: .obj
674 • Belongs to: "HTML::Mason::Interp"
676 Extension to add to the end of object files. Default is ".obj".
678 out_method
680 • Perl name: out_method
681 • Apache name: MasonOutMethod
683 • Type in httpd.conf: code
685 • Default: Print to STDOUT
687 • Belongs to: "HTML::Mason::Request"
689 Indicates where to send output. If out_method is a reference to a
691 scalar, output is appended to the scalar. If out_method is a reference
692 to a subroutine, the subroutine is called with each output string. For
693 example, to send output to a file called "mason.out":
694 my $fh = new IO::File ">mason.out";
696 ...
697 out_method => sub { $fh->print($_[0]) }
698 By default, out_method prints to standard output. Under Apache,
700 standard output is redirected to "$r->print".
701 plugins
703 • Perl name: plugins
704 • Apache name: MasonPlugins
706 • Type in httpd.conf: list
708 • Default: []
710 • Belongs to: "HTML::Mason::Request"
712 An array of plugins that will be called at various stages of request
714 processing. Please see HTML::Mason::Plugin for details.
715 postamble
717 • Perl name: postamble
718 • Apache name: MasonPostamble
720 • Type in httpd.conf: string
722 • Default: None
724 • Belongs to: "HTML::Mason::Compiler::ToObject"
726 Text given for this parameter is placed at the end of each component.
728 See also preamble. The request will be available as $m in postamble
729 code.
730 postprocess_perl
732 • Perl name: postprocess_perl
733 • Apache name: MasonPostprocessPerl
735 • Type in httpd.conf: code
737 • Default: None
739 • Belongs to: "HTML::Mason::Compiler"
741 Sub reference that is called to postprocess the Perl portion of a
743 compiled component, just before it is assembled into its final
744 subroutine form. The sub is called with a single parameter, a scalar
745 reference to the Perl portion of the component. The sub is expected to
746 process the string in-place. See also preprocess and postprocess_text.
747 postprocess_text
749 • Perl name: postprocess_text
750 • Apache name: MasonPostprocessText
752 • Type in httpd.conf: code
754 • Default: None
756 • Belongs to: "HTML::Mason::Compiler"
758 Sub reference that is called to postprocess the text portion of a
760 compiled component, just before it is assembled into its final
761 subroutine form. The sub is called with a single parameter, a scalar
762 reference to the text portion of the component. The sub is expected to
763 process the string in-place. See also preprocess and postprocess_perl.
764 preamble
766 • Perl name: preamble
767 • Apache name: MasonPreamble
769 • Type in httpd.conf: string
771 • Default: None
773 • Belongs to: "HTML::Mason::Compiler::ToObject"
775 Text given for this parameter is placed at the beginning of each
777 component, but after the execution of any "<%once>" block. See also
778 postamble. The request will be available as $m in preamble code.
779 preloads
781 • Perl name: preloads
782 • Apache name: MasonPreloads
784 • Type in httpd.conf: list
786 • Default: None
788 • Belongs to: "HTML::Mason::Interp"
790 A list of component paths, optionally with glob wildcards, to load when
792 the interpreter initializes. e.g.
793 preloads => ['/foo/index.html','/bar/*.pl']
795 Default is the empty list. For maximum performance, this should only
797 be used for components that are frequently viewed and rarely updated.
798 See the preloading components section of the administrator's manual for
799 further details.
800 As mentioned in the developer's manual, a component's "<%once>" section
802 is executed when it is loaded. For preloaded components, this means
803 that this section will be executed before a Mason or Apache request
804 exist, so preloading a component that uses $m or $r in a "<%once>"
805 section will fail.
806 preprocess
808 • Perl name: preprocess
809 • Apache name: MasonPreprocess
811 • Type in httpd.conf: code
813 • Default: None
815 • Belongs to: "HTML::Mason::Compiler"
817 Sub reference that is called to preprocess each component before the
819 compiler does it's magic. The sub is called with a single parameter, a
820 scalar reference to the script. The sub is expected to process the
821 script in-place. This is one way to extend the HTML::Mason syntax
822 with new tags, etc., although a much more flexible way is to subclass
823 the Lexer or Compiler class. See also postprocess_text and
824 postprocess_perl.
825 request_class
827 • Perl name: request_class
828 • Apache name: MasonRequestClass
830 • Type in httpd.conf: string
832 • Default: HTML::Mason::Request
834 • Belongs to: "HTML::Mason::Interp"
836 The class to use when creating requests. Defaults to
838 HTML::Mason::Request.
839 resolver_class
841 • Perl name: resolver_class
842 • Apache name: MasonResolverClass
844 • Type in httpd.conf: string
846 • Default: HTML::Mason::Resolver::File
848 • Belongs to: "HTML::Mason::Interp"
850 The class to use when creating a resolver. Defaults to
852 HTML::Mason::Resolver::File.
853 static_source
855 • Perl name: static_source
856 • Apache name: MasonStaticSource
858 • Type in httpd.conf: boolean
860 • Default: 0
862 • Belongs to: "HTML::Mason::Interp"
864 True or false, default is false. When false, Mason checks the timestamp
866 of the component source file each time the component is used to see if
867 it has changed. This provides the instant feedback for source changes
868 that is expected for development. However it does entail a file stat
869 for each component executed.
870 When true, Mason assumes that the component source tree is unchanging:
872 it will not check component source files to determine if the memory
873 cache or object file has expired. This can save many file stats per
874 request. However, in order to get Mason to recognize a component source
875 change, you must flush the memory cache and remove object files. See
876 static_source_touch_file for one easy way to arrange this.
877 We recommend turning this mode on in your production sites if possible,
879 if performance is of any concern.
880 static_source_touch_file
882 • Perl name: static_source_touch_file
883 • Apache name: MasonStaticSourceTouchFile
885 • Type in httpd.conf: string
887 • Default: None
889 • Belongs to: "HTML::Mason::Interp"
891 Specifies a filename that Mason will check once at the beginning of of
893 every request. When the file timestamp changes, Mason will (1) clear
894 its in-memory component cache, and (2) remove object files if they have
895 not already been deleted by another process.
896 This provides a convenient way to implement static_source mode. All
898 you need to do is make sure that a single file gets touched whenever
899 components change. For Mason's part, checking a single file at the
900 beginning of a request is much cheaper than checking every component
901 file when static_source=0.
902 subcomp_class
904 • Perl name: subcomp_class
905 • Apache name: MasonSubcompClass
907 • Type in httpd.conf: string
909 • Default: HTML::Mason::Component::Subcomponent
911 • Belongs to: "HTML::Mason::Compiler::ToObject"
913 The class into which subcomponent objects are blessed. This defaults
915 to HTML::Mason::Component::Subcomponent.
916 use_object_files
918 • Perl name: use_object_files
919 • Apache name: MasonUseObjectFiles
921 • Type in httpd.conf: boolean
923 • Default: 1
925 • Belongs to: "HTML::Mason::Interp"
927 True or false, default is true. Specifies whether Mason creates object
929 files to save the results of component parsing. You may want to turn
930 off object files for disk space reasons, but otherwise this should be
931 left alone.
932 use_source_line_numbers
934 • Perl name: use_source_line_numbers
935 • Apache name: MasonUseSourceLineNumbers
937 • Type in httpd.conf: boolean
939 • Default: 1
941 • Belongs to: "HTML::Mason::Compiler"
943 True or false, default is true. Indicates whether component line
945 numbers that appear in error messages, stack traces, etc. are in terms
946 of the source file instead of the object file. Mason does this by
947 inserting '#line' directives into compiled components. While source
948 line numbers are more immediately helpful, object file line numbers may
949 be more appropriate for in-depth debugging sessions.
950 use_strict
952 • Perl name: use_strict
953 • Apache name: MasonUseStrict
955 • Type in httpd.conf: boolean
957 • Default: 1
959 • Belongs to: "HTML::Mason::Compiler::ToObject"
961 True or false, default is true. Indicates whether or not a given
963 component should "use strict".
964 use_warnings
966 • Perl name: use_warnings
967 • Apache name: MasonUseWarnings
969 • Type in httpd.conf: boolean
971 • Default: 1
973 • Belongs to: "HTML::Mason::Compiler::ToObject"
975 True or false, default is false. Indicates whether or not a given
977 component should "use warnings".
978perl v5.32.1 2021-01-27 HTML::Mason::Params(3)