README
1Config::ApacheFormat 1.2
2========================
3
4CHANGES
5
6 - Nathan Wiger ported many features from Apache::ConfigFile in an
7 effort to combine the two modules. These features include:
8
9 o The fix_booleans option, which allows automatic conversion
10 of yes/on/true to 1 and no/off/false to 0
11
12 o The expand_vars option, allowing reuse of previously-defined
13 directives as $directive
14
15 o The setenv_vars option, which will automatically place
16 variables defined via the SetEnv directive into the %ENV
17 hash
18
19 o The hash_directives option, which allows proper handling of
20 directives where the first value is really a key
21 (ex. AddHandler).
22
23 o The duplicate_directives option, which allows the programmer
24 to choose how duplicate directives are handled (by default
25 the last one is kept, allowing subsequent configs to
26 override earlier Includes)
27
28 o Support for multiple blocks with the same name.
29
30 o Support for include directories and multiple include files
31 on a single line
32
33 o The root_directive option, which allows the user to define a
34 root for that config file which is prepended to relative
35 Include paths.
36
37 - Added include_directives option to allow for differently named
38 Include directives.
39
40 - Removed deprecated support for the wrong spelling of
41 inheritance_support as inheritence_support.
42
43 - Fixed bug preventing mixed-case valid_directives and
44 valid_blocks from working.
45
46
47INSTALLATION
48
49To install this module type the following:
50
51 perl Makefile.PL
52 make
53 make test
54 make install
55
56DEPENDENCIES
57
58This module requires these other modules and libraries:
59
60 Carp
61 Class::MethodMaker 1.08
62 Text::Balanced 1.89
63 File::Spec 0.82
64 Scalar::Util
65
66DESCRIPTION
67
68 This module is designed to parse a configuration file in the same syntax
69 used by the Apache web server (see http://httpd.apache.org for details).
70 This allows you to build applications which can be easily managed by
71 experienced Apache admins. Also, by using this module, you'll benefit
72 from the support for nested blocks with built-in parameter inheritance.
73 This can greatly reduce the amount or repeated information in your
74 configuration files.
75
76 A good reference to the Apache configuration file format can be found
77 here:
78
79 http://httpd.apache.org/docs-2.0/configuring.html
80
81 To quote from that document, concerning directive syntax:
82
83 Apache configuration files contain one directive per line. The
84 back-slash "\" may be used as the last character on a line to
85 indicate that the directive continues onto the next line. There must
86 be no other characters or white space between the back-slash and the
87 end of the line.
88
89 Directives in the configuration files are case-insensitive, but
90 arguments to directives are often case sensitive. Lines that begin
91 with the hash character "#" are considered comments, and are
92 ignored. Comments may not be included on a line after a configuration
93 directive. Blank lines and white space occurring before a directive
94 are ignored, so you may indent directives for clarity.
95
96 And block notation:
97
98 Directives placed in the main configuration files apply to the entire
99 server. If you wish to change the configuration for only a part of the
100 server, you can scope your directives by placing them in <Directory>,
101 <DirectoryMatch>, <Files>, <FilesMatch>, <Location>, and
102 <LocationMatch> sections. These sections limit the application of the
103 directives which they enclose to particular filesystem locations or
104 URLs. They can also be nested, allowing for very fine grained
105 configuration.
106
107 This module will parse actual Apache configuration files, but you will
108 need to set some options to non-default values. See the section on
109 "Parsing a Real Apache Config File" in the module documentation
110 for more details.
111
112COPYRIGHT AND LICENSE
113
114 Copyright (C) 2002-2003 Sam Tregar
115
116 This program is free software; you can redistribute it and/or modify
117 it under the same terms as Perl 5 itself.
118