.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "File::MMagic::XS 3"
.TH File::MMagic::XS 3 "2010-05-18" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
File::MMagic::XS \- Guess File Type With XS (a la mod_mime_magic)
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use File::MMagic::XS;
.Ve
.PP
.Vb 2
\&  my $m = File::MMagic::XS->new();
\&     $m = File::MMagic::XS->new('/etc/magic'); # use external magic file
.Ve
.PP
.Vb 1
\&  my $mime = $m->get_mime($file);
.Ve
.PP
.Vb 2
\&  # use File::MMagic compatible interface
\&  use File::MMagic::XS qw(:compat);
.Ve
.PP
.Vb 2
\&  my $m = File::MMagic::XS->new();
\&  $m->checktype_filename($file);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a port of Apache2 mod_mime_magic.c in Perl, written in \s-1XS\s0 with the
aim of being efficient and fast, especially for applications that need to be 
run for an extended amount of time.
.PP
There is a compatibility layer for File::MMagic. you can specify :compat
when importing the module
.PP
.Vb 1
\&   use File::MMagic::XS qw(:compat);
.Ve
.PP
And then the following methods are going to be available from File::MMagic::XS:
.PP
.Vb 4
\&   checktype_filename
\&   checktype_filehandle
\&   checktype_contents
\&   addMagicEntry
.Ve
.PP
Currently this software is in beta. If you have suggestions/recommendations 
about the interface or anything else, now is your chance to send them!
.SH "METHODS"
.IX Header "METHODS"
.Sh "new(%args)"
.IX Subsection "new(%args)"
Creates a new File::MMagic::XS object.
.PP
If you specify the \f(CW\*(C`file\*(C'\fR argument, then File::MMagic::XS will load magic
definitions from the specified file. If unspecified, it will use the magic
file that will be installed under File/MMagic/ directory.
.Sh "\fIclone()\fP"
.IX Subsection "clone()"
Clones an existing File::MMagic::XS object.
.Sh "parse_magic_file($file)"
.IX Subsection "parse_magic_file($file)"
Read and parse a magic file, as used by Apache2.
.Sh "get_mime($file)"
.IX Subsection "get_mime($file)"
Inspects the file specified by \f(CW$file\fR and returns a \s-1MIME\s0 type if possible.
If no matching \s-1MIME\s0 type is found, then undef is returned.
.Sh "fsmagic($file)"
.IX Subsection "fsmagic($file)"
Inspects a file and returns a \s-1MIME\s0 type using inode information only. The
contents of the file is not inspected.
.Sh "fhmagic($fh)"
.IX Subsection "fhmagic($fh)"
Inspects a file handle and returns a mime string by reading the contents
of the file handle.
.Sh "ascmagic($file)"
.IX Subsection "ascmagic($file)"
Inspects a piece of data (assuming it's not binary data), and attempts to
determine the file type.
.Sh "bufmagic($scalar)"
.IX Subsection "bufmagic($scalar)"
Inspects a scalar buffer, and attempts to determine the file type
.Sh "add_magic($magic_line)"
.IX Subsection "add_magic($magic_line)"
Adds a new magic entry to the object. The format of \f(CW$magic_line\fR is the same
as \fImagic\fR\|(5) file. This allows you to add custom magic entries at run time
.ie n .Sh "add_file_ext($ext, $mime)"
.el .Sh "add_file_ext($ext, \f(CW$mime\fP)"
.IX Subsection "add_file_ext($ext, $mime)"
Adds a new file extension to \s-1MIME\s0 mapping. This is used as a fallback method
to determining \s-1MIME\s0 types. 
.PP
.Vb 3
\&  my $magic = File::MMagic::XS->new;
\&  $magic->add_file_ext('t', 'text/perl-test');
\&  my $mime  = $magic->get_mime('t/01-sanity.t');
.Ve
.PP
This will make \fIget_mime()\fR return 'text/perl\-test'.
.Sh "\fIerror()\fP"
.IX Subsection "error()"
Returns the last error string.
.SH "PERFORMANCE"
.IX Header "PERFORMANCE"
This is on my laptop (MacBook, Core 2 Duo/ Mac \s-1OS\s0 X 10.4.3), tested against
File::MMagic::XS 0.09003
.PP
.Vb 3
\&          Rate  perl    xs
\&  perl   513/s    --  -96%
\&  xs   12048/s 2249%    --
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
File::MMagic
.SH "AUTHOR"
.IX Header "AUTHOR"
Copyright 2005\-2007 Daisuke Maki <daisuke@endeworks.jp>.
.PP
Underlying software: Copyright 1999\-2004 The Apache Software Foundation, Copyright (c) 1996\-1997 Cisco Systems, Inc., Copyright (c) Ian F. Darwin, 1987. Written by Ian F. Darwin.
.SH "LICENSE"
.IX Header "LICENSE"
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
.PP
See http://www.perl.com/perl/misc/Artistic.html