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