This file is indexed.

/usr/share/perl5/HTML/Mason/Params.pod is in libhtml-mason-perl 1:1.56-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

   1
   2
   3
   4
   5
   6
   7
   8
   9
  10
  11
  12
  13
  14
  15
  16
  17
  18
  19
  20
  21
  22
  23
  24
  25
  26
  27
  28
  29
  30
  31
  32
  33
  34
  35
  36
  37
  38
  39
  40
  41
  42
  43
  44
  45
  46
  47
  48
  49
  50
  51
  52
  53
  54
  55
  56
  57
  58
  59
  60
  61
  62
  63
  64
  65
  66
  67
  68
  69
  70
  71
  72
  73
  74
  75
  76
  77
  78
  79
  80
  81
  82
  83
  84
  85
  86
  87
  88
  89
  90
  91
  92
  93
  94
  95
  96
  97
  98
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129
 130
 131
 132
 133
 134
 135
 136
 137
 138
 139
 140
 141
 142
 143
 144
 145
 146
 147
 148
 149
 150
 151
 152
 153
 154
 155
 156
 157
 158
 159
 160
 161
 162
 163
 164
 165
 166
 167
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177
 178
 179
 180
 181
 182
 183
 184
 185
 186
 187
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212
 213
 214
 215
 216
 217
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235
 236
 237
 238
 239
 240
 241
 242
 243
 244
 245
 246
 247
 248
 249
 250
 251
 252
 253
 254
 255
 256
 257
 258
 259
 260
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270
 271
 272
 273
 274
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307
 308
 309
 310
 311
 312
 313
 314
 315
 316
 317
 318
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330
 331
 332
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349
 350
 351
 352
 353
 354
 355
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375
 376
 377
 378
 379
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391
 392
 393
 394
 395
 396
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410
 411
 412
 413
 414
 415
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428
 429
 430
 431
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470
 471
 472
 473
 474
 475
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492
 493
 494
 495
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512
 513
 514
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532
 533
 534
 535
 536
 537
 538
 539
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563
 564
 565
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641
 642
 643
 644
 645
 646
 647
 648
 649
 650
 651
 652
 653
 654
 655
 656
 657
 658
 659
 660
 661
 662
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674
 675
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687
 688
 689
 690
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705
 706
 707
 708
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749
 750
 751
 752
 753
 754
 755
 756
 757
 758
 759
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776
 777
 778
 779
 780
 781
 782
 783
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806
 807
 808
 809
 810
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827
 828
 829
 830
 831
 832
 833
 834
 835
 836
 837
 838
 839
 840
 841
 842
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862
 863
 864
 865
 866
 867
 868
 869
 870
 871
 872
 873
 874
 875
 876
 877
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889
 890
 891
 892
 893
 894
 895
 896
 897
 898
 899
 900
 901
 902
 903
 904
 905
 906
 907
 908
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927
 928
 929
 930
 931
 932
 933
 934
 935
 936
 937
 938
 939
 940
 941
 942
 943
 944
 945
 946
 947
 948
 949
 950
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
#
# 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.
#

=head1 NAME

HTML::Mason::Params - Mason configuration parameters

=head1 DESCRIPTION

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

=head1 PERL AND APACHE NAMES

Each parameter has two names: a Perl version and an Apache version.
The Perl version uses C<lowercase_with_underscores>, while the Apache
version uses C<StudlyCaps> with a C<Mason> prefix. The conversion from
one version to the other is otherwise very predictable. For example,

=over 4

=item *

C<autohandler_name> C<E<lt>--E<gt>> C<MasonAutohandlerName>

=item *

C<comp_root> C<E<lt>--E<gt>> C<MasonCompRoot>

=item *

C<data_cache_defaults> C<E<lt>--E<gt>> C<MasonDataCacheDefaults>

=back

=head2 Where Apache Names Are Used

The Apache parameter names are used in the Apache configuration file
in an L<httpd-based configuration|HTML::Mason::Admin/BASIC
CONFIGURATION VIA httpd.conf DIRECTIVES>.

=head2 Where Perl Names Are Used

The Perl parameter names are used from Perl code, i.e. anywhere other
than the Apache configuration file. For example,

=over 4

=item *

In an L<custom wrapper-based configuration|HTML::Mason::Admin/ADVANCED
CONFIGURATION>, you can pass most of these parameters to the
L<ApacheHandler|HTML::Mason::ApacheHandler> constructor.

