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