directive-dict.html revision 427ab2fd9aeee3a13a54b90f3eeec7e7214163fb
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
0c27b3fe77ac1d5094ba3521e8142d9e7973133fMark Andrews <TITLE>Definitions of terms used to describe Apache directives
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
4b6dc226f78862286daa69fba761eac9fd5da16aAutomatic Updater BGCOLOR="#FFFFFF"
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews TEXT="#000000"
a4ed9791ed94e50ef92025d097d498b8a5bf55d7James Brister LINK="#0000FF"
a4ed9791ed94e50ef92025d097d498b8a5bf55d7James Brister VLINK="#000080"
ab023a65562e62b85a824509d829b6fad87e00b1Rob Austein ALINK="#FF0000"
854d0238dbc2908490197984b3b9d558008a53dfMark Andrews<!--#include virtual="header.html" -->
854d0238dbc2908490197984b3b9d558008a53dfMark Andrews <H1 ALIGN="CENTER">Terms Used to Describe Apache Directives</H1>
6324997211a5e2d82528dcde98e8981190a35faeMichael Graff Each Apache configuration directive is described using a common format
3ddd814a97de1d152ba0913c592d6e6dc83d38a6Michael Graff that looks like this:
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews HREF="#Syntax"
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews ><STRONG>Syntax:</STRONG></A> <EM>directive-name</EM> <EM>some args</EM>
ae114ded82e773a4d9058f833f964a17514712a8Brian Wellington HREF="#Default"
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews <SAMP><EM>directive-name default-value</EM></SAMP>
5eb91bd90e3ad3426e5e3213031556a737cf3809Mark Andrews HREF="#Context"
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews ><STRONG>Context:</STRONG></A> <EM>context-list</EM>
add4043305ca411202ed9cf1929a4179016515ceBrian Wellington HREF="#Override"
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews ><STRONG>Override:</STRONG></A> <EM>override</EM>
e0a30050c8516a3d54a4f8dcdd88435704a8a3edMark Andrews HREF="#Status"
2047977ce2dfcfe3a0fa2d638c3242841310fad3Mark Andrews HREF="#Module"
2047977ce2dfcfe3a0fa2d638c3242841310fad3Mark Andrews ><STRONG>Module:</STRONG></A> <EM>module-name</EM>
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews HREF="#Compatibility"
3ddd814a97de1d152ba0913c592d6e6dc83d38a6Michael Graff ><STRONG>Compatibility:</STRONG></A> <EM>compatibility notes</EM>
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews Each of the directive's attributes, complete with possible values
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews where possible, are described in this document.
5fc7ba3e1ac5d72239e9971e0f469dd5796738f9Andreas Gustafsson <LI><A HREF="#Compatibility">Compatibility</A>
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews This indicates the format of the directive as it would appear in a
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews configuration file. This syntax is extremely directive-specific, so
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews refer to the text of the directive's description for details.
94a08e09db3dc844b6ee4841c368a2d7074a9c3fAndreas Gustafsson If the directive has a default value (<EM>i.e.</EM>, if you omit it
40f53fa8d9c6a4fc38c0014495e7a42b08f52481David Lawrence from your configuration entirely, the Apache Web server will behave as
4b6dc226f78862286daa69fba761eac9fd5da16aAutomatic Updater though you set it to a particular value), it is described here. If
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews there is no default value, this section should say
e851ea826066ac5a5b01c2c23218faa0273a12e8Evan Hunt This indicates where in the server's configuration files the directive
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews is legal. It's a comma-separated list of one or more of the following
6d12fdf96621801e80f3f4c2a8a569fe48766a20David Lawrence <DD>This means that the directive may be used in the server
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews configuration files (<EM>e.g.</EM>, <SAMP>httpd.conf</SAMP>,
cdc50af0bff41accc02c613b9c6d8cd41b171ffeBrian Wellington <SAMP>srm.conf</SAMP>, and <SAMP>access.conf</SAMP>), but
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews <STRONG>not</STRONG> within any <SAMP><VirtualHost></SAMP> or
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews <Directory> containers. It is not allowed in
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews <DD>This context means that the directive may appear inside
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews <SAMP><VirtualHost></SAMP> containers in the server
419590499823ce15b5d2ad4fe71eaf04bd5a86c0Michael Graff configuration files.
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews <DD>A directive marked as being valid in this context may be used
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews inside <SAMP><Directory></SAMP> containers in the server
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews configuration files.
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews <DD>If a directive is valid in this context, it means that it can
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews appear inside <EM>per</EM>-directory <SAMP>.htaccess</SAMP> files.
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews It may not be processed, though depending upon the
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews HREF="#Override"
d981ca645597116d227a48bf37cc5edc061c854dBob Halley >overrides</A>
b0ba1a6059b6d6c4b3aa77d8bc84cc443b981e01Mukund Sivaraman currently active.
41aad56b6cc458cbf7b8483576d990a77ae9bac2Andreas Gustafsson The directive is <EM>only</EM> allowed within the designated context;
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews if you try to use it elsewhere, you'll get a configuration error that
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews will either prevent the server from handling requests in that context
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews correctly, or will keep the server from operating at all --
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews The valid locations for the directive are actually the result of a
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews Boolean OR of all of the listed contexts. In other words, a directive
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews that is marked as being valid in "<SAMP>server config,
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews .htaccess</SAMP>" can be used in the <SAMP>httpd.conf</SAMP> file
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews and in <SAMP>.htaccess</SAMP> files, but not within any
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews <Directory> or <VirtualHost> containers.
6d12fdf96621801e80f3f4c2a8a569fe48766a20David Lawrence This directive attribute indicates which configuration override must
373ce67419680a398ba3dc51a14a486caaf0afb0Mark Andrews be active in order for the directive to be processed when it appears
373ce67419680a398ba3dc51a14a486caaf0afb0Mark Andrews in a <SAMP>.htaccess</SAMP> file. If the directive's
b0ba1a6059b6d6c4b3aa77d8bc84cc443b981e01Mukund Sivaraman HREF="#Context"
373ce67419680a398ba3dc51a14a486caaf0afb0Mark Andrews >context</A>
373ce67419680a398ba3dc51a14a486caaf0afb0Mark Andrews doesn't permit it to appear in <SAMP>.htaccess</SAMP> files, this
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews attribute should say "<EM>Not applicable</EM>".
63cef8bde8b92aeb30ccdcf21d4e44c9be9cc6e3Andreas Gustafsson Overrides are activated by the
373ce67419680a398ba3dc51a14a486caaf0afb0Mark Andrews HREF="core.html#allowoverride"
1c3191528684f3dd93ebb122298c2f8ebfc6d397Mark Andrews directive, and apply to a particular scope (such as a directory) and
3ddd814a97de1d152ba0913c592d6e6dc83d38a6Michael Graff all descendants, unless further modified by other
6d12fdf96621801e80f3f4c2a8a569fe48766a20David Lawrence <SAMP>AllowOverride</SAMP> directives at lower levels. The
9281e7aa775026dc47c01745fdcc438645146877Mark Andrews documentation for that directive also lists the possible override
9281e7aa775026dc47c01745fdcc438645146877Mark Andrews names available.
82ca33427bdd4f3bc4ed3431e86bd810fe751674Andreas Gustafsson This indicates how tightly bound into the Apache Web server the
9281e7aa775026dc47c01745fdcc438645146877Mark Andrews directive is; in other words, you may need to recompile the server
9281e7aa775026dc47c01745fdcc438645146877Mark Andrews with an enhanced set of modules in order to gain access to the
9281e7aa775026dc47c01745fdcc438645146877Mark Andrews directive and its functionality. Possible values for this attribute
9281e7aa775026dc47c01745fdcc438645146877Mark Andrews <DD>If a directive is listed as having "Core" status, that
9281e7aa775026dc47c01745fdcc438645146877Mark Andrews means it is part of the innermost portions of the Apache Web server,
9281e7aa775026dc47c01745fdcc438645146877Mark Andrews and is always available.
4529cdaedaf1a0a5f8ff89aeca510b7a4475446cBob Halley <DD>A directive labeled as having "Base" status is
6d12fdf96621801e80f3f4c2a8a569fe48766a20David Lawrence supported by one of the standard Apache modules which is compiled
9281e7aa775026dc47c01745fdcc438645146877Mark Andrews into the server by default, and is therefore normally available
9281e7aa775026dc47c01745fdcc438645146877Mark Andrews unless you've taken steps to remove the module from your configuration.
9281e7aa775026dc47c01745fdcc438645146877Mark Andrews <DD>A directive with "Extension" status is provided by one
9281e7aa775026dc47c01745fdcc438645146877Mark Andrews of the modules included with the Apache server kit, but the module
9281e7aa775026dc47c01745fdcc438645146877Mark Andrews isn't normally compiled into the server. To enable the directive
94a3bcd132e515b4baa0884ba9dd0f361d2e17bcMark Andrews and its functionality, you will need to change the server build
d981ca645597116d227a48bf37cc5edc061c854dBob Halley configuration files and re-compile Apache.
b1bc194f94c0b3cbc5999582f08e8d7a20b91e2eBob Halley <DD>"Experimental" status indicates that the directive is
b1bc194f94c0b3cbc5999582f08e8d7a20b91e2eBob Halley available as part of the Apache kit, but you're on your own if you
b0ba1a6059b6d6c4b3aa77d8bc84cc443b981e01Mukund Sivaraman try to use it. The directive is being documented for completeness,
d981ca645597116d227a48bf37cc5edc061c854dBob Halley and is not necessarily supported. The module which provides the
cdc50af0bff41accc02c613b9c6d8cd41b171ffeBrian Wellington directive may or may not be compiled in by default; check the top of
b1bc194f94c0b3cbc5999582f08e8d7a20b91e2eBob Halley the page which describes the directive and its module to see if it
b1bc194f94c0b3cbc5999582f08e8d7a20b91e2eBob Halley remarks on the availability.
b1bc194f94c0b3cbc5999582f08e8d7a20b91e2eBob Halley This quite simply lists the name of the source module which defines
d981ca645597116d227a48bf37cc5edc061c854dBob Halley the directive.
e27a69f8bd9538e08f775265167ba6cc5f47c587Bob Halley <H2><A NAME="Compatibility">Compatibility</A></H2>
e27a69f8bd9538e08f775265167ba6cc5f47c587Bob Halley If the directive wasn't part of the original Apache version 1
e27a69f8bd9538e08f775265167ba6cc5f47c587Bob Halley distribution, the version in which it was introduced should be listed
b0ba1a6059b6d6c4b3aa77d8bc84cc443b981e01Mukund Sivaraman here. If the directive has the same name as one from the NCSA HTTPd
e27a69f8bd9538e08f775265167ba6cc5f47c587Bob Halley server, any inconsistencies in behaviour between the two should also
e27a69f8bd9538e08f775265167ba6cc5f47c587Bob Halley be mentioned. Otherwise, this attribute should say "<EM>No
e27a69f8bd9538e08f775265167ba6cc5f47c587Bob Halley compatibility issues.</EM>"
e27a69f8bd9538e08f775265167ba6cc5f47c587Bob Halley<!--#include virtual="footer.html" -->