mod_mime_magic.html.en revision c6a2d6fa44f8698851dec5051ee3782c2913605f
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
3726777f47ac4bba3e21b075905959bbea47e72eerikabele XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
3726777f47ac4bba3e21b075905959bbea47e72eerikabele This file is generated from xml source: DO NOT EDIT
3726777f47ac4bba3e21b075905959bbea47e72eerikabele XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<link href="/style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<link href="/images/favicon.ico" rel="shortcut icon" /></head>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="/faq/">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<p class="apache">Apache HTTP Server Version 2.1</p>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs-project/">Documentation</a> > <a href="../">Version 2.1</a> > <a href="./">Modules</a></div>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<div id="preamble"><h1>Apache Module mod_mime_magic</h1>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<p><span>Available Languages: </span><a href="/en/mod/mod_mime_magic.html" title="English"> en </a></p>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Determines the MIME type of a file
3726777f47ac4bba3e21b075905959bbea47e72eerikabele by looking at a few bytes of its contents</td></tr>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>mime_magic_module</td></tr>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_mime_magic.c</td></tr></table>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele <p>This module determines the MIME type of files in the same
3726777f47ac4bba3e21b075905959bbea47e72eerikabele way the Unix <code>file(1)</code> command works: it looks at the first
3726777f47ac4bba3e21b075905959bbea47e72eerikabele few bytes of the file. It is intended as a "second line of defense"
3726777f47ac4bba3e21b075905959bbea47e72eerikabele for cases that <code class="module"><a href="/mod/mod_mime.html">mod_mime</a></code> can't resolve.</p>
cbbae5f6f6dab2f4431c8609ef9aee6c00705645nd <p>This module is derived from a free version of the
cbbae5f6f6dab2f4431c8609ef9aee6c00705645nd numbers" and other hints from a file's contents to figure out
cbbae5f6f6dab2f4431c8609ef9aee6c00705645nd what the contents are. This module is active only if the magic
3726777f47ac4bba3e21b075905959bbea47e72eerikabele file is specified by the <code class="directive"><a href="#mimemagicfile">MimeMagicFile</a></code> directive.</p>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<div id="quickview"><h3 class="directives">Directives</h3>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<li><img alt="" src="/images/down.gif" /> <a href="#mimemagicfile">MimeMagicFile</a></li>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<li><img alt="" src="/images/down.gif" /> <a href="#format">Format of the Magic File</a></li>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<li><img alt="" src="/images/down.gif" /> <a href="#performance">Performance Issues</a></li>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<li><img alt="" src="/images/down.gif" /> <a href="#notes">Notes</a></li>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<h2><a name="format" id="format">Format of the Magic File</a></h2>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele <p>The contents of the file are plain ASCII text in 4-5
3726777f47ac4bba3e21b075905959bbea47e72eerikabele columns. Blank lines are allowed but ignored. Commented lines
3726777f47ac4bba3e21b075905959bbea47e72eerikabele use a hash mark (<code>#</code>). The remaining lines are parsed for
3726777f47ac4bba3e21b075905959bbea47e72eerikabele the following columns:</p>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele <table class="bordered"><tr class="header"><th>Column</th><th>Description</th></tr>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele "<code>></code>" indicates a dependency upon the previous
a6d007137e5f9daa1b188752a35b2146065e69bfslive <td>long integer date (seconds since Unix epoch/1970)</td></tr>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele <p>For example, the following magic file lines would recognize
3726777f47ac4bba3e21b075905959bbea47e72eerikabele some audio formats:</p>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele0 string .snd
3726777f47ac4bba3e21b075905959bbea47e72eerikabele <p>Or these would recognize the difference between <code>*.doc</code>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele files containing Microsoft Word or FrameMaker documents. (These are
3726777f47ac4bba3e21b075905959bbea47e72eerikabele incompatible file formats which use the same file suffix.)</p>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele0 string \320\317\021\340\241\261 application/msword
3726777f47ac4bba3e21b075905959bbea47e72eerikabele0 string \333\245-\0\0\0 application/msword</pre></div>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele <p>An optional MIME encoding can be included as a fifth column.
3726777f47ac4bba3e21b075905959bbea47e72eerikabele For example, this can recognize gzipped files and set the
3726777f47ac4bba3e21b075905959bbea47e72eerikabele encoding for them.</p>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele <div class="example"><pre># gzip (GNU zip, not to be confused with
3726777f47ac4bba3e21b075905959bbea47e72eerikabele0 string \037\213 application/octet-stream x-gzip</pre></div>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<h2><a name="performance" id="performance">Performance Issues</a></h2>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele <p>This module is not for every system. If your system is barely
3726777f47ac4bba3e21b075905959bbea47e72eerikabele keeping up with its load or if you're performing a web server
3726777f47ac4bba3e21b075905959bbea47e72eerikabele benchmark, you may not want to enable this because the
3726777f47ac4bba3e21b075905959bbea47e72eerikabele processing is not free.</p>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele <p>However, an effort was made to improve the performance of
3726777f47ac4bba3e21b075905959bbea47e72eerikabele the original <code>file(1)</code> code to make it fit in a busy web
3726777f47ac4bba3e21b075905959bbea47e72eerikabele server. It was designed for a server where there are thousands of users
3726777f47ac4bba3e21b075905959bbea47e72eerikabele who publish their own documents. This is probably very common
3726777f47ac4bba3e21b075905959bbea47e72eerikabele on intranets. Many times, it's helpful if the server can make
3726777f47ac4bba3e21b075905959bbea47e72eerikabele more intelligent decisions about a file's contents than the
3726777f47ac4bba3e21b075905959bbea47e72eerikabele file name allows ...even if just to reduce the "why doesn't my
3726777f47ac4bba3e21b075905959bbea47e72eerikabele page work" calls when users improperly name their own files.
3726777f47ac4bba3e21b075905959bbea47e72eerikabele You have to decide if the extra work suits your
3726777f47ac4bba3e21b075905959bbea47e72eerikabele environment.</p>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele <p>The following notes apply to the <code class="module"><a href="/mod/mod_mime_magic.html">mod_mime_magic</a></code>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele module and are included here for compliance with contributors'
3726777f47ac4bba3e21b075905959bbea47e72eerikabele copyright restrictions that require their acknowledgment.</p>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele <p>mod_mime_magic: MIME type lookup via file magic numbers<br />
3726777f47ac4bba3e21b075905959bbea47e72eerikabele Copyright (c) 1996-1997 Cisco Systems, Inc.</p>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele <p>This software was submitted by Cisco Systems to the Apache Group
3726777f47ac4bba3e21b075905959bbea47e72eerikabele in July 1997. Future revisions and derivatives of this source code
3726777f47ac4bba3e21b075905959bbea47e72eerikabele must acknowledge Cisco Systems as the original contributor of this
3726777f47ac4bba3e21b075905959bbea47e72eerikabele module. All other licensing and usage conditions are those of the
3726777f47ac4bba3e21b075905959bbea47e72eerikabele Apache Group.</p>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele <p>Some of this code is derived from the free version of the file
3726777f47ac4bba3e21b075905959bbea47e72eerikabele command originally posted to comp.sources.unix. Copyright info for
3726777f47ac4bba3e21b075905959bbea47e72eerikabele that program is included below as required.</p>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele <p> - Copyright (c) Ian F. Darwin, 1987. Written by Ian F. Darwin.</p>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele <p>This software is not subject to any license of the American
3726777f47ac4bba3e21b075905959bbea47e72eerikabele Telephone and Telegraph Company or of the Regents of the University
3726777f47ac4bba3e21b075905959bbea47e72eerikabele of California.</p>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele <p>Permission is granted to anyone to use this software for any
3726777f47ac4bba3e21b075905959bbea47e72eerikabele purpose on any computer system, and to alter it and redistribute it
3726777f47ac4bba3e21b075905959bbea47e72eerikabele freely, subject to the following restrictions:</p>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele <li>The author is not responsible for the consequences of use of
3726777f47ac4bba3e21b075905959bbea47e72eerikabele this software, no matter how awful, even if they arise from flaws
3726777f47ac4bba3e21b075905959bbea47e72eerikabele <li>The origin of this software must not be misrepresented, either
3726777f47ac4bba3e21b075905959bbea47e72eerikabele by explicit claim or by omission. Since few users ever read
3726777f47ac4bba3e21b075905959bbea47e72eerikabele sources, credits must appear in the documentation.</li>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele <li>Altered versions must be plainly marked as such, and must not
3726777f47ac4bba3e21b075905959bbea47e72eerikabele be misrepresented as being the original software. Since few users
3726777f47ac4bba3e21b075905959bbea47e72eerikabele ever read sources, credits must appear in the documentation.</li>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele <li>This notice may not be removed or altered.</li>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele <p>For compliance with Mr Darwin's terms: this has been very
3726777f47ac4bba3e21b075905959bbea47e72eerikabele significantly modified from the free "file" command.</p>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele <li>all-in-one file for compilation convenience when moving from
3726777f47ac4bba3e21b075905959bbea47e72eerikabele one version of Apache to the next.</li>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele <li>Memory allocation is done through the Apache API's pool
3726777f47ac4bba3e21b075905959bbea47e72eerikabele structure.</li>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele <li>All functions have had necessary Apache API request or server
3726777f47ac4bba3e21b075905959bbea47e72eerikabele structures passed to them where necessary to call other Apache API
3726777f47ac4bba3e21b075905959bbea47e72eerikabele routines. (<em>i.e.</em>, usually for logging, files, or memory
3726777f47ac4bba3e21b075905959bbea47e72eerikabele allocation in itself or a called function.)</li>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele <li>struct magic has been converted from an array to a single-ended
3726777f47ac4bba3e21b075905959bbea47e72eerikabele linked list because it only grows one record at a time, it's only
3726777f47ac4bba3e21b075905959bbea47e72eerikabele accessed sequentially, and the Apache API has no equivalent of
3726777f47ac4bba3e21b075905959bbea47e72eerikabele <li>Functions have been changed to get their parameters from the
3726777f47ac4bba3e21b075905959bbea47e72eerikabele server configuration instead of globals. (It should be reentrant
3726777f47ac4bba3e21b075905959bbea47e72eerikabele now but has not been tested in a threaded environment.)</li>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele <li>Places where it used to print results to stdout now saves them
3726777f47ac4bba3e21b075905959bbea47e72eerikabele in a list where they're used to set the MIME type in the Apache
3726777f47ac4bba3e21b075905959bbea47e72eerikabele request record.</li>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele <li>Command-line flags have been removed since they will never be
3726777f47ac4bba3e21b075905959bbea47e72eerikabele used here.</li>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<div class="directive-section"><h2><a name="MimeMagicFile" id="MimeMagicFile">MimeMagicFile</a> <a name="mimemagicfile" id="mimemagicfile">Directive</a></h2>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable MIME-type determination based on file contents
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>MimeMagicFile <var>file-path</var></code></td></tr>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_mime_magic</td></tr>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele <p>The <code class="directive">MimeMagicFile</code> directive can be used to
3726777f47ac4bba3e21b075905959bbea47e72eerikabele enable this module, the default file is distributed at
3726777f47ac4bba3e21b075905959bbea47e72eerikabele <code>conf/magic</code>. Non-rooted paths are relative to the
3726777f47ac4bba3e21b075905959bbea47e72eerikabele <code class="directive"><a href="/mod/core.html#serverroot">ServerRoot</a></code>. Virtual hosts will use
3726777f47ac4bba3e21b075905959bbea47e72eerikabele the same file as the main server unless a more specific setting is
3726777f47ac4bba3e21b075905959bbea47e72eerikabele used, in which case the more specific setting overrides the main
3726777f47ac4bba3e21b075905959bbea47e72eerikabele server's file.</p>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<p><span>Available Languages: </span><a href="/en/mod/mod_mime_magic.html" title="English"> en </a></p>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<p class="apache">Copyright 1999-2004 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
3726777f47ac4bba3e21b075905959bbea47e72eerikabele<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="/faq/">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p></div>