/usr/share/perl5/MIME/Type.pod is in libmime-types-perl 1.32-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 | =head1 NAME
MIME::Type - Definition of one MIME type
=head1 SYNOPSIS
use MIME::Types;
my $mimetypes = MIME::Types->new;
my MIME::Type $plaintext = $mimetypes->type('text/plain');
print $plaintext->mediaType; # text
print $plaintext->subType; # plain
my @ext = $plaintext->extensions;
print "@ext" # txt asc c cc h hh cpp
print $plaintext->encoding # 8bit
if($plaintext->isBinary) # false
if($plaintext->isAscii) # true
if($plaintext->equals('text/plain') {...}
if($plaintext eq 'text/plain') # same
print MIME::Type->simplified('x-appl/x-zip') # 'appl/zip'
=head1 DESCRIPTION
MIME types are used in MIME entities, for instance as part of e-mail
and HTTP traffic. Sometimes real knowledge about a mime-type is need.
Objects of C<MIME::Type> store the information on one such type.
This module is built to conform to the MIME types of RFC's 2045 and 2231.
It follows the official IANA registry at
F<http://www.iana.org/assignments/media-types/>
and the collection kept at F<http://www.ltsw.se/knbase/internet/mime.htp>
=head1 OVERLOADED
=over 4
=item overload: B<string comparison>
When a MIME::Type object is compared to either a string or another
MIME::TYpe, the L<equals()|MIME::Type/"Knowledge"> method is called. Comparison is smart,
which means that it extends common string comparison with some
features which are defined in the related RFCs.
=item overload: B<stringification>
The stringification (use of the object in a place where a string
is required) will result in the type name, the same as L<type()|MIME::Type/"Attributes">
returns.
example: use of stringification
my $mime = MIME::Type->new('text/html');
print "$mime\n"; # explicit stringification
print $mime; # implicit stringification
=back
=head1 METHODS
=head2 Initiation
=over 4
=item MIME::Type-E<gt>B<new>(OPTIONS)
Create (I<instantiate>) a new MIME::Type object which manages one
mime type.
-Option --Default
encoding <depends on type>
extensions []
simplified <derived from type>
system undef
type <required>
=over 2
=item encoding => '7bit'|'8bit'|'base64'|'quoted-printable'
How must this data be encoded to be transported safely. The default
depends on the type: mimes with as main type C<text/> will default
to C<quoted-printable> and all other to C<base64>.
=item extensions => REF-ARRAY
An array of extensions which are using this mime.
=item simplified => STRING
The mime types main- and sub-label can both start with C<x->, to indicate
that is a non-registered name. Of course, after registration this flag
can disappear which adds to the confusion. The simplified string has the
C<x-> thingies removed and are translated to lower-case.
=item system => REGEX
Regular expression which defines for which systems this rule is valid. The
REGEX is matched on C<$^O>.
=item type => STRING
The type which is defined here. It consists of a I<type> and a I<sub-type>,
both case-insensitive. This module will return lower-case, but accept
upper-case.
=back
=back
=head2 Attributes
=over 4
=item $obj-E<gt>B<encoding>
Returns the type of encoding which is required to transport data of this
type safely.
=item $obj-E<gt>B<extensions>
Returns a list of extensions which are known to be used for this
mime type.
=item $obj-E<gt>B<simplified>([STRING])
=item MIME::Type-E<gt>B<simplified>([STRING])
Returns the simplified mime type for this object or the specified STRING.
Mime type names can get officially registered. Until then, they have to
carry an C<x-> preamble to indicate that. Of course, after recognition,
the C<x-> can disappear. In many cases, we prefer the simplified version
of the type.
example: results of simplified()
my $mime = MIME::Type->new(type => 'x-appl/x-zip');
print $mime->simplified; # 'appl/zip'
print $mime->simplified('text/plain'); # 'text/plain'
print MIME::Type->simplified('x-xyz/x-abc'); # 'xyz/abc'
=item $obj-E<gt>B<system>
Returns the regular expression which can be used to determine whether this
type is active on the system where you are working on.
=item $obj-E<gt>B<type>
Returns the long type of this object, for instance C<'text/plain'>
=back
=head2 Knowledge
=over 4
=item $obj-E<gt>B<equals>(STRING|MIME)
Compare this mime-type object with a STRING or other object. In case of
a STRING, simplification will take place.
=item $obj-E<gt>B<isAscii>
Returns false when the encoding is base64, and true otherwise. All encodings
except base64 are text encodings.
=item $obj-E<gt>B<isBinary>
Returns true when the encoding is base64.
=item $obj-E<gt>B<isRegistered>
Mime-types which are not registered by IANA nor defined in RFCs shall
start with an C<x->. This counts for as well the media-type as the
sub-type. In case either one of the types starts with C<x-> this
method will return false.
=item $obj-E<gt>B<isSignature>
Returns true when the type is in the list of known signatures.
=item $obj-E<gt>B<mediaType>
The media type of the simplified mime.
For C<'text/plain'> it will return C<'text'>.
For historical reasons, the C<'mainType'> method still can be used
to retreive the same value. However, that method is deprecated.
=item $obj-E<gt>B<subType>
The sub type of the simplified mime.
For C<'text/plain'> it will return C<'plain'>.
=back
=head1 DIAGNOSTICS
=over 4
=item Error: Type parameter is obligatory.
When a L<MIME::Type|MIME::Type> object is created, the type itself must be
specified with the C<type> option flag.
=back
=head1 SEE ALSO
This module is part of MIME-Types distribution version 1.32,
built on August 18, 2011. Website: F<http://perl.overmeer.net/mimetypes/>
=head1 LICENSE
Copyrights 1999,2001-2011 by Mark Overmeer. For other contributors see ChangeLog.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
See F<http://www.perl.com/perl/misc/Artistic.html>
|