directive-dict.xml revision db479b48bd4d75423ed4a45e15b75089d1a8ad72
1d363c6830b1389bb442b3110e1b803f2a69c979slive<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>
5f5d1b4cc970b7f06ff8ef6526128e9a27303d88nd<!-- $LastChangedRevision$ -->
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding Licensed to the Apache Software Foundation (ASF) under one or more
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding contributor license agreements. See the NOTICE file distributed with
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding this work for additional information regarding copyright ownership.
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding The ASF licenses this file to You under the Apache License, Version 2.0
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding (the "License"); you may not use this file except in compliance with
db479b48bd4d75423ed4a45e15b75089d1a8ad72fielding the License. You may obtain a copy of the License at
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd Unless required by applicable law or agreed to in writing, software
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd distributed under the License is distributed on an "AS IS" BASIS,
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd See the License for the specific language governing permissions and
d5d794fc2f4cc9ca6d6da17cfa2cdcd8d244bacdnd limitations under the License.
1d363c6830b1389bb442b3110e1b803f2a69c979slive <p>This document describes the terms that are used to describe
1d363c6830b1389bb442b3110e1b803f2a69c979slive<seealso><a href="/configuring.html">Configuration files</a></seealso>
d14417cf5a8f5ea4c3e8fea35ec3e50fba770d17erikabele<section id="Description"><title>Description</title>
1d363c6830b1389bb442b3110e1b803f2a69c979slive<p>A brief description of the purpose of the directive.</p>
1d363c6830b1389bb442b3110e1b803f2a69c979slive <p>This indicates the format of the directive as it would
1d363c6830b1389bb442b3110e1b803f2a69c979slive appear in a configuration file. This syntax is extremely
1d363c6830b1389bb442b3110e1b803f2a69c979slive directive-specific, and is described in detail in the
1d363c6830b1389bb442b3110e1b803f2a69c979slive directive's definition. Generally, the directive name is
1d363c6830b1389bb442b3110e1b803f2a69c979slive followed by a series of one or more space-separated arguments.
1d363c6830b1389bb442b3110e1b803f2a69c979slive If an argument contains a space, the argument must be enclosed
1d363c6830b1389bb442b3110e1b803f2a69c979slive in double quotes. Optional arguments are enclosed in square
1d363c6830b1389bb442b3110e1b803f2a69c979slive brackets. Where an argument can take on more than one possible
1d363c6830b1389bb442b3110e1b803f2a69c979slive value, the possible values are separated by vertical bars "|".
1d363c6830b1389bb442b3110e1b803f2a69c979slive Literal text is presented in the default font, while
1d363c6830b1389bb442b3110e1b803f2a69c979slive argument-types for which substitution is necessary are
1d363c6830b1389bb442b3110e1b803f2a69c979slive <em>emphasized</em>. Directives which can take a variable
1d363c6830b1389bb442b3110e1b803f2a69c979slive number of arguments will end in "..." indicating that the last
1d363c6830b1389bb442b3110e1b803f2a69c979slive argument is repeated.</p>
1d363c6830b1389bb442b3110e1b803f2a69c979slive <p>Directives use a great number of different argument types. A
1d363c6830b1389bb442b3110e1b803f2a69c979slive few common ones are defined below.</p>
1d363c6830b1389bb442b3110e1b803f2a69c979slive <dd>A complete Uniform Resource Locator including a scheme,
1d363c6830b1389bb442b3110e1b803f2a69c979slive hostname, and optional pathname as in
1d363c6830b1389bb442b3110e1b803f2a69c979slive <code>http://www.example.com/path/to/file.html</code></dd>
1d363c6830b1389bb442b3110e1b803f2a69c979slive <dd>The part of a <em>url</em> which follows the scheme and
1d363c6830b1389bb442b3110e1b803f2a69c979slive <em>url-path</em> represents a web-view of a resource, as
1d363c6830b1389bb442b3110e1b803f2a69c979slive opposed to a file-system view.</dd>
1d363c6830b1389bb442b3110e1b803f2a69c979slive <dd>The path to a file in the local file-system beginning
1d363c6830b1389bb442b3110e1b803f2a69c979slive with the root directory as in
1d363c6830b1389bb442b3110e1b803f2a69c979slive <code>/usr/local/apache/htdocs/path/to/file.html</code>.
1d363c6830b1389bb442b3110e1b803f2a69c979slive Unless otherwise specified, a <em>file-path</em> which does
1d363c6830b1389bb442b3110e1b803f2a69c979slive not begin with a slash will be treated as relative to the <a
1d363c6830b1389bb442b3110e1b803f2a69c979slive <dd>The path to a directory in the local file-system
1d363c6830b1389bb442b3110e1b803f2a69c979slive beginning with the root directory as in
1d363c6830b1389bb442b3110e1b803f2a69c979slive <dd>The name of a file with no accompanying path information
030108b1816bcda3d925df65357feabdce83bc94slive expression</glossary>. The directive definition will specify what the
1d363c6830b1389bb442b3110e1b803f2a69c979slive <dd>In general, this is the part of the <em>filename</em>
1d363c6830b1389bb442b3110e1b803f2a69c979slive which follows the last dot. However, Apache recognizes
1d363c6830b1389bb442b3110e1b803f2a69c979slive multiple filename extensions, so if a <em>filename</em>
1d363c6830b1389bb442b3110e1b803f2a69c979slive contains more than one dot, each dot-separated part of the
1d363c6830b1389bb442b3110e1b803f2a69c979slive filename following the first dot is an <em>extension</em>.
1d363c6830b1389bb442b3110e1b803f2a69c979slive For example, the <em>filename</em> <code>file.html.en</code>
1d363c6830b1389bb442b3110e1b803f2a69c979slive <code>.en</code>. For Apache directives, you may specify
1d363c6830b1389bb442b3110e1b803f2a69c979slive <em>extension</em>s with or without the leading dot. In
1d363c6830b1389bb442b3110e1b803f2a69c979slive addition, <em>extension</em>s are not case sensitive.</dd>
1d363c6830b1389bb442b3110e1b803f2a69c979slive <dd>A method of describing the format of a file which
1d363c6830b1389bb442b3110e1b803f2a69c979slive consists of a major format type and a minor format type,
1d363c6830b1389bb442b3110e1b803f2a69c979slive separated by a slash as in <code>text/html</code>.</dd>
1d363c6830b1389bb442b3110e1b803f2a69c979slive variable</a> defined in the Apache configuration process.
1d363c6830b1389bb442b3110e1b803f2a69c979slive Note this is not necessarily the same as an operating system
1d363c6830b1389bb442b3110e1b803f2a69c979slive environment variable. See the <a
1d363c6830b1389bb442b3110e1b803f2a69c979slive href="/env.html">environment variable documentation</a> for
1d363c6830b1389bb442b3110e1b803f2a69c979slive more details.</dd>
1d363c6830b1389bb442b3110e1b803f2a69c979slive <p>If the directive has a default value (<em>i.e.</em>, if you
1d363c6830b1389bb442b3110e1b803f2a69c979slive omit it from your configuration entirely, the Apache Web server
1d363c6830b1389bb442b3110e1b803f2a69c979slive will behave as though you set it to a particular value), it is
1d363c6830b1389bb442b3110e1b803f2a69c979slive described here. If there is no default value, this section
1d363c6830b1389bb442b3110e1b803f2a69c979slive should say "<em>None</em>". Note that the default listed here
1d363c6830b1389bb442b3110e1b803f2a69c979slive is not necessarily the same as the value the directive takes in
1d363c6830b1389bb442b3110e1b803f2a69c979slive the default httpd.conf distributed with the server.</p>
1d363c6830b1389bb442b3110e1b803f2a69c979slive <p>This indicates where in the server's configuration files the
1d363c6830b1389bb442b3110e1b803f2a69c979slive directive is legal. It's a comma-separated list of one or more
1d363c6830b1389bb442b3110e1b803f2a69c979slive of the following values:</p>
1d363c6830b1389bb442b3110e1b803f2a69c979slive <dd>This means that the directive may be used in the server
1d363c6830b1389bb442b3110e1b803f2a69c979slive configuration files (<em>e.g.</em>, <code>httpd.conf</code>), but
1d363c6830b1389bb442b3110e1b803f2a69c979slive <directive module="core" type="section">VirtualHost</directive>
1d363c6830b1389bb442b3110e1b803f2a69c979slive or <directive module="core" type="section">Directory</directive>
1d363c6830b1389bb442b3110e1b803f2a69c979slive containers. It is not allowed in <code>.htaccess</code> files
1d363c6830b1389bb442b3110e1b803f2a69c979slive at all.</dd>
1d363c6830b1389bb442b3110e1b803f2a69c979slive <dd>This context means that the directive may appear inside
1d363c6830b1389bb442b3110e1b803f2a69c979slive <directive module="core" type="section">VirtualHost</directive>
1d363c6830b1389bb442b3110e1b803f2a69c979slive containers in the server
1d363c6830b1389bb442b3110e1b803f2a69c979slive configuration files.</dd>
1d363c6830b1389bb442b3110e1b803f2a69c979slive <dd>A directive marked as being valid in this context may be
c3a3c963ad3f5b4d816b66117406d4e793049119slive type="section">Directory</directive>, <directive type="section"
c3a3c963ad3f5b4d816b66117406d4e793049119slive module="core">Location</directive>, <directive module="core"
c3a3c963ad3f5b4d816b66117406d4e793049119slive module="mod_proxy" type="section">Proxy</directive> containers
c3a3c963ad3f5b4d816b66117406d4e793049119slive in the server configuration files, subject to the restrictions
1d363c6830b1389bb442b3110e1b803f2a69c979slive <dd>If a directive is valid in this context, it means that it
1d363c6830b1389bb442b3110e1b803f2a69c979slive <code>.htaccess</code> files. It may not be processed, though
1d363c6830b1389bb442b3110e1b803f2a69c979slive <p>The directive is <em>only</em> allowed within the designated
1d363c6830b1389bb442b3110e1b803f2a69c979slive context; if you try to use it elsewhere, you'll get a
1d363c6830b1389bb442b3110e1b803f2a69c979slive configuration error that will either prevent the server from
1d363c6830b1389bb442b3110e1b803f2a69c979slive handling requests in that context correctly, or will keep the
1d363c6830b1389bb442b3110e1b803f2a69c979slive server from operating at all -- <em>i.e.</em>, the server won't
1d363c6830b1389bb442b3110e1b803f2a69c979slive even start.</p>
1d363c6830b1389bb442b3110e1b803f2a69c979slive <p>The valid locations for the directive are actually the
1d363c6830b1389bb442b3110e1b803f2a69c979slive result of a Boolean OR of all of the listed contexts. In other
1d363c6830b1389bb442b3110e1b803f2a69c979slive words, a directive that is marked as being valid in
1d363c6830b1389bb442b3110e1b803f2a69c979slive "<code>server config, .htaccess</code>" can be used in the
1d363c6830b1389bb442b3110e1b803f2a69c979slive <code>httpd.conf</code> file and in <code>.htaccess</code>
1d363c6830b1389bb442b3110e1b803f2a69c979slive <directive module="core" type="section">VirtualHost</directive>
1d363c6830b1389bb442b3110e1b803f2a69c979slive containers.</p>
1d363c6830b1389bb442b3110e1b803f2a69c979slive <p>This directive attribute indicates which configuration
1d363c6830b1389bb442b3110e1b803f2a69c979slive override must be active in order for the directive to be
1d363c6830b1389bb442b3110e1b803f2a69c979slive processed when it appears in a <code>.htaccess</code> file. If
1d363c6830b1389bb442b3110e1b803f2a69c979slive doesn't permit it to appear in <code>.htaccess</code> files,
1d363c6830b1389bb442b3110e1b803f2a69c979slive then no context will be listed.</p>
1d363c6830b1389bb442b3110e1b803f2a69c979slive module="core">AllowOverride</directive> directive, and apply
1d363c6830b1389bb442b3110e1b803f2a69c979slive to a particular scope (such as a directory) and all
1d363c6830b1389bb442b3110e1b803f2a69c979slive descendants, unless further modified by other
1d363c6830b1389bb442b3110e1b803f2a69c979slive <directive module="core">AllowOverride</directive> directives at
1d363c6830b1389bb442b3110e1b803f2a69c979slive lower levels. The documentation for that directive also lists the
1d363c6830b1389bb442b3110e1b803f2a69c979slive possible override names available.</p>
1d363c6830b1389bb442b3110e1b803f2a69c979slive <p>This indicates how tightly bound into the Apache Web server
1d363c6830b1389bb442b3110e1b803f2a69c979slive the directive is; in other words, you may need to recompile the
1d363c6830b1389bb442b3110e1b803f2a69c979slive server with an enhanced set of modules in order to gain access
1d363c6830b1389bb442b3110e1b803f2a69c979slive to the directive and its functionality. Possible values for
1d363c6830b1389bb442b3110e1b803f2a69c979slive this attribute are:</p>
1d363c6830b1389bb442b3110e1b803f2a69c979slive <dd>If a directive is listed as having "Core" status, that
1d363c6830b1389bb442b3110e1b803f2a69c979slive means it is part of the innermost portions of the Apache Web
1d363c6830b1389bb442b3110e1b803f2a69c979slive server, and is always available.</dd>
1d363c6830b1389bb442b3110e1b803f2a69c979slive <dd>A directive labeled as having "MPM" status is provided by
1d363c6830b1389bb442b3110e1b803f2a69c979slive a <a href="/mpm.html">Multi-Processing Module</a>. This
1d363c6830b1389bb442b3110e1b803f2a69c979slive type of directive will be available if and only if you are
1d363c6830b1389bb442b3110e1b803f2a69c979slive using one of the MPMs listed on the <a
1d363c6830b1389bb442b3110e1b803f2a69c979slive definition.</dd>
1d363c6830b1389bb442b3110e1b803f2a69c979slive <dd>A directive labeled as having "Base" status is supported
1d363c6830b1389bb442b3110e1b803f2a69c979slive by one of the standard Apache modules which is compiled into
1d363c6830b1389bb442b3110e1b803f2a69c979slive the server by default, and is therefore normally available
1d363c6830b1389bb442b3110e1b803f2a69c979slive unless you've taken steps to remove the module from your
1d363c6830b1389bb442b3110e1b803f2a69c979slive configuration.</dd>
1d363c6830b1389bb442b3110e1b803f2a69c979slive <dd>A directive with "Extension" status is provided by one of
1d363c6830b1389bb442b3110e1b803f2a69c979slive the modules included with the Apache server kit, but the
1d363c6830b1389bb442b3110e1b803f2a69c979slive module isn't normally compiled into the server. To enable the
1d363c6830b1389bb442b3110e1b803f2a69c979slive directive and its functionality, you will need to change the
1d363c6830b1389bb442b3110e1b803f2a69c979slive server build configuration files and re-compile Apache.</dd>
1d363c6830b1389bb442b3110e1b803f2a69c979slive <dd>"Experimental" status indicates that the directive is
1d363c6830b1389bb442b3110e1b803f2a69c979slive available as part of the Apache kit, but you're on your own
1d363c6830b1389bb442b3110e1b803f2a69c979slive if you try to use it. The directive is being documented for
1d363c6830b1389bb442b3110e1b803f2a69c979slive completeness, and is not necessarily supported. The module
1d363c6830b1389bb442b3110e1b803f2a69c979slive which provides the directive may or may not be compiled in by
1d363c6830b1389bb442b3110e1b803f2a69c979slive default; check the top of the page which describes the
1d363c6830b1389bb442b3110e1b803f2a69c979slive directive and its module to see if it remarks on the
1d363c6830b1389bb442b3110e1b803f2a69c979slive availability.</dd>
1d363c6830b1389bb442b3110e1b803f2a69c979slive <p>This quite simply lists the name of the source module which
1d363c6830b1389bb442b3110e1b803f2a69c979slive defines the directive.</p>
1d363c6830b1389bb442b3110e1b803f2a69c979slive<section id="Compatibility"><title>Compatibility</title>
1d363c6830b1389bb442b3110e1b803f2a69c979slive <p>If the directive wasn't part of the original Apache version
1d363c6830b1389bb442b3110e1b803f2a69c979slive 2 distribution, the version in which it was introduced should
1d363c6830b1389bb442b3110e1b803f2a69c979slive be listed here. In addition, if the directive is available
1d363c6830b1389bb442b3110e1b803f2a69c979slive only on certain platforms, it will be noted here.</p>
1d363c6830b1389bb442b3110e1b803f2a69c979slive</manualpage>