mod_mime_magic.xml revision e942c741056732f50da2074b36fe59805d370650
6aada32e978e09cc60d52cb05ae4cee91b676da1slive<!DOCTYPE modulesynopsis SYSTEM "/style/modulesynopsis.dtd">
e942c741056732f50da2074b36fe59805d370650slive<?xml-stylesheet type="text/xsl" href="/style/manual.en.xsl"?>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive<modulesynopsis>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive<description>Determines the MIME type of a file
6aada32e978e09cc60d52cb05ae4cee91b676da1slive by looking at a few bytes of its contents</description>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <p>This module determines the MIME type of files in the same
6aada32e978e09cc60d52cb05ae4cee91b676da1slive way the Unix file(1) command works: it looks at the first few
6aada32e978e09cc60d52cb05ae4cee91b676da1slive bytes of the file. It is intended as a "second line of defense"
6aada32e978e09cc60d52cb05ae4cee91b676da1slive resolve. To assure that mod_mime gets first try at determining
6aada32e978e09cc60d52cb05ae4cee91b676da1slive a file's MIME type, be sure to list mod_mime_magic
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <strong>before</strong> mod_mime in the configuration.</p>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <p>This module is derived from a free version of the
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <code>file(1)</code> command for Unix, which uses "magic
6aada32e978e09cc60d52cb05ae4cee91b676da1slive numbers" and other hints from a file's contents to figure out
6aada32e978e09cc60d52cb05ae4cee91b676da1slive what the contents are. This module is active only if the magic
6aada32e978e09cc60d52cb05ae4cee91b676da1slive file is specified by the <directive module="mod_mime_magic"
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <p>The contents of the file are plain ASCII text in 4-5
6aada32e978e09cc60d52cb05ae4cee91b676da1slive columns. Blank lines are allowed but ignored. Commented lines
6aada32e978e09cc60d52cb05ae4cee91b676da1slive use a hash mark "#". The remaining lines are parsed for the
6aada32e978e09cc60d52cb05ae4cee91b676da1slive following columns:</p>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive ">" indicates a dependency upon the previous non-">"
6aada32e978e09cc60d52cb05ae4cee91b676da1slive type of data to match
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <td>long integer date (seconds since Unix
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <p>For example, the following magic file lines would recognize
6aada32e978e09cc60d52cb05ae4cee91b676da1slive some audio formats.</p>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive0 string .snd
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <p>Or these would recognize the difference between "*.doc" files
6aada32e978e09cc60d52cb05ae4cee91b676da1slive containing Microsoft Word or FrameMaker documents. (These are
6aada32e978e09cc60d52cb05ae4cee91b676da1slive incompatible file formats which use the same file suffix.)</p>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <p>An optional MIME encoding can be included as a fifth column.
6aada32e978e09cc60d52cb05ae4cee91b676da1slive For example, this can recognize gzipped files and set the
6aada32e978e09cc60d52cb05ae4cee91b676da1slive encoding for them.</p>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive# gzip (GNU zip, not to be confused with [Info-ZIP/PKWARE] zip archiver)
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <p>This module is not for every system. If your system is barely
6aada32e978e09cc60d52cb05ae4cee91b676da1slive keeping up with its load or if you're performing a web server
6aada32e978e09cc60d52cb05ae4cee91b676da1slive benchmark, you may not want to enable this because the
6aada32e978e09cc60d52cb05ae4cee91b676da1slive processing is not free.</p>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <p>However, an effort was made to improve the performance of
6aada32e978e09cc60d52cb05ae4cee91b676da1slive the original file(1) code to make it fit in a busy web server.
6aada32e978e09cc60d52cb05ae4cee91b676da1slive It was designed for a server where there are thousands of users
6aada32e978e09cc60d52cb05ae4cee91b676da1slive who publish their own documents. This is probably very common
6aada32e978e09cc60d52cb05ae4cee91b676da1slive on intranets. Many times, it's helpful if the server can make
6aada32e978e09cc60d52cb05ae4cee91b676da1slive more intelligent decisions about a file's contents than the
6aada32e978e09cc60d52cb05ae4cee91b676da1slive file name allows ...even if just to reduce the "why doesn't my
6aada32e978e09cc60d52cb05ae4cee91b676da1slive page work" calls when users improperly name their own files.
6aada32e978e09cc60d52cb05ae4cee91b676da1slive You have to decide if the extra work suits your
6aada32e978e09cc60d52cb05ae4cee91b676da1slive environment.</p>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <p>When compiling an Apache server, this module should be at or
6aada32e978e09cc60d52cb05ae4cee91b676da1slive near the top of the list of modules in the Configuration file.
6aada32e978e09cc60d52cb05ae4cee91b676da1slive The modules are listed in increasing priority so that will mean
6aada32e978e09cc60d52cb05ae4cee91b676da1slive this one is used only as a last resort, just like it was
6aada32e978e09cc60d52cb05ae4cee91b676da1slive designed to.</p>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <p>The following notes apply to the mod_mime_magic module and are
6aada32e978e09cc60d52cb05ae4cee91b676da1slive included here for compliance with contributors' copyright
6aada32e978e09cc60d52cb05ae4cee91b676da1slive restrictions that require their acknowledgment. </p>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * mod_mime_magic: MIME type lookup via file magic numbers
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * Copyright (c) 1996-1997 Cisco Systems, Inc.
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * This software was submitted by Cisco Systems to the Apache Group in July
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * 1997. Future revisions and derivatives of this source code must
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * acknowledge Cisco Systems as the original contributor of this module.
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * All other licensing and usage conditions are those of the Apache Group.
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * Some of this code is derived from the free version of the file command
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * originally posted to comp.sources.unix. Copyright info for that program
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * is included below as required.
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * ---------------------------------------------------------------------------
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * - Copyright (c) Ian F. Darwin, 1987. Written by Ian F. Darwin.
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * This software is not subject to any license of the American Telephone and
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * Telegraph Company or of the Regents of the University of California.
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * Permission is granted to anyone to use this software for any purpose on any
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * computer system, and to alter it and redistribute it freely, subject to
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * the following restrictions:
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * 1. The author is not responsible for the consequences of use of this
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * software, no matter how awful, even if they arise from flaws in it.
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * 2. The origin of this software must not be misrepresented, either by
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * explicit claim or by omission. Since few users ever read sources, credits
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * must appear in the documentation.
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * 3. Altered versions must be plainly marked as such, and must not be
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * misrepresented as being the original software. Since few users ever read
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * sources, credits must appear in the documentation.
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * 4. This notice may not be removed or altered.
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * -------------------------------------------------------------------------
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * For compliance with Mr Darwin's terms: this has been very significantly
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * modified from the free "file" command.
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * - all-in-one file for compilation convenience when moving from one
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * version of Apache to the next.
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * - Memory allocation is done through the Apache API's pool structure.
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * - All functions have had necessary Apache API request or server
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * structures passed to them where necessary to call other Apache API
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * routines. (<em>i.e.</em>, usually for logging, files, or memory allocation in
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * itself or a called function.)
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * - struct magic has been converted from an array to a single-ended linked
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * list because it only grows one record at a time, it's only accessed
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * sequentially, and the Apache API has no equivalent of realloc().
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * - Functions have been changed to get their parameters from the server
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * configuration instead of globals. (It should be reentrant now but has
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * not been tested in a threaded environment.)
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * - Places where it used to print results to stdout now saves them in a
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * list where they're used to set the MIME type in the Apache request
6aada32e978e09cc60d52cb05ae4cee91b676da1slive * - Command-line flags have been removed since they will never be used here.
6aada32e978e09cc60d52cb05ae4cee91b676da1slive<directivesynopsis>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive<description>Enable MIME-type determination based on file contents
6aada32e978e09cc60d52cb05ae4cee91b676da1sliveusing the specified magic file</description>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <p>The <directive>MimeMagicFile</directive> directive can be used to
6aada32e978e09cc60d52cb05ae4cee91b676da1slive enable this module, the default file is distributed at
6aada32e978e09cc60d52cb05ae4cee91b676da1slive <code>conf/magic</code>. Non-rooted paths are relative to the
6aada32e978e09cc60d52cb05ae4cee91b676da1slive ServerRoot. Virtual hosts will use the same file as the main
6aada32e978e09cc60d52cb05ae4cee91b676da1slive server unless a more specific setting is used, in which case
6aada32e978e09cc60d52cb05ae4cee91b676da1slive the more specific setting overrides the main server's file.</p>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive</directivesynopsis>
6aada32e978e09cc60d52cb05ae4cee91b676da1slive</modulesynopsis>