=item *

In a L<standalone Mason script|HTML::Mason::Admin/Using Mason from a
standalone script>, you can pass most of these parameters to the
L<Interp|HTML::Mason::Interp> constructor.

=item *

When launching a L<subrequest|HTML::Mason::Devel/Subrequests>, you can
pass any of the C<HTML::Mason::Request> parameters to
L<make_subrequest|HTML::Mason::Request/item_make_subrequest>.

=back

=head1 PARAMETERS



=head2 allow_globals

=over 4

=item * Perl name:           allow_globals

=item * Apache name:         MasonAllowGlobals

=item * Type in httpd.conf:  list

=item * Default:             []

=item * Belongs to:          C<HTML::Mason::Compiler>




=back

List of variable names, complete with prefix (C<$@%>), that you intend
to use as globals in components.  Normally global variables are
forbidden by C<strict>, but any variable mentioned in this list is
granted a reprieve via a "use vars" statement. For example:

    allow_globals => [qw($DBH %session)]

In a mod_perl environment, C<$r> (the request object) is automatically
added to this list.


=head2 apache_status_title

=over 4

=item * Perl name:           apache_status_title

=item * Apache name:         MasonApacheStatusTitle

=item * Type in httpd.conf:  string

=item * Default:             HTML::Mason status

=item * Belongs to:          C<HTML::Mason::ApacheHandler>




=back

Title that you want this ApacheHandler to appear as under
Apache::Status.  Default is "HTML::Mason status".  This is useful if
you create more than one ApacheHandler object and want them all
visible via Apache::Status.


=head2 args_method

=over 4

=item * Perl name:           args_method

=item * Apache name:         MasonArgsMethod

=item * Type in httpd.conf:  string

=item * Default:             mod_perl

=item * Belongs to:          C<HTML::Mason::ApacheHandler>




=back

Method to use for unpacking GET and POST arguments. The valid options
are 'CGI' and 'mod_perl'; these indicate that a C<CGI.pm> or
C<Apache::Request> object (respectively) will be created for the
purposes of argument handling.

'mod_perl' is the default under mod_perl-1 and requires that you have 
installed the C<Apache::Request> package.  Under mod_perl-2, the default
is 'CGI' because C<Apache2::Request> is still in development.

If args_method is 'mod_perl', the C<$r> global is upgraded to an
Apache::Request object. This object inherits all Apache methods and
adds a few of its own, dealing with parameters and file uploads.  See
C<Apache::Request> for more information.

If the args_method is 'CGI', the Mason request object (C<$m>) will have a
method called C<cgi_object> available.  This method returns the CGI
object used for argument processing.

While Mason will load C<Apache::Request> or C<CGI> as needed at runtime, it
is recommended that you preload the relevant module either in your
F<httpd.conf> or F<handler.pl> file, as this will save some memory.


=head2 auto_send_headers

=over 4

=item * Perl name:           auto_send_headers

=item * Apache name:         MasonAutoSendHeaders

=item * Type in httpd.conf:  boolean

=item * Default:             1

=item * Belongs to:          C<HTML::Mason::Request::ApacheHandler>




=back

=for html <a name="item_auto_send_headers"></a>

True or false, default is true.  Indicates whether Mason should
automatically send HTTP headers before sending content back to the
client. If you set to false, you should call C<$r-E<gt>send_http_header>
manually.

See the L<sending HTTP headers|HTML::Mason::Devel/sending HTTP headers> section of the developer's manual for more details about the automatic
header feature.

NOTE: This parameter has no effect under mod_perl-2, since calling
C<$r-E<gt>send_http_header> is no longer needed.


=head2 autoflush

=over 4

=item * Perl name:           autoflush

=item * Apache name:         MasonAutoflush

=item * Type in httpd.conf:  boolean

=item * Default:             0

=item * Belongs to:          C<HTML::Mason::Request>




=back

True or false, default is false. Indicates whether to flush the output
buffer (C<$m-E<gt>flush_buffer>) after every string is output. Turn on
autoflush if you need to send partial output to the client, for
example in a progress meter.

As of Mason 1.3, autoflush will only work if L<enable_autoflush|HTML::Mason::Params/enable_autoflush> has
been set.  Components can be compiled more efficiently if they don't
have to check for autoflush. Before using autoflush you might consider
whether a few manual C<$m-E<gt>flush_buffer> calls would work nearly
as well.


