php-doc-en/reference/mime_magic/reference.xml
Hartmut Holzgraefe e9c779875a started to document my mime_magic extension
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@85361 c90b9560-bf6c-de11-be94-00142212c4b1
2002-06-11 10:14:50 +00:00

98 lines
2.5 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<reference id="ref.mime-magic">
<title>Mimetype Functions</title>
<titleabbrev>Mimetype</titleabbrev>
<partintro>
<section id="mime-magic.intro">
&reftitle.intro;
<para>
The functions in this module try to guess the content type
and encoding of a file by looking for certain
<emphasis>magic</emphasis> byte sequences at specific
positions within the file. While this is not a bullet proof
approach the heuristics used do a very good job.
</para>
<para>
This extension is derivated from Apache mod_mime_magic,
which is itself based on the <filename>file</filename>
command maintaind by Ian F. Darwin. See the source code for
further historic and copyright information.
</para>
</section>
<section id="mime-magic.requirements">
&reftitle.required;
&no.requirement;
</section>
<section id="mime-magic.installation">
&reftitle.install;
<para>
The extension needs a copy of the <filename>magic.mime</filename>
as distributed with the <filename>file</filename> command.
This file also part of most recent Linux distributions and usually
stored in the <filename>/usr/share/misc</filename> directory.
</para>
</section>
<section id="mime-magic.configuration">
&reftitle.runtime;
<table>
<title>MIME magic Configuration options</title>
<tgroup cols="3">
<thead>
<row>
<entry>Name</entry>
<entry>Default</entry>
<entry>Changeable</entry>
</row>
</thead>
<tbody>
<row>
<entry>mime_magic.magicfile</entry>
<entry>"/usr/share/misc/magic.mime"</entry>
<entry>PHP_INI_SYSTEM</entry>
</row>
</tbody>
</tgroup>
</table>
</section>
<section id="mime-magic.resources">
&reftitle.resources;
&no.resource;
</section>
<section id="mime-magic.constants">
&reftitle.constants;
&no.constants;
</section>
</partintro>
&reference.mime-magic.functions;
</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->