1 .\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.10)
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
9 .de Vb \" Begin verbatim text
14 .de Ve \" End verbatim text
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD. Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
53 . tm Index:\\$1\t\\n%\t"\\$2"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear. Run. Save yourself. No user-serviceable parts.
65 . \" fudge factors for nroff and troff
74 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 . \" simple accents for nroff and troff
90 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
97 . \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 . \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 . \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
124 .\" ========================================================================
126 .IX Title "File::Type 3"
127 .TH File::Type 3 "2004-05-06" "perl v5.8.8" "User Contributed Perl Documentation"
128 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
133 File::Type \- determine file type using magic
135 .IX Header "SYNOPSIS"
137 \& my $ft = File::Type\->new();
139 \& # read in data from file to $data, then
140 \& my $type_from_data = $ft\->checktype_contents($data);
142 \& # alternatively, check file from disk
143 \& my $type_from_file = $ft\->checktype_filename($file);
145 \& # convenient method for checking either a file or data
146 \& my $type_1 = $ft\->mime_type($file);
147 \& my $type_2 = $ft\->mime_type($data);
150 .IX Header "DESCRIPTION"
151 File::Type uses magic numbers (typically at the start of a file) to
152 determine the \s-1MIME\s0 type of that file.
154 File::Type can use either a filename, or file contents, to determine the
160 Returns a new File::Type object.
161 .SS "mime_type($argument)"
162 .IX Subsection "mime_type($argument)"
163 Takes either data or a filename, determines what it is, and passes the
164 argument through to the relevant method below. If the argument is a
165 directory, returns undef.
166 .SS "checktype_filename($filename)"
167 .IX Subsection "checktype_filename($filename)"
168 Opens \f(CW$filename\fR (if possible; if not, returns undef) and returns the \s-1MIME\s0
170 .SS "checktype_contents($data)"
171 .IX Subsection "checktype_contents($data)"
172 Matches \f(CW$data\fR against the magic database criteria and returns the \s-1MIME\s0
177 * Add additional magic match criteria
183 .IX Subsection "NOTES"
184 Some magic definitions in the mime-magic file used in the creation of this
185 module vary from those in other apps (eg image/x\-png not image/png).
187 .IX Header "SEE ALSO"
188 File::MMagic and File::MimeInfo perform the same job, but have a number
189 of problems that led to the creation of this module.
191 File::MMagic inlines a copy of the magic database, and uses a \s-1DATA\s0
192 filehandle, which causes problems when running under mod_perl.
194 File::MimeInfo uses an external magic file, and relies on file extensions
195 rather than magic to determine the mime type.
197 As a result, File::Type uses a seperate module and script to create the
198 code at the core of this module, which means that there is no need to
199 include a magic database at all, and that it is safe to run under mod_perl.
201 File::Type::Builder, which generates the code at the heart of this module.
202 .SH "ACKNOWLEDGMENTS"
203 .IX Header "ACKNOWLEDGMENTS"
204 File::Type is built from a mime-magic file from cleancode.org. The original
205 can be found at <http://cleancode.org/cgi\-bin/viewcvs.cgi/email/mime\-magic.mime?rev=1.1.1.1>.
208 Paul Mison <pmison@fotango.com>
210 .IX Header "COPYRIGHT"
211 Copyright 2003\-2004 Fotango Ltd.
214 Licensed under the same terms as Perl itself.