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 / F278335_mod_mime.xml < prev    next >
Extensible Markup Language  |  2004-09-04  |  41KB  |  900 lines

  1. <?xml version="1.0"?>
  2. <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
  3. <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
  4. <!-- $Revision: 1.18.2.9 $ -->
  5.  
  6. <!--
  7.  Copyright 2002-2004 The Apache Software Foundation
  8.  
  9.  Licensed under the Apache License, Version 2.0 (the "License");
  10.  you may not use this file except in compliance with the License.
  11.  You may obtain a copy of the License at
  12.  
  13.      http://www.apache.org/licenses/LICENSE-2.0
  14.  
  15.  Unless required by applicable law or agreed to in writing, software
  16.  distributed under the License is distributed on an "AS IS" BASIS,
  17.  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18.  See the License for the specific language governing permissions and
  19.  limitations under the License.
  20. -->
  21.  
  22. <modulesynopsis metafile="mod_mime.xml.meta">
  23.  
  24. <name>mod_mime</name>
  25. <description>Associates the requested filename's extensions
  26.     with the file's behavior (handlers and filters)
  27.     and content (mime-type, language, character set and
  28.     encoding)</description>
  29. <status>Base</status>
  30. <sourcefile>mod_mime.c</sourcefile>
  31. <identifier>mime_module</identifier>
  32.  
  33. <summary>
  34.     <p>This module is used to associate various bits of "meta
  35.     information" with files by their filename extensions. This
  36.     information relates the filename of the document to it's
  37.     mime-type, language, character set and encoding. This
  38.     information is sent to the browser, and participates in content
  39.     negotiation, so the user's preferences are respected when
  40.     choosing one of several possible files to serve. See
  41.     <module>mod_negotiation</module> for more information
  42.     about <a href="../content-negotiation.html">content negotiation</a>.</p>
  43.  
  44.     <p>The directives <directive
  45.     module="mod_mime">AddCharset</directive>, <directive
  46.     module="mod_mime">AddEncoding</directive>, <directive
  47.     module="mod_mime">AddLanguage</directive> and <directive
  48.     module="mod_mime">AddType</directive> are all used to map file
  49.     extensions onto the meta-information for that file. Respectively
  50.     they set the character set, content-encoding, content-language,
  51.     and MIME-type (content-type) of documents.  The directive <directive
  52.     module="mod_mime">TypesConfig</directive> is used to specify a
  53.     file which also maps extensions onto MIME types. </p>
  54.  
  55.     <p>In addition, <module>mod_mime</module> may define the <a
  56.     href="../handler.html">handler</a> and <a
  57.     href="../filter.html">filters</a> that originate and process
  58.     content.  The directives <directive
  59.     module="mod_mime">AddHandler</directive>, <directive
  60.     module="mod_mime">AddOutputFilter</directive>, and <directive
  61.     module="mod_mime">AddInputFilter</directive> control the modules
  62.     or scripts that serve the document.  The <directive
  63.     module="mod_mime">MultiviewsMatch</directive> directive allows
  64.     <module>mod_negotiation</module> to consider these file extensions
  65.     to be included when testing Multiviews matches.</p>
  66.  
  67.     <p>While <module>mod_mime</module> associates meta-information
  68.     with filename extensions, the <module>core</module> server
  69.     provides directives that are used to associate all the files in a
  70.     given container (<em>e.g.</em>, <directive type="section"
  71.     module="core">Location</directive>, <directive type="section"
  72.     module="core">Directory</directive>, or <directive type="section"
  73.     module="core">Files</directive>) with particular
  74.     meta-information. These directives include <directive
  75.     module="core">ForceType</directive>, <directive
  76.     module="core">SetHandler</directive>, <directive
  77.     module="core">SetInputFilter</directive>, and <directive
  78.     module="core">SetOutputFilter</directive>.  The core directives
  79.     override any filename extension mappings defined in
  80.     <module>mod_mime</module>.</p>
  81.  
  82.     <p>Note that changing the meta-information for a file does not
  83.     change the value of the <code>Last-Modified</code> header.
  84.     Thus, previously cached copies may still be used by a client or
  85.     proxy, with the previous headers. If you change the
  86.     meta-information (language, content type, character set or
  87.     encoding) you may need to 'touch' affected files (updating
  88.     their last modified date) to ensure that all visitors are
  89.     receive the corrected content headers.</p>
  90. </summary>
  91. <seealso><directive
  92. module="mod_mime_magic">MimeMagicFile</directive></seealso>
  93. <seealso><directive module="core">AddDefaultCharset</directive></seealso>
  94. <seealso><directive module="core">ForceType</directive></seealso>
  95. <seealso><directive module="core">DefaultType</directive></seealso>
  96. <seealso><directive module="core">SetHandler</directive></seealso>
  97. <seealso><directive module="core">SetInputFilter</directive></seealso>
  98. <seealso><directive module="core">SetOutputFilter</directive></seealso>
  99.  
  100. <section id="multipleext"><title>Files with Multiple Extensions</title>
  101.     <p>Files can have more than one extension, and the order of the
  102.     extensions is <em>normally</em> irrelevant. For example, if the
  103.     file <code>welcome.html.fr</code> maps onto content type
  104.     <code>text/html</code> and language French then the file
  105.     <code>welcome.fr.html</code> will map onto exactly the same information.
  106.     If more than one extension is given which maps onto the same
  107.     type of meta-information, then the one to the right will be
  108.     used, except for languages and content encodings. For example, if
  109.     <code>.gif</code> maps to the MIME-type <code>image/gif</code> and
  110.     <code>.html</code> maps to the MIME-type <code>text/html</code>, then the
  111.     file <code>welcome.gif.html</code> will be associated with the MIME-type
  112.     <code>text/html</code>.</p>
  113.  
  114.     <p><a href="#charset-lang">Languages</a> and <a href="#contentencoding"
  115.     >content encodings</a> are treated accumulative, because one can assign
  116.     more than one language or encoding to a particular ressource. For example,
  117.     the file <code>welcome.html.en.de</code> will be delivered with
  118.     <code>Content-Language: en, de</code> and <code>Content-Type:
  119.     text/html</code>.</p>
  120.  
  121.     <p>Care should be taken when a file with multiple extensions
  122.     gets associated with both a MIME-type and a handler. This will
  123.     usually result in the request being by the module associated
  124.     with the handler. For example, if the <code>.imap</code>
  125.     extension is mapped to the handler <code>imap-file</code> (from
  126.     <module>mod_imap</module>) and the <code>.html</code> extension is
  127.     mapped to the MIME-type <code>text/html</code>, then the file
  128.     <code>world.imap.html</code> will be associated with both the
  129.     <code>imap-file</code> handler and <code>text/html</code> MIME-type.
  130.     When it is processed, the <code>imap-file</code> handler will be used,
  131.     and so it will be treated as a <module>mod_imap</module> imagemap
  132.     file.</p>
  133. </section>
  134.  
  135. <section id="contentencoding"><title>Content encoding</title>
  136.     <p>A file of a particular MIME type can additionally be encoded a
  137.     particular way to simplify transmission over the Internet.
  138.     While this usually will refer to compression, such as
  139.     <code>gzip</code>, it can also refer to encryption, such a
  140.     <code>pgp</code> or to an encoding such as UUencoding, which is
  141.     designed for transmitting a binary file in an ASCII (text)
  142.     format.</p>
  143.  
  144.     <p>The <a href="http://www.ietf.org/rfc/rfc2616.txt">HTTP/1.1
  145.     RFC</a>, section 14.11 puts it this way:</p>
  146.  
  147.     <blockquote cite="http://www.ietf.org/rfc/rfc2616.txt">
  148.       <p>The Content-Encoding entity-header field is used as a modifier to
  149.       the media-type. When present, its value indicates what additional
  150.       content codings have been applied to the entity-body, and thus what
  151.       decoding mechanisms must be applied in order to obtain the media-type
  152.       referenced by the Content-Type header field. Content-Encoding is
  153.       primarily used to allow a document to be compressed without losing
  154.       the identity of its underlying media type.</p>
  155.     </blockquote>
  156.  
  157.     <p>By using more than one file extension (see <a
  158.     href="#multipleext">section above about multiple file
  159.     extensions</a>), you can indicate that a file is of a
  160.     particular <em>type</em>, and also has a particular
  161.     <em>encoding</em>. </p>
  162.  
  163.     <p>For example, you may have a file which is a Microsoft Word
  164.     document, which is pkzipped to reduce its size. If the
  165.     <code>.doc</code> extension is associated with the Microsoft
  166.     Word file type, and the <code>.zip</code> extension is
  167.     associated with the pkzip file encoding, then the file
  168.     <code>Resume.doc.zip</code> would be known to be a pkzip'ed Word
  169.     document.</p>
  170.  
  171.     <p>Apache sends a <code>Content-encoding</code> header with the
  172.     resource, in order to tell the client browser about the
  173.     encoding method.</p>
  174.  
  175.     <example>Content-encoding: pkzip</example>
  176. </section>
  177.  
  178. <section id="charset-lang"><title>Character sets and languages</title>
  179.     <p>In addition to file type and the file encoding,
  180.     another important piece of information is what language a
  181.     particular document is in, and in what character set the file
  182.     should be displayed. For example, the document might be written
  183.     in the Vietnamese alphabet, or in Cyrillic, and should be
  184.     displayed as such. This information, also, is transmitted in
  185.     HTTP headers.</p>
  186.  
  187.     <p>The character set, language, encoding and mime type are all 
  188.     used in the process of content negotiation (See 
  189.     <module>mod_negotiation</module>) to determine
  190.     which document to give to the client, when there are
  191.     alternative documents in more than one character set, language, 
  192.     encoding or mime type. All filename extensions associations
  193.     created with <directive module="mod_mime">AddCharset</directive>,
  194.     <directive module="mod_mime">AddEncoding</directive>, <directive
  195.     module="mod_mime">AddLanguage</directive> and <directive
  196.     module="mod_mime">AddType</directive> directives
  197.     (and extensions listed in the <directive module="mod_mime_magic"
  198.     >MimeMagicFile</directive>) participate in this select process.
  199.     Filename extensions that are only associated using the <directive
  200.     module="mod_mime">AddHandler</directive>, <directive module="mod_mime"
  201.     >AddInputFilter</directive> or <directive module="mod_mime"
  202.     >AddOutputFilter</directive> directives may be included or excluded
  203.     from matching by using the <directive module="mod_mime"
  204.     >MultiviewsMatch</directive> directive.</p>
  205.  
  206.     <section id="charset"><title>Charset</title>
  207.       <p>To convey this further information, Apache optionally sends
  208.       a <code>Content-Language</code> header, to specify the language
  209.       that the document is in, and can append additional information
  210.       onto the <code>Content-Type</code> header to indicate the
  211.       particular character set that should be used to correctly
  212.       render the information.</p>
  213.  
  214.       <example>
  215.         Content-Language: en, fr<br />
  216.     Content-Type: text/plain; charset=ISO-8859-1
  217.       </example>
  218.  
  219.       <p>The language specification is the two-letter abbreviation
  220.       for the language. The <code>charset</code> is the name of the
  221.       particular character set which should be used.</p>
  222.     </section>
  223. </section>
  224.  
  225. <directivesynopsis>
  226. <name>AddCharset</name>
  227. <description>Maps the given filename extensions to the specified content
  228. charset</description>
  229. <syntax>AddCharset <var>charset</var> <var>extension</var>
  230. [<var>extension</var>] ...</syntax>
  231. <contextlist><context>server config</context><context>virtual host</context>
  232. <context>directory</context><context>.htaccess</context></contextlist>
  233. <override>FileInfo</override>
  234.  
  235. <usage>
  236.     <p>The <directive>AddCharset</directive> directive maps the given
  237.     filename extensions to the specified content charset. <var>charset</var>
  238.     is the MIME charset parameter of filenames containing
  239.     <var>extension</var>. This mapping is added to any already in force,
  240.     overriding any mappings that already exist for the same
  241.     <var>extension</var>.</p>
  242.  
  243.     <example><title>Example</title>
  244.       AddLanguage ja .ja<br />
  245.       AddCharset EUC-JP .euc<br />
  246.       AddCharset ISO-2022-JP .jis<br />
  247.       AddCharset SHIFT_JIS .sjis
  248.     </example>
  249.  
  250.     <p>Then the document <code>xxxx.ja.jis</code> will be treated
  251.     as being a Japanese document whose charset is <code>ISO-2022-JP</code>
  252.     (as will the document <code>xxxx.jis.ja</code>). The
  253.     <directive>AddCharset</directive> directive is useful for both to
  254.     inform the client about the character encoding of the document so that
  255.     the document can be interpreted and displayed appropriately, and for <a
  256.     href="../content-negotiation.html">content negotiation</a>,
  257.     where the server returns one from several documents based on
  258.     the client's charset preference.</p>
  259.  
  260.     <p>The <var>extension</var> argument is case-insensitive, and can
  261.     be specified with or without a leading dot.</p>
  262. </usage>
  263. <seealso><module>mod_negotiation</module></seealso>
  264. <seealso><directive module="core">AddDefaultCharset</directive></seealso>
  265. </directivesynopsis>
  266.  
  267. <directivesynopsis>
  268. <name>AddEncoding</name>
  269. <description>Maps the given filename extensions to the specified encoding
  270. type</description>
  271. <syntax>AddEncoding <var>MIME-enc</var> <var>extension</var>
  272. [<var>extension</var>] ...</syntax>
  273. <contextlist><context>server config</context><context>virtual host</context>
  274. <context>directory</context><context>.htaccess</context></contextlist>
  275. <override>FileInfo</override>
  276.  
  277. <usage>
  278.     <p>The <directive>AddEncoding</directive> directive maps the given
  279.     filename extensions to the specified encoding type. <var>MIME-enc</var>
  280.     is the MIME encoding to use for documents containing the
  281.     <var>extension</var>. This mapping is added to any already in force,
  282.     overriding any mappings that already exist for the same
  283.     <var>extension</var>.</p>
  284.  
  285.     <example><title>Example</title>
  286.       AddEncoding x-gzip .gz<br />
  287.       AddEncoding x-compress .Z
  288.     </example>
  289.  
  290.     <p>This will cause filenames containing the <code>.gz</code> extension
  291.     to be marked as encoded using the <code>x-gzip</code> encoding, and
  292.     filenames containing the <code>.Z</code> extension to be marked as
  293.     encoded with <code>x-compress</code>.</p>
  294.  
  295.     <p>Old clients expect <code>x-gzip</code> and <code>x-compress</code>,
  296.     however the standard dictates that they're equivalent to
  297.     <code>gzip</code> and <code>compress</code> respectively. Apache does
  298.     content encoding comparisons by ignoring any leading <code>x-</code>.
  299.     When responding with an encoding Apache will use whatever form
  300.     (<em>i.e.</em>, <code>x-foo</code> or <code>foo</code>) the
  301.     client requested. If the client didn't specifically request a
  302.     particular form Apache will use the form given by the
  303.     <code>AddEncoding</code> directive. To make this long story
  304.     short, you should always use <code>x-gzip</code> and
  305.     <code>x-compress</code> for these two specific encodings. More
  306.     recent encodings, such as <code>deflate</code> should be
  307.     specified without the <code>x-</code>.</p>
  308.  
  309.     <p>The <var>extension</var> argument is case-insensitive, and can
  310.     be specified with or without a leading dot.</p>
  311. </usage>
  312. </directivesynopsis>
  313.  
  314. <directivesynopsis>
  315. <name>AddHandler</name>
  316. <description>Maps the filename extensions to the specified
  317. handler</description>
  318. <syntax>AddHandler <var>handler-name</var> <var>extension</var>
  319. [<var>extension</var>] ...</syntax>
  320. <contextlist><context>server config</context><context>virtual host</context>
  321. <context>directory</context><context>.htaccess</context></contextlist>
  322. <override>FileInfo</override>
  323.  
  324. <usage>
  325.     <p>Files having the name <var>extension</var> will be served by the
  326.     specified <var><a href="../handler.html">handler-name</a></var>. This
  327.     mapping is added to any already in force, overriding any mappings that
  328.     already exist for the same <var>extension</var>. For example, to
  329.     activate CGI scripts with the file extension <code>.cgi</code>, you
  330.     might use:</p>
  331.  
  332.     <example>
  333.       AddHandler cgi-script .cgi
  334.     </example>
  335.  
  336.     <p>Once that has been put into your httpd.conf file, any file containing
  337.     the <code>.cgi</code> extension will be treated as a CGI program.</p>
  338.  
  339.     <p>The <var>extension</var> argument is case-insensitive, and can
  340.     be specified with or without a leading dot.</p>
  341. </usage>
  342. <seealso><directive module="core">SetHandler</directive></seealso>
  343. </directivesynopsis>
  344.  
  345. <directivesynopsis>
  346. <name>AddInputFilter</name>
  347. <description>Maps filename extensions to the filters that will process
  348. client requests</description>
  349. <syntax>AddInputFilter <var>filter</var>[;<var>filter</var>...]
  350. <var>extension</var> [<var>extension</var>] ...</syntax>
  351. <contextlist><context>server config</context><context>virtual host</context>
  352. <context>directory</context><context>.htaccess</context></contextlist>
  353. <override>FileInfo</override>
  354. <compatibility>AddInputFilter is only available in Apache 2.0.26 and
  355. later.</compatibility>
  356.  
  357. <usage>
  358.     <p><directive>AddInputFilter</directive> maps the filename extension
  359.     <var>extension</var> to the <a href="../filter.html">filters</a> which
  360.     will process client requests and POST input when they are received by
  361.     the server. This is in addition to any filters defined elsewhere,
  362.     including the <directive module="core">SetInputFilter</directive>
  363.     directive. This mapping is merged over any already in force, overriding
  364.     any mappings that already exist for the same <var>extension</var>.</p>
  365.  
  366.     <p>If more than one filter is specified, they must be separated
  367.     by semicolons in the order in which they should process the
  368.     content. Both the filter and <var>extension</var> arguments are
  369.     case-insensitive, and the extension may be specified with or
  370.     without a leading dot.</p>
  371. </usage>
  372. <seealso><directive module="mod_mime">RemoveInputFilter</directive></seealso>
  373. <seealso><directive module="core">SetInputFilter</directive></seealso>
  374. </directivesynopsis>
  375.  
  376. <directivesynopsis>
  377. <name>AddLanguage</name>
  378. <description>Maps the given filename extension to the specified content
  379. language</description>
  380. <syntax>AddLanguage <var>MIME-lang</var> <var>extension</var>
  381. [<var>extension</var>] ...</syntax>
  382. <contextlist><context>server config</context><context>virtual host</context>
  383. <context>directory</context><context>.htaccess</context></contextlist>
  384. <override>FileInfo</override>
  385.  
  386. <usage>
  387.     <p>The <directive>AddLanguage</directive> directive maps the given
  388.     filename extension to the specified content language.
  389.     <var>MIME-lang</var> is the MIME language of filenames containing
  390.     <var>extension</var>. This mapping is added to any already in force,
  391.     overriding any mappings that already exist for the same
  392.     <var>extension</var>.</p>
  393.  
  394.     <example><title>Example</title>
  395.       AddEncoding x-compress .Z<br />
  396.       AddLanguage en .en<br />
  397.       AddLanguage fr .fr
  398.     </example>
  399.  
  400.     <p>Then the document <code>xxxx.en.Z</code> will be treated as
  401.     being a compressed English document (as will the document
  402.     <code>xxxx.Z.en</code>). Although the content language is
  403.     reported to the client, the browser is unlikely to use this
  404.     information. The <directive>AddLanguage</directive> directive is
  405.     more useful for <a href="../content-negotiation.html">content
  406.     negotiation</a>, where the server returns one from several documents
  407.     based on the client's language preference.</p>
  408.  
  409.     <p>If multiple language assignments are made for the same
  410.     extension, the last one encountered is the one that is used.
  411.     That is, for the case of:</p>
  412.  
  413.     <example>
  414.       AddLanguage en .en<br />
  415.       AddLanguage en-gb .en<br />
  416.       AddLanguage en-us .en
  417.     </example>
  418.  
  419.     <p>documents with the extension <code>.en</code> would be treated as
  420.     being <code>en-us</code>.</p>
  421.  
  422.     <p>The <var>extension</var> argument is case-insensitive, and can
  423.     be specified with or without a leading dot.</p>
  424. </usage>
  425. <seealso><module>mod_negotiation</module></seealso>
  426. </directivesynopsis>
  427.  
  428. <directivesynopsis>
  429. <name>AddOutputFilter</name>
  430. <description>Maps filename extensions to the filters that will process
  431. responses from the server</description>
  432. <syntax>AddOutputFilter <var>filter</var>[;<var>filter</var>...]
  433. <var>extension</var> [<var>extension</var>] ...</syntax>
  434. <contextlist><context>server config</context><context>virtual host</context>
  435. <context>directory</context><context>.htaccess</context></contextlist>
  436. <override>FileInfo</override>
  437. <compatibility>AddOutputFilter is only available in Apache 2.0.26 and
  438. later.</compatibility>
  439.  
  440. <usage>
  441.     <p>The <directive>AddOutputFilter</directive> directive maps the
  442.     filename extension <var>extension</var> to the <a
  443.     href="../filter.html">filters</a> which will process responses
  444.     from the server before they are sent to the client. This is in
  445.     addition to any filters defined elsewhere, including <directive
  446.     module="core">SetOutputFilter</directive> and <directive module="core"
  447.     >AddOutputFilterByType</directive> directive. This mapping is merged
  448.     over any already in force, overriding any mappings that already exist
  449.     for the same <var>extension</var>.</p>
  450.  
  451.     <p>For example, the following configuration will process all
  452.     <code>.shtml</code> files for server-side includes and will then
  453.     compress the output using <module>mod_deflate</module>.</p>
  454.  
  455.     <example>
  456.       AddOutputFilter INCLUDES;DEFLATE shtml
  457.     </example>
  458.  
  459.     <p>If more than one filter is specified, they must be separated
  460.     by semicolons in the order in which they should process the
  461.     content. Both the <var>filter</var> and <var>extension</var> arguments
  462.     are case-insensitive, and the extension may be specified with or
  463.     without a leading dot.</p>
  464. </usage>
  465. <seealso><directive module="mod_mime">RemoveOutputFilter</directive></seealso>
  466. <seealso><directive module="core">SetOutputFilter</directive></seealso>
  467. </directivesynopsis>
  468.  
  469. <directivesynopsis>
  470. <name>AddType</name>
  471. <description>Maps the given filename extensions onto the specified content
  472. type</description>
  473. <syntax>AddType <var>MIME-type</var> <var>extension</var>
  474. [<var>extension</var>] ...</syntax>
  475. <contextlist><context>server config</context><context>virtual host</context>
  476. <context>directory</context><context>.htaccess</context></contextlist>
  477. <override>FileInfo</override>
  478.  
  479. <usage>
  480.     <p>The <directive>AddType</directive> directive maps the given filename
  481.     extensions onto the specified content type. <var>MIME-type</var> is the
  482.     MIME type to use for filenames containing <var>extension</var>. This
  483.     mapping is added to any already in force, overriding any mappings that
  484.     already exist for the same <var>extension</var>. This directive can
  485.     be used to add mappings not listed in the MIME types file (see the
  486.     <directive module="mod_mime">TypesConfig</directive> directive).</p>
  487.     
  488.     <example><title>Example</title>
  489.       AddType image/gif .gif
  490.     </example>
  491.  
  492.     <note>
  493.       It is recommended that new MIME types be added using the
  494.       <directive>AddType</directive> directive rather than changing the 
  495.       <directive module="mod_mime">TypesConfig</directive> file.
  496.     </note>
  497.  
  498.     <p>The <var>extension</var> argument is case-insensitive, and can
  499.     be specified with or without a leading dot.</p>
  500. </usage>
  501. <seealso><directive module="core">DefaultType</directive></seealso>
  502. <seealso><directive module="core">ForceType</directive></seealso>
  503. </directivesynopsis>
  504.  
  505. <directivesynopsis>
  506. <name>MultiviewsMatch</name>
  507. <description>The types of files that will be included when searching for
  508. a matching file with MultiViews</description>
  509. <syntax>MultiviewsMatch Any|NegotiatedOnly|Filters|Handlers
  510. [Handlers|Filters]</syntax>
  511. <default>MultiviewsMatch NegotiatedOnly</default>
  512. <contextlist><context>server config</context><context>virtual host</context>
  513. <context>directory</context><context>.htaccess</context></contextlist>
  514. <override>FileInfo</override>
  515. <compatibility>Available in Apache 2.0.26 and later.</compatibility>
  516.  
  517. <usage>
  518.     <p><directive>MultiviewsMatch</directive> permits three different
  519.     behaviors for <a href="mod_negotiation.html">mod_negotiation</a>'s
  520.     Multiviews feature.  Multiviews allows a request for a file,
  521.     <em>e.g.</em> <code>index.html</code>, to match any negotiated
  522.     extensions following the base request, <em>e.g.</em>
  523.     <code>index.html.en</code>, <code>index.html.fr</code>, or
  524.     <code>index.html.gz</code>.</p>
  525.  
  526.     <p>The <code>NegotiatedOnly</code> option provides that every extension
  527.     following the base name must correlate to a recognized
  528.     <module>mod_mime</module> extension for content negotation, <em>e.g.</em>
  529.     Charset, Content-Type, Language, or Encoding.  This is the strictest
  530.     implementation with the fewest unexpected side effects, and is the
  531.     default behavior.</p>
  532.  
  533.     <p>To include extensions associated with Handlers and/or Filters,
  534.     set the <directive>MultiviewsMatch</directive> directive to either
  535.     <code>Handlers</code>, <code>Filters</code>, or both option keywords.
  536.     If all other factors are equal, the smallest file will be served,
  537.     <em>e.g.</em> in deciding between <code>index.html.cgi</code> of 500
  538.     bytes and <code>index.html.pl</code> of 1000 bytes, the <code>.cgi</code>
  539.     file would win in this example. Users of <code>.asis</code> files
  540.     might prefer to use the Handler option, if <code>.asis</code> files are
  541.     associated with the <code>asis-handler</code>.</p>
  542.  
  543.     <p>You may finally allow <code>Any</code> extensions to match, even if
  544.     <module>mod_mime</module> doesn't recognize the extension. This was the
  545.     behavior in Apache 1.3, and can cause unpredicatable results, such as
  546.     serving .old or .bak files the webmaster never expected to be served.</p>
  547.  
  548.     <p>For example, the following configuration will allow handlers
  549.     and filters to participate in Multviews, but will exclude unknown
  550.     files:</p>
  551.  
  552.     <example>
  553.       MultiviewsMatch Handlers Filters
  554.     </example>
  555. </usage>
  556. <seealso><directive module="core">Options</directive></seealso>
  557. <seealso><module>mod_negotiation</module></seealso>
  558. </directivesynopsis>
  559.  
  560. <directivesynopsis>
  561. <name>DefaultLanguage</name>
  562. <description>Sets all files in the given scope to the specified
  563. language</description>
  564. <syntax>DefaultLanguage <var>MIME-lang</var></syntax>
  565. <contextlist><context>server config</context><context>virtual host</context>
  566. <context>directory</context><context>.htaccess</context></contextlist>
  567. <override>FileInfo</override>
  568.  
  569. <usage>
  570.     <p>The <directive>DefaultLanguage</directive> directive tells Apache
  571.     that all files in the directive's scope (<em>e.g.</em>, all files
  572.     covered by the current <directive module="core" type="section"
  573.     >Directory</directive> container) that don't have an explicit language
  574.     extension (such as <code>.fr</code> or <code>.de</code> as configured
  575.     by <directive module="mod_mime">AddLanguage</directive>) should be
  576.     considered to be in the specified <var>MIME-lang</var> language. This
  577.     allows entire directories to be marked as containing Dutch content, for
  578.     instance, without having to rename each file. Note that unlike using
  579.     extensions to specify languages, <directive>DefaultLanguage</directive>
  580.     can only specify a single language.</p>
  581.  
  582.     <p>If no <directive>DefaultLanguage</directive> directive is in force,
  583.     and a file does not have any language extensions as configured
  584.     by <directive module="mod_mime">AddLanguage</directive>, then that file
  585.     will be considered to have no language attribute.</p>
  586.  
  587.     <example><title>Example</title>
  588.       DefaultLanguage en
  589.     </example>
  590. </usage>
  591. <seealso><module>mod_negotiation</module></seealso>
  592. </directivesynopsis>
  593.  
  594. <directivesynopsis>
  595. <name>ModMimeUsePathInfo</name>
  596. <description>Tells <module>mod_mime</module> to treat <code>path_info</code>
  597. components as part of the filename</description>
  598. <syntax>ModMimeUsePathInfo On|Off</syntax>
  599. <default>ModMimeUsePathInfo Off</default>
  600. <contextlist><context>directory</context></contextlist>
  601. <compatibility>Available in Apache 2.0.41 and later</compatibility>
  602.  
  603. <usage>
  604.     <p>The <directive>ModMimeUsePathInfo</directive> directive is used to
  605.     combine the filename with the <code>path_info</code> URL component to
  606.     apply <module>mod_mime</module>'s directives to the request. The default
  607.     value is <code>Off</code> - therefore, the <code>path_info</code>
  608.     component is ignored.</p>
  609.  
  610.     <p>This directive is recommended when you have a virtual filesystem.</p>
  611.  
  612.     <example><title>Example</title>
  613.       ModMimeUsePathInfo On
  614.     </example>
  615.  
  616.     <p>If you have a request for <code>/bar/foo.shtml</code> where
  617.     <code>/bar</code> is a Location and <directive
  618.     >ModMimeUsePathInfo</directive> is <code>On</code>,
  619.     <module>mod_mime</module> will treat the incoming request as
  620.     <code>/bar/foo.shtml</code> and directives like <code>AddOutputFilter
  621.     INCLUDES .shtml</code> will add the <code>INCLUDES</code> filter to the
  622.     request. If <directive>ModMimeUsePathInfo</directive> is not set, the
  623.     <code>INCLUDES</code> filter will not be added.</p>
  624. </usage>
  625. <seealso><directive module="core">AcceptPathInfo</directive></seealso>
  626. </directivesynopsis>
  627.  
  628. <directivesynopsis>
  629. <name>RemoveCharset</name>
  630. <description>Removes any character set associations for a set of file
  631. extensions</description>
  632. <syntax>RemoveCharset <var>extension</var> [<var>extension</var>]
  633. ...</syntax>
  634. <contextlist><context>virtual host</context><context>directory</context>
  635. <context>.htaccess</context></contextlist>
  636. <override>FileInfo</override>
  637. <compatibility>RemoveCharset is only available in Apache 2.0.24 and
  638. later.</compatibility>
  639.  
  640. <usage>
  641.     <p>The <directive>RemoveCharset</directive> directive removes any
  642.     character set associations for files with the given extensions.
  643.     This allows <code>.htaccess</code> files in subdirectories to
  644.     undo any associations inherited from parent directories or the
  645.     server config files.</p>
  646.  
  647.     <p>The <var>extension</var> argument is case-insensitive, and can
  648.     be specified with or without a leading dot.</p>
  649.  
  650.     <example><title>Example</title>
  651.       RemoveCharset .html .shtml
  652.     </example>
  653. </usage>
  654. </directivesynopsis>
  655.  
  656. <directivesynopsis>
  657. <name>RemoveEncoding</name>
  658. <description>Removes any content encoding associations for a set of file
  659. extensions</description>
  660. <syntax>RemoveEncoding <var>extension</var> [<var>extension</var>]
  661. ...</syntax>
  662. <contextlist><context>virtual host</context><context>directory</context>
  663. <context>.htaccess</context></contextlist>
  664. <override>FileInfo</override>
  665.  
  666. <usage>
  667.     <p>The <directive>RemoveEncoding</directive> directive removes any
  668.     encoding associations for files with the given extensions. This
  669.     allows <code>.htaccess</code> files in subdirectories to undo
  670.     any associations inherited from parent directories or the
  671.     server config files. An example of its use might be:</p>
  672.  
  673.     <example><title>/foo/.htaccess:</title>
  674.       AddEncoding x-gzip .gz<br />
  675.       AddType text/plain .asc<br />
  676.       <Files *.gz.asc><br />
  677.       <indent>
  678.         RemoveEncoding .gz<br />
  679.       </indent>
  680.       </Files>
  681.     </example>
  682.  
  683.     <p>This will cause <code>foo.gz</code> to be marked as being
  684.     encoded with the gzip method, but <code>foo.gz.asc</code> as an
  685.     unencoded plaintext file.</p>
  686.  
  687.     <note><title>Note</title>
  688.       <p><directive>RemoveEncoding</directive> directives are processed
  689.       <em>after</em> any <directive module="mod_mime">AddEncoding</directive>
  690.       directives, so it is possible they may undo the effects of the latter
  691.       if both occur within the same directory configuration.</p>
  692.     </note>
  693.  
  694.     <p>The <var>extension</var> argument is case-insensitive, and can
  695.     be specified with or without a leading dot.</p>
  696. </usage>
  697. </directivesynopsis>
  698.  
  699. <directivesynopsis>
  700. <name>RemoveHandler</name>
  701. <description>Removes any handler associations for a set of file
  702. extensions</description>
  703. <syntax>RemoveHandler <var>extension</var> [<var>extension</var>]
  704. ...</syntax>
  705. <contextlist><context>virtual host</context><context>directory</context>
  706. <context>.htaccess</context></contextlist>
  707. <override>FileInfo</override>
  708.  
  709. <usage>
  710.     <p>The <directive>RemoveHandler</directive> directive removes any
  711.     handler associations for files with the given extensions. This allows
  712.     <code>.htaccess</code> files in subdirectories to undo any
  713.     associations inherited from parent directories or the server
  714.     config files. An example of its use might be:</p>
  715.  
  716.     <example><title>/foo/.htaccess:</title>
  717.       AddHandler server-parsed .html
  718.     </example>
  719.  
  720.     <example><title>/foo/bar/.htaccess:</title>
  721.       RemoveHandler .html
  722.     </example>
  723.  
  724.     <p>This has the effect of returning <code>.html</code> files in
  725.     the <code>/foo/bar</code> directory to being treated as normal
  726.     files, rather than as candidates for parsing (see the <module
  727.     >mod_include</module> module).</p>
  728.  
  729.     <p>The <var>extension</var> argument is case-insensitive, and can
  730.     be specified with or without a leading dot.</p>
  731. </usage>
  732. </directivesynopsis>
  733.  
  734. <directivesynopsis>
  735. <name>RemoveInputFilter</name>
  736. <description>Removes any input filter associations for a set of file
  737. extensions</description>
  738. <syntax>RemoveInputFilter <var>extension</var> [<var>extension</var>]
  739. ...</syntax>
  740. <contextlist><context>virtual host</context><context>directory</context>
  741. <context>.htaccess</context></contextlist>
  742. <override>FileInfo</override>
  743. <compatibility>RemoveInputFilter is only available in Apache 2.0.26 and
  744. later.</compatibility>
  745.  
  746. <usage>   
  747.     <p>The <directive>RemoveInputFilter</directive> directive removes any
  748.     input filter associations for files with the given extensions.
  749.     This allows <code>.htaccess</code> files in subdirectories to
  750.     undo any associations inherited from parent directories or the
  751.     server config files.</p>
  752.  
  753.     <p>The <var>extension</var> argument is case-insensitive, and can
  754.     be specified with or without a leading dot.</p>
  755. </usage>
  756. <seealso><directive module="mod_mime">AddInputFilter</directive></seealso>
  757. <seealso><directive module="core">SetInputFilter</directive></seealso>
  758. </directivesynopsis>
  759.  
  760. <directivesynopsis>
  761. <name>RemoveLanguage</name>
  762. <description>Removes any language associations for a set of file
  763. extensions</description>
  764. <syntax>RemoveLanguage <var>extension</var> [<var>extension</var>]
  765. ...</syntax>
  766. <contextlist><context>virtual host</context><context>directory</context>
  767. <context>.htaccess</context></contextlist>
  768. <override>FileInfo</override>
  769. <compatibility>RemoveLanguage is only available in Apache 2.0.24 and
  770. later.</compatibility>
  771.  
  772. <usage>
  773.     <p>The <directive>RemoveLanguage</directive> directive removes any
  774.     language associations for files with the given extensions. This
  775.     allows <code>.htaccess</code> files in subdirectories to undo
  776.     any associations inherited from parent directories or the
  777.     server config files.</p>
  778.  
  779.     <p>The <var>extension</var> argument is case-insensitive, and can
  780.     be specified with or without a leading dot.</p>
  781. </usage>
  782. </directivesynopsis>
  783.  
  784. <directivesynopsis>
  785. <name>RemoveOutputFilter</name>
  786. <description>Removes any output filter associations for a set of file
  787. extensions</description>
  788. <syntax>RemoveOutputFilter <var>extension</var> [<var>extension</var>]
  789. ...</syntax>
  790. <contextlist><context>virtual host</context><context>directory</context>
  791. <context>.htaccess</context></contextlist>
  792. <override>FileInfo</override>
  793. <compatibility>RemoveOutputFilter is only available in Apache 2.0.26 and
  794. later.</compatibility>
  795.  
  796. <usage>    
  797.     <p>The <directive>RemoveOutputFilter</directive> directive removes any
  798.     output filter associations for files with the given extensions.
  799.     This allows <code>.htaccess</code> files in subdirectories to
  800.     undo any associations inherited from parent directories or the
  801.     server config files.</p>
  802.  
  803.     <p>The <var>extension</var> argument is case-insensitive, and can
  804.     be specified with or without a leading dot.</p>
  805.  
  806.     <example><title>Example</title>
  807.       RemoveOutputFilter shtml
  808.     </example>
  809. </usage>
  810. <seealso><directive module="mod_mime">AddOutputFilter</directive></seealso>
  811. </directivesynopsis>
  812.  
  813. <directivesynopsis>
  814. <name>RemoveType</name>
  815. <description>Removes any content type associations for a set of file
  816. extensions</description>
  817. <syntax>RemoveType <var>extension</var> [<var>extension</var>]
  818. ...</syntax>
  819. <contextlist><context>virtual host</context><context>directory</context>
  820. <context>.htaccess</context></contextlist>
  821. <override>FileInfo</override>
  822.  
  823. <usage>
  824.     <p>The <directive>RemoveType</directive> directive removes any MIME
  825.     type associations for files with the given extensions. This allows
  826.     <code>.htaccess</code> files in subdirectories to undo any
  827.     associations inherited from parent directories or the server
  828.     config files. An example of its use might be:</p>
  829.  
  830.     <example><title>/foo/.htaccess:</title>
  831.       RemoveType .cgi
  832.     </example>
  833.  
  834.     <p>This will remove any special handling of <code>.cgi</code>
  835.     files in the <code>/foo/</code> directory and any beneath it,
  836.     causing the files to be treated as being of the <directive
  837.     module="core">DefaultType</directive>.</p>
  838.  
  839.     <note><title>Note</title>
  840.       <p><directive>RemoveType</directive> directives are processed
  841.       <em>after</em> any <directive module="mod_mime">AddType</directive>
  842.       directives, so it is possible they may undo the effects of the
  843.       latter if both occur within the same directory configuration.</p>
  844.     </note>
  845.  
  846.     <p>The <var>extension</var> argument is case-insensitive, and can
  847.     be specified with or without a leading dot.</p>
  848. </usage>
  849. </directivesynopsis>
  850.  
  851. <directivesynopsis>
  852. <name>TypesConfig</name>
  853. <description>The location of the <code>mime.types</code> file</description>
  854. <syntax>TypesConfig <var>file-path</var></syntax>
  855. <default>TypesConfig conf/mime.types</default>
  856. <contextlist><context>server config</context></contextlist>
  857.  
  858. <usage>
  859.     <p>The <directive>TypesConfig</directive> directive sets the location
  860.     of the MIME types configuration file. <var>File-path</var> is relative
  861.     to the <directive module="core">ServerRoot</directive>. This file sets
  862.     the default list of mappings from filename extensions to content
  863.     types. Most administrators use the provided <code>mime.types</code>
  864.     file, which associates common filename extensions with IANA registered
  865.     content types. The current list is maintained at <a href=
  866.     "http://www.isi.edu/in-notes/iana/assignments/media-types/media-types"
  867.     >http://www.isi.edu/in-notes/iana/assignments/media-types/media-types</a>.
  868.     This simplifies the <code>httpd.conf</code> file by providing the
  869.     majority of media-type definitions, and may be overridden by
  870.     <directive module="mod_mime">AddType</directive> directives as
  871.     needed. You should not edit the <code>mime.types</code> file, because
  872.     it may be replaced when you upgrade your server.</p>
  873.  
  874.     <p>The file contains lines in the format of the arguments to
  875.     an <directive module="mod_mime">AddType</directive> directive:</p>
  876.  
  877.     <example>
  878.       <var>MIME-type</var> [<var>extension</var>] ...
  879.     </example>
  880.  
  881.     <p>The case of the extension does not matter. Blank lines, and lines
  882.     beginning with a hash character (<code>#</code>) are ignored.</p>
  883.  
  884.     <note>
  885.       Please do <strong>not</strong> send requests to the Apache HTTP
  886.       Server Project to add any new entries in the distributed
  887.       <code>mime.types</code> file unless (1) they are already
  888.       registered with IANA, and (2) they use widely accepted,
  889.       non-conflicting filename extensions across platforms.
  890.       <code>category/x-subtype</code> requests will be automatically
  891.       rejected, as will any new two-letter extensions as they will
  892.       likely conflict later with the already crowded language and
  893.       character set namespace.
  894.     </note>
  895. </usage>
  896. <seealso><module>mod_mime_magic</module></seealso>
  897. </directivesynopsis>
  898.  
  899. </modulesynopsis>
  900.