You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by nd...@apache.org on 2002/12/15 17:54:07 UTC
cvs commit: httpd-2.0/docs/manual/mod mod_mime_magic.html.en quickreference.html.en
nd 2002/12/15 08:54:07
Modified: docs/manual/mod mod_mime_magic.html.en
quickreference.html.en
Log:
update transformation
Revision Changes Path
1.16 +169 -233 httpd-2.0/docs/manual/mod/mod_mime_magic.html.en
Index: mod_mime_magic.html.en
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/mod_mime_magic.html.en,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -r1.15 -r1.16
--- mod_mime_magic.html.en 11 Dec 2002 21:18:12 -0000 1.15
+++ mod_mime_magic.html.en 15 Dec 2002 16:54:07 -0000 1.16
@@ -28,12 +28,9 @@
<h3>Summary</h3>
<p>This module determines the MIME type of files in the same
- way the Unix file(1) command works: it looks at the first few
- bytes of the file. It is intended as a "second line of defense"
- for cases that <code class="module"><a href="../mod/mod_mime.html">mod_mime</a></code> can't
- resolve. To assure that mod_mime gets first try at determining
- a file's MIME type, be sure to list mod_mime_magic
- <strong>before</strong> mod_mime in the configuration.</p>
+ way the Unix <code>file(1)</code> command works: it looks at the first
+ few bytes of the file. It is intended as a "second line of defense"
+ for cases that <code class="module"><a href="../mod/mod_mime.html">mod_mime</a></code> can't resolve.</p>
<p>This module is derived from a free version of the
<code>file(1)</code> command for Unix, which uses "magic
@@ -47,180 +44,109 @@
</ul>
<h3>Topics</h3>
<ul id="topics">
-<li><img alt="" src="../images/down.gif" /> Format of the Magic File</li>
-<li><img alt="" src="../images/down.gif" /> Performance Issues</li>
+<li><img alt="" src="../images/down.gif" /> <a href="#format">Format of the Magic File</a></li>
+<li><img alt="" src="../images/down.gif" /> <a href="#performance">Performance Issues</a></li>
<li><img alt="" src="../images/down.gif" /> <a href="#notes">Notes</a></li>
</ul></div>
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
<div class="section">
-<h2>Format of the Magic File</h2>
+<h2><a name="format" id="format">Format of the Magic File</a></h2>
<p>The contents of the file are plain ASCII text in 4-5
columns. Blank lines are allowed but ignored. Commented lines
- use a hash mark "#". The remaining lines are parsed for the
- following columns:</p>
-
- <table class="bordered">
- <tr>
- <th>Column</th>
-
- <th>Description</th>
- </tr>
-
- <tr>
- <td>1</td>
+ use a hash mark (<code>#</code>). The remaining lines are parsed for
+ the following columns:</p>
+ <table class="bordered"><tr class="header"><th>Column</th><th>Description</th></tr>
+<tr><td>1</td>
<td>byte number to begin checking from<br />
- ">" indicates a dependency upon the previous non-">"
- line</td>
- </tr>
-
- <tr>
- <td>2</td>
-
- <td>
- type of data to match
-
- <table class="bordered">
- <tr>
- <td>byte</td>
-
- <td>single character</td>
- </tr>
-
- <tr>
- <td>short</td>
-
- <td>machine-order 16-bit integer</td>
- </tr>
-
- <tr>
- <td>long</td>
-
- <td>machine-order 32-bit integer</td>
- </tr>
-
- <tr>
- <td>string</td>
-
- <td>arbitrary-length string</td>
- </tr>
-
- <tr>
- <td>date</td>
-
- <td>long integer date (seconds since Unix
- epoch/1970)</td>
- </tr>
-
- <tr>
- <td>beshort</td>
-
- <td>big-endian 16-bit integer</td>
- </tr>
-
- <tr>
- <td>belong</td>
-
- <td>big-endian 32-bit integer</td>
- </tr>
-
- <tr>
- <td>bedate</td>
-
- <td>big-endian 32-bit integer date</td>
- </tr>
-
- <tr>
- <td>leshort</td>
-
- <td>little-endian 16-bit integer</td>
- </tr>
-
- <tr>
- <td>lelong</td>
-
- <td>little-endian 32-bit integer</td>
- </tr>
-
- <tr>
- <td>ledate</td>
-
- <td>little-endian 32-bit integer date</td>
- </tr>
- </table>
- </td>
- </tr>
-
- <tr>
- <td>3</td>
-
- <td>contents of data to match</td>
- </tr>
-
- <tr>
- <td>4</td>
-
- <td>MIME type if matched</td>
- </tr>
+ "<code>></code>" indicates a dependency upon the previous
+ non-"<code>></code>" line</td></tr>
+<tr class="odd"><td>2</td>
+ <td>type of data to match
+ <table class="bordered">
+ <tr><td><code>byte</code></td>
+ <td>single character</td></tr>
+ <tr><td><code>short</code></td>
+ <td>machine-order 16-bit integer</td></tr>
+ <tr><td><code>long</code></td>
+ <td>machine-order 32-bit integer</td></tr>
+ <tr><td><code>string</code></td>
+ <td>arbitrary-length string</td></tr>
+ <tr><td><code>date</code></td>
+ <td>long integer date (seconds since Unix epoch/1970)</td></tr>
+ <tr><td><code>beshort</code></td>
+ <td>big-endian 16-bit integer</td></tr>
+ <tr><td><code>belong</code></td>
+ <td>big-endian 32-bit integer</td></tr>
+ <tr><td><code>bedate</code></td>
+ <td>big-endian 32-bit integer date</td></tr>
+ <tr><td><code>leshort</code></td>
+ <td>little-endian 16-bit integer</td></tr>
+ <tr><td><code>lelong</code></td>
+ <td>little-endian 32-bit integer</td></tr>
+ <tr><td><code>ledate</code></td>
+ <td>little-endian 32-bit integer date</td></tr>
+ </table></td></tr>
+<tr><td>3</td>
+ <td>contents of data to match</td></tr>
+<tr class="odd"><td>4</td>
+ <td>MIME type if matched</td></tr>
+<tr><td>5</td>
+ <td>MIME encoding if matched (optional)</td></tr>
+</table>
- <tr>
- <td>5</td>
+ <p>For example, the following magic file lines would recognize
+ some audio formats:</p>
- <td>MIME encoding if matched (optional)</td>
- </tr>
- </table>
+ <div class="example"><pre># Sun/NeXT audio data
+0 string .snd
+>12 belong 1 audio/basic
+>12 belong 2 audio/basic
+>12 belong 3 audio/basic
+>12 belong 4 audio/basic
+>12 belong 5 audio/basic
+>12 belong 6 audio/basic
+>12 belong 7 audio/basic
+>12 belong 23 audio/x-adpcm</pre></div>
- <p>For example, the following magic file lines would recognize
- some audio formats.</p>
-<div class="example"><pre>
-# Sun/NeXT audio data
-0 string .snd
->12 belong 1 audio/basic
->12 belong 2 audio/basic
->12 belong 3 audio/basic
->12 belong 4 audio/basic
->12 belong 5 audio/basic
->12 belong 6 audio/basic
->12 belong 7 audio/basic
->12 belong 23 audio/x-adpcm
-</pre></div>
- <p>Or these would recognize the difference between "*.doc" files
- containing Microsoft Word or FrameMaker documents. (These are
+ <p>Or these would recognize the difference between <code>*.doc</code>
+ files containing Microsoft Word or FrameMaker documents. (These are
incompatible file formats which use the same file suffix.)</p>
-<div class="example"><pre>
-# Frame
-0 string \<MakerFile application/x-frame
-0 string \<MIFFile application/x-frame
-0 string \<MakerDictionary application/x-frame
-0 string \<MakerScreenFon application/x-frame
-0 string \<MML application/x-frame
-0 string \<Book application/x-frame
-0 string \<Maker application/x-frame
+
+ <div class="example"><pre># Frame
+0 string \<MakerFile application/x-frame
+0 string \<MIFFile application/x-frame
+0 string \<MakerDictionary application/x-frame
+0 string \<MakerScreenFon application/x-frame
+0 string \<MML application/x-frame
+0 string \<Book application/x-frame
+0 string \<Maker application/x-frame
# MS-Word
-0 string \376\067\0\043 application/msword
-0 string \320\317\021\340\241\261 application/msword
-0 string \333\245-\0\0\0 application/msword
-</pre></div>
+0 string \376\067\0\043 application/msword
+0 string \320\317\021\340\241\261 application/msword
+0 string \333\245-\0\0\0 application/msword</pre></div>
+
<p>An optional MIME encoding can be included as a fifth column.
For example, this can recognize gzipped files and set the
encoding for them.</p>
-<div class="example"><pre>
-# gzip (GNU zip, not to be confused with [Info-ZIP/PKWARE] zip archiver)
-0 string \037\213 application/octet-stream x-gzip
-</pre></div>
+
+ <div class="example"><pre># gzip (GNU zip, not to be confused with
+# [Info-ZIP/PKWARE] zip archiver)
+
+0 string \037\213 application/octet-stream x-gzip</pre></div>
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
<div class="section">
-<h2>Performance Issues</h2>
+<h2><a name="performance" id="performance">Performance Issues</a></h2>
<p>This module is not for every system. If your system is barely
keeping up with its load or if you're performing a web server
benchmark, you may not want to enable this because the
processing is not free.</p>
<p>However, an effort was made to improve the performance of
- the original file(1) code to make it fit in a busy web server.
- It was designed for a server where there are thousands of users
+ the original <code>file(1)</code> code to make it fit in a busy web
+ server. It was designed for a server where there are thousands of users
who publish their own documents. This is probably very common
on intranets. Many times, it's helpful if the server can make
more intelligent decisions about a file's contents than the
@@ -228,86 +154,96 @@
page work" calls when users improperly name their own files.
You have to decide if the extra work suits your
environment.</p>
-
- <p>When compiling an Apache server, this module should be at or
- near the top of the list of modules in the Configuration file.
- The modules are listed in increasing priority so that will mean
- this one is used only as a last resort, just like it was
- designed to.</p>
-
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
<div class="section">
<h2><a name="notes" id="notes">Notes</a></h2>
-
- <p>The following notes apply to the mod_mime_magic module and are
- included here for compliance with contributors' copyright
- restrictions that require their acknowledgment. </p>
-<pre>
-/*
- * mod_mime_magic: MIME type lookup via file magic numbers
- * Copyright (c) 1996-1997 Cisco Systems, Inc.
- *
- * This software was submitted by Cisco Systems to the Apache Group in July
- * 1997. Future revisions and derivatives of this source code must
- * acknowledge Cisco Systems as the original contributor of this module.
- * All other licensing and usage conditions are those of the Apache Group.
- *
- * Some of this code is derived from the free version of the file command
- * originally posted to comp.sources.unix. Copyright info for that program
- * is included below as required.
- * ---------------------------------------------------------------------------
- * - Copyright (c) Ian F. Darwin, 1987. Written by Ian F. Darwin.
- *
- * This software is not subject to any license of the American Telephone and
- * Telegraph Company or of the Regents of the University of California.
- *
- * Permission is granted to anyone to use this software for any purpose on any
- * computer system, and to alter it and redistribute it freely, subject to
- * the following restrictions:
- *
- * 1. The author is not responsible for the consequences of use of this
- * software, no matter how awful, even if they arise from flaws in it.
- *
- * 2. The origin of this software must not be misrepresented, either by
- * explicit claim or by omission. Since few users ever read sources, credits
- * must appear in the documentation.
- *
- * 3. Altered versions must be plainly marked as such, and must not be
- * misrepresented as being the original software. Since few users ever read
- * sources, credits must appear in the documentation.
- *
- * 4. This notice may not be removed or altered.
- * -------------------------------------------------------------------------
- *
- * For compliance with Mr Darwin's terms: this has been very significantly
- * modified from the free "file" command.
- * - all-in-one file for compilation convenience when moving from one
- * version of Apache to the next.
- * - Memory allocation is done through the Apache API's pool structure.
- * - All functions have had necessary Apache API request or server
- * structures passed to them where necessary to call other Apache API
- * routines. (<em>i.e.</em>, usually for logging, files, or memory allocation in
- * itself or a called function.)
- * - struct magic has been converted from an array to a single-ended linked
- * list because it only grows one record at a time, it's only accessed
- * sequentially, and the Apache API has no equivalent of realloc().
- * - Functions have been changed to get their parameters from the server
- * configuration instead of globals. (It should be reentrant now but has
- * not been tested in a threaded environment.)
- * - Places where it used to print results to stdout now saves them in a
- * list where they're used to set the MIME type in the Apache request
- * record.
- * - Command-line flags have been removed since they will never be used here.
- *
- */
-</pre>
+ <p>The following notes apply to the <code class="module"><a href="../mod/mod_mime_magic.html">mod_mime_magic</a></code>
+ module and are included here for compliance with contributors'
+ copyright restrictions that require their acknowledgment.</p>
+
+ <div class="note">
+ <p>mod_mime_magic: MIME type lookup via file magic numbers<br />
+ Copyright (c) 1996-1997 Cisco Systems, Inc.</p>
+
+ <p>This software was submitted by Cisco Systems to the Apache Group
+ in July 1997. Future revisions and derivatives of this source code
+ must acknowledge Cisco Systems as the original contributor of this
+ module. All other licensing and usage conditions are those of the
+ Apache Group.</p>
+
+ <p>Some of this code is derived from the free version of the file
+ command originally posted to comp.sources.unix. Copyright info for
+ that program is included below as required.</p>
+ </div>
+
+ <div class="note">
+ <p> - Copyright (c) Ian F. Darwin, 1987. Written by Ian F. Darwin.</p>
+
+ <p>This software is not subject to any license of the American
+ Telephone and Telegraph Company or of the Regents of the University
+ of California.</p>
+
+ <p>Permission is granted to anyone to use this software for any
+ purpose on any computer system, and to alter it and redistribute it
+ freely, subject to the following restrictions:</p>
+
+ <ol>
+ <li>The author is not responsible for the consequences of use of
+ this software, no matter how awful, even if they arise from flaws
+ in it.</li>
+
+ <li>The origin of this software must not be misrepresented, either
+ by explicit claim or by omission. Since few users ever read
+ sources, credits must appear in the documentation.</li>
+
+ <li>Altered versions must be plainly marked as such, and must not
+ be misrepresented as being the original software. Since few users
+ ever read sources, credits must appear in the documentation.</li>
+
+ <li>This notice may not be removed or altered.</li>
+ </ol>
+ </div>
+
+ <div class="note">
+ <p>For compliance with Mr Darwin's terms: this has been very
+ significantly modified from the free "file" command.</p>
+
+ <ul>
+ <li>all-in-one file for compilation convenience when moving from
+ one version of Apache to the next.</li>
+
+ <li>Memory allocation is done through the Apache API's pool
+ structure.</li>
+
+ <li>All functions have had necessary Apache API request or server
+ structures passed to them where necessary to call other Apache API
+ routines. (<em>i.e.</em>, usually for logging, files, or memory
+ allocation in itself or a called function.)</li>
+
+ <li>struct magic has been converted from an array to a single-ended
+ linked list because it only grows one record at a time, it's only
+ accessed sequentially, and the Apache API has no equivalent of
+ <code>realloc()</code>.</li>
+
+ <li>Functions have been changed to get their parameters from the
+ server configuration instead of globals. (It should be reentrant
+ now but has not been tested in a threaded environment.)</li>
+
+ <li>Places where it used to print results to stdout now saves them
+ in a list where they're used to set the MIME type in the Apache
+ request record.</li>
+
+ <li>Command-line flags have been removed since they will never be
+ used here.</li>
+ </ul>
+ </div>
</div>
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
<div class="directive-section"><h2><a name="MimeMagicFile" id="MimeMagicFile">MimeMagicFile</a> <a name="mimemagicfile" id="mimemagicfile">Directive</a></h2>
<table class="directive">
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enable MIME-type determination based on file contents
using the specified magic file</td></tr>
-<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>MimeMagicFile <em>file-path</em></code></td></tr>
+<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>MimeMagicFile <var>file-path</var></code></td></tr>
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr>
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_mime_magic</td></tr>
@@ -315,14 +251,14 @@
<p>The <code class="directive">MimeMagicFile</code> directive can be used to
enable this module, the default file is distributed at
<code>conf/magic</code>. Non-rooted paths are relative to the
- ServerRoot. Virtual hosts will use the same file as the main
- server unless a more specific setting is used, in which case
- the more specific setting overrides the main server's file.</p>
-
- <p>For example</p>
-
- <div class="example"><p><code>MimeMagicFile conf/magic</code></p></div>
-
+ <code class="directive"><a href="../mod/core.html#serverroot">ServerRoot</a></code>. Virtual hosts will use
+ the same file as the main server unless a more specific setting is
+ used, in which case the more specific setting overrides the main
+ server's file.</p>
+
+ <div class="example"><h3>Example</h3><p><code>
+ MimeMagicFile conf/magic
+ </code></p></div>
</div>
</div>
1.56 +1 -1 httpd-2.0/docs/manual/mod/quickreference.html.en
Index: quickreference.html.en
===================================================================
RCS file: /home/cvs/httpd-2.0/docs/manual/mod/quickreference.html.en,v
retrieving revision 1.55
retrieving revision 1.56
diff -u -r1.55 -r1.56
--- quickreference.html.en 11 Dec 2002 21:33:38 -0000 1.55
+++ quickreference.html.en 15 Dec 2002 16:54:07 -0000 1.56
@@ -418,7 +418,7 @@
<tr class="odd"><td><a href="mod_cern_meta.html#metafiles">MetaFiles on|off</a></td><td> off </td><td>svdh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Activates CERN meta-file processing</td></tr>
<tr><td><a href="mod_cern_meta.html#metasuffix">MetaSuffix <var>suffix</var></a></td><td> .meta </td><td>svdh</td><td>E</td></tr><tr><td class="descr" colspan="4">File name suffix for the file containg CERN-style
meta information</td></tr>
-<tr class="odd"><td><a href="mod_mime_magic.html#mimemagicfile">MimeMagicFile <em>file-path</em></a></td><td /><td>sv</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Enable MIME-type determination based on file contents
+<tr class="odd"><td><a href="mod_mime_magic.html#mimemagicfile">MimeMagicFile <var>file-path</var></a></td><td /><td>sv</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Enable MIME-type determination based on file contents
using the specified magic file</td></tr>
<tr><td><a href="prefork.html#minspareservers">MinSpareServers <var>number</var></a></td><td> 5 </td><td>s</td><td>M</td></tr><tr><td class="descr" colspan="4">Minimum number of idle child server processes</td></tr>
<tr class="odd"><td><a href="mpm_common.html#minsparethreads">MinSpareThreads <var>number</var></a></td><td /><td>s</td><td>M</td></tr><tr class="odd"><td class="descr" colspan="4">Minimum number of idle threads available to handle request