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