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