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