.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" 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 .. .\" 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. \*(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- .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" '' . 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 .\" .\" 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::Type 3pm" .TH File::Type 3pm "2022-10-13" "perl v5.34.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 \s-1MIME\s0 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 \s-1MIME\s0 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 \s-1MIME\s0 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 "\s-1NOTES\s0" .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 \s-1DATA\s0 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 separate 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 . .SH "AUTHOR" .IX Header "AUTHOR" Paul Mison .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2003\-2004 Fotango Ltd. .SH "LICENSE" .IX Header "LICENSE" Licensed under the same terms as Perl itself.