.\" 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::MimeInfo::Magic 3"
.TH File::MimeInfo::Magic 3 "2008-01-07" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
File::MimeInfo::Magic \- Determine file type with magic
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&        use File::MimeInfo::Magic;
\&        my $mime_type = mimetype($file);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module inherits from File::MimeInfo, it is transparant
to its functions but adds support for the freedesktop magic file.
.SH "EXPORT"
.IX Header "EXPORT"
The method \f(CW\*(C`mimetype\*(C'\fR is exported by default. The methods \f(CW\*(C`magic\*(C'\fR, 
\&\f(CW\*(C`inodetype\*(C'\fR, \f(CW\*(C`globs\*(C'\fR and \f(CW\*(C`describe\*(C'\fR can be exported on demand.
.SH "METHODS"
.IX Header "METHODS"
See also File::MimeInfo for methods that are inherited.
.ie n .IP """mimetype($file)""" 4
.el .IP "\f(CWmimetype($file)\fR" 4
.IX Item "mimetype($file)"
Returns a mime-type string for \f(CW$file\fR, returns undef on failure.
.Sp
This method bundles \f(CW\*(C`inodetype()\*(C'\fR, \f(CW\*(C`globs()\*(C'\fR and \f(CW\*(C`magic()\*(C'\fR.
.Sp
Magic rules with an priority of 80 and higher are checked before
\&\f(CW\*(C`globs()\*(C'\fR is called, all other magic rules afterwards.
.Sp
If this doesn't work the file is read and the mime-type defaults
to 'text/plain' or to 'application/octet\-stream' when the first ten chars
of the file match ascii control chars (white spaces excluded).
If the file doesn't exist or isn't readable \f(CW\*(C`undef\*(C'\fR is returned.
.Sp
If \f(CW$file\fR is an object reference only \f(CW\*(C`magic\*(C'\fR and the default method
are used.
.ie n .IP """magic($file)""" 4
.el .IP "\f(CWmagic($file)\fR" 4
.IX Item "magic($file)"
Returns a mime-type string for \f(CW$file\fR based on the magic rules, 
returns undef on failure.
.Sp
\&\f(CW$file\fR can be an object reference, in that case it is supposed to have a 
\&\f(CW\*(C`seek()\*(C'\fR and a \f(CW\*(C`read()\*(C'\fR method. 
This allows you for example to determine the mimetype of data in memory
by using IO::Scalar.
.ie n .IP """rehash()""" 4
.el .IP "\f(CWrehash()\fR" 4
.IX Item "rehash()"
Rehash the data files. Glob and magic 
information is preparsed when this method is called.
.Sp
If you want to by-pass the \s-1XDG\s0 basedir system you can specify your database
directories by setting \f(CW@File::MimeInfo::DIRS\fR. But normally it is better to
change the \s-1XDG\s0 basedir environment variables.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
File::MimeInfo
.SH "BUGS"
.IX Header "BUGS"
Please mail the author when you encounter any bugs.
.PP
Most likely to cause bugs is the fact that I partially used line based parsing
while the source data is binary and can contain newlines on strange places.
I tested with the 0.11 version of the database and found no problems, but I
can think of configurations that can cause problems.
.SH "AUTHOR"
.IX Header "AUTHOR"
Jaap Karssenberg || Pardus [Larus] <pardus@cpan.org>
.PP
Copyright (c) 2003 Jaap G Karssenberg. All rights reserved.
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.