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