mod_mime.html revision 6fbf10ebad03aa5f5c38086f9cf39ad917487113
03831d35f7499c87d51205817c93e9a8d42c4baestevel<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
03831d35f7499c87d51205817c93e9a8d42c4baestevel<!-- Background white, links blue (unvisited), navy (visited), red (active) -->
03831d35f7499c87d51205817c93e9a8d42c4baestevel BGCOLOR="#FFFFFF"
03831d35f7499c87d51205817c93e9a8d42c4baestevel TEXT="#000000"
03831d35f7499c87d51205817c93e9a8d42c4baestevel LINK="#0000FF"
03831d35f7499c87d51205817c93e9a8d42c4baestevel VLINK="#000080"
03831d35f7499c87d51205817c93e9a8d42c4baestevel ALINK="#FF0000"
03831d35f7499c87d51205817c93e9a8d42c4baestevel<!--#include virtual="header.html" -->
03831d35f7499c87d51205817c93e9a8d42c4baestevelThis module is contained in the <code>mod_mime.c</code> file, and is
03831d35f7499c87d51205817c93e9a8d42c4baestevelcompiled in by default. It provides for determining the types of files
03831d35f7499c87d51205817c93e9a8d42c4baestevelfrom the filename.
03831d35f7499c87d51205817c93e9a8d42c4baestevelThis module is used to determine various bits of "meta information"
03831d35f7499c87d51205817c93e9a8d42c4baestevelabout documents. This information relates to the content of the
03831d35f7499c87d51205817c93e9a8d42c4baesteveldocument and is returned to the browser or used in content-negotiation
03831d35f7499c87d51205817c93e9a8d42c4baestevelwithin the server. In addition, a "handler" can be set for a document,
03831d35f7499c87d51205817c93e9a8d42c4baestevelwhich determines how the document will be processed within the server.
03831d35f7499c87d51205817c93e9a8d42c4baestevelThe directives <A HREF="#addencoding">AddEncoding</A>, <A
03831d35f7499c87d51205817c93e9a8d42c4baestevelHREF="#addlanguage">AddLanguage</A> and <A HREF="#addtype">AddType</A>
03831d35f7499c87d51205817c93e9a8d42c4baestevelare all used to map file extensions onto the meta-information for that
03831d35f7499c87d51205817c93e9a8d42c4baestevelfile. Respectively they set the content-encoding, handler,
03831d35f7499c87d51205817c93e9a8d42c4baestevelcontent-language and mime-type (content-type) of documents. The
03831d35f7499c87d51205817c93e9a8d42c4baesteveldirective <A HREF="#typesconfig">TypesConfig</A> is used to specify a
03831d35f7499c87d51205817c93e9a8d42c4baestevelfile which also maps extensions onto mime types. The directives <A
03831d35f7499c87d51205817c93e9a8d42c4baestevelHREF="#sethandler">SetHandler</A> are used to associated all the files
03831d35f7499c87d51205817c93e9a8d42c4baestevelin a given location (e.g. a particular directory) onto a particular
03831d35f7499c87d51205817c93e9a8d42c4baestevelmime type or handler.
03831d35f7499c87d51205817c93e9a8d42c4baestevelFiles can have more than one extension, and the order of the
03831d35f7499c87d51205817c93e9a8d42c4baestevelextensions is normally irrelevant. For example, if the file
03831d35f7499c87d51205817c93e9a8d42c4baestevel<CODE>welcome.html.fr</CODE> maps onto content type text/html and
03831d35f7499c87d51205817c93e9a8d42c4baestevellanguage French then the file <CODE>welcome.fr.html</CODE> will map
03831d35f7499c87d51205817c93e9a8d42c4baestevelonto exactly the same information. The only exception to this is if an
03831d35f7499c87d51205817c93e9a8d42c4baestevelextension is given which Apache does not know how to handle. In this
03831d35f7499c87d51205817c93e9a8d42c4baestevelcase it will "forget" about any information it obtained from
03831d35f7499c87d51205817c93e9a8d42c4baestevelextensions to the left of the unknown extension. So, for example, if
03831d35f7499c87d51205817c93e9a8d42c4baestevelthe extensions fr and html are mapped to the appropriate language and
03831d35f7499c87d51205817c93e9a8d42c4baesteveltype but extension xxx is not assigned to anything, then the file
03831d35f7499c87d51205817c93e9a8d42c4baestevel<CODE>welcome.fr.xxx.html</CODE> will be associated with content-type
03831d35f7499c87d51205817c93e9a8d42c4baestevel<!--%plaintext <?INDEX {\tt AddEncoding} directive> -->
03831d35f7499c87d51205817c93e9a8d42c4baestevel<strong>Syntax:</strong> AddEncoding <em>mime-enc extension extension...</em><br>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
03831d35f7499c87d51205817c93e9a8d42c4baestevelThe AddEncoding directive adds to the list of filename extensions which
03831d35f7499c87d51205817c93e9a8d42c4baestevelfilenames may end in for the specified encoding type. <em>Mime-enc</em>
03831d35f7499c87d51205817c93e9a8d42c4baestevelis the mime encoding to use for documents ending in <em>extension</em>.
03831d35f7499c87d51205817c93e9a8d42c4baestevelAddEncoding x-gzip gz<br>
03831d35f7499c87d51205817c93e9a8d42c4baestevelAddEncoding x-compress Z
03831d35f7499c87d51205817c93e9a8d42c4baestevelThis will cause files ending in .gz to be marked as encoded using the x-gzip
03831d35f7499c87d51205817c93e9a8d42c4baestevelencoding, and .Z files to be marked as encoded with x-compress.<p><hr>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<strong>Syntax:</strong> AddHandler <em>handler-name extension extension...</em><br>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<strong>Compatibility:</strong> AddHandler is only available in Apache
03831d35f7499c87d51205817c93e9a8d42c4baestevel1.1 and later<p>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<p>AddHandler maps the filename extensions <em>extension</em> to the
03831d35f7499c87d51205817c93e9a8d42c4baestevel<em>handler-name</em>. For example, to activate CGI scripts
03831d35f7499c87d51205817c93e9a8d42c4baestevelwith the file extension "<code>.cgi</code>", you might use:
03831d35f7499c87d51205817c93e9a8d42c4baestevel AddHandler cgi-script cgi
03831d35f7499c87d51205817c93e9a8d42c4baestevel<p>Once that has been put into your srm.conf or httpd.conf file, any
03831d35f7499c87d51205817c93e9a8d42c4baestevelfile ending with "<code>.cgi</code>" will be treated as a CGI
03831d35f7499c87d51205817c93e9a8d42c4baestevelprogram.</p>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<!--%plaintext <?INDEX {\tt AddLanguage} directive> -->
03831d35f7499c87d51205817c93e9a8d42c4baestevel<strong>Syntax:</strong> AddLanguage <em>mime-lang extension extension...</em><br>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
03831d35f7499c87d51205817c93e9a8d42c4baestevelThe AddLanguage directive adds to the list of filename extensions which
03831d35f7499c87d51205817c93e9a8d42c4baestevelfilenames may end in for the specified content language. <em>Mime-lang</em>
03831d35f7499c87d51205817c93e9a8d42c4baestevelis the mime language of files with names ending <em>extension</em>,
03831d35f7499c87d51205817c93e9a8d42c4baestevelafter any content encoding extensions have been removed. Example:
03831d35f7499c87d51205817c93e9a8d42c4baestevelAddEncoding x-compress Z<br>
03831d35f7499c87d51205817c93e9a8d42c4baestevelAddLanguage en .en<br>
03831d35f7499c87d51205817c93e9a8d42c4baestevelAddLanguage fr .fr<br>
03831d35f7499c87d51205817c93e9a8d42c4baestevelThen the document <code>xxxx.en.Z</code> will be treated as being a compressed
03831d35f7499c87d51205817c93e9a8d42c4baestevelEnglish document. Although the content language is reported to the client,
03831d35f7499c87d51205817c93e9a8d42c4baestevelthe browser is unlikely to use this information. The AddLanguage directive
03831d35f7499c87d51205817c93e9a8d42c4baestevelis more useful for content negotiation, where the server returns one
03831d35f7499c87d51205817c93e9a8d42c4baestevelfrom several documents based on the client's language preference.<p><hr>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<!--%plaintext <?INDEX {\tt AddType} directive> -->
03831d35f7499c87d51205817c93e9a8d42c4baestevel<strong>Syntax:</strong> AddType <em>mime-type extension extension...</em><br>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<Strong>Context:</strong> server config, virtual host, directory, .htaccess<br>
03831d35f7499c87d51205817c93e9a8d42c4baestevelThe AddType directive adds to the list of filename extensions which
03831d35f7499c87d51205817c93e9a8d42c4baestevelfilenames may end in for the specified content type. <em>Mime-enc</em>
03831d35f7499c87d51205817c93e9a8d42c4baestevelis the mime type to use for documents ending in <em>extension</em>.
03831d35f7499c87d51205817c93e9a8d42c4baestevelafter content-encoding and language extensions have been removed. Example:
03831d35f7499c87d51205817c93e9a8d42c4baestevelIt is recommended that new mime types be added using the AddType directive
03831d35f7499c87d51205817c93e9a8d42c4baestevelrather than changing the <A HREF="#typesconfig">TypesConfig</A> file.<p>
03831d35f7499c87d51205817c93e9a8d42c4baestevelNote that, unlike the NCSA httpd, this directive cannot be used to set the
03831d35f7499c87d51205817c93e9a8d42c4baestevel<strong>Syntax:</strong> ForceType <em>media type</em><br>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<strong>Compatibility:</strong> ForceType is only available in Apache
03831d35f7499c87d51205817c93e9a8d42c4baestevel1.1 and later.<p>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<p>When placed into an <code>.htaccess</code> file or a
03831d35f7499c87d51205817c93e9a8d42c4baestevel<code><Directory></code> or <code><Location></code> section,
03831d35f7499c87d51205817c93e9a8d42c4baestevelthis directive forces all matching files to be served
03831d35f7499c87d51205817c93e9a8d42c4baestevelas the content type given by <em>media type</em>. For example, if you
03831d35f7499c87d51205817c93e9a8d42c4baestevelhad a directory full of GIF files, but did not want to label them all with
03831d35f7499c87d51205817c93e9a8d42c4baestevel".gif", you might want to use:
03831d35f7499c87d51205817c93e9a8d42c4baestevel<p>Note that this will override any filename extensions that might
03831d35f7499c87d51205817c93e9a8d42c4baestevelmedia type.</p>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<strong>Syntax:</strong> SetHandler <em>handler-name</em><br>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<strong>Compatibility:</strong> SetHandler is only available in Apache
03831d35f7499c87d51205817c93e9a8d42c4baestevel1.1 and later.<p>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<p>When placed into an <code>.htaccess</code> file or a
03831d35f7499c87d51205817c93e9a8d42c4baestevel<code><Directory></code> or <code><Location></code> section,
03831d35f7499c87d51205817c93e9a8d42c4baestevelthis directive forces all matching files to be parsed through the
03831d35f7499c87d51205817c93e9a8d42c4baestevelgiven by <em>handler-name</em>. For example, if you had a
03831d35f7499c87d51205817c93e9a8d42c4baesteveldirectory you wanted to be parsed entirely as imagemap rule files,
03831d35f7499c87d51205817c93e9a8d42c4baestevelregardless of extension, you might put the following into an
03831d35f7499c87d51205817c93e9a8d42c4baestevel SetHandler imap-file
03831d35f7499c87d51205817c93e9a8d42c4baestevel<p>Another example: if you wanted to have the server display a status
03831d35f7499c87d51205817c93e9a8d42c4baestevelreport whenever a URL of <code>http://servername/status</code> was
03831d35f7499c87d51205817c93e9a8d42c4baestevelcalled, you might put the following into access.conf:
03831d35f7499c87d51205817c93e9a8d42c4baestevel <Location /status>
03831d35f7499c87d51205817c93e9a8d42c4baestevel SetHandler server-status
03831d35f7499c87d51205817c93e9a8d42c4baestevel </Location>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<!--%plaintext <?INDEX {\tt TypesConfig} directive> -->
03831d35f7499c87d51205817c93e9a8d42c4baestevel<strong>Syntax:</strong> TypesConfig <em>filename</em><br>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<strong>Default:</strong> <code>TypesConfig conf/mime.types</code><br>
03831d35f7499c87d51205817c93e9a8d42c4baestevelThe TypesConfig directive sets the location of the mime types configuration
03831d35f7499c87d51205817c93e9a8d42c4baestevel<A HREF="core.html#serverroot">ServerRoot</A>. This file sets the default list of
03831d35f7499c87d51205817c93e9a8d42c4baestevelmappings from filename extensions to content types; changing this file is not
03831d35f7499c87d51205817c93e9a8d42c4baestevelrecommended. Use the <A HREF="#addtype">AddType</A> directive instead. The
03831d35f7499c87d51205817c93e9a8d42c4baestevelfile contains lines in the format of the arguments to an AddType command:
03831d35f7499c87d51205817c93e9a8d42c4baestevel<blockquote><em>mime-type extension extension ...</em></blockquote>
03831d35f7499c87d51205817c93e9a8d42c4baestevelThe extensions are lower-cased. Blank lines, and lines beginning with a hash
03831d35f7499c87d51205817c93e9a8d42c4baestevelcharacter (`#') are ignored.<p>
03831d35f7499c87d51205817c93e9a8d42c4baestevel<!--#include virtual="footer.html" -->