=head2 autohandler_name

=over 4

=item * Perl name:           autohandler_name

=item * Apache name:         MasonAutohandlerName

=item * Type in httpd.conf:  string

=item * Default:             autohandler

=item * Belongs to:          C<HTML::Mason::Interp>




=back

File name used for
L<autohandlers|HTML::Mason::Devel/autohandlers>. Default is
"autohandler".  If this is set to an empty string ("") then
autohandlers are turned off entirely.


=head2 buffer_preallocate_size

=over 4

=item * Perl name:           buffer_preallocate_size

=item * Apache name:         MasonBufferPreallocateSize

=item * Type in httpd.conf:  string

=item * Default:             0

=item * Belongs to:          C<HTML::Mason::Interp>




=back

=for html <a name="item_buffer_preallocate_size"></a>

Number of bytes to preallocate in the output buffer for each request.
Defaults to 0. Setting this to, say, your maximum page size (or close
to it) can reduce the number of reallocations Perl performs as
components add to the output buffer.


=head2 code_cache_max_size

=over 4

=item * Perl name:           code_cache_max_size

=item * Apache name:         MasonCodeCacheMaxSize

=item * Type in httpd.conf:  string

=item * Default:             unlimited

=item * Belongs to:          C<HTML::Mason::Interp>




=back

=for html <a name="item_code_cache_max_size"></a>

Specifies the maximum number of components that should be held in the
in-memory code cache. The default is 'unlimited', meaning no
components will ever be discarded; Mason can perform certain
optimizations in this mode. Setting this to zero disables the code
cache entirely. See the L<code cache|HTML::Mason::Admin/code cache>
section of the administrator's manual for further details.


=head2 comp_class

=over 4

=item * Perl name:           comp_class

=item * Apache name:         MasonCompClass

=item * Type in httpd.conf:  string

=item * Default:             HTML::Mason::Component

=item * Belongs to:          C<HTML::Mason::Compiler::ToObject>




=back

The class into which component objects are blessed.  This defaults to
L<HTML::Mason::Component|HTML::Mason::Component>.


=head2 comp_root

=over 4

=item * Perl name:           comp_root

=item * Apache name:         MasonCompRoot

=item * Type in httpd.conf:  list

=item * Default:             Varies

=item * Belongs to:          C<HTML::Mason::Interp>




=back

=for html <a name="item_comp_root"></a>

The component root marks the top of your component hierarchy and
defines how component paths are translated into real file paths. For
example, if your component root is F</usr/local/httpd/docs>, a component
path of F</products/index.html> translates to the file
F</usr/local/httpd/docs/products/index.html>.

Under L<Apache|HTML::Mason::ApacheHandler> and
L<CGI|HTML::Mason::CGIHandler>, comp_root defaults to the server's
document root. In standalone mode comp_root defaults to the current
working directory.

This parameter may be either a scalar or an array reference.  If it is
a scalar, it should be a filesystem path indicating the component
root. If it is an array reference, it should be of the following form:

 [ [ foo => '/usr/local/foo' ],
   [ bar => '/usr/local/bar' ] ]

This is an array of two-element array references, not a hash.  The
"keys" for each path must be unique and their "values" must be
filesystem paths.  These paths will be searched in the provided order
whenever a component path is resolved. For example, given the above
component roots and a component path of F</products/index.html>, Mason
would search first for F</usr/local/foo/products/index.html>, then for
F</usr/local/bar/products/index.html>.

The keys are used in several ways. They help to distinguish component
caches and object files between different component roots, and they
appear in the C<title()> of a component.

When you specify a single path for a component root, this is actually
translated into

  [ [ MAIN => path ] ]

If you have turned on L<dynamic_comp_root|HTML::Mason::Params/dynamic_comp_root>, you may modify the
component root(s) of an interpreter between requests by calling
C<$interp-E<gt>comp_root> with a value. However, the path associated
with any given key may not change between requests. For example,
if the initial component root is

 [ [ foo => '/usr/local/foo' ],
   [ bar => '/usr/local/bar' ], ]

