granicus.if.org Git - apache/blob - docs/manual/mod/directive-dict.html.en

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