home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 November / CMCD1104.ISO / Software / Complet / Apache / apache_2.0.52-win32-x86-no_ssl.msi / Data.Cab / F278092_mod_mime_magic.html.en < prev    next >
Extensible Markup Language  |  2004-04-03  |  14KB  |  274 lines
  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" />
  12. <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  13. <body>
  14. <div id="page-header">
  15. <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>
  16. <p class="apache">Apache HTTP Server Version 2.0</p>
  17. <img alt="" src="../images/feather.gif" /></div>
  18. <div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
  19. <div id="path">
  20. <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.0</a> > <a href="./">Modules</a></div>
  21. <div id="page-content">
  22. <div id="preamble"><h1>Apache Module mod_mime_magic</h1>
  23. <div class="toplang">
  24. <p><span>Available Languages: </span><a href="../en/mod/mod_mime_magic.html" title="English"> en </a></p>
  25. </div>
  26. <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Determines the MIME type of a file
  27.     by looking at a few bytes of its contents</td></tr>
  28. <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  29. <tr><th><a href="module-dict.html#ModuleIdentifier">ModuleáIdentifier:</a></th><td>mime_magic_module</td></tr>
  30. <tr><th><a href="module-dict.html#SourceFile">SourceáFile:</a></th><td>mod_mime_magic.c</td></tr></table>
  31. <h3>Summary</h3>
  32.  
  33.     <p>This module determines the MIME type of files in the same
  34.     way the Unix <code>file(1)</code> command works: it looks at the first
  35.     few bytes of the file. It is intended as a "second line of defense"
  36.     for cases that <code class="module"><a href="../mod/mod_mime.html">mod_mime</a></code> can't resolve.</p>
  37.  
  38.     <p>This module is derived from a free version of the
  39.     <code>file(1)</code> command for Unix, which uses "magic
  40.     numbers" and other hints from a file's contents to figure out
  41.     what the contents are. This module is active only if the magic
  42.     file is specified by the <code class="directive"><a href="#mimemagicfile">MimeMagicFile</a></code> directive.</p>
  43. </div>
  44. <div id="quickview"><h3 class="directives">Directives</h3>
  45. <ul id="toc">
  46. <li><img alt="" src="../images/down.gif" /> <a href="#mimemagicfile">MimeMagicFile</a></li>
  47. </ul>
  48. <h3>Topics</h3>
  49. <ul id="topics">
  50. <li><img alt="" src="../images/down.gif" /> <a href="#format">Format of the Magic File</a></li>
  51. <li><img alt="" src="../images/down.gif" /> <a href="#performance">Performance Issues</a></li>
  52. <li><img alt="" src="../images/down.gif" /> <a href="#notes">Notes</a></li>
  53. </ul></div>
  54. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  55. <div class="section">
  56. <h2><a name="format" id="format">Format of the Magic File</a></h2>
  57.  
  58.     <p>The contents of the file are plain ASCII text in 4-5
  59.     columns. Blank lines are allowed but ignored. Commented lines
  60.     use a hash mark (<code>#</code>). The remaining lines are parsed for
  61.     the following columns:</p>
  62.  
  63.     <table class="bordered"><tr class="header"><th>Column</th><th>Description</th></tr>
  64. <tr><td>1</td>
  65.         <td>byte number to begin checking from<br />
  66.          "<code>></code>" indicates a dependency upon the previous
  67.          non-"<code>></code>" line</td></tr>
  68. <tr class="odd"><td>2</td>
  69.         <td><p>type of data to match</p>
  70.         <table class="bordered">
  71.         
  72.         <tr><td><code>byte</code></td>
  73.             <td>single character</td></tr>
  74.         <tr><td><code>short</code></td>
  75.             <td>machine-order 16-bit integer</td></tr>
  76.         <tr><td><code>long</code></td>
  77.             <td>machine-order 32-bit integer</td></tr>
  78.         <tr><td><code>string</code></td>
  79.             <td>arbitrary-length string</td></tr>
  80.         <tr><td><code>date</code></td>
  81.             <td>long integer date (seconds since Unix epoch/1970)</td></tr>
  82.         <tr><td><code>beshort</code></td>
  83.             <td>big-endian 16-bit integer</td></tr>
  84.         <tr><td><code>belong</code></td>
  85.             <td>big-endian 32-bit integer</td></tr>
  86.         <tr><td><code>bedate</code></td>
  87.             <td>big-endian 32-bit integer date</td></tr>
  88.         <tr><td><code>leshort</code></td>
  89.             <td>little-endian 16-bit integer</td></tr>
  90.         <tr><td><code>lelong</code></td>
  91.             <td>little-endian 32-bit integer</td></tr>
  92.         <tr><td><code>ledate</code></td>
  93.             <td>little-endian 32-bit integer date</td></tr>
  94.         </table></td></tr>
  95. <tr><td>3</td>
  96.         <td>contents of data to match</td></tr>
  97. <tr class="odd"><td>4</td>
  98.         <td>MIME type if matched</td></tr>
  99. <tr><td>5</td>
  100.         <td>MIME encoding if matched (optional)</td></tr>
  101. </table>
  102.  
  103.     <p>For example, the following magic file lines would recognize
  104.     some audio formats:</p>
  105.  
  106.     <div class="example"><pre># Sun/NeXT audio data
  107. 0      string      .snd
  108. >12    belong      1       audio/basic
  109. >12    belong      2       audio/basic
  110. >12    belong      3       audio/basic
  111. >12    belong      4       audio/basic
  112. >12    belong      5       audio/basic
  113. >12    belong      6       audio/basic
  114. >12    belong      7       audio/basic
  115. >12    belong     23       audio/x-adpcm</pre></div>
  116.  
  117.     <p>Or these would recognize the difference between <code>*.doc</code>
  118.     files containing Microsoft Word or FrameMaker documents. (These are
  119.     incompatible file formats which use the same file suffix.)</p>
  120.  
  121.     <div class="example"><pre># Frame
  122. 0  string  \<MakerFile        application/x-frame
  123. 0  string  \<MIFFile          application/x-frame
  124. 0  string  \<MakerDictionary  application/x-frame
  125. 0  string  \<MakerScreenFon   application/x-frame
  126. 0  string  \<MML              application/x-frame
  127. 0  string  \<Book             application/x-frame
  128. 0  string  \<Maker            application/x-frame
  129.  
  130. # MS-Word
  131. 0  string  \376\067\0\043            application/msword
  132. 0  string  \320\317\021\340\241\261  application/msword
  133. 0  string  \333\245-\0\0\0           application/msword</pre></div>
  134.  
  135.     <p>An optional MIME encoding can be included as a fifth column.
  136.     For example, this can recognize gzipped files and set the
  137.     encoding for them.</p>
  138.  
  139.     <div class="example"><pre># gzip (GNU zip, not to be confused with
  140. #       [Info-ZIP/PKWARE] zip archiver)
  141.  
  142. 0  string  \037\213  application/octet-stream  x-gzip</pre></div>
  143. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  144. <div class="section">
  145. <h2><a name="performance" id="performance">Performance Issues</a></h2>
  146.     <p>This module is not for every system. If your system is barely
  147.     keeping up with its load or if you're performing a web server
  148.     benchmark, you may not want to enable this because the
  149.     processing is not free.</p>
  150.  
  151.     <p>However, an effort was made to improve the performance of
  152.     the original <code>file(1)</code> code to make it fit in a busy web
  153.     server. It was designed for a server where there are thousands of users
  154.     who publish their own documents. This is probably very common
  155.     on intranets. Many times, it's helpful if the server can make
  156.     more intelligent decisions about a file's contents than the
  157.     file name allows ...even if just to reduce the "why doesn't my
  158.     page work" calls when users improperly name their own files.
  159.     You have to decide if the extra work suits your
  160.     environment.</p>
  161. </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  162. <div class="section">
  163. <h2><a name="notes" id="notes">Notes</a></h2>
  164.     <p>The following notes apply to the <code class="module"><a href="../mod/mod_mime_magic.html">mod_mime_magic</a></code>
  165.     module and are included here for compliance with contributors'
  166.     copyright restrictions that require their acknowledgment.</p>
  167.  
  168.     <div class="note">
  169.       <p>mod_mime_magic: MIME type lookup via file magic numbers<br />
  170.       Copyright (c) 1996-1997 Cisco Systems, Inc.</p>
  171.  
  172.       <p>This software was submitted by Cisco Systems to the Apache Group
  173.       in July 1997. Future revisions and derivatives of this source code
  174.       must acknowledge Cisco Systems as the original contributor of this
  175.       module. All other licensing and usage conditions are those of the
  176.       Apache Group.</p>
  177.  
  178.       <p>Some of this code is derived from the free version of the file
  179.       command originally posted to comp.sources.unix. Copyright info for
  180.       that program is included below as required.</p>
  181.     </div>
  182.  
  183.     <div class="note">
  184.       <p> - Copyright (c) Ian F. Darwin, 1987. Written by Ian F. Darwin.</p>
  185.  
  186.       <p>This software is not subject to any license of the American
  187.       Telephone and Telegraph Company or of the Regents of the University
  188.       of California.</p>
  189.  
  190.       <p>Permission is granted to anyone to use this software for any
  191.       purpose on any computer system, and to alter it and redistribute it
  192.       freely, subject to the following restrictions:</p>
  193.  
  194.       <ol>
  195.         <li>The author is not responsible for the consequences of use of
  196.         this software, no matter how awful, even if they arise from flaws
  197.         in it.</li>
  198.  
  199.         <li>The origin of this software must not be misrepresented, either
  200.         by explicit claim or by omission. Since few users ever read
  201.         sources, credits must appear in the documentation.</li>
  202.  
  203.         <li>Altered versions must be plainly marked as such, and must not
  204.         be misrepresented as being the original software. Since few users
  205.         ever read sources, credits must appear in the documentation.</li>
  206.  
  207.         <li>This notice may not be removed or altered.</li>
  208.       </ol>
  209.     </div>
  210.  
  211.     <div class="note">
  212.       <p>For compliance with Mr Darwin's terms: this has been very
  213.       significantly modified from the free "file" command.</p>
  214.  
  215.       <ul>
  216.         <li>all-in-one file for compilation convenience when moving from
  217.         one version of Apache to the next.</li>
  218.  
  219.         <li>Memory allocation is done through the Apache API's pool
  220.         structure.</li>
  221.  
  222.         <li>All functions have had necessary Apache API request or server
  223.         structures passed to them where necessary to call other Apache API
  224.         routines. (<em>i.e.</em>, usually for logging, files, or memory
  225.         allocation in itself or a called function.)</li>
  226.  
  227.         <li>struct magic has been converted from an array to a single-ended
  228.         linked list because it only grows one record at a time, it's only
  229.         accessed sequentially, and the Apache API has no equivalent of
  230.         <code>realloc()</code>.</li>
  231.  
  232.         <li>Functions have been changed to get their parameters from the
  233.         server configuration instead of globals.  (It should be reentrant
  234.         now but has not been tested in a threaded environment.)</li>
  235.  
  236.         <li>Places where it used to print results to stdout now saves them
  237.         in a list where they're used to set the MIME type in the Apache
  238.         request record.</li>
  239.  
  240.         <li>Command-line flags have been removed since they will never be
  241.         used here.</li>
  242.       </ul>
  243.     </div>
  244. </div>
  245. <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  246. <div class="directive-section"><h2><a name="MimeMagicFile" id="MimeMagicFile">MimeMagicFile</a> <a name="mimemagicfile" id="mimemagicfile">Directive</a></h2>
  247. <table class="directive">
  248. <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable MIME-type determination based on file contents
  249. using the specified magic file</td></tr>
  250. <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>MimeMagicFile <var>file-path</var></code></td></tr>
  251. <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
  252. <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  253. <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_mime_magic</td></tr>
  254. </table>
  255.     <p>The <code class="directive">MimeMagicFile</code> directive can be used to
  256.     enable this module, the default file is distributed at
  257.     <code>conf/magic</code>. Non-rooted paths are relative to the
  258.     <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>. Virtual hosts will use
  259.     the same file as the main server unless a more specific setting is
  260.     used, in which case the more specific setting overrides the main
  261.     server's file.</p>
  262.  
  263.     <div class="example"><h3>Example</h3><p><code>
  264.       MimeMagicFile conf/magic
  265.     </code></p></div>
  266.  
  267. </div>
  268. </div>
  269. <div class="bottomlang">
  270. <p><span>Available Languages: </span><a href="../en/mod/mod_mime_magic.html" title="English"> en </a></p>
  271. </div><div id="footer">
  272. <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>
  273. <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>
  274. </body></html>