.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" 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::Type 3"
.TH File::Type 3 2024-09-01 "perl v5.40.0" "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::Type \- determine file type using magic
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    my $ft = File::Type\->new();
\&    
\&    # read in data from file to $data, then
\&    my $type_from_data = $ft\->checktype_contents($data);
\&    
\&    # alternatively, check file from disk
\&    my $type_from_file = $ft\->checktype_filename($file);
\&
\&    # convenient method for checking either a file or data
\&    my $type_1 = $ft\->mime_type($file);
\&    my $type_2 = $ft\->mime_type($data);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
File::Type uses magic numbers (typically at the start of a file) to 
determine the MIME type of that file.
.PP
File::Type can use either a filename, or file contents, to determine the
type of a file.
.SH METHODS
.IX Header "METHODS"
.SS new
.IX Subsection "new"
Returns a new File::Type object.
.SS mime_type($argument)
.IX Subsection "mime_type($argument)"
Takes either data or a filename, determines what it is, and passes the
argument through to the relevant method below. If the argument is a 
directory, returns undef.
.SS checktype_filename($filename)
.IX Subsection "checktype_filename($filename)"
Opens \f(CW$filename\fR (if possible; if not, returns undef) and returns the MIME 
type of the file.
.SS checktype_contents($data)
.IX Subsection "checktype_contents($data)"
Matches \f(CW$data\fR against the magic database criteria and returns the MIME
type of the file.
.SH TODO
.IX Header "TODO"
.RS 4
* Add additional magic match criteria
.RE
.SH BUGS
.IX Header "BUGS"
None known.
.SS NOTES
.IX Subsection "NOTES"
Some magic definitions in the mime-magic file used in the creation of this 
module vary from those in other apps (eg image/x\-png not image/png).
.SH "SEE ALSO"
.IX Header "SEE ALSO"
File::MMagic and File::MimeInfo perform the same job, but have a number
of problems that led to the creation of this module.
.PP
File::MMagic inlines a copy of the magic database, and uses a DATA
filehandle, which causes problems when running under mod_perl.
.PP
File::MimeInfo uses an external magic file, and relies on file extensions
rather than magic to determine the mime type.
.PP
As a result, File::Type uses a seperate module and script to create the
code at the core of this module, which means that there is no need to
include a magic database at all, and that it is safe to run under mod_perl.
.PP
File::Type::Builder, which generates the code at the heart of this module.
.SH ACKNOWLEDGMENTS
.IX Header "ACKNOWLEDGMENTS"
File::Type is built from a mime-magic file from cleancode.org. The original
can be found at <http://cleancode.org/cgi\-bin/viewcvs.cgi/email/mime\-magic.mime?rev=1.1.1.1>.
.SH AUTHOR
.IX Header "AUTHOR"
Paul Mison <pmison@fotango.com>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2003\-2004 Fotango Ltd.
.SH LICENSE
.IX Header "LICENSE"
Licensed under the same terms as Perl itself.