then it may not be changed to

 [ [ foo => '/usr/local/bar' ],
   [ bar => '/usr/local/baz' ],

but it may be changed to

 [ [ foo   => '/usr/local/foo' ],
   [ blarg => '/usr/local/blarg' ] ]

In other words, you may add or remove key/path pairs but not modify an
already-used key/path pair. The reason for this restriction is that
the interpreter maintains a component cache per key that would become
invalid if the associated paths were to change.


=head2 compiler_class

=over 4

=item * Perl name:           compiler_class

=item * Apache name:         MasonCompilerClass

=item * Type in httpd.conf:  string

=item * Default:             HTML::Mason::Compiler::ToObject

=item * Belongs to:          C<HTML::Mason::Interp>




=back

The class to use when creating a compiler. Defaults to
L<HTML::Mason::Compiler::ToObject|HTML::Mason::Compiler::ToObject>.


=head2 component_error_handler

=over 4

=item * Perl name:           component_error_handler

=item * Apache name:         MasonComponentErrorHandler

=item * Type in httpd.conf:  code

=item * Default:             sub { package HTML::Mason::Exceptions; use warnings; use strict 'refs'; my($err) = @_; return unless $err; if (UNIVERSAL::can($err, 'rethrow')) { $err->rethrow; } elsif (ref $err) { die $err; } 'HTML::Mason::Exception'->throw('error', $err); }

=item * Belongs to:          C<HTML::Mason::Request>




=back

A code reference used to handle errors thrown during component
compilation or runtime. By default, this is a subroutine that turns
non-exception object errors in components into exceptions. If this
parameter is set to a false value, these errors are simply rethrown
as-is.

Turning exceptions into objects can be expensive, since this will
cause the generation of a stack trace for each error. If you are using
strings or unblessed references as exceptions in your code, you may
want to turn this off as a performance boost.


=head2 data_cache_api

=over 4

=item * Perl name:           data_cache_api

=item * Apache name:         MasonDataCacheApi

=item * Type in httpd.conf:  string

=item * Default:             1.1

=item * Belongs to:          C<HTML::Mason::Request>




=back

The C<$m-E<gt>cache> API to use:

=over

=item *

'1.1', the default, indicates a C<Cache::Cache> based API.

=item *

'chi' indicates a C<CHI> based API.

=item *

'1.0' indicates the custom cache API used in Mason 1.0x and
earlier. This compatibility layer is provided as a convenience for
users upgrading from older versions of Mason, but will not be
supported indefinitely.

=back


=head2 data_cache_defaults

=over 4

=item * Perl name:           data_cache_defaults

=item * Apache name:         MasonDataCacheDefaults

=item * Type in httpd.conf:  hash_list

=item * Default:             None

=item * Belongs to:          C<HTML::Mason::Request>




=back

A hash reference of default options to use for the C<$m-E<gt>cache>
command.  For example, to use Cache::Cache's C<MemoryCache>
implementation by default:

    data_cache_defaults => {cache_class => 'MemoryCache'}

To use the CHI C<FastMmap> driver by default:

    data_cache_api      => 'CHI',
    data_cache_defaults => {driver => 'FastMmap'},

These settings are overridden by options given to particular
C<$m-E<gt>cache> calls.


=head2 data_dir

=over 4

=item * Perl name:           data_dir

=item * Apache name:         MasonDataDir

=item * Type in httpd.conf:  string

=item * Default:             None

=item * Belongs to:          C<HTML::Mason::Interp>




=back

The data directory is a writable directory that Mason uses for various
features and optimizations: for example, component object files and
data cache files. Mason will create the directory on startup, if necessary, and set its
permissions according to the web server User/Group.

Under L<Apache|HTML::Mason::ApacheHandler>, data_dir defaults to a
directory called "mason" under the Apache server root. You will
need to change this on certain systems that assign a high-level
server root such as F</usr>!

In non-Apache environments, data_dir has no default. If it is left
unspecified, Mason will not use L<object files|HTML::Mason::Admin/object files>, and the default
L<data cache class|HTML::Mason::Request/item_cache> will be
C<MemoryCache> instead of C<FileCache>.


=head2 decline_dirs

=over 4

=item * Perl name:           decline_dirs

=item * Apache name:         MasonDeclineDirs

=item * Type in httpd.conf:  boolean

=item * Default:             1

=item * Belongs to:          C<HTML::Mason::ApacheHandler>




=back

True or false, default is true. Indicates whether Mason should decline
directory requests, leaving Apache to serve up a directory index or a
C<FORBIDDEN> error as appropriate. See the L<allowing directory requests|HTML::Mason::Admin/allowing directory requests> section of the administrator's manual
for more information about handling directories with Mason.


=head2 default_escape_flags

=over 4

=item * Perl name:           default_escape_flags

=item * Apache name:         MasonDefaultEscapeFlags

=item * Type in httpd.conf:  string

=item * Default:             []

=item * Belongs to:          C<HTML::Mason::Compiler>




=back

Escape flags to apply to all <% %> expressions by default. The current
valid flags are

    h - escape for HTML ('<' => '&lt;', etc.)
    u - escape for URL (':' => '%3A', etc.)

The developer can override default escape flags on a per-expression
basis; see the L<escaping expressions|HTML::Mason::Devel/escaping expressions> section of the developer's manual.

If you want to set I<multiple> flags as the default, this should be
given as a reference to an array of flags.


=head2 define_args_hash

=over 4

=item * Perl name:           define_args_hash

=item * Apache name:         MasonDefineArgsHash

=item * Type in httpd.conf:  string

=item * Default:             auto

=item * Belongs to:          C<HTML::Mason::Compiler::ToObject>




=back

One of "always", "auto", or "never".  This determines whether or not
an C<%ARGS> hash is created in components.  If it is set to "always",
one is always defined.  If set to "never", it is never defined.

The default, "auto", will cause the hash to be defined only if some
part of the component contains the string "ARGS".  This is somewhat
crude, and may result in some false positives, but this is preferable
to false negatives.

Not defining the args hash means that we can avoid copying component
arguments, which can save memory and slightly improve execution speed.


=head2 dhandler_name

=over 4

=item * Perl name:           dhandler_name

=item * Apache name:         MasonDhandlerName

=item * Type in httpd.conf:  string

=item * Default:             dhandler

=item * Belongs to:          C<HTML::Mason::Request>




=back

File name used for L<dhandlers|HTML::Mason::Devel/dhandlers>. Default
is "dhandler".  If this is set to an empty string ("") then dhandlers
are turned off entirely.


=head2 dynamic_comp_root

=over 4

=item * Perl name:           dynamic_comp_root

=item * Apache name:         MasonDynamicCompRoot

=item * Type in httpd.conf:  boolean

=item * Default:             0

=item * Belongs to:          C<HTML::Mason::Interp>




=back

True or false, defaults to false. Indicates whether the L<comp_root|HTML::Mason::Params/comp_root>
can be modified on this interpreter between requests. Mason can
perform a few optimizations with a fixed component root, so you
should only set this to true if you actually need it.


=head2 enable_autoflush

=over 4

=item * Perl name:           enable_autoflush

=item * Apache name:         MasonEnableAutoflush

=item * Type in httpd.conf:  boolean

=item * Default:             1

=item * Belongs to:          C<HTML::Mason::Compiler>




=back

True or false, default is true. Indicates whether components are
compiled with support for L<autoflush|HTML::Mason::Params/autoflush>. The component can be compiled
to a more efficient form if it does not have to check for autoflush
mode, so you should set this to 0 if you can.


=head2 error_format

=over 4

=item * Perl name:           error_format

=item * Apache name:         MasonErrorFormat

=item * Type in httpd.conf:  string

=item * Default:             Varies

=item * Belongs to:          C<HTML::Mason::Request>




=back

Indicates how errors are formatted. The built-in choices are

=over

=item *

I<brief> - just the error message with no trace information

=item *

I<text> - a multi-line text format

=item *

I<line> - a single-line text format, with different pieces of
information separated by tabs (useful for log files)

=item *

I<html> - a fancy html format

=back

The default format under L<Apache|HTML::Mason::ApacheHandler> and
L<CGI|HTML::Mason::CGIHandler> is either I<line> or I<html> depending
on whether the error mode is I<fatal> or I<output>, respectively. The
default for standalone mode is I<text>.

The formats correspond to C<HTML::Mason::Exception> methods named
as_I<format>. You can define your own format by creating an
appropriately named method; for example, to define an "xml" format,
create a method C<HTML::Mason::Exception::as_xml> patterned after one of
the built-in methods.


=head2 error_mode

=over 4

=item * Perl name:           error_mode

=item * Apache name:         MasonErrorMode

=item * Type in httpd.conf:  string

=item * Default:             Varies

=item * Belongs to:          C<HTML::Mason::Request>




=back

Indicates how errors are returned to the caller.  The choices are
I<fatal>, meaning die with the error, and I<output>, meaning output
the error just like regular output.

The default under L<Apache|HTML::Mason::ApacheHandler> and
L<CGI|HTML::Mason::CGIHandler> is I<output>, causing the error to be
displayed in the browser.  The default for standalone mode is
I<fatal>.


=head2 escape_flags

=over 4

=item * Perl name:           escape_flags

=item * Apache name:         MasonEscapeFlags

=item * Type in httpd.conf:  hash_list

=item * Default:             None

=item * Belongs to:          C<HTML::Mason::Interp>




=back

A hash reference of escape flags to set for this object.  See the
section on the L<set_escape
method|HTML::Mason::Interp/item_set_escape> for more details.


=head2 ignore_warnings_expr

=over 4

=item * Perl name:           ignore_warnings_expr

=item * Apache name:         MasonIgnoreWarningsExpr

=item * Type in httpd.conf:  regex

=item * Default:             qr/Subroutine .* redefined/i

=item * Belongs to:          C<HTML::Mason::Interp>




=back

Regular expression indicating which warnings to ignore when loading
components. Any warning that is not ignored will prevent the
component from being loaded and executed. For example:

    ignore_warnings_expr =>
        'Global symbol.*requires explicit package'

If set to undef, all warnings are heeded. If set to '.', warnings
are turned off completely as a specially optimized case.

By default, this is set to 'Subroutine .* redefined'.  This allows you
to declare global subroutines inside <%once> sections and not receive
an error when the component is reloaded.


=head2 in_package

=over 4

=item * Perl name:           in_package

=item * Apache name:         MasonInPackage

=item * Type in httpd.conf:  string

=item * Default:             HTML::Mason::Commands

=item * Belongs to:          C<HTML::Mason::Compiler::ToObject>




=back

This is the package in which a component's code is executed.  For
historical reasons, this defaults to C<HTML::Mason::Commands>.


=head2 interp_class

=over 4

=item * Perl name:           interp_class

=item * Apache name:         MasonInterpClass

=item * Type in httpd.conf:  string

=item * Default:             HTML::Mason::Interp

=item * Belongs to:          C<HTML::Mason::ApacheHandler>




=back

The class to use when creating a interpreter. Defaults to
L<HTML::Mason::Interp|HTML::Mason::Interp>.


=head2 lexer_class

=over 4

=item * Perl name:           lexer_class

=item * Apache name:         MasonLexerClass

=item * Type in httpd.conf:  string

=item * Default:             HTML::Mason::Lexer

=item * Belongs to:          C<HTML::Mason::Compiler>




=back

The class to use when creating a lexer. Defaults to L<HTML::Mason::Lexer|HTML::Mason::Lexer>.


=head2 max_recurse

=over 4

=item * Perl name:           max_recurse

=item * Apache name:         MasonMaxRecurse

=item * Type in httpd.conf:  string

=item * Default:             32

=item * Belongs to:          C<HTML::Mason::Request>




=back

The maximum recursion depth for the component stack, for the request
stack, and for the inheritance stack. An error is signalled if the
maximum is exceeded.  Default is 32.


=head2 named_component_subs

=over 4

=item * Perl name:           named_component_subs

=item * Apache name:         MasonNamedComponentSubs

=item * Type in httpd.conf:  boolean

=item * Default:             0

=item * Belongs to:          C<HTML::Mason::Compiler::ToObject>




=back

When compiling a component, use uniquely named subroutines for the a
component's body, subcomponents, and methods. Doing this allows you to
effectively profile Mason components. Without this, all components
simply show up as __ANON__ or something similar in the profiler.


=head2 object_file_extension

=over 4

=item * Perl name:           object_file_extension

=item * Apache name:         MasonObjectFileExtension

=item * Type in httpd.conf:  string

=item * Default:             .obj

=item * Belongs to:          C<HTML::Mason::Interp>




=back

Extension to add to the end of object files. Default is ".obj".


=head2 out_method

=over 4

=item * Perl name:           out_method

=item * Apache name:         MasonOutMethod

=item * Type in httpd.conf:  code

=item * Default:             Print to STDOUT

=item * Belongs to:          C<HTML::Mason::Request>




=back

Indicates where to send output. If out_method is a reference to a
scalar, output is appended to the scalar.  If out_method is a
reference to a subroutine, the subroutine is called with each output
string. For example, to send output to a file called "mason.out":

    my $fh = new IO::File ">mason.out";
    ...
    out_method => sub { $fh->print($_[0]) }

By default, out_method prints to standard output. Under
L<Apache|HTML::Mason::ApacheHandler>, standard output is
redirected to C<< $r->print >>.


=head2 plugins

=over 4

=item * Perl name:           plugins

=item * Apache name:         MasonPlugins

=item * Type in httpd.conf:  list

=item * Default:             []

=item * Belongs to:          C<HTML::Mason::Request>




=back

An array of plugins that will be called at various stages of request
processing.  Please see L<HTML::Mason::Plugin|HTML::Mason::Plugin> for
details.


=head2 postamble

=over 4

=item * Perl name:           postamble

=item * Apache name:         MasonPostamble

=item * Type in httpd.conf:  string

=item * Default:             None

=item * Belongs to:          C<HTML::Mason::Compiler::ToObject>




=back

Text given for this parameter is placed at the end of each
component. See also L<preamble|HTML::Mason::Params/preamble>.  The request will be available as
C<$m> in postamble code.


=head2 postprocess_perl

=over 4

=item * Perl name:           postprocess_perl

=item * Apache name:         MasonPostprocessPerl

=item * Type in httpd.conf:  code

=item * Default:             None

=item * Belongs to:          C<HTML::Mason::Compiler>




=back

Sub reference that is called to postprocess the Perl portion of a
compiled component, just before it is assembled into its final
subroutine form.  The sub is called with a single parameter, a scalar
reference to the Perl portion of the component.  The sub is expected
to process the string in-place. See also
L<preprocess|HTML::Mason::Params/preprocess> and L<postprocess_text|HTML::Mason::Params/postprocess_text>.


=head2 postprocess_text

=over 4

=item * Perl name:           postprocess_text

=item * Apache name:         MasonPostprocessText

=item * Type in httpd.conf:  code

=item * Default:             None

=item * Belongs to:          C<HTML::Mason::Compiler>




=back

Sub reference that is called to postprocess the text portion of a
compiled component, just before it is assembled into its final
subroutine form.  The sub is called with a single parameter, a scalar
reference to the text portion of the component.  The sub is expected
to process the string in-place. See also
L<preprocess|HTML::Mason::Params/preprocess> and L<postprocess_perl|HTML::Mason::Params/postprocess_perl>.


=head2 preamble

=over 4

=item * Perl name:           preamble

=item * Apache name:         MasonPreamble

=item * Type in httpd.conf:  string

=item * Default:             None

=item * Belongs to:          C<HTML::Mason::Compiler::ToObject>




=back

Text given for this parameter is placed at the beginning of each
component, but after the execution of any C<< <%once> >> block. See
also L<postamble|HTML::Mason::Params/postamble>. The request will be available as C<$m> in preamble
code.


=head2 preloads

=over 4

=item * Perl name:           preloads

=item * Apache name:         MasonPreloads

=item * Type in httpd.conf:  list

=item * Default:             None

=item * Belongs to:          C<HTML::Mason::Interp>




=back

A list of component paths, optionally with glob wildcards, to load
when the interpreter initializes. e.g.

    preloads => ['/foo/index.html','/bar/*.pl']

Default is the empty list.  For maximum performance, this should only
be used for components that are frequently viewed and rarely updated.
See the L<preloading components|HTML::Mason::Admin/preloading components> section of the administrator's manual for further details.

As mentioned in the developer's manual, a component's C<< <%once> >>
section is executed when it is loaded.  For preloaded components, this
means that this section will be executed before a Mason or Apache
request exist, so preloading a component that uses C<$m> or C<$r> in a
C<< <%once> >> section will fail.


=head2 preprocess

=over 4

=item * Perl name:           preprocess

=item * Apache name:         MasonPreprocess

=item * Type in httpd.conf:  code

=item * Default:             None

=item * Belongs to:          C<HTML::Mason::Compiler>




=back

Sub reference that is called to preprocess each component before the compiler does
it's magic.  The sub is called with a single parameter, a scalar reference
to the script.  The sub is expected to process the script in-place.   This is
one way to extend the HTML::Mason syntax with new tags, etc., although a much
more flexible way is to subclass the Lexer or Compiler class. See also
L<postprocess_text|HTML::Mason::Params/postprocess_text> and L<postprocess_perl|HTML::Mason::Params/postprocess_perl>.


=head2 request_class

=over 4

=item * Perl name:           request_class

=item * Apache name:         MasonRequestClass

=item * Type in httpd.conf:  string

=item * Default:             HTML::Mason::Request

=item * Belongs to:          C<HTML::Mason::Interp>




=back

The class to use when creating requests. Defaults to
L<HTML::Mason::Request|HTML::Mason::Request>.


=head2 resolver_class

=over 4

=item * Perl name:           resolver_class

=item * Apache name:         MasonResolverClass

=item * Type in httpd.conf:  string

=item * Default:             HTML::Mason::Resolver::File

=item * Belongs to:          C<HTML::Mason::Interp>




=back

The class to use when creating a resolver. Defaults to
L<HTML::Mason::Resolver::File|HTML::Mason::Resolver::File>.


=head2 static_source

=over 4

=item * Perl name:           static_source

=item * Apache name:         MasonStaticSource

=item * Type in httpd.conf:  boolean

=item * Default:             0

=item * Belongs to:          C<HTML::Mason::Interp>




=back

True or false, default is false. When false, Mason checks the
timestamp of the component source file each time the component is used
to see if it has changed. This provides the instant feedback for
source changes that is expected for development.  However it does
entail a file stat for each component executed.

When true, Mason assumes that the component source tree is unchanging:
it will not check component source files to determine if the memory
cache or object file has expired.  This can save many file stats per
request. However, in order to get Mason to recognize a component
source change, you must flush the memory cache and remove object files.
See L<static_source_touch_file|HTML::Mason::Params/static_source_touch_file> for one easy way to arrange this.

We recommend turning this mode on in your production sites if
possible, if performance is of any concern.


=head2 static_source_touch_file

=over 4

=item * Perl name:           static_source_touch_file

=item * Apache name:         MasonStaticSourceTouchFile

=item * Type in httpd.conf:  string

=item * Default:             None

=item * Belongs to:          C<HTML::Mason::Interp>




=back

Specifies a filename that Mason will check once at the beginning of
of every request. When the file timestamp changes, Mason will (1) clear
its in-memory component cache, and (2) remove object files if
they have not already been deleted by another process.

This provides a convenient way to implement L<static_source|HTML::Mason::Params/static_source> mode.
All you need to do is make sure that a single file gets touched
whenever components change. For Mason's part, checking a single
file at the beginning of a request is much cheaper than checking
every component file when static_source=0.


=head2 subcomp_class

=over 4

=item * Perl name:           subcomp_class

=item * Apache name:         MasonSubcompClass

=item * Type in httpd.conf:  string

=item * Default:             HTML::Mason::Component::Subcomponent

=item * Belongs to:          C<HTML::Mason::Compiler::ToObject>




=back

The class into which subcomponent objects are blessed.  This defaults
to L<HTML::Mason::Component::Subcomponent|HTML::Mason::Component::Subcomponent>.


=head2 use_object_files

=over 4

=item * Perl name:           use_object_files

=item * Apache name:         MasonUseObjectFiles

=item * Type in httpd.conf:  boolean

=item * Default:             1

=item * Belongs to:          C<HTML::Mason::Interp>




=back

True or false, default is true.  Specifies whether Mason creates
object files to save the results of component parsing. You may want to
turn off object files for disk space reasons, but otherwise this
should be left alone.


=head2 use_source_line_numbers

=over 4

=item * Perl name:           use_source_line_numbers

=item * Apache name:         MasonUseSourceLineNumbers

=item * Type in httpd.conf:  boolean

=item * Default:             1

=item * Belongs to:          C<HTML::Mason::Compiler>




=back

True or false, default is true. Indicates whether component line
numbers that appear in error messages, stack traces, etc. are in terms
of the source file instead of the object file. Mason does this by
inserting '#line' directives into compiled components.  While source
line numbers are more immediately helpful, object file line numbers
may be more appropriate for in-depth debugging sessions.


=head2 use_strict

=over 4

=item * Perl name:           use_strict

=item * Apache name:         MasonUseStrict

=item * Type in httpd.conf:  boolean

=item * Default:             1

=item * Belongs to:          C<HTML::Mason::Compiler::ToObject>




=back

True or false, default is true. Indicates whether or not a given
component should C<use strict>.

=head2 use_warnings

=over 4

=item * Perl name:           use_warnings

=item * Apache name:         MasonUseWarnings

=item * Type in httpd.conf:  boolean

=item * Default:             1

=item * Belongs to:          C<HTML::Mason::Compiler::ToObject>

=back

True or false, default is false. Indicates whether or not a given
component should C<use warnings>.