directive-dict.html revision 1997e02bed99bd0c081962ade257a0ea12ebe15b
a23fd118e437af0a7877dd313db8fdaa3537c675yl <TITLE>Definitions of terms used to describe Apache directives
a23fd118e437af0a7877dd313db8fdaa3537c675yl<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
a23fd118e437af0a7877dd313db8fdaa3537c675yl BGCOLOR="#FFFFFF"
a23fd118e437af0a7877dd313db8fdaa3537c675yl TEXT="#000000"
a23fd118e437af0a7877dd313db8fdaa3537c675yl LINK="#0000FF"
a23fd118e437af0a7877dd313db8fdaa3537c675yl VLINK="#000080"
a23fd118e437af0a7877dd313db8fdaa3537c675yl ALINK="#FF0000"
a23fd118e437af0a7877dd313db8fdaa3537c675yl<!--#include virtual="header.html" -->
a23fd118e437af0a7877dd313db8fdaa3537c675yl <H1 ALIGN="CENTER">Terms Used to Describe Apache Directives</H1>
a23fd118e437af0a7877dd313db8fdaa3537c675yl Each Apache configuration directive is described using a common format
a23fd118e437af0a7877dd313db8fdaa3537c675yl that looks like this:
a23fd118e437af0a7877dd313db8fdaa3537c675yl HREF="#Syntax"
a23fd118e437af0a7877dd313db8fdaa3537c675yl REL="Help"
a23fd118e437af0a7877dd313db8fdaa3537c675yl ><STRONG>Syntax:</STRONG></A> <EM>directive-name</EM> <EM>some args</EM>
8347601bcb0a439f6e50fc36b4039a73d08700e1yl HREF="#Default"
a23fd118e437af0a7877dd313db8fdaa3537c675yl REL="Help"
a23fd118e437af0a7877dd313db8fdaa3537c675yl HREF="#Context"
a23fd118e437af0a7877dd313db8fdaa3537c675yl REL="Help"
a23fd118e437af0a7877dd313db8fdaa3537c675yl HREF="#Override"
8347601bcb0a439f6e50fc36b4039a73d08700e1yl REL="Help"
8347601bcb0a439f6e50fc36b4039a73d08700e1yl HREF="#Status"
a23fd118e437af0a7877dd313db8fdaa3537c675yl REL="Help"
a23fd118e437af0a7877dd313db8fdaa3537c675yl HREF="#Module"
a23fd118e437af0a7877dd313db8fdaa3537c675yl REL="Help"
a23fd118e437af0a7877dd313db8fdaa3537c675yl HREF="#Compatibility"
a23fd118e437af0a7877dd313db8fdaa3537c675yl REL="Help"
a23fd118e437af0a7877dd313db8fdaa3537c675yl ><STRONG>Compatibility:</STRONG></A> <EM>compatibility notes</EM>
a23fd118e437af0a7877dd313db8fdaa3537c675yl Each of the directive's attributes, complete with possible values
8347601bcb0a439f6e50fc36b4039a73d08700e1yl where possible, are described in this document.
a23fd118e437af0a7877dd313db8fdaa3537c675yl This indicates the format of the directive as it would appear in a
a23fd118e437af0a7877dd313db8fdaa3537c675yl configuration file. This syntax is extremely directive-specific,
a23fd118e437af0a7877dd313db8fdaa3537c675yl and is described in detail in the directive's definition.
a23fd118e437af0a7877dd313db8fdaa3537c675yl Generally, the directive name is followed by a series of one or
a23fd118e437af0a7877dd313db8fdaa3537c675yl more arguments. Optional arguments are enclosed in square brackets.
8347601bcb0a439f6e50fc36b4039a73d08700e1yl Where an argument can take on more than one possible value, possible
a23fd118e437af0a7877dd313db8fdaa3537c675yl values are separated by a vertical bar. Literal text is presented
a23fd118e437af0a7877dd313db8fdaa3537c675yl in the default font, while argument-types for which substitution
a23fd118e437af0a7877dd313db8fdaa3537c675yl is necessary are emphasized. Directives which can take a variable
8347601bcb0a439f6e50fc36b4039a73d08700e1yl number of arguments will end in "..." indicating that the last
a23fd118e437af0a7877dd313db8fdaa3537c675yl argument is repeated.
a23fd118e437af0a7877dd313db8fdaa3537c675yl If the directive has a default value (<EM>i.e.</EM>, if you omit it
a23fd118e437af0a7877dd313db8fdaa3537c675yl from your configuration entirely, the Apache Web server will behave as
8347601bcb0a439f6e50fc36b4039a73d08700e1yl though you set it to a particular value), it is described here. If
8347601bcb0a439f6e50fc36b4039a73d08700e1yl there is no default value, this section should say
a23fd118e437af0a7877dd313db8fdaa3537c675yl This indicates where in the server's configuration files the directive
8347601bcb0a439f6e50fc36b4039a73d08700e1yl is legal. It's a comma-separated list of one or more of the following
a23fd118e437af0a7877dd313db8fdaa3537c675yl <DD>This means that the directive may be used in the server
8347601bcb0a439f6e50fc36b4039a73d08700e1yl configuration files (<EM>e.g.</EM>, <SAMP>httpd.conf</SAMP>,
8347601bcb0a439f6e50fc36b4039a73d08700e1yl <SAMP>srm.conf</SAMP>, and <SAMP>access.conf</SAMP>), but
a23fd118e437af0a7877dd313db8fdaa3537c675yl <STRONG>not</STRONG> within any <SAMP><VirtualHost></SAMP> or
8347601bcb0a439f6e50fc36b4039a73d08700e1yl <Directory> containers. It is not allowed in
a23fd118e437af0a7877dd313db8fdaa3537c675yl <DD>This context means that the directive may appear inside
a23fd118e437af0a7877dd313db8fdaa3537c675yl <SAMP><VirtualHost></SAMP> containers in the server
a23fd118e437af0a7877dd313db8fdaa3537c675yl configuration files.
8347601bcb0a439f6e50fc36b4039a73d08700e1yl <DD>A directive marked as being valid in this context may be used
a23fd118e437af0a7877dd313db8fdaa3537c675yl <SAMP><Location></SAMP>, and <SAMP><Files></SAMP>
a23fd118e437af0a7877dd313db8fdaa3537c675yl containers in the server configuration files, subject to the
8347601bcb0a439f6e50fc36b4039a73d08700e1yl restrictions outlined in <A HREF="/sections.html">How Directory,
a23fd118e437af0a7877dd313db8fdaa3537c675yl Location and Files sections work</A>.
a23fd118e437af0a7877dd313db8fdaa3537c675yl <DD>If a directive is valid in this context, it means that it can
a23fd118e437af0a7877dd313db8fdaa3537c675yl appear inside <EM>per</EM>-directory <SAMP>.htaccess</SAMP> files.
8347601bcb0a439f6e50fc36b4039a73d08700e1yl It may not be processed, though depending upon the
a23fd118e437af0a7877dd313db8fdaa3537c675yl HREF="#Override"
a23fd118e437af0a7877dd313db8fdaa3537c675yl REL="Help"
8347601bcb0a439f6e50fc36b4039a73d08700e1yl >overrides</A>
a23fd118e437af0a7877dd313db8fdaa3537c675yl currently active.
8347601bcb0a439f6e50fc36b4039a73d08700e1yl The directive is <EM>only</EM> allowed within the designated context;
a23fd118e437af0a7877dd313db8fdaa3537c675yl if you try to use it elsewhere, you'll get a configuration error that
8347601bcb0a439f6e50fc36b4039a73d08700e1yl will either prevent the server from handling requests in that context
7eced415e5dd557aef2d78483b5a7785f0e13670xw correctly, or will keep the server from operating at all --
a23fd118e437af0a7877dd313db8fdaa3537c675yl The valid locations for the directive are actually the result of a
a23fd118e437af0a7877dd313db8fdaa3537c675yl Boolean OR of all of the listed contexts. In other words, a directive
a23fd118e437af0a7877dd313db8fdaa3537c675yl that is marked as being valid in "<SAMP>server config,
a23fd118e437af0a7877dd313db8fdaa3537c675yl .htaccess</SAMP>" can be used in the <SAMP>httpd.conf</SAMP> file
a23fd118e437af0a7877dd313db8fdaa3537c675yl <Directory> or <VirtualHost> containers.
a23fd118e437af0a7877dd313db8fdaa3537c675yl This directive attribute indicates which configuration override must
a23fd118e437af0a7877dd313db8fdaa3537c675yl be active in order for the directive to be processed when it appears
8347601bcb0a439f6e50fc36b4039a73d08700e1yl HREF="#Context"
8347601bcb0a439f6e50fc36b4039a73d08700e1yl REL="Help"
a23fd118e437af0a7877dd313db8fdaa3537c675yl >context</A>
a23fd118e437af0a7877dd313db8fdaa3537c675yl doesn't permit it to appear in <SAMP>.htaccess</SAMP> files, this
8347601bcb0a439f6e50fc36b4039a73d08700e1yl attribute should say "<EM>Not applicable</EM>".
a23fd118e437af0a7877dd313db8fdaa3537c675yl Overrides are activated by the
a23fd118e437af0a7877dd313db8fdaa3537c675yl HREF="core.html#allowoverride"
8347601bcb0a439f6e50fc36b4039a73d08700e1yl REL="Help"
a23fd118e437af0a7877dd313db8fdaa3537c675yl directive, and apply to a particular scope (such as a directory) and
a23fd118e437af0a7877dd313db8fdaa3537c675yl all descendants, unless further modified by other
8347601bcb0a439f6e50fc36b4039a73d08700e1yl <SAMP>AllowOverride</SAMP> directives at lower levels. The
8347601bcb0a439f6e50fc36b4039a73d08700e1yl documentation for that directive also lists the possible override
8347601bcb0a439f6e50fc36b4039a73d08700e1yl names available.
a23fd118e437af0a7877dd313db8fdaa3537c675yl This indicates how tightly bound into the Apache Web server the
8347601bcb0a439f6e50fc36b4039a73d08700e1yl directive is; in other words, you may need to recompile the server
a23fd118e437af0a7877dd313db8fdaa3537c675yl with an enhanced set of modules in order to gain access to the
a23fd118e437af0a7877dd313db8fdaa3537c675yl directive and its functionality. Possible values for this attribute
a23fd118e437af0a7877dd313db8fdaa3537c675yl <DD>If a directive is listed as having "Core" status, that
8347601bcb0a439f6e50fc36b4039a73d08700e1yl means it is part of the innermost portions of the Apache Web server,
a23fd118e437af0a7877dd313db8fdaa3537c675yl and is always available.
8347601bcb0a439f6e50fc36b4039a73d08700e1yl <DD>A directive labeled as having "MPM" status is
a23fd118e437af0a7877dd313db8fdaa3537c675yl provided by a <a href="/mpm.html">Multi-Processing Module</a>.
a23fd118e437af0a7877dd313db8fdaa3537c675yl This type of directive will be available if and only if you are
a23fd118e437af0a7877dd313db8fdaa3537c675yl using one of the MPMs lised on the <a href="#Module">Module</a>
8347601bcb0a439f6e50fc36b4039a73d08700e1yl line of the directive definition.
8347601bcb0a439f6e50fc36b4039a73d08700e1yl <DD>A directive labeled as having "Base" status is
8347601bcb0a439f6e50fc36b4039a73d08700e1yl supported by one of the standard Apache modules which is compiled
8347601bcb0a439f6e50fc36b4039a73d08700e1yl into the server by default, and is therefore normally available
8347601bcb0a439f6e50fc36b4039a73d08700e1yl unless you've taken steps to remove the module from your configuration.
a23fd118e437af0a7877dd313db8fdaa3537c675yl <DD>A directive with "Extension" status is provided by one
8347601bcb0a439f6e50fc36b4039a73d08700e1yl of the modules included with the Apache server kit, but the module
a23fd118e437af0a7877dd313db8fdaa3537c675yl isn't normally compiled into the server. To enable the directive
a23fd118e437af0a7877dd313db8fdaa3537c675yl and its functionality, you will need to change the server build
a23fd118e437af0a7877dd313db8fdaa3537c675yl configuration files and re-compile Apache.
8347601bcb0a439f6e50fc36b4039a73d08700e1yl <DD>"Experimental" status indicates that the directive is
8347601bcb0a439f6e50fc36b4039a73d08700e1yl available as part of the Apache kit, but you're on your own if you
a23fd118e437af0a7877dd313db8fdaa3537c675yl try to use it. The directive is being documented for completeness,
a23fd118e437af0a7877dd313db8fdaa3537c675yl and is not necessarily supported. The module which provides the
8347601bcb0a439f6e50fc36b4039a73d08700e1yl directive may or may not be compiled in by default; check the top of
8347601bcb0a439f6e50fc36b4039a73d08700e1yl the page which describes the directive and its module to see if it
a23fd118e437af0a7877dd313db8fdaa3537c675yl remarks on the availability.
a23fd118e437af0a7877dd313db8fdaa3537c675yl This quite simply lists the name of the source module which defines
a23fd118e437af0a7877dd313db8fdaa3537c675yl the directive.
7eced415e5dd557aef2d78483b5a7785f0e13670xw If the directive wasn't part of the original Apache version 1
7eced415e5dd557aef2d78483b5a7785f0e13670xw distribution, the version in which it was introduced should be listed
7eced415e5dd557aef2d78483b5a7785f0e13670xw here. If the directive has the same name as one from the NCSA HTTPd
a23fd118e437af0a7877dd313db8fdaa3537c675yl server, any inconsistencies in behaviour between the two should also
a23fd118e437af0a7877dd313db8fdaa3537c675yl be mentioned. Otherwise, this attribute should say "<EM>No
a23fd118e437af0a7877dd313db8fdaa3537c675yl compatibility issues.</EM>"
a23fd118e437af0a7877dd313db8fdaa3537c675yl<!--#include virtual="footer.html" -->