directive-dict.html revision b1f2458b99bd740bf64fd601b884af1c7ac4e445
1506e77ef38e9fed0fc0b180ee505b6a02ca98f3slive<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd <TITLE>Definitions of terms used to describe Apache directives
1506e77ef38e9fed0fc0b180ee505b6a02ca98f3slive<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
1506e77ef38e9fed0fc0b180ee505b6a02ca98f3slive BGCOLOR="#FFFFFF"
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd TEXT="#000000"
8a75fe091731dcfd6581bd8a2423ba654b4e8e17nd LINK="#0000FF"
1506e77ef38e9fed0fc0b180ee505b6a02ca98f3slive VLINK="#000080"
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd ALINK="#FF0000"
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd<!--#include virtual="header.html" -->
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd <H1 ALIGN="CENTER">Terms Used to Describe Apache Directives</H1>
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd Each Apache configuration directive is described using a common format
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd that looks like this:
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd HREF="#Syntax"
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd REL="Help"
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd ><STRONG>Syntax:</STRONG></A> <EM>directive-name</EM> <EM>some args</EM>
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd HREF="#Default"
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd REL="Help"
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd HREF="#Context"
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd REL="Help"
aedd0bf93c729eb723b1eeffccf46bf0117ff0ederikabele HREF="#Override"
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd REL="Help"
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd HREF="#Status"
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd REL="Help"
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd HREF="#Module"
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd REL="Help"
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd HREF="#Compatibility"
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd REL="Help"
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd ><STRONG>Compatibility:</STRONG></A> <EM>compatibility notes</EM>
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd Each of the directive's attributes, complete with possible values
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd where possible, are described in this document.
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd This indicates the format of the directive as it would appear in a
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd configuration file. This syntax is extremely directive-specific, so
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd refer to the text of the directive's description for details.
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd If the directive has a default value (<EM>i.e.</EM>, if you omit it
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd from your configuration entirely, the Apache Web server will behave as
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd though you set it to a particular value), it is described here. If
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd there is no default value, this section should say
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd This indicates where in the server's configuration files the directive
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd is legal. It's a comma-separated list of one or more of the following
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd <DD>This means that the directive may be used in the server
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd configuration files (<EM>e.g.</EM>, <SAMP>httpd.conf</SAMP>,
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd <SAMP>srm.conf</SAMP>, and <SAMP>access.conf</SAMP>), but
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd <STRONG>not</STRONG> within any <SAMP><VirtualHost></SAMP> or
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd <Directory> containers. It is not allowed in
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd <DD>This context means that the directive may appear inside
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd <SAMP><VirtualHost></SAMP> containers in the server
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd configuration files.
8a72c24379e10c3f3d0dfe352bf15e45ee65c179nd <DD>A directive marked as being valid in this context may be used
8a72c24379e10c3f3d0dfe352bf15e45ee65c179nd <SAMP><Location></SAMP>, and <SAMP><Files></SAMP>
1f53e295ebd19aed1767d12da7abfab9936c148cjerenkrantz containers in the server configuration files, subject to the
1f53e295ebd19aed1767d12da7abfab9936c148cjerenkrantz restrictions outlined in <A HREF="/sections.html">How Directory,
1f53e295ebd19aed1767d12da7abfab9936c148cjerenkrantz Location and Files sections work</A>.
35ffb30f57f777dbf3f17c5a5ddf706559942c16nd <DD>If a directive is valid in this context, it means that it can
8a72c24379e10c3f3d0dfe352bf15e45ee65c179nd appear inside <EM>per</EM>-directory <SAMP>.htaccess</SAMP> files.
8a72c24379e10c3f3d0dfe352bf15e45ee65c179nd It may not be processed, though depending upon the
8a72c24379e10c3f3d0dfe352bf15e45ee65c179nd HREF="#Override"
8a72c24379e10c3f3d0dfe352bf15e45ee65c179nd REL="Help"
8a72c24379e10c3f3d0dfe352bf15e45ee65c179nd >overrides</A>
8a72c24379e10c3f3d0dfe352bf15e45ee65c179nd currently active.
8a72c24379e10c3f3d0dfe352bf15e45ee65c179nd The directive is <EM>only</EM> allowed within the designated context;
8a72c24379e10c3f3d0dfe352bf15e45ee65c179nd if you try to use it elsewhere, you'll get a configuration error that
8a72c24379e10c3f3d0dfe352bf15e45ee65c179nd will either prevent the server from handling requests in that context
8a72c24379e10c3f3d0dfe352bf15e45ee65c179nd correctly, or will keep the server from operating at all --
8a72c24379e10c3f3d0dfe352bf15e45ee65c179nd The valid locations for the directive are actually the result of a
8a72c24379e10c3f3d0dfe352bf15e45ee65c179nd Boolean OR of all of the listed contexts. In other words, a directive
8a72c24379e10c3f3d0dfe352bf15e45ee65c179nd that is marked as being valid in "<SAMP>server config,
8a72c24379e10c3f3d0dfe352bf15e45ee65c179nd .htaccess</SAMP>" can be used in the <SAMP>httpd.conf</SAMP> file
8a72c24379e10c3f3d0dfe352bf15e45ee65c179nd <Directory> or <VirtualHost> containers.
8a72c24379e10c3f3d0dfe352bf15e45ee65c179nd This directive attribute indicates which configuration override must
8a72c24379e10c3f3d0dfe352bf15e45ee65c179nd be active in order for the directive to be processed when it appears
8a72c24379e10c3f3d0dfe352bf15e45ee65c179nd HREF="#Context"
8a72c24379e10c3f3d0dfe352bf15e45ee65c179nd REL="Help"
8a72c24379e10c3f3d0dfe352bf15e45ee65c179nd >context</A>
8a72c24379e10c3f3d0dfe352bf15e45ee65c179nd doesn't permit it to appear in <SAMP>.htaccess</SAMP> files, this
8a72c24379e10c3f3d0dfe352bf15e45ee65c179nd attribute should say "<EM>Not applicable</EM>".
8a72c24379e10c3f3d0dfe352bf15e45ee65c179nd Overrides are activated by the
8a72c24379e10c3f3d0dfe352bf15e45ee65c179nd HREF="core.html#allowoverride"
8a72c24379e10c3f3d0dfe352bf15e45ee65c179nd REL="Help"
8a72c24379e10c3f3d0dfe352bf15e45ee65c179nd directive, and apply to a particular scope (such as a directory) and
8a72c24379e10c3f3d0dfe352bf15e45ee65c179nd all descendants, unless further modified by other
8a72c24379e10c3f3d0dfe352bf15e45ee65c179nd <SAMP>AllowOverride</SAMP> directives at lower levels. The
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd documentation for that directive also lists the possible override
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd names available.
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd This indicates how tightly bound into the Apache Web server the
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd directive is; in other words, you may need to recompile the server
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd with an enhanced set of modules in order to gain access to the
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd directive and its functionality. Possible values for this attribute
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd <DD>If a directive is listed as having "Core" status, that
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd means it is part of the innermost portions of the Apache Web server,
02b39e6d8d0bf5fc0014bb1b4826b05db879ddafnd and is always available.
<!--#include virtual="footer.html" -->