1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
<!--
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
This file is generated from xml source: DO NOT EDIT
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
-->
<title>Terms Used to Describe Directives - Apache HTTP Server Version 2.5</title>
<link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
<link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
<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" />
<script src="../style/scripts/prettify.min.js" type="text/javascript">
</script>
<link href="../images/favicon.ico" rel="shortcut icon" /></head>
<body id="manual-page"><div id="page-header">
<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.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>
<p class="apache">Apache HTTP Server Version 2.5</p>
<img alt="" src="../images/feather.png" /></div>
<div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
<div id="path">
<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>
<div class="toplang">
<p><span>Available Languages: </span><a href="../en/mod/directive-dict.html" title="English"> en </a> |
<a href="../es/mod/directive-dict.html" hreflang="es" rel="alternate" title="Espa�ol"> es </a> |
<a href="../fr/mod/directive-dict.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a> |
<a href="../ja/mod/directive-dict.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
<a href="../ko/mod/directive-dict.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> |
<a href="../tr/mod/directive-dict.html" hreflang="tr" rel="alternate" title="T�rk�e"> tr </a></p>
</div>
<p>This document describes the terms that are used to describe
each Apache <a href="directives.html">configuration
directive</a>.</p>
</div>
<div id="quickview"><ul id="toc"><li><img alt="" src="../images/down.gif" /> <a href="#Description">Description</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#Syntax">Syntax</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#Default">Default</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#Context">Context</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#Override">Override</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#Status">Status</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#Module">Module</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#Compatibility">Compatibility</a></li>
</ul><h3>See also</h3><ul class="seealso"><li><a href="../configuring.html">Configuration files</a></li><li><a href="#comments_section">Comments</a></li></ul></div>
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
<div class="section">
<h2><a name="Description" id="Description">Description</a> <a title="Permanent link" href="#Description" class="permalink">¶</a></h2>
<p>A brief description of the purpose of the directive.</p>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
<div class="section">
<h2><a name="Syntax" id="Syntax">Syntax</a> <a title="Permanent link" href="#Syntax" class="permalink">¶</a></h2>
<p>This indicates the format of the directive as it would
appear in a configuration file. This syntax is extremely
directive-specific, and is described in detail in the
directive's definition. Generally, the directive name is
followed by a series of one or more space-separated arguments.
If an argument contains a space, the argument must be enclosed
in double quotes. Optional arguments are enclosed in square
brackets. Where an argument can take on more than one possible
value, the possible values are separated by vertical bars "|".
Literal text is presented in the default font, while
argument-types for which substitution is necessary are
<em>emphasized</em>. Directives which can take a variable
number of arguments will end in "..." indicating that the last
argument is repeated.</p>
<p>Directives use a great number of different argument types. A
few common ones are defined below.</p>
<dl>
<dt><em>URL</em></dt>
<dd>A complete Uniform Resource Locator including a scheme,
hostname, and optional pathname as in
<code>http://www.example.com/path/to/file.html</code></dd>
<dt><em>URL-path</em></dt>
<dd>The part of a <em>url</em> which follows the scheme and
hostname as in <code>/path/to/file.html</code>. The
<em>url-path</em> represents a web-view of a resource, as
opposed to a file-system view.</dd>
<dt><em>file-path</em></dt>
<dd>The path to a file in the local file-system beginning
with the root directory as in
<code>/usr/local/apache/htdocs/path/to/file.html</code>.
Unless otherwise specified, a <em>file-path</em> which does
not begin with a slash will be treated as relative to the <a href="core.html#serverroot">ServerRoot</a>.</dd>
<dt><em>directory-path</em></dt>
<dd>The path to a directory in the local file-system
beginning with the root directory as in
<code>/usr/local/apache/htdocs/path/to/</code>.</dd>
<dt><em>filename</em></dt>
<dd>The name of a file with no accompanying path information
as in <code>file.html</code>.</dd>
<dt><em>regex</em></dt>
<dd>A Perl-compatible <a class="glossarylink" href="../glossary.html#regex" title="see glossary">regular
expression</a>. The directive definition will specify what the
<em>regex</em> is matching against.</dd>
<dt><em>extension</em></dt>
<dd>In general, this is the part of the <em>filename</em>
which follows the last dot. However, Apache recognizes
multiple filename extensions, so if a <em>filename</em>
contains more than one dot, each dot-separated part of the
filename following the first dot is an <em>extension</em>.
For example, the <em>filename</em> <code>file.html.en</code>
contains two extensions: <code>.html</code> and
<code>.en</code>. For Apache directives, you may specify
<em>extension</em>s with or without the leading dot. In
addition, <em>extension</em>s are not case sensitive.</dd>
<dt><em>MIME-type</em></dt>
<dd>A method of describing the format of a file which
consists of a major format type and a minor format type,
separated by a slash as in <code>text/html</code>.</dd>
<dt><em>env-variable</em></dt>
<dd>The name of an <a href="../env.html">environment
variable</a> defined in the Apache configuration process.
Note this is not necessarily the same as an operating system
environment variable. See the <a href="../env.html">environment variable documentation</a> for
more details.</dd>
<dt><em>time-interval</em></dt>
<dd>A time-interval format especially suited to specifying
timeout parameters. Supports the following format specifiers:
<ul>
<li><em>s</em>: Seconds</li>
<li><em>h</em>: Hours</li>
<li><em>ms</em>: Milli-seconds</li>
<li><em>mi[n]</em>: Minutes</li>
</ul>
For example: <code>Timeout 575ms</code>
</dd>
</dl>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
<div class="section">
<h2><a name="Default" id="Default">Default</a> <a title="Permanent link" href="#Default" class="permalink">¶</a></h2>
<p>If the directive has a default value (<em>i.e.</em>, if you
omit it from your configuration entirely, the Apache Web server
will behave as though you set it to a particular value), it is
described here. If there is no default value, this section
should say "<em>None</em>". Note that the default listed here
is not necessarily the same as the value the directive takes in
the default httpd.conf distributed with the server.</p>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
<div class="section">
<h2><a name="Context" id="Context">Context</a> <a title="Permanent link" href="#Context" class="permalink">¶</a></h2>
<p>This indicates where in the server's configuration files the
directive is legal. It's a comma-separated list of one or more
of the following values:</p>
<dl>
<dt>server config</dt>
<dd>This means that the directive may be used in the server
configuration files (<em>e.g.</em>, <code>httpd.conf</code>), but
<strong>not</strong> within any
<code class="directive"><a href="../mod/core.html#virtualhost"><VirtualHost></a></code>
or <code class="directive"><a href="../mod/core.html#directory"><Directory></a></code>
containers. It is not allowed in <code>.htaccess</code> files
at all.</dd>
<dt>virtual host</dt>
<dd>This context means that the directive may appear inside
<code class="directive"><a href="../mod/core.html#virtualhost"><VirtualHost></a></code>
containers in the server
configuration files.</dd>
<dt>directory</dt>
<dd>A directive marked as being valid in this context may be
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>, <code class="directive"><a href="../mod/core.html#if"><If></a></code>, and <code class="directive"><a href="../mod/mod_proxy.html#proxy"><Proxy></a></code> containers
in the server configuration files, subject to the restrictions
outlined in <a href="../sections.html">Configuration
Sections</a>.</dd>
<dt>.htaccess</dt>
<dd>If a directive is valid in this context, it means that it
can appear inside <em>per</em>-directory
<code>.htaccess</code> files. It may not be processed, though
depending upon the <a href="#Override">overrides</a> currently active.</dd>
</dl>
<p>The directive is <em>only</em> allowed within the designated
context; if you try to use it elsewhere, you'll get a
configuration error that will either prevent the server from
handling requests in that context correctly, or will keep the
server from operating at all -- <em>i.e.</em>, the server won't
even start.</p>
<p>The valid locations for the directive are actually the
result of a Boolean OR of all of the listed contexts. In other
words, a directive that is marked as being valid in
"<code>server config, .htaccess</code>" can be used in the
<code>httpd.conf</code> file and in <code>.htaccess</code>
files, but not within any <code class="directive"><a href="../mod/core.html#directory"><Directory></a></code> or
<code class="directive"><a href="../mod/core.html#virtualhost"><VirtualHost></a></code>
containers.</p>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
<div class="section">
<h2><a name="Override" id="Override">Override</a> <a title="Permanent link" href="#Override" class="permalink">¶</a></h2>
<p>This directive attribute indicates which configuration
override must be active in order for the directive to be
processed when it appears in a <code>.htaccess</code> file. If
the directive's <a href="#Context">context</a>
doesn't permit it to appear in <code>.htaccess</code> files,
then no context will be listed.</p>
<p>Overrides are activated by the <code class="directive"><a href="../mod/core.html#allowoverride">AllowOverride</a></code> directive, and apply
to a particular scope (such as a directory) and all
descendants, unless further modified by other
<code class="directive"><a href="../mod/core.html#allowoverride">AllowOverride</a></code> directives at
lower levels. The documentation for that directive also lists the
possible override names available.</p>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
<div class="section">
<h2><a name="Status" id="Status">Status</a> <a title="Permanent link" href="#Status" class="permalink">¶</a></h2>
<p>This indicates how tightly bound into the Apache Web server
the directive is; in other words, you may need to recompile the
server with an enhanced set of modules in order to gain access
to the directive and its functionality. Possible values for
this attribute are:</p>
<dl>
<dt>Core</dt>
<dd>If a directive is listed as having "Core" status, that
means it is part of the innermost portions of the Apache Web
server, and is always available.</dd>
<dt>MPM</dt>
<dd>A directive labeled as having "MPM" status is provided by
a <a href="../mpm.html">Multi-Processing Module</a>. This
type of directive will be available if and only if you are
using one of the MPMs listed on the <a href="#Module">Module</a> line of the directive
definition.</dd>
<dt>Base</dt>
<dd>A directive labeled as having "Base" status is supported
by one of the standard Apache modules which is compiled into
the server by default, and is therefore normally available
unless you've taken steps to remove the module from your
configuration.</dd>
<dt>Extension</dt>
<dd>A directive with "Extension" status is provided by one of
the modules included with the Apache server kit, but the
module isn't normally compiled into the server. To enable the
directive and its functionality, you will need to change the
server build configuration files and re-compile Apache.</dd>
<dt>Experimental</dt>
<dd>"Experimental" status indicates that the directive is
available as part of the Apache kit, but you're on your own
if you try to use it. The directive is being documented for
completeness, and is not necessarily supported. The module
which provides the directive may or may not be compiled in by
default; check the top of the page which describes the
directive and its module to see if it remarks on the
availability.</dd>
</dl>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
<div class="section">
<h2><a name="Module" id="Module">Module</a> <a title="Permanent link" href="#Module" class="permalink">¶</a></h2>
<p>This quite simply lists the name of the source module which
defines the directive.</p>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
<div class="section">
<h2><a name="Compatibility" id="Compatibility">Compatibility</a> <a title="Permanent link" href="#Compatibility" class="permalink">¶</a></h2>
<p>If the directive wasn't part of the original Apache version
2 distribution, the version in which it was introduced should
be listed here. In addition, if the directive is available
only on certain platforms, it will be noted here.</p>
</div></div>
<div class="bottomlang">
<p><span>Available Languages: </span><a href="../en/mod/directive-dict.html" title="English"> en </a> |
<a href="../es/mod/directive-dict.html" hreflang="es" rel="alternate" title="Espa�ol"> es </a> |
<a href="../fr/mod/directive-dict.html" hreflang="fr" rel="alternate" title="Fran�ais"> fr </a> |
<a href="../ja/mod/directive-dict.html" hreflang="ja" rel="alternate" title="Japanese"> ja </a> |
<a href="../ko/mod/directive-dict.html" hreflang="ko" rel="alternate" title="Korean"> ko </a> |
<a href="../tr/mod/directive-dict.html" hreflang="tr" rel="alternate" title="T�rk�e"> tr </a></p>
</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>Notice:</strong><br />This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
<script type="text/javascript"><!--//--><![CDATA[//><!--
var comments_shortname = 'httpd';
var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/directive-dict.html';
(function(w, d) {
if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
d.write('<div id="comments_thread"><\/div>');
var s = d.createElement('script');
s.type = 'text/javascript';
s.async = true;
s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
(d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
}
else {
d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
}
})(window, document);
//--><!]]></script></div><div id="footer">
<p class="apache">Copyright 2019 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>
<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.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[//><!--
if (typeof(prettyPrint) !== 'undefined') {
prettyPrint();
}
//--><!]]></script>
</body></html>
|
