.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "File::MMagic::XS 3pm"
.TH File::MMagic::XS 3pm 2024-03-07 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.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;
\&
\&  my $m = File::MMagic::XS\->new();
\&     $m = File::MMagic::XS\->new(\*(Aq/etc/magic\*(Aq); # use external magic file
\&
\&  my $mime = $m\->get_mime($file);
\&
\&  # use File::MMagic compatible interface
\&  use File::MMagic::XS qw(:compat);
\&
\&  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 XS 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"
.SS 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.
.SS \fBclone()\fP
.IX Subsection "clone()"
Clones an existing File::MMagic::XS object.
.SS parse_magic_file($file)
.IX Subsection "parse_magic_file($file)"
Read and parse a magic file, as used by Apache2.
.SS get_mime($file)
.IX Subsection "get_mime($file)"
Inspects the file specified by \f(CW$file\fR and returns a MIME type if possible.
If no matching MIME type is found, then undef is returned.
.SS fsmagic($file)
.IX Subsection "fsmagic($file)"
Inspects a file and returns a MIME type using inode information only. The
contents of the file is not inspected.
.SS fhmagic($fh)
.IX Subsection "fhmagic($fh)"
Inspects a file handle and returns a mime string by reading the contents
of the file handle.
.SS ascmagic($file)
.IX Subsection "ascmagic($file)"
Inspects a piece of data (assuming it's not binary data), and attempts to
determine the file type.
.SS bufmagic($scalar)
.IX Subsection "bufmagic($scalar)"
Inspects a scalar buffer, and attempts to determine the file type
.SS 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 \fBmagic\fR\|(5) file. This allows you to add custom magic entries at run time
.ie n .SS "add_file_ext($ext, $mime)"
.el .SS "add_file_ext($ext, \f(CW$mime\fP)"
.IX Subsection "add_file_ext($ext, $mime)"
Adds a new file extension to MIME mapping. This is used as a fallback method
to determining MIME types.
.PP
.Vb 3
\&  my $magic = File::MMagic::XS\->new;
\&  $magic\->add_file_ext(\*(Aqt\*(Aq, \*(Aqtext/perl\-test\*(Aq);
\&  my $mime  = $magic\->get_mime(\*(Aqt/01\-sanity.t\*(Aq);
.Ve
.PP
This will make \fBget_mime()\fR return 'text/perl\-test'.
.SS \fBerror()\fP
.IX Subsection "error()"
Returns the last error string.
.SH PERFORMANCE
.IX Header "PERFORMANCE"
This is on my laptop (MacBook, Core 2 Duo/ Mac OS 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