home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2004 March / PCWMAR04.iso / Software / Resources / Apache / apache_2.0.48-win32-x86-no_ssl.exe / F254354_mod_proxy.xml < prev    next >
Encoding:
Text File  |  2003-07-28  |  41.0 KB  |  950 lines

  1. syntax>
  2. <default>LogFormat "%h %l %u %t \"%r\" %>s %b"</default>
  3. <contextlist><context>server config</context><context>virtual host</context>
  4. </contextlist>
  5.  
  6. <usage>
  7.     <p>This directive specifies the format of the access log
  8.     file.</p>
  9.  
  10.     <p>The <directive>LogFormat</directive> directive can take one of two
  11.     forms. In the first form, where only one argument is specified,
  12.     this directive sets the log format which will be used by logs
  13.     specified in subsequent <directive>TransferLog</directive>
  14.     directives. The single argument can specify an explicit
  15.     <var>format</var> as discussed in the <a href="#formats">custom log
  16.     formats</a> section above. Alternatively, it can use a
  17.     <var>nickname</var> to refer to a log format defined in a
  18.     previous <directive>LogFormat</directive> directive as described
  19.     below.</p>
  20.  
  21.     <p>The second form of the <directive>LogFormat</directive> 
  22.     directive associates an explicit <var>format</var> with a
  23.     <var>nickname</var>. This <var>nickname</var> can then be used in
  24.     subsequent <directive>LogFormat</directive> or
  25.     <directive module="mod_log_config">CustomLog</directive> directives
  26.     rather than repeating the entire format string. A
  27.     <directive>LogFormat</directive> directive that defines a nickname
  28.     <strong>does nothing else</strong> -- that is, it <em>only</em>
  29.     defines the nickname, it doesn't actually apply the format and make
  30.     it the default. Therefore, it will not affect subsequent
  31.     <directive module="mod_log_config">TransferLog</directive> directives.
  32.     In addition, <directive>LogFormat</directive> cannot use one nickname
  33.     to define another nickname. Note that the nickname should not contain
  34.     percent signs (<code>%</code>).</p>
  35.  
  36.     <example><title>Example</title>
  37.       LogFormat "%v %h %l %u %t \"%r\" %>s %b" vhost_common
  38.     </example>
  39. </usage>
  40. </directivesynopsis>
  41.  
  42. <directivesynopsis>
  43. <name>TransferLog</name>
  44. <description>Specify location of a log file</description>
  45. <syntax>TransferLog <var>file</var>|<var>pipe</var></syntax>
  46. <contextlist><context>server config</context><context>virtual host</context>
  47. </contextlist>
  48.  
  49. <usage>
  50.     <p>This directive has exactly the same arguments and effect as
  51.     the <directive module="mod_log_config">CustomLog</directive>
  52.     directive, with the exception that it does not allow the log format
  53.     to be specified explicitly or for conditional logging of requests.
  54.     Instead, the log format is determined by the most recently specified
  55.     <directive module="mod_log_config">LogFormat</directive> directive
  56.     which does not define a nickname. Common Log Format is used if no
  57.     other format has been specified.</p>
  58.  
  59.     <example><title>Example</title>
  60.       LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\""<br />
  61.       TransferLog logs/access_log
  62.     </example>
  63. </usage>
  64. </directivesynopsis>
  65.  
  66. </modulesynopsis>
  67. <?xml version="1.0" encoding="UTF-8" ?>
  68.  
  69. <metafile>
  70.   <basename>mod_log_config</basename>
  71.   <path>/mod/</path>
  72.   <relpath>..</relpath>
  73.  
  74.   <variants>
  75.     <variant>en</variant>
  76.   </variants>
  77. </metafile>
  78. <?xml version="1.0"?>
  79. <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
  80. <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
  81. <modulesynopsis metafile="mod_mem_cache.xml.meta">
  82.  
  83. <name>mod_mem_cache</name>
  84. <description>Content cache keyed to URIs</description>
  85. <status>Experimental</status>
  86. <sourcefile>mod_mem_cache.c</sourcefile>
  87. <identifier>mem_cache_module</identifier>
  88.  
  89. <summary>
  90.     <note type="warning">
  91.       This module is experimental. Documentation is still under
  92.       development...
  93.     </note>
  94.  
  95.     <p>This module <em>requires</em> the service of <module
  96.     >mod_cache</module>. It acts as a support module for <module
  97.     >mod_cache</module> and provides a memory based storage manager.
  98.     <module>mod_mem_cache</module> can be configured to operate in two
  99.     modes: caching open file descriptors or caching objects in heap storage.
  100.     <module>mod_mem_cache</module> is most useful when used to cache locally
  101.     generated content or to cache backend server content for <module
  102.     >mod_proxy</module> configured for <directive module="mod_proxy"
  103.     >ProxyPass</directive> (aka <dfn>reverse proxy</dfn>).</p>
  104.  
  105.     <p>Content is stored in and retrieved from the cache using URI based
  106.     keys. Content with access protection is not cached.</p>
  107. </summary>
  108. <seealso><module>mod_cache</module></seealso>
  109. <seealso><module>mod_disk_cache</module></seealso>
  110.  
  111. <directivesynopsis>
  112. <name>MCacheSize</name>
  113. <description>The maximum amount of memory used by the cache in
  114. KBytes</description>
  115. <syntax>MCacheSize <var>KBytes</var></syntax>
  116. <default>MCacheSize 100</default>
  117. <contextlist><context>server config</context></contextlist>
  118.  
  119. <usage>
  120.     <p>The <directive>MCacheSize</directive> directive sets the maximum
  121.     amount of memory to be used by the cache, in KBytes (1024-byte units).
  122.     If a new object needs to be inserted in the cache and the size of the
  123.     object is greater than the remaining memory, objects will be removed
  124.     until the new object can be cached. The object to be removed is
  125.     selected using the algorithm specified by <directive
  126.     module="mod_mem_cache">MCacheRemovalAlgorithm</directive>.</p>
  127.  
  128.     <example><title>Example</title>
  129.       MCacheSize 700000
  130.     </example>
  131.  
  132.     <note><title>Note</title>
  133.       <p>The <directive>MCacheSize</directive> value must be greater than
  134.       the value specified by the <directive module="mod_mem_cache"
  135.       >MCacheMaxObjectSize</directive> directive.</p>
  136.     </note>
  137. </usage>
  138. </directivesynopsis>
  139.  
  140. <directivesynopsis>
  141. <name>MCacheMaxObjectCount</name>
  142. <description>The maximum number of objects allowed to be placed in the
  143. cache</description>
  144. <syntax>MCacheMaxObjectCount <var>value</var></syntax>
  145. <default>MCacheMaxObjectCount 1009</default>
  146. <contextlist><context>server config</context></contextlist>
  147.  
  148. <usage>
  149.     <p>The <directive>MCacheMaxObjectCount</directive> directive sets the
  150.     maximum number of objects to be cached. The value is used to create the
  151.     open hash table. If a new object needs to be inserted in the cache and
  152.     the maximum number of objects has been reached, an object will be
  153.     removed to allow the new object to be cached. The object to be removed
  154.     is selected using the algorithm specified by <directive
  155.     module="mod_mem_cache">MCacheRemovalAlgorithm</directive>.</p>
  156.  
  157.     <example><title>Example</title>
  158.       MCacheMaxObjectCount 13001
  159.     </example>
  160. </usage>
  161. </directivesynopsis>
  162.  
  163. <directivesynopsis>
  164. <name>MCacheMinObjectSize</name>
  165. <description>The minimum size (in bytes) of a document to be allowed in the
  166. cache</description>
  167. <syntax>MCacheMinObjectSize <var>bytes</var></syntax>
  168. <default>MCacheMinObjectSize 0</default>
  169. <contextlist><context>server config</context></contextlist>
  170.  
  171. <usage>
  172.     <p>The <directive>MCacheMinObjectSize</directive> directive sets the
  173.     minimum size in bytes of a document for it to be considered
  174.     cacheable.</p>
  175.  
  176.     <example><title>Example</title>
  177.       MCacheMinObjectSize 10000
  178.     </example>
  179. </usage>
  180. </directivesynopsis>
  181.  
  182. <directivesynopsis>
  183. <name>MCacheMaxObjectSize</name>
  184. <description>The maximum size (in bytes) of a document allowed in the
  185. cache</description>
  186. <syntax>MCacheMaxObjectSize <var>bytes</var></syntax>
  187. <default>MCacheMaxObjectSize 10000</default>
  188. <contextlist><context>server config</context></contextlist>
  189.  
  190. <usage>
  191.     <p>The <directive>MCacheMaxObjectSize</directive> directive sets the
  192.     maximum allowable size, in bytes, of a document for it to be considered
  193.     cacheable.</p>
  194.  
  195.     <example><title>Example</title>
  196.       MCacheMaxObjectSize 6400000
  197.     </example>
  198.  
  199.     <note><title>Note</title>
  200.       <p>The value of <directive>MCacheMaxObjectSize</directive> must be
  201.       greater than the value specified by the <directive
  202.       module="mod_mem_cache">MCacheMinObjectSize</directive> directive.</p>
  203.     </note>
  204. </usage>
  205. </directivesynopsis>
  206.  
  207. <directivesynopsis>
  208. <name>MCacheRemovalAlgorithm</name>
  209. <description>The algorithm used to select documents for removal from the
  210. cache</description>
  211. <syntax>MCacheRemovalAlgorithm LRU|GDSF</syntax>
  212. <default>MCacheRemovalAlgorithm GDSF</default>
  213. <contextlist><context>server config</context></contextlist>
  214.  
  215. <usage>
  216.     <p>The <directive>MCacheRemovalAlgorithm</directive> directive specifies
  217.     the algorithm used to select documents for removal from the cache.
  218.     Two choices are available:</p>
  219.  
  220.     <dl>
  221.       <dt><code>LRU</code> (Least Recently Used)</dt>
  222.       <dd><code>LRU</code> removes the documents that have not been accessed
  223.       for the longest time.</dd>
  224.  
  225.       <dt><code>GDSF</code> (GreadyDual-Size)</dt>
  226.       <dd><code>GDSF</code> assigns a priority to cached documents based
  227.       on the cost of a cache miss and the size of the document. Documents
  228.       with the lowest priority are removed first.</dd>
  229.     </dl>
  230.  
  231.     <example><title>Example</title>
  232.       MCacheRemovalAlgorithm GDSF<br />
  233.       MCacheRemovalAlgorithm LRU
  234.     </example>
  235. </usage>
  236. </directivesynopsis>
  237.  
  238. <directivesynopsis>
  239. <name>MCacheMaxStreamingBuffer</name>
  240. <description>Maximum amount of a streamed response to buffer in memory
  241. before declaring the response uncacheable</description>
  242. <syntax>MCacheMaxStreamingBuffer <var>size_in_bytes</var></syntax>
  243. <default>MCacheMaxStreamingBuffer the smaller of 100000 or MCacheMaxObjectSize</default>
  244. <contextlist><context>server config</context>
  245. </contextlist>
  246.  
  247. <usage>
  248.     <p>The <directive>MCacheMaxStreamingBuffer</directive> directive
  249.     specifies the maximum number of bytes of a streamed response to
  250.     buffer before deciding that the response is too big to cache.
  251.     A streamed response is one in which the entire content is not
  252.     immediately available and in which the <code>Content-Length</code>
  253.     may not be known. Sources of streaming responses include proxied
  254.     responses and the output of CGI scripts. By default, a streamed
  255.     response will <em>not</em> be cached unless it has a
  256.     <code>Content-Length</code> header. The reason for this is to
  257.     avoid using a large amount of memory to buffer a partial response
  258.     that might end up being too large to fit in the cache.
  259.     The <directive>MCacheMaxStreamingBuffer</directive> directive allows
  260.     buffering of streamed responses that don't contain a
  261.     <code>Content-Length</code> up to the specified maximum amount of
  262.     space. If the maximum buffer space is reached, the buffered
  263.     content is discarded and the attempt to cache is abandoned.</p>
  264.  
  265.     <note><title>Note:</title>
  266.       <p>Using a nonzero value for <directive>MCacheMaxStreamingBuffer</directive> 
  267.       will not delay the transmission of the response to the client.
  268.       As soon as <module>mod_mem_cache</module> copies a block of streamed
  269.       content into a buffer, it sends the block on to the next output
  270.       filter for delivery to the client.</p>
  271.     </note>
  272.  
  273.     <example>
  274.       # Enable caching of streamed responses up to 64KB:<br />
  275.       MCacheMaxStreamingBuffer 65536
  276.     </example>
  277. </usage>
  278. </directivesynopsis>
  279.  
  280. </modulesynopsis>
  281. <?xml version="1.0" encoding="UTF-8" ?>
  282.  
  283. <metafile>
  284.   <basename>mod_mem_cache</basename>
  285.   <path>/mod/</path>
  286.   <relpath>..</relpath>
  287.  
  288.   <variants>
  289.     <variant>en</variant>
  290.   </variants>
  291. </metafile>
  292. <?xml version="1.0"?>
  293. <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
  294. <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
  295. <modulesynopsis metafile="mod_mime.xml.meta">
  296.  
  297. <name>mod_mime</name>
  298. <description>Associates the requested filename's extensions
  299.     with the file's behavior (handlers and filters)
  300.     and content (mime-type, language, character set and
  301.     encoding)</description>
  302. <status>Base</status>
  303. <sourcefile>mod_mime.c</sourcefile>
  304. <identifier>mime_module</identifier>
  305.  
  306. <summary>
  307.     <p>This module is used to associate various bits of "meta
  308.     information" with files by their filename extensions. This
  309.     information relates the filename of the document to it's
  310.     mime-type, language, character set and encoding. This
  311.     information is sent to the browser, and participates in content
  312.     negotiation, so the user's preferences are respected when
  313.     choosing one of several possible files to serve. See
  314.     <module>mod_negotiation</module> for more information
  315.     about <a href="../content-negotiation.html">content negotiation</a>.</p>
  316.  
  317.     <p>The directives <directive
  318.     module="mod_mime">AddCharset</directive>, <directive
  319.     module="mod_mime">AddEncoding</directive>, <directive
  320.     module="mod_mime">AddLanguage</directive> and <directive
  321.     module="mod_mime">AddType</directive> are all used to map file
  322.     extensions onto the meta-information for that file. Respectively
  323.     they set the character set, content-encoding, content-language,
  324.     and MIME-type (content-type) of documents.  The directive <directive
  325.     module="mod_mime">TypesConfig</directive> is used to specify a
  326.     file which also maps extensions onto MIME types. </p>
  327.  
  328.     <p>In addition, <module>mod_mime</module> may define the <a
  329.     href="../handler.html">handler</a> and <a
  330.     href="../filter.html">filters</a> that originate and process
  331.     content.  The directives <directive
  332.     module="mod_mime">AddHandler</directive>, <directive
  333.     module="mod_mime">AddOutputFilter</directive>, and <directive
  334.     module="mod_mime">AddInputFilter</directive> control the modules
  335.     or scripts that serve the document.  The <directive
  336.     module="mod_mime">MultiviewsMatch</directive> directive allows
  337.     <module>mod_negotiation</module> to consider these file extensions
  338.     to be included when testing Multiviews matches.</p>
  339.  
  340.     <p>While <module>mod_mime</module> associates meta-information
  341.     with filename extensions, the <module>core</module> server
  342.     provides directives that are used to associate all the files in a
  343.     given container (<em>e.g.</em>, <directive type="section"
  344.     module="core">Location</directive>, <directive type="section"
  345.     module="core">Directory</directive>, or <directive type="section"
  346.     module="core">Files</directive>) with particular
  347.     meta-information. These directives include <directive
  348.     module="core">ForceType</directive>, <directive
  349.     module="core">SetHandler</directive>, <directive
  350.     module="core">SetInputFilter</directive>, and <directive
  351.     module="core">SetOutputFilter</directive>.  The core directives
  352.     override any filename extension mappings defined in
  353.     <module>mod_mime</module>.</p>
  354.  
  355.     <p>Note that changing the meta-information for a file does not
  356.     change the value of the <code>Last-Modified</code> header.
  357.     Thus, previously cached copies may still be used by a client or
  358.     proxy, with the previous headers. If you change the
  359.     meta-information (language, content type, character set or
  360.     encoding) you may need to 'touch' affected files (updating
  361.     their last modified date) to ensure that all visitors are
  362.     receive the corrected content headers.</p>
  363. </summary>
  364. <seealso><directive
  365. module="mod_mime_magic">MimeMagicFile</directive></seealso>
  366. <seealso><directive module="core">AddDefaultCharset</directive></seealso>
  367. <seealso><directive module="core">ForceType</directive></seealso>
  368. <seealso><directive module="core">DefaultType</directive></seealso>
  369. <seealso><directive module="core">SetHandler</directive></seealso>
  370. <seealso><directive module="core">SetInputFilter</directive></seealso>
  371. <seealso><directive module="core">SetOutputFilter</directive></seealso>
  372.  
  373. <section id="multipleext"><title>Files with Multiple Extensions</title>
  374.     <p>Files can have more than one extension, and the order of the
  375.     extensions is <em>normally</em> irrelevant. For example, if the
  376.     file <code>welcome.html.fr</code> maps onto content type
  377.     <code>text/html</code> and language French then the file
  378.     <code>welcome.fr.html</code> will map onto exactly the same information.
  379.     If more than one extension is given which maps onto the same
  380.     type of meta-information, then the one to the right will be
  381.     used. For example, if <code>.gif</code> maps to the MIME-type
  382.     <code>image/gif</code> and <code>.html</code> maps to the MIME-type
  383.     <code>text/html</code>, then the file <code>welcome.gif.html</code>
  384.     will be associated with the MIME-type <code>text/html</code>.</p>
  385.  
  386.     <p>Care should be taken when a file with multiple extensions
  387.     gets associated with both a MIME-type and a handler. This will
  388.     usually result in the request being by the module associated
  389.     with the handler. For example, if the <code>.imap</code>
  390.     extension is mapped to the handler <code>imap-file</code> (from
  391.     <module>mod_imap</module>) and the <code>.html</code> extension is
  392.     mapped to the MIME-type <code>text/html</code>, then the file
  393.     <code>world.imap.html</code> will be associated with both the
  394.     <code>imap-file</code> handler and <code>text/html</code> MIME-type.
  395.     When it is processed, the <code>imap-file</code> handler will be used,
  396.     and so it will be treated as a <module>mod_imap</module> imagemap
  397.     file.</p>
  398. </section>
  399.  
  400. <section id="contentencoding"><title>Content encoding</title>
  401.     <p>A file of a particular MIME type can additionally be encoded a
  402.     particular way to simplify transmission over the Internet.
  403.     While this usually will refer to compression, such as
  404.     <code>gzip</code>, it can also refer to encryption, such a
  405.     <code>pgp</code> or to an encoding such as UUencoding, which is
  406.     designed for transmitting a binary file in an ASCII (text)
  407.     format.</p>
  408.  
  409.     <p>The <a href="http://www.ietf.org/rfc/rfc2616.txt">HTTP/1.1
  410.     RFC</a>, section 14.11 puts it this way:</p>
  411.  
  412.     <blockquote cite="http://www.ietf.org/rfc/rfc2616.txt">
  413.       <p>The Content-Encoding entity-header field is used as a modifier to
  414.       the media-type. When present, its value indicates what additional
  415.       content codings have been applied to the entity-body, and thus what
  416.       decoding mechanisms must be applied in order to obtain the media-type
  417.       referenced by the Content-Type header field. Content-Encoding is
  418.       primarily used to allow a document to be compressed without losing
  419.       the identity of its underlying media type.</p>
  420.     </blockquote>
  421.  
  422.     <p>By using more than one file extension (see <a
  423.     href="#multipleext">section above about multiple file
  424.     extensions</a>), you can indicate that a file is of a
  425.     particular <em>type</em>, and also has a particular
  426.     <em>encoding</em>. </p>
  427.  
  428.     <p>For example, you may have a file which is a Microsoft Word
  429.     document, which is pkzipped to reduce its size. If the
  430.     <code>.doc</code> extension is associated with the Microsoft
  431.     Word file type, and the <code>.zip</code> extension is
  432.     associated with the pkzip file encoding, then the file
  433.     <code>Resume.doc.zip</code>would be known to be a pkzip'ed Word
  434.     document.</p>
  435.  
  436.     <p>Apache sends a <code>Content-encoding</code> header with the
  437.     resource, in order to tell the client browser about the
  438.     encoding method.</p>
  439.  
  440.     <example>Content-encoding: pkzip</example>
  441. </section>
  442.  
  443. <section id="charset-lang"><title>Character sets and languages</title>
  444.     <p>In addition to file type and the file encoding,
  445.     another important piece of information is what language a
  446.     particular document is in, and in what character set the file
  447.     should be displayed. For example, the document might be written
  448.     in the Vietnamese alphabet, or in Cyrillic, and should be
  449.     displayed as such. This information, also, is transmitted in
  450.     HTTP headers.</p>
  451.  
  452.     <p>The character set, language, encoding and mime type are all 
  453.     used in the process of content negotiation (See 
  454.     <module>mod_negotiation</module>) to determine
  455.     which document to give to the client, when there are
  456.     alternative documents in more than one character set, language, 
  457.     encoding or mime type. All filename extensions associations
  458.     created with <directive module="mod_mime">AddCharset</directive>,
  459.     <directive module="mod_mime">AddEncoding</directive>, <directive
  460.     module="mod_mime">AddLanguage</directive> and <directive
  461.     module="mod_mime">AddType</directive> directives
  462.     (and extensions listed in the <directive module="mod_mime_magic"
  463.     >MimeMagicFile</directive>) participate in this select process.
  464.     Filename extensions that are only associated using the <directive
  465.     module="mod_mime">AddHandler</directive>, <directive module="mod_mime"
  466.     >AddInputFilter</directive> or <directive module="mod_mime"
  467.     >AddOutputFilter</directive> directives may be included or excluded
  468.     from matching by using the <directive module="mod_mime"
  469.     >MultiviewsMatch</directive> directive.</p>
  470.  
  471.     <section id="charset"><title>Charset</title>
  472.       <p>To convey this further information, Apache optionally sends
  473.       a <code>Content-Language</code> header, to specify the language
  474.       that the document is in, and can append additional information
  475.       onto the <code>Content-Type</code> header to indicate the
  476.       particular character set that should be used to correctly
  477.       render the information.</p>
  478.  
  479.       <example>
  480.         Content-Language: en, fr<br />
  481.     Content-Type: text/plain; charset=ISO-8859-1
  482.       </example>
  483.  
  484.       <p>The language specification is the two-letter abbreviation
  485.       for the language. The <code>charset</code> is the name of the
  486.       particular character set which should be used.</p>
  487.     </section>
  488. </section>
  489.  
  490. <directivesynopsis>
  491. <name>AddCharset</name>
  492. <description>Maps the given filename extensions to the specified content
  493. charset</description>
  494. <syntax>AddCharset <var>charset</var> <var>extension</var>
  495. [<var>extension</var>] ...</syntax>
  496. <contextlist><context>server config</context><context>virtual host</context>
  497. <context>directory</context><context>.htaccess</context></contextlist>
  498. <override>FileInfo</override>
  499.  
  500. <usage>
  501.     <p>The <directive>AddCharset</directive> directive maps the given
  502.     filename extensions to the specified content charset. <var>charset</var>
  503.     is the MIME charset parameter of filenames containing
  504.     <var>extension</var>. This mapping is added to any already in force,
  505.     overriding any mappings that already exist for the same
  506.     <var>extension</var>.</p>
  507.  
  508.     <example><title>Example</title>
  509.       AddLanguage ja .ja<br />
  510.       AddCharset EUC-JP .euc<br />
  511.       AddCharset ISO-2022-JP .jis<br />
  512.       AddCharset SHIFT_JIS .sjis
  513.     </example>
  514.  
  515.     <p>Then the document <code>xxxx.ja.jis</code> will be treated
  516.     as being a Japanese document whose charset is <code>ISO-2022-JP</code>
  517.     (as will the document <code>xxxx.jis.ja</code>). The
  518.     <directive>AddCharset</directive> directive is useful for both to
  519.     inform the client about the character encoding of the document so that
  520.     the document can be interpreted and displayed appropriately, and for <a
  521.     href="../content-negotiation.html">content negotiation</a>,
  522.     where the server returns one from several documents based on
  523.     the client's charset preference.</p>
  524.  
  525.     <p>The <var>extension</var> argument is case-insensitive, and can
  526.     be specified with or without a leading dot.</p>
  527. </usage>
  528. <seealso><module>mod_negotiation</module></seealso>
  529. <seealso><directive module="core">AddDefaultCharset</directive></seealso>
  530. </directivesynopsis>
  531.  
  532. <directivesynopsis>
  533. <name>AddEncoding</name>
  534. <description>Maps the given filename extensions to the specified encoding
  535. type</description>
  536. <syntax>AddEncoding <var>MIME-enc</var> <var>extension</var>
  537. [<var>extension</var>] ...</syntax>
  538. <contextlist><context>server config</context><context>virtual host</context>
  539. <context>directory</context><context>.htaccess</context></contextlist>
  540. <override>FileInfo</override>
  541.  
  542. <usage>
  543.     <p>The <directive>AddEncoding</directive> directive maps the given
  544.     filename extensions to the specified encoding type. <var>MIME-enc</var>
  545.     is the MIME encoding to use for documents containing the
  546.     <var>extension</var>. This mapping is added to any already in force,
  547.     overriding any mappings that already exist for the same
  548.     <var>extension</var>.</p>
  549.  
  550.     <example><title>Example</title>
  551.       AddEncoding x-gzip .gz<br />
  552.       AddEncoding x-compress .Z
  553.     </example>
  554.  
  555.     <p>This will cause filenames containing the <code>.gz</code> extension
  556.     to be marked as encoded using the <code>x-gzip</code> encoding, and
  557.     filenames containing the <code>.Z</code> extension to be marked as
  558.     encoded with <code>x-compress</code>.</p>
  559.  
  560.     <p>Old clients expect <code>x-gzip</code> and <code>x-compress</code>,
  561.     however the standard dictates that they're equivalent to
  562.     <code>gzip</code> and <code>compress</code> respectively. Apache does
  563.     content encoding comparisons by ignoring any leading <code>x-</code>.
  564.     When responding with an encoding Apache will use whatever form
  565.     (<em>i.e.</em>, <code>x-foo</code> or <code>foo</code>) the
  566.     client requested. If the client didn't specifically request a
  567.     particular form Apache will use the form given by the
  568.     <code>AddEncoding</code> directive. To make this long story
  569.     short, you should always use <code>x-gzip</code> and
  570.     <code>x-compress</code> for these two specific encodings. More
  571.     recent encodings, such as <code>deflate</code> should be
  572.     specified without the <code>x-</code>.</p>
  573.  
  574.     <p>The <var>extension</var> argument is case-insensitive, and can
  575.     be specified with or without a leading dot.</p>
  576. </usage>
  577. </directivesynopsis>
  578.  
  579. <directivesynopsis>
  580. <name>AddHandler</name>
  581. <description>Maps the filename extensions to the specified
  582. handler</description>
  583. <syntax>AddHandler <var>handler-name</var> <var>extension</var>
  584. [<var>extension</var>] ...</syntax>
  585. <contextlist><context>server config</context><context>virtual host</context>
  586. <context>directory</context><context>.htaccess</context></contextlist>
  587. <override>FileInfo</override>
  588.  
  589. <usage>
  590.     <p>Files having the name <var>extension</var> will be served by the
  591.     specified <var><a href="../handler.html">handler-name</a></var>. This
  592.     mapping is added to any already in force, overriding any mappings that
  593.     already exist for the same <var>extension</var>. For example, to
  594.     activate CGI scripts with the file extension <code>.cgi</code>, you
  595.     might use:</p>
  596.  
  597.     <example>
  598.       AddHandler cgi-script .cgi
  599.     </example>
  600.  
  601.     <p>Once that has been put into your httpd.conf file, any file containing
  602.     the <code>.cgi</code> extension will be treated as a CGI program.</p>
  603.  
  604.     <p>The <var>extension</var> argument is case-insensitive, and can
  605.     be specified with or without a leading dot.</p>
  606. </usage>
  607. <seealso><directive module="core">SetHandler</directive></seealso>
  608. </directivesynopsis>
  609.  
  610. <directivesynopsis>
  611. <name>AddInputFilter</name>
  612. <description>Maps filename extensions to the filters that will process
  613. client requests</description>
  614. <syntax>AddInputFilter <var>filter</var>[;<var>filter</var>...]
  615. <var>extension</var> [<var>extension</var>] ...</syntax>
  616. <contextlist><context>server config</context><context>virtual host</context>
  617. <context>directory</context><context>.htaccess</context></contextlist>
  618. <override>FileInfo</override>
  619. <compatibility>AddInputFilter is only available in Apache 2.0.26 and
  620. later.</compatibility>
  621.  
  622. <usage>
  623.     <p><directive>AddInputFilter</directive> maps the filename extension
  624.     <var>extension</var> to the <a href="../filter.html">filters</a> which
  625.     will process client requests and POST input when they are received by
  626.     the server. This is in addition to any filters defined elsewhere,
  627.     including the <directive module="core">SetInputFilter</directive>
  628.     directive. This mapping is merged over any already in force, overriding
  629.     any mappings that already exist for the same <var>extension</var>.</p>
  630.  
  631.     <p>If more than one filter is specified, they must be separated
  632.     by semicolons in the order in which they should process the
  633.     content. Both the filter and <var>extension</var> arguments are
  634.     case-insensitive, and the extension may be specified with or
  635.     without a leading dot.</p>
  636. </usage>
  637. </directivesynopsis>
  638.  
  639. <directivesynopsis>
  640. <name>AddLanguage</name>
  641. <description>Maps the given filename extension to the specified content
  642. language</description>
  643. <syntax>AddLanguage <var>MIME-lang</var> <var>extension</var>
  644. [<var>extension</var>] ...</syntax>
  645. <contextlist><context>server config</context><context>virtual host</context>
  646. <context>directory</context><context>.htaccess</context></contextlist>
  647. <override>FileInfo</override>
  648.  
  649. <usage>
  650.     <p>The <directive>AddLanguage</directive> directive maps the given
  651.     filename extension to the specified content language.
  652.     <var>MIME-lang</var> is the MIME language of filenames containing
  653.     <var>extension</var>. This mapping is added to any already in force,
  654.     overriding any mappings that already exist for the same
  655.     <var>extension</var>.</p>
  656.  
  657.     <example><title>Example</title>
  658.       AddEncoding x-compress .Z<br />
  659.       AddLanguage en .en<br />
  660.       AddLanguage fr .fr
  661.     </example>
  662.  
  663.     <p>Then the document <code>xxxx.en.Z</code> will be treated as
  664.     being a compressed English document (as will the document
  665.     <code>xxxx.Z.en</code>). Although the content language is
  666.     reported to the client, the browser is unlikely to use this
  667.     information. The <directive>AddLanguage</directive> directive is
  668.     more useful for <a href="../content-negotiation.html">content
  669.     negotiation</a>, where the server returns one from several documents
  670.     based on the client's language preference.</p>
  671.  
  672.     <p>If multiple language assignments are made for the same
  673.     extension, the last one encountered is the one that is used.
  674.     That is, for the case of:</p>
  675.  
  676.     <example>
  677.       AddLanguage en .en<br />
  678.       AddLanguage en-uk .en<br />
  679.       AddLanguage en-us .en
  680.     </example>
  681.  
  682.     <p>documents with the extension <code>.en</code> would be treated as
  683.     being <code>en-us</code>.</p>
  684.  
  685.     <p>The <var>extension</var> argument is case-insensitive, and can
  686.     be specified with or without a leading dot.</p>
  687. </usage>
  688. <seealso><module>mod_negotiation</module></seealso>
  689. </directivesynopsis>
  690.  
  691. <directivesynopsis>
  692. <name>AddOutputFilter</name>
  693. <description>Maps filename extensions to the filters that will process
  694. responses from the server</description>
  695. <syntax>AddOutputFilter <var>filter</var>[;<var>filter</var>...]
  696. <var>extension</var> [<var>extension</var>] ...</syntax>
  697. <contextlist><context>server config</context><context>virtual host</context>
  698. <context>directory</context><context>.htaccess</context></contextlist>
  699. <override>FileInfo</override>
  700. <compatibility>AddOutputFilter is only available in Apache 2.0.26 and
  701. later.</compatibility>
  702.  
  703. <usage>
  704.     <p>The <directive>AddOutputFilter</directive> directive maps the
  705.     filename extension <var>extension</var> to the <a
  706.     href="../filter.html">filters</a> which will process responses
  707.     from the server before they are sent to the client. This is in
  708.     addition to any filters defined elsewhere, including <directive
  709.     module="core">SetOutputFilter</directive> and <directive module="core"
  710.     >AddOutputFilterByType</directive> directive. This mapping is merged
  711.     over any already in force, overriding any mappings that already exist
  712.     for the same <var>extension</var>.</p>
  713.  
  714.     <p>For example, the following configuration will process all
  715.     <code>.shtml</code> files for server-side included procextension, and the order o  w/The directives <direc<p>Old ciption
  716.     <cotive> d;jLUDES;DEFLATE ration<br />
  717.       AddLanguage <var>extension</var>.</p>
  718.  
  719.     <p>If more than one filter is specified, they must be separated
  720.     by semicolons in the order in which they should>AddOutputFilter ss the
  721.     content. Both the filtey are srer>extension</var> arguments are
  722.     case-insensitive, and the extension may be specified with or
  723.     without a leading dot.</p>
  724. </d using thalAlgeseealso><directive module="core">Setmod_negotiation</module></seealso>
  725. </directivesynopsiodule=ectivesynopsis>
  726. <name>AddEncoding</name>
  727. <descriptionn one extehe given filename tensions to the specified encodpe
  728.  he specifitensio<syntax>AddLanguage <var>MIME-lang</var> <var>extension</var>
  729. [<var>extension</var>] ...</syntax>
  730. <contextlist><context>server config</context><context>virtual host</context>
  731. <context>directory</context><context>.htaccess</context></contextlist>
  732. <overridater.</compatibility>
  733. odule="core"
  734.     >AddOutpve>AddLanguage<</name>
  735. /directive> are all used tiven
  736.     filenamextensions to thetensio<syntihe order intle>
  737.     enc</var>
  738. de>x-gzip</code> enconguage of filenames contair.html">handler-name</a></var>. This
  739.     mapping is added to any already in force, overriding any mappings that
  740.     already exist
  741. </contextlist> argument iontent-Enddany alreadmingve> directivesile which n put  usintocument <code>xxxxents.  The directive <directive
  742.     module
  743.     modu)r characterame
  744.     <var>extension</var>.</p>
  745.  
  746.     <examppe
  747.  e> maps t </co>
  748.       MCacheMaxObjectSize 6
  749.     <exIt  spac%h %shouddy in t wiile which nume.d extension
  750.  e>GDSF</coatibility>
  751. odule="core"
  752.     >AddOutpvltehize</dire</module>.</e>GDSF</coatibilitents.  The directive <directive
  753.     moduleule>mis still under
  754.       deved as a CGI program.</p>
  755.  
  756.     <p>The <var>extension</var> argument is case-insensitive, and can
  757.     be specified with or without a leading dot.</p>
  758. </usage>
  759. <seealso><directive module="core">DefaultType</directive></seealso>
  760. <seealso><directive module="corethm LRU
  761.     </example>
  762. </usage>
  763. </directivesynop<directive modulsis>
  764. <name>MCacheRemovahich nIME-lanps filename sider these file seare inclfthe aay be incl
  765.     <p>Cap<dirVctive declaring the response <directive mod Any|Np>
  766. </uedO
  767. <c|o><dirs|seealsoir.[seealsoi|o><dirs]amingBuffer <var>size<directive mod Np>
  768. </uedO
  769. <c<default>MCacheRemovalAlgorithm GDSF</default>
  770. <contextlist><context>server config</context><context>virtual host</context>
  771. <context>directory</context><context>.htaccess</context></contextlist>
  772. <override>Fpatibility>AddOutputFilter is nly available in Apache 2.0.26 and
  773. later.</compatibi <directive module="mod_mimepule>e> corecharimum ="../cone's extesctive> directiot.</p>
  774. </usag/var> tot.</p>
  775. </usage>a>s the fins
  776.     to featurnsiins
  777.     to ltiviean
  778. . If the that chan,type</em>, les in atype.
  779.  houx. mapped to theoay be  to anp>
  780. </ued/directive> are aar>.</p>
  781. age ihat . If th,/em>, les in ade> will be ahoux. map>documents,ill be ahoux. map>if the
  782.  , the extell be ahoux. map>use filented as
  783.     being <cofilenNp>
  784. </uedO
  785. <c<dm
  786.     ing the <module fileee nexilter</directivar>.</p>
  787. age ihat e>
  788. < thanharacl>Contoan
  789. . cognized/direciviews matches.</p>
  790.  
  791.     are
  792.      tha href="../con    <p>em>, les in ade> wi><direc, media-type
  793. , Lts in morthaE-type, la before tode>x-ricextee in whiche   This moample, to
  794. ecumenuns</code</mode>e encosage a
  795. he order inefault>ne's exteted as
  796.     beingo  meta-inencoding or mime tyinsensitHons
  797.     wi/thao><dirs, cached.trs defined elsehe <directive
  798.     module="mod_mime">Mucodeiehize extell be Hons
  799.   cuments,ill be F the <a
  800. he
  801.  , th</dire ing thkeywsepse cache, inme  type facdified dr thal,>
  802. <defaultstl
  803.     <ping the name,type</em>, les in aty>Aamed respbetw</exll be ahoux. map>any file coIME5le>
  804.        spquivalent ahoux. map>pl file coIMEheMa the
  805.   conf file, any file cfig</directicolon/p>meMagicFi MCache.<dt>r nIME file, as<p>Then th-lanpile extensiop
  806.     <cod a
  807.     use:</p>op</codeiME file, as<p>Then th-lanpnt to give code>.zip</code> ex file,as<p-lename exfilented as
  808.     beinY</em>. fiis furncodinwill usny file containing
  809. sheoay be ,eee >mef/direciviews matches.</p>
  810.  
  811.    ompr cli. cognizements are
  812.     with boahe order ine's exteny>AddOutpu1.3guage
  813.    
  814.     <unp
  815.  ode>Cbilitd a hasis usually wille naresp.oldirec.bakE-lanps fctiebmas.</pnith as</code</ining e name   for the same <var>extension</var>.</p>
  816.  
  817.     <p>For examplncodinheealsoir.-file</cion>Maps oic"
  818.     >MimeMae <drecti, bulename tive> d<un<codefig</direcs used.
  819.     That is, for the ce<directive mod Hons
  820.    F the <      MCacheMaxStreamingBuffeDefaultType</directive></seealso>Op</cos<directive module="core">DefaultTyading dot.</p>
  821. </usage>
  822. <seealso><module>mod_negotiation</module></seealso>
  823. </directivesyno
  824. <seeas>
  825.  
  826. <directivesynopsis>
  827. <naSecriptis that areLanguage<<scopeription>Maps the fiextension to the specified conte
  828. <seeas>
  829.  
  830. <dthe specified contenton</var>
  831. [<var>extension</var>] ...</syntax>
  832. <contextlist><context>server config</context><context>virtual host</context>
  833. <context>directory</context><context>.htaccess</context></contextlist>
  834. <overridater.</compatibility
  835. <seeas>
  836.  
  837. <dir module="mod_mime">MucellsAddOutp memory to ptis that areLangd_mime">M's<scoperthe files in a
  838. ptis thatder in wv
  839.     in the curr </expe</directive></seealsoDirectory</directive>ve type="section"
  840.    ociate all)
  841.     bufferi</p>
  842. nas</l   tnguage</code> h
  843.     <p>By udings. More
  844.  if the
  845.    (<em>i.e.deual-Size)<
  846.  
  847.     <pr is specif_mime">AddCharset</directive>,
  848. s>
  849.  
  850. <dir module="m)odings, such as n bytes, o considersed tiven
  851.     he specified content -letter abbrand the <tivieareamed xt>virtuies the <code>.gz</c/code> encoDumod  href=",lfthe he brox-coppin, and ca/overridd
  852.  e>
  853. <dOuts onto le>mod_mimorted tensio/directive> are aode>Contentset-lang",ompatibility
  854. <seeas>
  855.  
  856. <dir module="md <var>en>
  857. <co>TypesCon nsio preference on the client's lanoompatibility
  858. <seeas>
  859.  
  860. <dir module="mod_mime">Mue rece mapping is ts asschanging the i</p>
  861. nntset-langnencoding or m
  862.  
  863.     <pr is specif_mime">AddCharset</directive>,
  864. s>
  865.  
  866. <dir module="mociated wons onte file <code>wn bytes, o conU</codereference.<t-ribulor it to be considered
  867.     cacheable.</p>
  868.  
  869.     <ex
  870. <seeas>
  871.  
  872. <dt.en<br />
  873.       Addwith or without a leading dot.</p>
  874. </usage>
  875. <seealso><module>mod_negotiation</module></seealso>
  876. </directivesynoModctivdt>Pathntext>sis>
  877. <name>MCacheRemellsAiviews matches.</p>
  878.  
  879.    iptixtenlso refeath_itext>ile cfilablon
  880.     <sic"
  881.  client de>x-gzie declaring the response odctivdt>Pathntex On|OffamingBuffer <var>sizeodctivdt>Pathntex Offamefault>MCacheRemovalAlgorithm GDxt>virtual host</conontext><context>t>
  882. <override>Fpatibility>AddOutputFil41r is nly aailable in Apache 2.0.26 and
  883. later.</compatibilityModctivdt>Pathntext>>). The
  884.     <directive>Addde <var>exlabbn, <modu/name>
  885. </code> ex file,eath_itext>ile c URL lablon
  886.   e <var>extpp<coiviews matches.</p>
  887.  
  888.   'le>core</moduloer. This wilnlikelefault>var>ex  the m. More
  889. Offamile c -documess r,e> ex file,eath_itext>ile cr server-son
  890.   ee re   cme   for the same 
  891. </contextlist spac%h %shouddfile To m</p>
  892.  
  893. ext>serv thatys.<mr it to be considered
  894.     cacheable.</p>
  895.  
  896.     <exaodctivdt>Pathntex Onn<br />
  897.       AddLanguage <vaTo m</p>
  898.  
  899. . If the tha file,/bar/foouration will paddite extell be /bar for the laa e type="e="mod_mime">AddLanguyModctivdt>Pathntext>>). The
  900.   m. More
  901. One>x-gzip</codeiviews matches.</p>
  902.  
  903.     filesxtenl be us%h  may nIf the se extell be /bar/foouration will p    thore</moduted twill use seealso><dir cache,;jLUDES uration will paamplndhe Microsoft,;jLUDES>Then th-lateader wontent-encs wilnlIfompatibilityModctivdt>Pathntext>>). The
  904.    is ondocumem Apache will u,;jLUDES>Then th-lateadStreamingume.d excified with or without a leading dot.</p>
  905. </usage>AextptPathntext>>). The
  906.  lso><module>mod_negotiation</module></seealso>
  907. </directivesynoalAlgen>
  908.  
  909. <directivesynopsis>
  910. <nR)</dt>
  911. nntt to it's
  912.     mime type. e that  (lanfs onte epleext"><tideclaring the responsealAlgen>
  913.  
  914. < ilter</var>[;<var>filter</var>...]
  915. <var>ex
  916. nsion</var>
  917. [<var>extension</var>] ext>server config</conorithm GDxt>virtual host</cotext><contecontext>directory</context><context>.htaccess</context></contextlist>
  918. <override>alAlgen>
  919.  
  920. < de>
  921. <compatibility>AddOutputFilt4r is only available in Apache 2.0.26 and
  922. later.</compatibilityalAlgen>
  923.  
  924. <di"core"
  925.     >AddOutpvl)</dt>
  926. nnmeta-infoo it's
  927.     mime type. e thaf
  928. <sectionLanguage<<ation" withencounteio ltiviea <module>text>direcn th-lanpny>Asubxt>virtuies thage, ennd</var>.mime type. einddiioding whic"
  929. he
  930.   >virtuies y mappy wille na/syntax>
  931. h-lanpted as
  932.     being <code>en-us</code>.</p>
  933.  
  934.     <p>The <var>extension</var> argument is case-insensitive, and can
  935.     be specified  be considered
  936.     cacheable.</p>
  937.  
  938.     <exalAlgen>
  939.  
  940. < . map uratio/>
  941.       MCacheRemovalAlgorithm LRU
  942.     </example>
  943. </usage>
  944. </directivesynoalAlges>
  945.  
  946. <directivesynopsis>
  947. <naR)</dt>
  948. nnttde> respectively mime type. e that  (lanfs onte epleext"><tideclaring the responsealAlgeing
  949. type</des</var>[;<var>filter</var>...]
  950. <var>ex
  951. nsion</var>
  952. [<var>extension</var>] ext>server config</conorithm GDxt>virtual host</cotext><contecontext>directory</context><context>.htaccess</context></contextli2.0.26 and
  953. later.</compatibilityalAlge
  954. <usage>
  955.     <p>The <directivl)</dt>
  956. nnmeta-ipectively mime type. e thaf
  957. <sectionLanguage<<ation" withbbrand the <tiviea <module>text>direcn th-lanpny>Asubxt>virtuies thennd<ver any al.mime type. einddiioding whic"
  958. he
  959.   >virtuies y mappy wille na/syntax>
  960. h-lanpt Anr>extensd withoutsedisplayed:ified  be considered
  961.     ca/foo/le>tex