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