1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
4 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
5 This file is generated from xml source: DO NOT EDIT
6 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
8 <title>Terms Used to Describe Directives - Apache HTTP Server</title>
9 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
10 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
11 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
12 <script src="../style/scripts/prettify.js" type="text/javascript">
15 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
16 <body id="manual-page"><div id="page-header">
17 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
18 <p class="apache">Apache HTTP Server Version 2.5</p>
19 <img alt="" src="../images/feather.gif" /></div>
20 <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
22 <a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.5</a></div><div id="page-content"><div id="preamble"><h1>Terms Used to Describe Directives</h1>
24 <p><span>Available Languages: </span><a href="../en/mod/directive-dict.html" title="English"> en </a> |
25 <a href="../ja/mod/directive-dict.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
26 <a href="../ko/mod/directive-dict.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> |
27 <a href="../tr/mod/directive-dict.html" hreflang="tr" rel="alternate" title="Türkçe"> tr </a></p>
30 <p>This document describes the terms that are used to describe
31 each Apache <a href="directives.html">configuration
34 <div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#Description">Description</a></li>
35 <li><img alt="" src="../images/down.gif" /> <a href="#Syntax">Syntax</a></li>
36 <li><img alt="" src="../images/down.gif" /> <a href="#Default">Default</a></li>
37 <li><img alt="" src="../images/down.gif" /> <a href="#Context">Context</a></li>
38 <li><img alt="" src="../images/down.gif" /> <a href="#Override">Override</a></li>
39 <li><img alt="" src="../images/down.gif" /> <a href="#Status">Status</a></li>
40 <li><img alt="" src="../images/down.gif" /> <a href="#Module">Module</a></li>
41 <li><img alt="" src="../images/down.gif" /> <a href="#Compatibility">Compatibility</a></li>
42 </ul><h3>See also</h3><ul class="seealso"><li><a href="../configuring.html">Configuration files</a></li></ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
43 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
45 <h2><a name="Description" id="Description">Description</a></h2>
47 <p>A brief description of the purpose of the directive.</p>
48 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
50 <h2><a name="Syntax" id="Syntax">Syntax</a></h2>
52 <p>This indicates the format of the directive as it would
53 appear in a configuration file. This syntax is extremely
54 directive-specific, and is described in detail in the
55 directive's definition. Generally, the directive name is
56 followed by a series of one or more space-separated arguments.
57 If an argument contains a space, the argument must be enclosed
58 in double quotes. Optional arguments are enclosed in square
59 brackets. Where an argument can take on more than one possible
60 value, the possible values are separated by vertical bars "|".
61 Literal text is presented in the default font, while
62 argument-types for which substitution is necessary are
63 <em>emphasized</em>. Directives which can take a variable
64 number of arguments will end in "..." indicating that the last
65 argument is repeated.</p>
67 <p>Directives use a great number of different argument types. A
68 few common ones are defined below.</p>
73 <dd>A complete Uniform Resource Locator including a scheme,
74 hostname, and optional pathname as in
75 <code>http://www.example.com/path/to/file.html</code></dd>
77 <dt><em>URL-path</em></dt>
79 <dd>The part of a <em>url</em> which follows the scheme and
80 hostname as in <code>/path/to/file.html</code>. The
81 <em>url-path</em> represents a web-view of a resource, as
82 opposed to a file-system view.</dd>
84 <dt><em>file-path</em></dt>
86 <dd>The path to a file in the local file-system beginning
87 with the root directory as in
88 <code>/usr/local/apache/htdocs/path/to/file.html</code>.
89 Unless otherwise specified, a <em>file-path</em> which does
90 not begin with a slash will be treated as relative to the <a href="core.html#serverroot">ServerRoot</a>.</dd>
92 <dt><em>directory-path</em></dt>
94 <dd>The path to a directory in the local file-system
95 beginning with the root directory as in
96 <code>/usr/local/apache/htdocs/path/to/</code>.</dd>
98 <dt><em>filename</em></dt>
100 <dd>The name of a file with no accompanying path information
101 as in <code>file.html</code>.</dd>
103 <dt><em>regex</em></dt>
105 <dd>A Perl-compatible <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular
106 expression</a>. The directive definition will specify what the
107 <em>regex</em> is matching against.</dd>
109 <dt><em>extension</em></dt>
111 <dd>In general, this is the part of the <em>filename</em>
112 which follows the last dot. However, Apache recognizes
113 multiple filename extensions, so if a <em>filename</em>
114 contains more than one dot, each dot-separated part of the
115 filename following the first dot is an <em>extension</em>.
116 For example, the <em>filename</em> <code>file.html.en</code>
117 contains two extensions: <code>.html</code> and
118 <code>.en</code>. For Apache directives, you may specify
119 <em>extension</em>s with or without the leading dot. In
120 addition, <em>extension</em>s are not case sensitive.</dd>
122 <dt><em>MIME-type</em></dt>
124 <dd>A method of describing the format of a file which
125 consists of a major format type and a minor format type,
126 separated by a slash as in <code>text/html</code>.</dd>
128 <dt><em>env-variable</em></dt>
130 <dd>The name of an <a href="../env.html">environment
131 variable</a> defined in the Apache configuration process.
132 Note this is not necessarily the same as an operating system
133 environment variable. See the <a href="../env.html">environment variable documentation</a> for
136 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
137 <div class="section">
138 <h2><a name="Default" id="Default">Default</a></h2>
140 <p>If the directive has a default value (<em>i.e.</em>, if you
141 omit it from your configuration entirely, the Apache Web server
142 will behave as though you set it to a particular value), it is
143 described here. If there is no default value, this section
144 should say "<em>None</em>". Note that the default listed here
145 is not necessarily the same as the value the directive takes in
146 the default httpd.conf distributed with the server.</p>
147 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
148 <div class="section">
149 <h2><a name="Context" id="Context">Context</a></h2>
151 <p>This indicates where in the server's configuration files the
152 directive is legal. It's a comma-separated list of one or more
153 of the following values:</p>
156 <dt>server config</dt>
158 <dd>This means that the directive may be used in the server
159 configuration files (<em>e.g.</em>, <code>httpd.conf</code>), but
160 <strong>not</strong> within any
161 <code class="directive"><a href="../mod/core.html#virtualhost"><VirtualHost></a></code>
162 or <code class="directive"><a href="../mod/core.html#directory"><Directory></a></code>
163 containers. It is not allowed in <code>.htaccess</code> files
166 <dt>virtual host</dt>
168 <dd>This context means that the directive may appear inside
169 <code class="directive"><a href="../mod/core.html#virtualhost"><VirtualHost></a></code>
170 containers in the server
171 configuration files.</dd>
175 <dd>A directive marked as being valid in this context may be
176 used inside <code class="directive"><a href="../mod/core.html#directory"><Directory></a></code>, <code class="directive"><a href="../mod/core.html#location"><Location></a></code>, <code class="directive"><a href="../mod/core.html#files"><Files></a></code>, and <code class="directive"><a href="../mod/mod_proxy.html#proxy"><Proxy></a></code> containers
177 in the server configuration files, subject to the restrictions
178 outlined in <a href="../sections.html">Configuration
183 <dd>If a directive is valid in this context, it means that it
184 can appear inside <em>per</em>-directory
185 <code>.htaccess</code> files. It may not be processed, though
186 depending upon the <a href="#Override">overrides</a> currently active.</dd>
189 <p>The directive is <em>only</em> allowed within the designated
190 context; if you try to use it elsewhere, you'll get a
191 configuration error that will either prevent the server from
192 handling requests in that context correctly, or will keep the
193 server from operating at all -- <em>i.e.</em>, the server won't
196 <p>The valid locations for the directive are actually the
197 result of a Boolean OR of all of the listed contexts. In other
198 words, a directive that is marked as being valid in
199 "<code>server config, .htaccess</code>" can be used in the
200 <code>httpd.conf</code> file and in <code>.htaccess</code>
201 files, but not within any <code class="directive"><a href="../mod/core.html#directory"><Directory></a></code> or
202 <code class="directive"><a href="../mod/core.html#virtualhost"><VirtualHost></a></code>
204 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
205 <div class="section">
206 <h2><a name="Override" id="Override">Override</a></h2>
208 <p>This directive attribute indicates which configuration
209 override must be active in order for the directive to be
210 processed when it appears in a <code>.htaccess</code> file. If
211 the directive's <a href="#Context">context</a>
212 doesn't permit it to appear in <code>.htaccess</code> files,
213 then no context will be listed.</p>
215 <p>Overrides are activated by the <code class="directive"><a href="../mod/core.html#allowoverride">AllowOverride</a></code> directive, and apply
216 to a particular scope (such as a directory) and all
217 descendants, unless further modified by other
218 <code class="directive"><a href="../mod/core.html#allowoverride">AllowOverride</a></code> directives at
219 lower levels. The documentation for that directive also lists the
220 possible override names available.</p>
221 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
222 <div class="section">
223 <h2><a name="Status" id="Status">Status</a></h2>
225 <p>This indicates how tightly bound into the Apache Web server
226 the directive is; in other words, you may need to recompile the
227 server with an enhanced set of modules in order to gain access
228 to the directive and its functionality. Possible values for
229 this attribute are:</p>
234 <dd>If a directive is listed as having "Core" status, that
235 means it is part of the innermost portions of the Apache Web
236 server, and is always available.</dd>
240 <dd>A directive labeled as having "MPM" status is provided by
241 a <a href="../mpm.html">Multi-Processing Module</a>. This
242 type of directive will be available if and only if you are
243 using one of the MPMs listed on the <a href="#Module">Module</a> line of the directive
248 <dd>A directive labeled as having "Base" status is supported
249 by one of the standard Apache modules which is compiled into
250 the server by default, and is therefore normally available
251 unless you've taken steps to remove the module from your
256 <dd>A directive with "Extension" status is provided by one of
257 the modules included with the Apache server kit, but the
258 module isn't normally compiled into the server. To enable the
259 directive and its functionality, you will need to change the
260 server build configuration files and re-compile Apache.</dd>
262 <dt>Experimental</dt>
264 <dd>"Experimental" status indicates that the directive is
265 available as part of the Apache kit, but you're on your own
266 if you try to use it. The directive is being documented for
267 completeness, and is not necessarily supported. The module
268 which provides the directive may or may not be compiled in by
269 default; check the top of the page which describes the
270 directive and its module to see if it remarks on the
273 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
274 <div class="section">
275 <h2><a name="Module" id="Module">Module</a></h2>
277 <p>This quite simply lists the name of the source module which
278 defines the directive.</p>
279 </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
280 <div class="section">
281 <h2><a name="Compatibility" id="Compatibility">Compatibility</a></h2>
283 <p>If the directive wasn't part of the original Apache version
284 2 distribution, the version in which it was introduced should
285 be listed here. In addition, if the directive is available
286 only on certain platforms, it will be noted here.</p>
288 <div class="bottomlang">
289 <p><span>Available Languages: </span><a href="../en/mod/directive-dict.html" title="English"> en </a> |
290 <a href="../ja/mod/directive-dict.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
291 <a href="../ko/mod/directive-dict.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> |
292 <a href="../tr/mod/directive-dict.html" hreflang="tr" rel="alternate" title="Türkçe"> tr </a></p>
293 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>This section is experimental!</strong><br />Comments placed here should not be expected
294 to last beyond the testing phase of this system, nor do we in any way guarantee that we'll read them.</div>
295 <div id="disqus_thread">
296 </div><script type="text/javascript"><!--//--><![CDATA[//><!--
298 var disqus_shortname = 'httpd';
299 var disqus_identifier = window.location.href.replace(/(current|trunk)/, "2.4").replace(/\/[a-z]{2}\//, "/").replace(window.location.protocol, "http:") + '.' + lang;
300 if (disqus_identifier.indexOf("httpd.apache.org") != -1) {
302 var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
303 dsq.src = window.location.protocol + '//' + disqus_shortname + '.disqus.com/embed.js';
304 (document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
307 var text = document.createTextNode("Comments have been disabled for offline viewing.");
308 document.getElementById('disqus_thread').appendChild(text);
310 //--><!]]></script></div><div id="footer">
311 <p class="apache">Copyright 2012 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
312 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
313 if (typeof(prettyPrint) !== undefined) {