1<?xml version="1.0" encoding="ISO-8859-1"?> 2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> 3<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!-- 4 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX 5 This file is generated from xml source: DO NOT EDIT 6 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX 7 --> 8<title>mod_mime_magic - Apache HTTP Server</title> 9<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" /> 10<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" /> 11<link href="/style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="/style/css/prettify.css" /> 12<script src="/style/scripts/prettify.js" type="text/javascript"> 13</script> 14 15<link href="/images/favicon.ico" rel="shortcut icon" /></head> 16<body> 17<div id="page-header"> 18<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p> 19<p class="apache">Apache HTTP Server Version 2.2</p> 20<img alt="" src="/images/feather.gif" /></div> 21<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div> 22<div id="path"> 23<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.2</a> > <a href="./">Modules</a></div> 24<div id="page-content"> 25<div id="preamble"><h1>Apache Module mod_mime_magic</h1> 26<div class="toplang"> 27<p><span>Available Languages: </span><a href="/en/mod/mod_mime_magic.html" title="English"> en </a></p> 28</div> 29<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Determines the MIME type of a file 30 by looking at a few bytes of its contents</td></tr> 31<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr> 32<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>mime_magic_module</td></tr> 33<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_mime_magic.c</td></tr></table> 34<h3>Summary</h3> 35 36 <p>This module determines the <a class="glossarylink" href="/glossary.html#mime-type" title="see glossary">MIME 37 type</a> of files in the same way the Unix 38 <code>file(1)</code> command works: it looks at the first few 39 bytes of the file. It is intended as a "second line of defense" 40 for cases that <code class="module"><a href="/mod/mod_mime.html">mod_mime</a></code> can't resolve.</p> 41 42 <p>This module is derived from a free version of the 43 <code>file(1)</code> command for Unix, which uses "magic 44 numbers" and other hints from a file's contents to figure out 45 what the contents are. This module is active only if the magic 46 file is specified by the <code class="directive"><a href="#mimemagicfile">MimeMagicFile</a></code> directive.</p> 47</div> 48<div id="quickview"><h3 class="directives">Directives</h3> 49<ul id="toc"> 50<li><img alt="" src="/images/down.gif" /> <a href="#mimemagicfile">MimeMagicFile</a></li> 51</ul> 52<h3>Topics</h3> 53<ul id="topics"> 54<li><img alt="" src="/images/down.gif" /> <a href="#format">Format of the Magic File</a></li> 55<li><img alt="" src="/images/down.gif" /> <a href="#performance">Performance Issues</a></li> 56<li><img alt="" src="/images/down.gif" /> <a href="#notes">Notes</a></li> 57</ul><ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div> 58<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 59<div class="section"> 60<h2><a name="format" id="format">Format of the Magic File</a></h2> 61 62 <p>The contents of the file are plain ASCII text in 4-5 63 columns. Blank lines are allowed but ignored. Commented lines 64 use a hash mark (<code>#</code>). The remaining lines are parsed for 65 the following columns:</p> 66 67 <table class="bordered"><tr class="header"><th>Column</th><th>Description</th></tr> 68<tr><td>1</td> 69 <td>byte number to begin checking from<br /> 70 "<code>></code>" indicates a dependency upon the previous 71 non-"<code>></code>" line</td></tr> 72<tr class="odd"><td>2</td> 73 <td><p>type of data to match</p> 74 <table class="bordered"> 75 76 <tr><td><code>byte</code></td> 77 <td>single character</td></tr> 78 <tr><td><code>short</code></td> 79 <td>machine-order 16-bit integer</td></tr> 80 <tr><td><code>long</code></td> 81 <td>machine-order 32-bit integer</td></tr> 82 <tr><td><code>string</code></td> 83 <td>arbitrary-length string</td></tr> 84 <tr><td><code>date</code></td> 85 <td>long integer date (seconds since Unix epoch/1970)</td></tr> 86 <tr><td><code>beshort</code></td> 87 <td>big-endian 16-bit integer</td></tr> 88 <tr><td><code>belong</code></td> 89 <td>big-endian 32-bit integer</td></tr> 90 <tr><td><code>bedate</code></td> 91 <td>big-endian 32-bit integer date</td></tr> 92 <tr><td><code>leshort</code></td> 93 <td>little-endian 16-bit integer</td></tr> 94 <tr><td><code>lelong</code></td> 95 <td>little-endian 32-bit integer</td></tr> 96 <tr><td><code>ledate</code></td> 97 <td>little-endian 32-bit integer date</td></tr> 98 </table></td></tr> 99<tr><td>3</td> 100 <td>contents of data to match</td></tr> 101<tr class="odd"><td>4</td> 102 <td>MIME type if matched</td></tr> 103<tr><td>5</td> 104 <td>MIME encoding if matched (optional)</td></tr> 105</table> 106 107 <p>For example, the following magic file lines would recognize 108 some audio formats:</p> 109 110 <div class="example"><pre># Sun/NeXT audio data 1110 string .snd 112>12 belong 1 audio/basic 113>12 belong 2 audio/basic 114>12 belong 3 audio/basic 115>12 belong 4 audio/basic 116>12 belong 5 audio/basic 117>12 belong 6 audio/basic 118>12 belong 7 audio/basic 119>12 belong 23 audio/x-adpcm</pre></div> 120 121 <p>Or these would recognize the difference between <code>*.doc</code> 122 files containing Microsoft Word or FrameMaker documents. (These are 123 incompatible file formats which use the same file suffix.)</p> 124 125 <div class="example"><pre># Frame 1260 string \<MakerFile application/x-frame 1270 string \<MIFFile application/x-frame 1280 string \<MakerDictionary application/x-frame 1290 string \<MakerScreenFon application/x-frame 1300 string \<MML application/x-frame 1310 string \<Book application/x-frame 1320 string \<Maker application/x-frame 133 134# MS-Word 1350 string \376\067\0\043 application/msword 1360 string \320\317\021\340\241\261 application/msword 1370 string \333\245-\0\0\0 application/msword</pre></div> 138 139 <p>An optional MIME encoding can be included as a fifth column. 140 For example, this can recognize gzipped files and set the 141 encoding for them.</p> 142 143 <div class="example"><pre># gzip (GNU zip, not to be confused with 144# [Info-ZIP/PKWARE] zip archiver) 145 1460 string \037\213 application/octet-stream x-gzip</pre></div> 147</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 148<div class="section"> 149<h2><a name="performance" id="performance">Performance Issues</a></h2> 150 <p>This module is not for every system. If your system is barely 151 keeping up with its load or if you're performing a web server 152 benchmark, you may not want to enable this because the 153 processing is not free.</p> 154 155 <p>However, an effort was made to improve the performance of 156 the original <code>file(1)</code> code to make it fit in a busy web 157 server. It was designed for a server where there are thousands of users 158 who publish their own documents. This is probably very common 159 on intranets. Many times, it's helpful if the server can make 160 more intelligent decisions about a file's contents than the 161 file name allows ...even if just to reduce the "why doesn't my 162 page work" calls when users improperly name their own files. 163 You have to decide if the extra work suits your 164 environment.</p> 165</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 166<div class="section"> 167<h2><a name="notes" id="notes">Notes</a></h2> 168 <p>The following notes apply to the <code class="module"><a href="/mod/mod_mime_magic.html">mod_mime_magic</a></code> 169 module and are included here for compliance with contributors' 170 copyright restrictions that require their acknowledgment.</p> 171 172 <div class="note"> 173 <p>mod_mime_magic: MIME type lookup via file magic numbers<br /> 174 Copyright (c) 1996-1997 Cisco Systems, Inc.</p> 175 176 <p>This software was submitted by Cisco Systems to the Apache Group 177 in July 1997. Future revisions and derivatives of this source code 178 must acknowledge Cisco Systems as the original contributor of this 179 module. All other licensing and usage conditions are those of the 180 Apache Group.</p> 181 182 <p>Some of this code is derived from the free version of the file 183 command originally posted to comp.sources.unix. Copyright info for 184 that program is included below as required.</p> 185 </div> 186 187 <div class="note"> 188 <p> - Copyright (c) Ian F. Darwin, 1987. Written by Ian F. Darwin.</p> 189 190 <p>This software is not subject to any license of the American 191 Telephone and Telegraph Company or of the Regents of the University 192 of California.</p> 193 194 <p>Permission is granted to anyone to use this software for any 195 purpose on any computer system, and to alter it and redistribute it 196 freely, subject to the following restrictions:</p> 197 198 <ol> 199 <li>The author is not responsible for the consequences of use of 200 this software, no matter how awful, even if they arise from flaws 201 in it.</li> 202 203 <li>The origin of this software must not be misrepresented, either 204 by explicit claim or by omission. Since few users ever read 205 sources, credits must appear in the documentation.</li> 206 207 <li>Altered versions must be plainly marked as such, and must not 208 be misrepresented as being the original software. Since few users 209 ever read sources, credits must appear in the documentation.</li> 210 211 <li>This notice may not be removed or altered.</li> 212 </ol> 213 </div> 214 215 <div class="note"> 216 <p>For compliance with Mr Darwin's terms: this has been very 217 significantly modified from the free "file" command.</p> 218 219 <ul> 220 <li>all-in-one file for compilation convenience when moving from 221 one version of Apache to the next.</li> 222 223 <li>Memory allocation is done through the Apache API's pool 224 structure.</li> 225 226 <li>All functions have had necessary Apache API request or server 227 structures passed to them where necessary to call other Apache API 228 routines. (<em>i.e.</em>, usually for logging, files, or memory 229 allocation in itself or a called function.)</li> 230 231 <li>struct magic has been converted from an array to a single-ended 232 linked list because it only grows one record at a time, it's only 233 accessed sequentially, and the Apache API has no equivalent of 234 <code>realloc()</code>.</li> 235 236 <li>Functions have been changed to get their parameters from the 237 server configuration instead of globals. (It should be reentrant 238 now but has not been tested in a threaded environment.)</li> 239 240 <li>Places where it used to print results to stdout now saves them 241 in a list where they're used to set the MIME type in the Apache 242 request record.</li> 243 244 <li>Command-line flags have been removed since they will never be 245 used here.</li> 246 </ul> 247 </div> 248</div> 249<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div> 250<div class="directive-section"><h2><a name="MimeMagicFile" id="MimeMagicFile">MimeMagicFile</a> <a name="mimemagicfile" id="mimemagicfile">Directive</a></h2> 251<table class="directive"> 252<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable MIME-type determination based on file contents 253using the specified magic file</td></tr> 254<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>MimeMagicFile <var>file-path</var></code></td></tr> 255<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr> 256<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr> 257<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_mime_magic</td></tr> 258</table> 259 <p>The <code class="directive">MimeMagicFile</code> directive can be used to 260 enable this module, the default file is distributed at 261 <code>conf/magic</code>. Non-rooted paths are relative to the 262 <code class="directive"><a href="/mod/core.html#serverroot">ServerRoot</a></code>. Virtual hosts will use 263 the same file as the main server unless a more specific setting is 264 used, in which case the more specific setting overrides the main 265 server's file.</p> 266 267 <div class="example"><h3>Example</h3><p><code> 268 MimeMagicFile conf/magic 269 </code></p></div> 270 271</div> 272</div> 273<div class="bottomlang"> 274<p><span>Available Languages: </span><a href="/en/mod/mod_mime_magic.html" title="English"> en </a></p> 275</div><div class="top"><a href="#page-header"><img src="/images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div> 276<script type="text/javascript"><!--//--><![CDATA[//><!-- 277var comments_shortname = 'httpd'; 278var comments_identifier = 'http://httpd.apache.org/docs/2.2/mod/mod_mime_magic.html'; 279(function(w, d) { 280 if (w.location.hostname.toLowerCase() == "httpd.apache.org") { 281 d.write('<div id="comments_thread"><\/div>'); 282 var s = d.createElement('script'); 283 s.type = 'text/javascript'; 284 s.async = true; 285 s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier; 286 (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s); 287 } 288 else { 289 d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>'); 290 } 291})(window, document); 292//--><!]]></script></div><div id="footer"> 293<p class="apache">Copyright 2013 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> 294<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/directives.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!-- 295if (typeof(prettyPrint) !== 'undefined') { 296 prettyPrint(); 297} 298//--><!]]></script> 299</body></html>
