mod_mime.html revision 0d138763c21c2d07211adbb023b8505cdcb83819
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainen<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainen<HTML>
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainen<HEAD>
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainen<TITLE>Apache module mod_mime</TITLE>
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainen</HEAD>
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainen
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainen<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainen<BODY
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainen BGCOLOR="#FFFFFF"
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainen TEXT="#000000"
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainen LINK="#0000FF"
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainen VLINK="#000080"
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainen ALINK="#FF0000"
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainen>
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainen<!--#include virtual="header.html" -->
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainen<H1 ALIGN="CENTER">Module mod_mime</h1>
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainen
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo SirainenThis module is contained in the <code>mod_mime.c</code> file, and is
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainencompiled in by default. It provides for determining the types of files
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainenfrom the filename.
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainen
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainen<h2>Summary</h2>
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainen
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo SirainenThis module is used to determine various bits of "meta information"
88b9f9eb91da632d3e941fe4276f8ace03205b25Timo Sirainenabout documents. This information relates to the content of the
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainendocument and is returned to the browser or used in content-negotiation
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainenwithin the server. In addition, a "handler" can be set for a document,
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainenwhich determines how the document will be processed within the server.
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainen
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainen<P>
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainen
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo SirainenThe directives <A HREF="#addencoding">AddEncoding</A>, <A
88b9f9eb91da632d3e941fe4276f8ace03205b25Timo SirainenHREF="#addhandler">AddHandler</A>, <A
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo SirainenHREF="#addlanguage">AddLanguage</A> and <A HREF="#addtype">AddType</A>
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainenare all used to map file extensions onto the meta-information for that
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainenfile. Respectively they set the content-encoding, handler,
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainencontent-language and mime-type (content-type) of documents. The
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainendirective <A HREF="#typesconfig">TypesConfig</A> is used to specify a
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainenfile which also maps extensions onto mime types. The directives <A
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo SirainenHREF="#forcetype">ForceType</A> and <A
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo SirainenHREF="#sethandler">SetHandler</A> are used to associated all the files
c8296ac1ed68ed5c5168de545b76f9b27fc76d35Timo Sirainenin a given location (e.g. a particular directory) onto a particular
mime type or handler.
<P>
Files can have more than one extension, and the order of the
extensions is normally irrelevant. For example, if the file
<CODE>welcome.html.fr</CODE> maps onto content type text/html and
language French then the file <CODE>welcome.fr.html</CODE> will map
onto exactly the same information. The only exception to this is if an
extension is given which Apache does not know how to handle. In this
case it will "forget" about any information it obtained from
extensions to the left of the unknown extension. So, for example, if
the extensions fr and html are mapped to the appropriate language and
type but extension xxx is not assigned to anything, then the file
<CODE>welcome.fr.xxx.html</CODE> will be associated with content-type
text/html but <i>no</i> language.
<P>
Note that changing the type or encoding of a file does not change the
value of the <code>Last-Modified</code> header. Thus, previously cached
copies may still be used by a client or proxy, with the previous headers.
<P>
<h2> Directives</h2>
<ul>
<li><A HREF="#addencoding">AddEncoding</A>
<li><A HREF="#addhandler">AddHandler</A>
<li><A HREF="#addlanguage">AddLanguage</A>
<li><A HREF="#addtype">AddType</A>
<li><A HREF="#forcetype">ForceType</A>
<li><A HREF="#sethandler">SetHandler</A>
<li><A HREF="#typesconfig">TypesConfig</A>
</ul>
<hr>
<h2><A name="addencoding">AddEncoding</A></h2>
<!--%plaintext &lt;?INDEX {\tt AddEncoding} directive&gt; -->
<strong>Syntax:</strong> AddEncoding <em>mime-enc extension extension...</em><br>
<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
<Strong>Override:</strong> FileInfo<br>
<strong>Status:</strong> Base<br>
<strong>Module:</strong> mod_mime<p>
The AddEncoding directive adds to the list of filename extensions which
filenames may end in for the specified encoding type. <em>Mime-enc</em>
is the mime encoding to use for documents ending in <em>extension</em>.
Example:
<blockquote><code>
AddEncoding x-gzip gz<br>
AddEncoding x-compress Z
</code></blockquote>
This will cause files ending in .gz to be marked as encoded using the x-gzip
encoding, and .Z files to be marked as encoded with x-compress.<p><hr>
<h2><a name="addhandler">AddHandler</a></h2>
<strong>Syntax:</strong> AddHandler <em>handler-name extension extension...</em><br>
<strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
<strong>Status:</strong> Base<br>
<strong>Module:</strong> mod_mime<br>
<strong>Compatibility:</strong> AddHandler is only available in Apache
1.1 and later<p>
<p>AddHandler maps the filename extensions <em>extension</em> to the
<a href="/handler.html">handler</a>
<em>handler-name</em>. For example, to activate CGI scripts
with the file extension "<code>.cgi</code>", you might use:
<pre>
AddHandler cgi-script cgi
</pre>
<p>Once that has been put into your srm.conf or httpd.conf file, any
file ending with "<code>.cgi</code>" will be treated as a CGI
program.</p>
<HR>
<h2><A name="addlanguage">AddLanguage</A></h2>
<!--%plaintext &lt;?INDEX {\tt AddLanguage} directive&gt; -->
<strong>Syntax:</strong> AddLanguage <em>mime-lang extension extension...</em><br>
<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
<Strong>Override:</strong> FileInfo<br>
<strong>Status:</strong> Base<br>
<strong>Module:</strong> mod_mime<p>
The AddLanguage directive adds to the list of filename extensions which
filenames may end in for the specified content language. <em>Mime-lang</em>
is the mime language of files with names ending <em>extension</em>,
after any content encoding extensions have been removed. Example:
<blockquote><code>
AddEncoding x-compress Z<br>
AddLanguage en .en<br>
AddLanguage fr .fr<br>
</code></blockquote>
Then the document <code>xxxx.en.Z</code> will be treated as being a compressed
English document. Although the content language is reported to the client,
the browser is unlikely to use this information. The AddLanguage directive
is more useful for content negotiation, where the server returns one
from several documents based on the client's language preference.<p><hr>
<h2><A name="addtype">AddType</A></h2>
<!--%plaintext &lt;?INDEX {\tt AddType} directive&gt; -->
<strong>Syntax:</strong> AddType <em>mime-type extension extension...</em><br>
<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
<Strong>Override:</strong> FileInfo<br>
<strong>Status:</strong> Base<br>
<strong>Module:</strong> mod_mime<p>
The AddType directive adds to the list of filename extensions which
filenames may end in for the specified content type. <em>Mime-enc</em>
is the mime type to use for documents ending in <em>extension</em>.
after content-encoding and language extensions have been removed. Example:
<blockquote><code>
AddType image/gif GIF
</code></blockquote>
It is recommended that new mime types be added using the AddType directive
rather than changing the <A HREF="#typesconfig">TypesConfig</A> file.<p>
Note that, unlike the NCSA httpd, this directive cannot be used to set the
type of particular files.<p><hr>
<h2><a name="forcetype">ForceType</a></h2>
<strong>Syntax:</strong> ForceType <em>media type</em><br>
<strong>Context:</strong> directory, .htaccess<br>
<strong>Status:</strong> Base<br>
<strong>Module:</strong> mod_mime<br>
<strong>Compatibility:</strong> ForceType is only available in Apache
1.1 and later.<p>
<p>When placed into an <code>.htaccess</code> file or a
<code>&lt;Directory&gt;</code> or <code>&lt;Location&gt;</code> section,
this directive forces all matching files to be served
as the content type given by <em>media type</em>. For example, if you
had a directory full of GIF files, but did not want to label them all with
".gif", you might want to use:
<pre>
ForceType image/gif
</pre>
<p>Note that this will override any filename extensions that might
media type.</p>
<h2><a name="sethandler">SetHandler</a></h2>
<strong>Syntax:</strong> SetHandler <em>handler-name</em><br>
<strong>Context:</strong> directory, .htaccess<br>
<strong>Status:</strong> Base<br>
<strong>Module:</strong> mod_mime<br>
<strong>Compatibility:</strong> SetHandler is only available in Apache
1.1 and later.<p>
<p>When placed into an <code>.htaccess</code> file or a
<code>&lt;Directory&gt;</code> or <code>&lt;Location&gt;</code> section,
this directive forces all matching files to be parsed through the
<a href="/handler.html">handler</a>
given by <em>handler-name</em>. For example, if you had a
directory you wanted to be parsed entirely as imagemap rule files,
regardless of extension, you might put the following into an
<code>.htaccess</code> file in that directory:
<pre>
SetHandler imap-file
</pre>
<p>Another example: if you wanted to have the server display a status
report whenever a URL of <code>http://servername/status</code> was
called, you might put the following into access.conf:
<pre>
&lt;Location /status&gt;
SetHandler server-status
&lt;/Location&gt;
</pre>
<HR>
<h2><A name="typesconfig">TypesConfig</A></h2>
<!--%plaintext &lt;?INDEX {\tt TypesConfig} directive&gt; -->
<strong>Syntax:</strong> TypesConfig <em>filename</em><br>
<strong>Default:</strong> <code>TypesConfig conf/mime.types</code><br>
<Strong>Context:</strong> server config<br>
<strong>Status:</strong> Base<br>
<strong>Module:</strong> mod_mime<p>
The TypesConfig directive sets the location of the mime types configuration
file. <em>Filename</em> is relative to the
<A HREF="core.html#serverroot">ServerRoot</A>. This file sets the default list of
mappings from filename extensions to content types; changing this file is not
recommended. Use the <A HREF="#addtype">AddType</A> directive instead. The
file contains lines in the format of the arguments to an AddType command:
<blockquote><em>mime-type extension extension ...</em></blockquote>
The extensions are lower-cased. Blank lines, and lines beginning with a hash
character (`#') are ignored.<p>
<!--#include virtual="footer.html" -->
</BODY>
</HTML>