mirror of
https://github.com/apache/httpd.git
synced 2026-01-06 09:01:14 +03:00
63e7bd76a6
meta data. Note the effect of multiple extensions in all the Add* directive descriptions, and explain that these directives add or override existing mappings. Remove assumptions that there is only one extension. Add note about how setting both handlers and media types could result in unexpected results. Remove some highly misleading information such as that the type is the extension left "after content-encoding and language extensions have been removed" PR: 3151 git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@82403 13f79535-47bb-0310-9956-ffa450edef68
420 lines
14 KiB
HTML
420 lines
14 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
|
|
<HTML>
|
|
<HEAD>
|
|
<TITLE>Apache module mod_mime</TITLE>
|
|
</HEAD>
|
|
|
|
<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
|
|
<BODY
|
|
BGCOLOR="#FFFFFF"
|
|
TEXT="#000000"
|
|
LINK="#0000FF"
|
|
VLINK="#000080"
|
|
ALINK="#FF0000"
|
|
>
|
|
<!--#include virtual="header.html" -->
|
|
<H1 ALIGN="CENTER">Module mod_mime</H1>
|
|
|
|
This module is contained in the <CODE>mod_mime.c</CODE> file, and is
|
|
compiled in by default. It provides for determining the types of files
|
|
from the filename.
|
|
|
|
<H2>Summary</H2>
|
|
|
|
This module is used to determine various bits of "meta information"
|
|
about documents. This information relates to the content of the
|
|
document and is returned to the browser or used in content-negotiation
|
|
within the server. In addition, a "handler" can be set for a document,
|
|
which determines how the document will be processed within the server.
|
|
|
|
<P>
|
|
|
|
The directives <A HREF="#addencoding">AddEncoding</A>, <A
|
|
HREF="#addhandler">AddHandler</A>, <A
|
|
HREF="#addlanguage">AddLanguage</A> and <A HREF="#addtype">AddType</A>
|
|
are all used to map file extensions onto the meta-information for that
|
|
file. Respectively they set the content-encoding, handler,
|
|
content-language and MIME-type (content-type) of documents. The
|
|
directive <A HREF="#typesconfig">TypesConfig</A> is used to specify a
|
|
file which also maps extensions onto mime types. The directives <A
|
|
HREF="#forcetype">ForceType</A> and <A
|
|
HREF="#sethandler">SetHandler</A> are used to associated all the files
|
|
in a given location (<EM>e.g.</EM>, a particular directory) onto a particular
|
|
mime type or handler.
|
|
|
|
<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.
|
|
|
|
<A NAME="multipleext"><H2>Files with Multiple Extensions</H2></A>
|
|
|
|
Files can have more than one extension, and the order of the
|
|
extensions is <i>normally</i> 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 <EM>no</EM> language.
|
|
|
|
<P>
|
|
|
|
If more than one extension is given which maps onto the same type of
|
|
meta-information, then the one to the right will be used. For example,
|
|
if ".gif" maps to the MIME-type image/gif and ".html" maps to the
|
|
MIME-type text/html, then the file <CODE>welcome.gif.html</CODE> will
|
|
be associated with the MIME-type "text/html".
|
|
|
|
<P>
|
|
|
|
Care should be taken when a file with multiple extensions gets
|
|
associated with both a MIME-type and a handler. This will usually
|
|
result in the request being by the module associated with the
|
|
handler. For example, if the <CODE>.imap</CODE> extension is mapped to
|
|
the handler "imap-file" (from mod_imap) and the <CODE>.html</CODE>
|
|
extension is mapped to the MIME-type "text/html", then the file
|
|
<CODE>world.imap.html</CODE> will be associated with both the
|
|
"imap-file" handler and "text/html" MIME-type. When it is processed,
|
|
the "imap-file" handler will be used, and so it will be treated as a
|
|
mod_imap imagemap file.
|
|
|
|
<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 <?INDEX {\tt AddEncoding} directive> -->
|
|
<A
|
|
HREF="directive-dict.html#Syntax"
|
|
REL="Help"
|
|
><STRONG>Syntax:</STRONG></A> AddEncoding <EM>MIME-enc extension extension...</EM><BR>
|
|
<A
|
|
HREF="directive-dict.html#Context"
|
|
REL="Help"
|
|
><STRONG>Context:</STRONG></A> server config, virtual host, directory, .htaccess<BR>
|
|
<A
|
|
HREF="directive-dict.html#Override"
|
|
REL="Help"
|
|
><STRONG>Override:</STRONG></A> FileInfo<BR>
|
|
<A
|
|
HREF="directive-dict.html#Status"
|
|
REL="Help"
|
|
><STRONG>Status:</STRONG></A> Base<BR>
|
|
<A
|
|
HREF="directive-dict.html#Module"
|
|
REL="Help"
|
|
><STRONG>Module:</STRONG></A> mod_mime<P>
|
|
|
|
The AddEncoding directive maps the given filename extensions to the
|
|
specified encoding type. <EM>Mime-enc</EM> is the mime encoding to use
|
|
for documents containing the <EM>extension</EM>. This mapping is added
|
|
to any already in force, overriding any mappings that already exist
|
|
for the same <EM>extension</EM>.
|
|
|
|
Example:
|
|
<BLOCKQUOTE><CODE> AddEncoding x-gzip gz<BR> AddEncoding x-compress Z
|
|
</CODE></BLOCKQUOTE>
|
|
|
|
This will cause filenames containing the .gz extension to be marked as
|
|
encoded using the x-gzip encoding, and filenames containing the .Z
|
|
extension to be marked as encoded with x-compress.<P>
|
|
|
|
Old clients expect <CODE>x-gzip</CODE> and <CODE>x-compress</CODE>,
|
|
however the standard dictates that they're equivalent to <CODE>gzip</CODE>
|
|
and <CODE>compress</CODE> respectively. Apache does content encoding
|
|
comparisons by ignoring any leading <CODE>x-</CODE>. When responding
|
|
with an encoding Apache will use whatever form (<EM>i.e.</EM>, <CODE>x-foo</CODE>
|
|
or <CODE>foo</CODE>) the client requested. If the client didn't
|
|
specifically request a particular form Apache will use the form given by
|
|
the <CODE>AddEncoding</CODE> directive. To make this long story short,
|
|
you should always use <CODE>x-gzip</CODE> and <CODE>x-compress</CODE>
|
|
for these two specific encodings. More recent encodings, such as
|
|
<CODE>deflate</CODE> should be specified without the <CODE>x-</CODE>.
|
|
|
|
<P>
|
|
|
|
<STRONG>See also</STRONG>: <A HREF="#multipleext">Files with
|
|
multiple extensions</A>
|
|
|
|
<P><HR>
|
|
|
|
<H2><A NAME="addhandler">AddHandler</A></H2>
|
|
|
|
<A
|
|
HREF="directive-dict.html#Syntax"
|
|
REL="Help"
|
|
><STRONG>Syntax:</STRONG></A> AddHandler <EM>handler-name extension extension...</EM><BR>
|
|
<A
|
|
HREF="directive-dict.html#Context"
|
|
REL="Help"
|
|
><STRONG>Context:</STRONG></A> server config, virtual host, directory, .htaccess<BR>
|
|
<A
|
|
HREF="directive-dict.html#Override"
|
|
REL="Help"
|
|
><STRONG>Override:</STRONG></A> FileInfo<BR>
|
|
<A
|
|
HREF="directive-dict.html#Status"
|
|
REL="Help"
|
|
><STRONG>Status:</STRONG></A> Base<BR>
|
|
<A
|
|
HREF="directive-dict.html#Module"
|
|
REL="Help"
|
|
><STRONG>Module:</STRONG></A> mod_mime<BR>
|
|
<A
|
|
HREF="directive-dict.html#Compatibility"
|
|
REL="Help"
|
|
><STRONG>Compatibility:</STRONG></A> 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>. This
|
|
mapping is added to any already in force, overriding any mappings that
|
|
already exist for the same <EM>extension</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 containing the "<CODE>.cgi</CODE>" extension will be treated as a
|
|
CGI program.</P>
|
|
|
|
<P>
|
|
|
|
<STRONG>See also</STRONG>: <A HREF="#multipleext">Files with
|
|
multiple extensions</A>
|
|
|
|
<HR>
|
|
|
|
<H2><A NAME="addlanguage">AddLanguage</A></H2>
|
|
<!--%plaintext <?INDEX {\tt AddLanguage} directive> -->
|
|
<A
|
|
HREF="directive-dict.html#Syntax"
|
|
REL="Help"
|
|
><STRONG>Syntax:</STRONG></A> AddLanguage <EM>MIME-lang extension extension...</EM><BR>
|
|
<A
|
|
HREF="directive-dict.html#Context"
|
|
REL="Help"
|
|
><STRONG>Context:</STRONG></A> server config, virtual host, directory, .htaccess<BR>
|
|
<A
|
|
HREF="directive-dict.html#Override"
|
|
REL="Help"
|
|
><STRONG>Override:</STRONG></A> FileInfo<BR>
|
|
<A
|
|
HREF="directive-dict.html#Status"
|
|
REL="Help"
|
|
><STRONG>Status:</STRONG></A> Base<BR>
|
|
<A
|
|
HREF="directive-dict.html#Module"
|
|
REL="Help"
|
|
><STRONG>Module:</STRONG></A> mod_mime<P>
|
|
|
|
The AddLanguage directive maps the given filename extensions to the
|
|
specified content language. <EM>Mime-lang</EM> is the mime language of
|
|
filenames containing <EM>extension</EM>. This mapping is added to any
|
|
already in force, overriding any mappings that already exist for the
|
|
same <EM>extension</EM>.
|
|
|
|
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 (as will the document
|
|
<CODE>xxxx.Z.en</CODE>). 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>
|
|
|
|
<P>
|
|
|
|
<STRONG>See also</STRONG>: <A HREF="#multipleext">Files with
|
|
multiple extensions</A>
|
|
|
|
<HR>
|
|
|
|
<H2><A NAME="addtype">AddType</A></H2>
|
|
<!--%plaintext <?INDEX {\tt AddType} directive> -->
|
|
<A
|
|
HREF="directive-dict.html#Syntax"
|
|
REL="Help"
|
|
><STRONG>Syntax:</STRONG></A> AddType <EM>MIME-type extension extension...</EM><BR>
|
|
<A
|
|
HREF="directive-dict.html#Context"
|
|
REL="Help"
|
|
><STRONG>Context:</STRONG></A> server config, virtual host, directory, .htaccess<BR>
|
|
<A
|
|
HREF="directive-dict.html#Override"
|
|
REL="Help"
|
|
><STRONG>Override:</STRONG></A> FileInfo<BR>
|
|
<A
|
|
HREF="directive-dict.html#Status"
|
|
REL="Help"
|
|
><STRONG>Status:</STRONG></A> Base<BR>
|
|
<A
|
|
HREF="directive-dict.html#Module"
|
|
REL="Help"
|
|
><STRONG>Module:</STRONG></A> mod_mime<P>
|
|
|
|
The AddType directive maps the given filename extensions onto the
|
|
specified content type. <EM>Mime-enc</EM> is the mime type to use for
|
|
filenames containing <EM>extension</EM>. This mapping is added to any
|
|
already in force, overriding any mappings that already exist for the
|
|
same <EM>extension</EM>. This directive can be used to add mappings
|
|
not listed in the mime types file (see the <CODE><A
|
|
HREF="#typesconfig">TypesConfig</A></CODE> directive).
|
|
|
|
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>
|
|
|
|
<P>
|
|
|
|
<STRONG>See also</STRONG>: <A HREF="#multipleext">Files with
|
|
multiple extensions</A>
|
|
|
|
<HR>
|
|
|
|
<H2><A NAME="forcetype">ForceType</A></H2>
|
|
|
|
<A
|
|
HREF="directive-dict.html#Syntax"
|
|
REL="Help"
|
|
><STRONG>Syntax:</STRONG></A> ForceType <EM>media type</EM><BR>
|
|
<A
|
|
HREF="directive-dict.html#Context"
|
|
REL="Help"
|
|
><STRONG>Context:</STRONG></A> directory, .htaccess<BR>
|
|
<A
|
|
HREF="directive-dict.html#Status"
|
|
REL="Help"
|
|
><STRONG>Status:</STRONG></A> Base<BR>
|
|
<A
|
|
HREF="directive-dict.html#Module"
|
|
REL="Help"
|
|
><STRONG>Module:</STRONG></A> mod_mime<BR>
|
|
<A
|
|
HREF="directive-dict.html#Compatibility"
|
|
REL="Help"
|
|
><STRONG>Compatibility:</STRONG></A> ForceType is only available in Apache
|
|
1.1 and later.<P>
|
|
|
|
<P>When placed into an <CODE>.htaccess</CODE> file or a
|
|
<CODE><Directory></CODE> or <CODE><Location></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 determine
|
|
the media type.</P><HR>
|
|
|
|
<H2><A NAME="sethandler">SetHandler</A></H2>
|
|
|
|
<A
|
|
HREF="directive-dict.html#Syntax"
|
|
REL="Help"
|
|
><STRONG>Syntax:</STRONG></A> SetHandler <EM>handler-name</EM><BR>
|
|
<A
|
|
HREF="directive-dict.html#Context"
|
|
REL="Help"
|
|
><STRONG>Context:</STRONG></A> directory, .htaccess<BR>
|
|
<A
|
|
HREF="directive-dict.html#Status"
|
|
REL="Help"
|
|
><STRONG>Status:</STRONG></A> Base<BR>
|
|
<A
|
|
HREF="directive-dict.html#Module"
|
|
REL="Help"
|
|
><STRONG>Module:</STRONG></A> mod_mime<BR>
|
|
<A
|
|
HREF="directive-dict.html#Compatibility"
|
|
REL="Help"
|
|
><STRONG>Compatibility:</STRONG></A> SetHandler is only available in Apache
|
|
1.1 and later.<P>
|
|
|
|
<P>When placed into an <CODE>.htaccess</CODE> file or a
|
|
<CODE><Directory></CODE> or <CODE><Location></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>
|
|
<Location /status>
|
|
SetHandler server-status
|
|
</Location>
|
|
</PRE>
|
|
<HR>
|
|
|
|
<H2><A NAME="typesconfig">TypesConfig</A></H2>
|
|
<!--%plaintext <?INDEX {\tt TypesConfig} directive> -->
|
|
<A
|
|
HREF="directive-dict.html#Syntax"
|
|
REL="Help"
|
|
><STRONG>Syntax:</STRONG></A> TypesConfig <EM>filename</EM><BR>
|
|
<A
|
|
HREF="directive-dict.html#Default"
|
|
REL="Help"
|
|
><STRONG>Default:</STRONG></A> <CODE>TypesConfig conf/mime.types</CODE><BR>
|
|
<A
|
|
HREF="directive-dict.html#Context"
|
|
REL="Help"
|
|
><STRONG>Context:</STRONG></A> server config<BR>
|
|
<A
|
|
HREF="directive-dict.html#Status"
|
|
REL="Help"
|
|
><STRONG>Status:</STRONG></A> Base<BR>
|
|
<A
|
|
HREF="directive-dict.html#Module"
|
|
REL="Help"
|
|
><STRONG>Module:</STRONG></A> 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>
|
|
|