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