directive-dict.html revision cb42d9a6faa272087b328ff2059e83ce1b834d56
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <TITLE>Definitions of terms used to describe Apache directives
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
530eba85dbd41b8a0fa5255d3648d1440199a661slive BGCOLOR="#FFFFFF"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive TEXT="#000000"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive LINK="#0000FF"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive VLINK="#000080"
003f0c9fda6664daf5092a0e42f65ede20098153slive ALINK="#FF0000"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<!--#include virtual="header.html" -->
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <H1 ALIGN="CENTER">Terms Used to Describe Apache Directives</H1>
18b4b0fd6056093002ddef488636bf5ebe415ef0erikabele Each Apache configuration directive is described using a common format
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive that looks like this:
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive HREF="#Syntax"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive ><STRONG>Syntax:</STRONG></A> <EM>directive-name</EM> <EM>some args</EM>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive HREF="#Default"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive HREF="#Context"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive HREF="#Override"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive HREF="#Status"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive HREF="#Module"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive HREF="#Compatibility"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive ><STRONG>Compatibility:</STRONG></A> <EM>compatibility notes</EM>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive HREF="#Deprecated"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Each of the directive's attributes, complete with possible values
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive where possible, are described in this document.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive This indicates the format of the directive as it would appear in a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive configuration file. This syntax is extremely directive-specific,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive and is described in detail in the directive's definition.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Generally, the directive name is followed by a series of one or
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive more space-separated arguments. If an argument contains a space,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the argument must be enclosed in double quotes. Optional arguments
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive are enclosed in square brackets. Where an argument can take on more
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive than one possible value, the possible values are separated by
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive vertical bars "|". Literal text is presented in the default font,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive while argument-types for which substitution is necessary are
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <em>emphasized</em>. Directives which can take a variable number of
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive arguments will end in "..." indicating that the last argument is
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Directives use a great number of different argument types.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive A few common ones are defined below.</p>
003f0c9fda6664daf5092a0e42f65ede20098153slive<dd>A complete Uniform Resource Locator including a scheme, hostname,
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveand optional pathname as in
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<code>http://www.example.com/path/to/file.html</code></dd>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<dd>The part of a <em>url</em> which follows the scheme and hostname
003f0c9fda6664daf5092a0e42f65ede20098153sliveas in <code>/path/to/file.html</code>. The <em>url-path</em>
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliverepresents a web-view of a resource, as opposed to a file-system
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<dd>The path to a file in the local file-system beginning with the
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveroot directory as in
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<code>/usr/local/apache/htdocs/path/to/file.html</code>. Unless
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveotherwise specified, a <em>file-path</em> which does not begin with a
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveslash will be treated as relative to the <a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<dd>The path to a directory in the local file-system beginning with
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivethe root directory as in
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<dd>The name of a file with no accompanying path information as in
003f0c9fda6664daf5092a0e42f65ede20098153slive<dd>A <a href="/misc/FAQ.html#regex">regular expression</a>, which
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveis a way of describing a pattern to match in text. The directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivedefinition will specify what the <em>regex</em> is matching
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveagainst.</dd>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<dd>In general, this is the part of the <em>filename</em> which
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivefollows the last dot. However, Apache recognizes multiple filename
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveextensions, so if a <em>filename</em> contains more than one dot, each
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivedot-separated part of the filename following the first dot is an
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<code>file.html.en</code> contains two extensions: <code>.html</code>
80c4526970a11f37c0f8e3b82afdf03902dac3f3sliveand <code>.en</code>. For Apache directives, you may specify
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<em>extension</em>s with or without the leading dot. In addition,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<dd>A method of describing the format of a file which consists of a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivemajor format type and a minor format type, separated by a slash
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<dd>The name of an <a href="/env.html">environment variable</a>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivedefined in the Apache configuration process. Note this is not
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivenecessarily the same as an operating system environment variable. See
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivethe <a href="/env.html">environment variable documentation</a> for
80c4526970a11f37c0f8e3b82afdf03902dac3f3slivemore details.</dd>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive If the directive has a default value (<EM>i.e.</EM>, if you omit it
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive from your configuration entirely, the Apache Web server will behave as
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive though you set it to a particular value), it is described here. If
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive there is no default value, this section should say
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive "<EM>None</EM>". Note that the default listed here is not
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive necessarily the same as the value the directive takes in the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive default httpd.conf distributed with the server.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive This indicates where in the server's configuration files the directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive is legal. It's a comma-separated list of one or more of the following
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <DD>This means that the directive may be used in the server
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive configuration files (<EM>e.g.</EM>, <SAMP>httpd.conf</SAMP>,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <SAMP>srm.conf</SAMP>, and <SAMP>access.conf</SAMP>), but
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <STRONG>not</STRONG> within any <SAMP><VirtualHost></SAMP> or
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <Directory> containers. It is not allowed in
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <DD>This context means that the directive may appear inside
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <SAMP><VirtualHost></SAMP> containers in the server
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive configuration files.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <DD>A directive marked as being valid in this context may be used
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <SAMP><Location></SAMP>, and <SAMP><Files></SAMP>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive containers in the server configuration files, subject to the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive restrictions outlined in <A HREF="/sections.html">How Directory,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Location and Files sections work</A>.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <DD>If a directive is valid in this context, it means that it can
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive appear inside <EM>per</EM>-directory <SAMP>.htaccess</SAMP> files.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive It may not be processed, though depending upon the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive HREF="#Override"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive >overrides</A>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive currently active.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive The directive is <EM>only</EM> allowed within the designated context;
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive if you try to use it elsewhere, you'll get a configuration error that
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive will either prevent the server from handling requests in that context
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive correctly, or will keep the server from operating at all --
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive The valid locations for the directive are actually the result of a
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Boolean OR of all of the listed contexts. In other words, a directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive that is marked as being valid in "<SAMP>server config,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive .htaccess</SAMP>" can be used in the <SAMP>httpd.conf</SAMP> file
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive and in <SAMP>.htaccess</SAMP> files, but not within any
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <Directory> or <VirtualHost> containers.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive This directive attribute indicates which configuration override must
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive be active in order for the directive to be processed when it appears
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive HREF="#Context"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive >context</A>
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive doesn't permit it to appear in <SAMP>.htaccess</SAMP> files, this
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive attribute should say "<EM>Not applicable</EM>".
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive Overrides are activated by the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive HREF="core.html#allowoverride"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directive, and apply to a particular scope (such as a directory) and
530eba85dbd41b8a0fa5255d3648d1440199a661slive all descendants, unless further modified by other
530eba85dbd41b8a0fa5255d3648d1440199a661slive <SAMP>AllowOverride</SAMP> directives at lower levels. The
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive documentation for that directive also lists the possible override
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive names available.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive This indicates how tightly bound into the Apache Web server the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directive is; in other words, you may need to recompile the server
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive with an enhanced set of modules in order to gain access to the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directive and its functionality. Possible values for this attribute
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <DD>If a directive is listed as having "Core" status, that
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholes means it is part of the innermost portions of the Apache Web server,
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholes and is always available.
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholes <DD>A directive labeled as having "MPM" status is
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholes provided by a <a href="/mpm.html">Multi-Processing Module</a>.
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholes This type of directive will be available if and only if you are
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholes using one of the MPMs lised on the <a href="#Module">Module</a>
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholes line of the directive definition.
4c7bdb15764021d39e486adb7bc2166d3f683773bnicholes <DD>A directive labeled as having "Base" status is
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive supported by one of the standard Apache modules which is compiled
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive into the server by default, and is therefore normally available
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive unless you've taken steps to remove the module from your configuration.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <DD>A directive with "Extension" status is provided by one
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive of the modules included with the Apache server kit, but the module
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive isn't normally compiled into the server. To enable the directive
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive and its functionality, you will need to change the server build
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive configuration files and re-compile Apache.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive <DD>"Experimental" status indicates that the directive is
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive available as part of the Apache kit, but you're on your own if you
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive try to use it. The directive is being documented for completeness,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive and is not necessarily supported. The module which provides the
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive directive may or may not be compiled in by default; check the top of
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the page which describes the directive and its module to see if it
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive remarks on the availability.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive This quite simply lists the name of the source module which defines
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the directive.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive If the directive wasn't part of the original Apache version 1
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive distribution, the version in which it was introduced should be listed
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive here. If the directive has the same name as one from the NCSA HTTPd
003f0c9fda6664daf5092a0e42f65ede20098153slive server, any inconsistencies in behaviour between the two should also
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive be mentioned. Otherwise, this attribute should say "<EM>No
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive compatibility issues.</EM>"
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive If this directive is eliminated since the Apache version 1 distribution,
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive the directive or option that replaces the behavior should be cited here.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive In general, directives, features, and options are only deprecated to
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive minimize debugging of conflicting features, or if the feature can only
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive continue to be supported in an alternate manner.
80c4526970a11f37c0f8e3b82afdf03902dac3f3slive<!--#include virtual="footer.html" -->