/usr/share/doc/shared-mime-info/shared-mime-info-spec.html/x34.html is in shared-mime-info 1.9-2.
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 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>Unified system</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="Shared MIME-info Database"
HREF="index.html"><LINK
REL="PREVIOUS"
TITLE="Shared MIME-info Database"
HREF="index.html"><LINK
REL="NEXT"
TITLE="Contributors"
HREF="x497.html"></HEAD
><BODY
CLASS="sect1"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>Shared MIME-info Database</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="index.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="x497.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="sect1"
><H1
CLASS="sect1"
><A
NAME="AEN34"
>2. Unified system</A
></H1
><P
> In discussions about the previous systems used by GNOME, KDE and ROX (see the
"History and related systems" document), it was clear that the differences
between the databases were simply a result of them being separate, and not due
to any fundamental disagreements between developers. Everyone is keen to see
them merged.
</P
><P
> This specification proposes:
<P
></P
><UL
><LI
><P
> A standard way for applications to install new MIME related information.
</P
></LI
><LI
><P
> A standard way of getting the MIME type for a file.
</P
></LI
><LI
><P
> A standard way of getting information about a MIME type.
</P
></LI
><LI
><P
> Standard locations for all the files, and methods of resolving conflicts.
</P
></LI
></UL
>
Further, the existing databases have been merged into a single package
[<SPAN
CLASS="citation"
>SharedMIME</SPAN
>].
</P
><DIV
CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="s2_layout"
>2.1. Directory layout</A
></H2
><P
> There are two important requirements for the way the MIME database is stored:
<P
></P
><UL
><LI
><P
> Applications must be able to extend the database in any way when they are installed,
to add both new rules for determining type, and new information about specific types.
</P
></LI
><LI
><P
> It must be possible to install applications in /usr, /usr/local and the user's home directory
(in the normal Unix way) and have the MIME information used.
</P
></LI
></UL
>
</P
><P
> This specification uses the XDG Base Directory Specification[<SPAN
CLASS="citation"
>BaseDir</SPAN
>] to
define the prefixes below which the database is stored.
In the rest of this document, paths shown with the prefix
<TT
CLASS="filename"
><MIME></TT
> indicate the files should be loaded from
the <TT
CLASS="filename"
>mime</TT
> subdirectory of every directory in
<CODE
CLASS="envar"
>XDG_DATA_HOME</CODE
>:<CODE
CLASS="envar"
>XDG_DATA_DIRS</CODE
>.
</P
><P
> For example, when using the default paths, <SPAN
CLASS="QUOTE"
>"Load all the
<TT
CLASS="filename"
><MIME>/text/html.xml</TT
> files"</SPAN
> means to
load <TT
CLASS="filename"
>/usr/share/mime/text/html.xml</TT
>,
<TT
CLASS="filename"
>/usr/local/share/mime/text/html.xml</TT
>, and
<TT
CLASS="filename"
>~/.local/share/mime/text/html.xml</TT
> (if they exist, and in this order).
Information found in a directory is added to the information found in previous
directories, except when <KBD
CLASS="userinput"
>glob-deleteall</KBD
> or <KBD
CLASS="userinput"
>magic-deleteall</KBD
>
is used to overwrite parts of a mimetype definition.
</P
><P
> Each application that wishes to contribute to the MIME database will install a
single XML file, named after the application, into one of the three
<TT
CLASS="filename"
><MIME>/packages/</TT
> directories (depending on where the user requested
the application be installed). After installing, uninstalling or modifying this
file, the application MUST run the <B
CLASS="command"
>update-mime-database</B
> command,
which is provided by the freedesktop.org shared database[<SPAN
CLASS="citation"
>SharedMIME</SPAN
>].
</P
><P
> <B
CLASS="command"
>update-mime-database</B
> is passed the <TT
CLASS="filename"
>mime</TT
>
directory containing the <TT
CLASS="filename"
>packages</TT
> subdirectory which was
modified as its only argument. It scans all the XML files in the <TT
CLASS="filename"
>packages</TT
>
subdirectory, combines the information in them, and creates a number of output files.
</P
><P
> Where the information from these files is conflicting, information from directories
lower in the list takes precedence.
Any file named <TT
CLASS="filename"
>Override.xml</TT
> takes precedence over all other files in
the same <TT
CLASS="filename"
>packages</TT
> directory. This can be used by
tools which let the user edit the database to ensure that the user's
changes take effect.
</P
><P
> The files created by <B
CLASS="command"
>update-mime-database</B
> are:
<P
></P
><UL
><LI
><P
> <TT
CLASS="filename"
><MIME>/globs</TT
> (contains a mapping from names to MIME types) [deprecated for globs2]
</P
></LI
><LI
><P
> <TT
CLASS="filename"
><MIME>/globs2</TT
> (contains a mapping from names to MIME types and glob weight)
</P
></LI
><LI
><P
> <TT
CLASS="filename"
><MIME>/magic</TT
> (contains a mapping from file contents to MIME types)
</P
></LI
><LI
><P
> <TT
CLASS="filename"
><MIME>/subclasses</TT
> (contains a mapping from MIME types to types they inherit from)
</P
></LI
><LI
><P
> <TT
CLASS="filename"
><MIME>/aliases</TT
> (contains a mapping from aliases to MIME types)
</P
></LI
><LI
><P
> <TT
CLASS="filename"
><MIME>/icons</TT
> (contains a mapping from MIME types to icons)
</P
></LI
><LI
><P
> <TT
CLASS="filename"
><MIME>/generic-icons</TT
> (contains a mapping from MIME types to generic icons)
</P
></LI
><LI
><P
> <TT
CLASS="filename"
><MIME>/XMLnamespaces</TT
> (contains a mapping from XML
(namespaceURI, localName) pairs to MIME types)
</P
></LI
><LI
><P
> <TT
CLASS="filename"
><MIME>/MEDIA/SUBTYPE.xml</TT
> (one file for each MIME
type, giving details about the type, including comment, icon and generic-icon)
</P
></LI
><LI
><P
> <TT
CLASS="filename"
><MIME>/mime.cache</TT
> (contains the same information as the <TT
CLASS="filename"
>globs2</TT
>,
<TT
CLASS="filename"
>magic</TT
>, <TT
CLASS="filename"
>subclasses</TT
>, <TT
CLASS="filename"
>aliases</TT
>,
<TT
CLASS="filename"
>icons</TT
>, <TT
CLASS="filename"
>generic-icons</TT
> and <TT
CLASS="filename"
>XMLnamespaces</TT
> files,
in a binary, mmappable format)
</P
></LI
></UL
>
The format of these generated files and the source files in <TT
CLASS="filename"
>packages</TT
>
are explained in the following sections. This step serves several purposes. First, it allows
applications to quickly get the data they need without parsing all the source XML files (the
base package alone is over 700K). Second, it allows the database to be used for other
purposes (such as creating the <TT
CLASS="filename"
>/etc/mime.types</TT
> file if
desired). Third, it allows validation to be performed on the input data,
and removes the need for other applications to carefully check the input for
errors themselves.
</P
></DIV
><DIV
CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="AEN124"
>2.2. The source XML files</A
></H2
><P
> Each application provides only a single XML source file, which is installed in the
<TT
CLASS="filename"
>packages</TT
> directory as described above. This file is an XML file
whose document element is named <KBD
CLASS="userinput"
>mime-info</KBD
> and whose namespace URI
is <A
HREF="http://www.freedesktop.org/standards/shared-mime-info"
TARGET="_top"
>http://www.freedesktop.org/standards/shared-mime-info</A
>. All elements
described in this specification MUST have this namespace too.
</P
><P
> The document element may contain zero or more <KBD
CLASS="userinput"
>mime-type</KBD
> child nodes,
in any order, each describing a single MIME type. Each element has a <KBD
CLASS="userinput"
>type</KBD
>
attribute giving the MIME type that it describes.
</P
><P
> Each <KBD
CLASS="userinput"
>mime-type</KBD
> node may contain any combination of the following elements,
and in any order:
<P
></P
><UL
><LI
><P
> <KBD
CLASS="userinput"
>glob</KBD
> elements have a <KBD
CLASS="userinput"
>pattern</KBD
> attribute. Any file
whose name matches this pattern will be given this MIME type (subject to conflicting rules in
other files, of course). There is also an optional <KBD
CLASS="userinput"
>weight</KBD
> attribute which
is used when resolving conflicts with other glob matches. The default weight value is 50, and
the maximum is 100.
</P
><P
> KDE's glob system replaces GNOME's and ROX's ext/regex fields, since it
is trivial to detect a pattern in the form '*.ext' and store it in an
extension hash table internally. The full power of regular expressions was
not being used by either desktop, and glob patterns are more suitable for
filename matching anyway.
</P
><P
> The first glob element represents the "main" extension for the file type.
While this doesn't affect the mimetype matching algorithm, this information can be useful
when a single main extension is needed for a mimetype, for instance so that applications
can choose an appropriate extension when saving a file.
</P
></LI
><LI
><P
> A <KBD
CLASS="userinput"
>glob-deleteall</KBD
> element, which indicates that patterns from
previously parsed directories must be discarded. The patterns defined in this file
(if any) are used instead.
</P
></LI
><LI
><P
> <KBD
CLASS="userinput"
>magic</KBD
> elements contain a list of
<KBD
CLASS="userinput"
>match</KBD
> elements, any of which may match, and an optional
<KBD
CLASS="userinput"
>priority</KBD
> attribute for all of the contained rules. Low
numbers should be used for more generic types (such as 'gzip compressed data')
and higher values for specific subtypes (such as a word processor format that
happens to use gzip to compress the file). The default priority value is 50, and
the maximum is 100.
</P
><P
> Each <KBD
CLASS="userinput"
>match</KBD
> element has a number of attributes:
<DIV
CLASS="informaltable"
><P
></P
><A
NAME="AEN153"
></A
><TABLE
BORDER="1"
CLASS="CALSTABLE"
><COL><COL><COL><THEAD
><TR
><TH
>Attribute</TH
><TH
>Required?</TH
><TH
>Value</TH
></TR
></THEAD
><TBODY
><TR
><TD
>type</TD
><TD
>Yes</TD
><TD
> <KBD
CLASS="userinput"
>string</KBD
>, <KBD
CLASS="userinput"
>host16</KBD
>,
<KBD
CLASS="userinput"
>host32</KBD
>, <KBD
CLASS="userinput"
>big16</KBD
>,
<KBD
CLASS="userinput"
>big32</KBD
>, <KBD
CLASS="userinput"
>little16</KBD
>,
<KBD
CLASS="userinput"
>little32</KBD
> or <KBD
CLASS="userinput"
>byte</KBD
>.
</TD
></TR
><TR
><TD
>offset</TD
><TD
>Yes</TD
><TD
>The byte offset(s)
in the file to check. This may be a single number or a range in the
form `start:end', indicating that all offsets in the range should be
checked. The range is inclusive.</TD
></TR
><TR
><TD
>value</TD
><TD
>Yes</TD
><TD
> The value to compare the file contents with, in the format indicated by the type
attribute.
</TD
></TR
><TR
><TD
>mask</TD
><TD
>No</TD
><TD
> The number to AND the value in the file with before comparing it to
`value'. Masks for numerical types can be any number, while masks for strings
must be in base 16, and start with 0x.
</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
>
Each element corresponds to one line of
<SPAN
CLASS="citerefentry"
><SPAN
CLASS="refentrytitle"
>file</SPAN
>(1)</SPAN
>'s <TT
CLASS="filename"
>magic.mime</TT
> file.
They can be nested in the same way to provide the equivalent of continuation
lines. That is, <a><b/><c/></a> means 'a and (b or c)'.
</P
></LI
><LI
><P
> A <KBD
CLASS="userinput"
>magic-deleteall</KBD
> element, which indicates that magic matches from
previously parsed directories must be discarded. The magic defined in this file
(if any) is used instead.
</P
></LI
><LI
><P
> <KBD
CLASS="userinput"
>alias</KBD
> elements indicate that the type is also sometimes
known by another name, given by the <KBD
CLASS="userinput"
>type</KBD
> attribute. For
example, <KBD
CLASS="userinput"
>audio/midi</KBD
> has an alias of
<KBD
CLASS="userinput"
>audio/x-midi</KBD
>. Note that there should not be a
<KBD
CLASS="userinput"
>mime-type</KBD
> element defining each alias; a single
element defines the canonical name for the type and lists all its aliases.
</P
></LI
><LI
><P
> <KBD
CLASS="userinput"
>sub-class-of</KBD
> elements indicate that any data of this
type is also some other type, given by the <KBD
CLASS="userinput"
>type</KBD
>
attribute. See <A
HREF="x34.html#subclassing"
>Section 2.11</A
>.
</P
></LI
><LI
><P
> <KBD
CLASS="userinput"
>comment</KBD
> elements give a human-readable textual description of the MIME
type, usually composed of an acronym of the file name extension and a short description, like
"ODS spreadsheet".
There may be many of these elements with different <KBD
CLASS="userinput"
>xml:lang</KBD
> attributes
to provide the text in multiple languages.
</P
></LI
><LI
><P
> <KBD
CLASS="userinput"
>acronym</KBD
> elements give experienced users a terse idea of the document contents.
for example "ODS", "GEDCOM", "JPEG" and "XML".
There may be many of these elements with different <KBD
CLASS="userinput"
>xml:lang</KBD
> attributes
to provide the text in multiple languages, although these should only be used if absolutely necessary.
</P
></LI
><LI
><P
> <KBD
CLASS="userinput"
>expanded-acronym</KBD
> elements are the expanded versions of the acronym elements,
for example "OpenDocument Spreadsheet", "GEnealogical Data COMmunication", and "eXtensible Markup Language".
The purpose of these elements is to provide users a way to look up information on various MIME types or
file formats in third-party resources.
There may be many of these elements with different <KBD
CLASS="userinput"
>xml:lang</KBD
> attributes
to provide the text in multiple languages, although these should only be used if absolutely necessary.
</P
></LI
><LI
><P
> <KBD
CLASS="userinput"
>icon</KBD
> elements specify the icon to be used for this particular mime-type, given
by the <KBD
CLASS="userinput"
>name</KBD
> attribute. Generally the icon used for a mimetype is created
based on the mime-type by mapping "/" characters to "-", but users can override this by using
the <KBD
CLASS="userinput"
>icon</KBD
> element to customize the icon for a particular mimetype.
This element is not used in the system database, but only used in the user overridden database.
Only one <KBD
CLASS="userinput"
>icon</KBD
> element is allowed.
</P
></LI
><LI
><P
> <KBD
CLASS="userinput"
>generic-icon</KBD
> elements specify the icon to use as a generic icon for this
particular mime-type, given by the <KBD
CLASS="userinput"
>name</KBD
> attribute. This is used if there
is no specific icon (see <KBD
CLASS="userinput"
>icon</KBD
> for how these are found). These are
used for categories of similar types (like spreadsheets or archives) that can use a common icon.
The Icon Naming Specification lists a set of such icon names. If this element is not specified
then the mimetype is used to generate the generic icon by using the top-level media type (e.g.
"video" in "video/ogg") and appending "-x-generic" (i.e. "video-x-generic" in the previous example).
Only one <KBD
CLASS="userinput"
>generic-icon</KBD
> element is allowed.
</P
></LI
><LI
><P
> <KBD
CLASS="userinput"
>root-XML</KBD
> elements have <KBD
CLASS="userinput"
>namespaceURI</KBD
>
and <KBD
CLASS="userinput"
>localName</KBD
> attributes. If a file is identified as being an XML file,
these rules allow a more specific MIME type to be chosen based on the namespace and localname
of the document element.
</P
><P
> If <KBD
CLASS="userinput"
>localName</KBD
> is present but empty then the document element may have
any name, but the namespace must still match.
</P
></LI
><LI
><P
> <KBD
CLASS="userinput"
>treemagic</KBD
> elements contain a list of <KBD
CLASS="userinput"
>treematch</KBD
> elements,
any of which may match, and an optional <KBD
CLASS="userinput"
>priority</KBD
> attribute for all of the
contained rules. The default priority value is 50, and the maximum is 100.
</P
><P
> Each <KBD
CLASS="userinput"
>treematch</KBD
> element has a number of attributes:
<DIV
CLASS="informaltable"
><P
></P
><A
NAME="AEN242"
></A
><TABLE
BORDER="1"
CLASS="CALSTABLE"
><COL><COL><COL><THEAD
><TR
><TH
>Attribute</TH
><TH
>Required?</TH
><TH
>Value</TH
></TR
></THEAD
><TBODY
><TR
><TD
>path</TD
><TD
>Yes</TD
><TD
>A path that must be present on the mounted volume/filesystem. The path is interpreted as a relative path starting at the root of the tested volume/filesystem</TD
></TR
><TR
><TD
>type</TD
><TD
>No</TD
><TD
>The type of path. Possible values: <KBD
CLASS="userinput"
>file</KBD
>, <KBD
CLASS="userinput"
>directory</KBD
>, <KBD
CLASS="userinput"
>link</KBD
></TD
></TR
><TR
><TD
>match-case</TD
><TD
>No</TD
><TD
>Whether path should be matched case-sensitively. Possible values: <KBD
CLASS="userinput"
>true</KBD
>, <KBD
CLASS="userinput"
>false</KBD
></TD
></TR
><TR
><TD
>executable</TD
><TD
>No</TD
><TD
>Whether the file must be executable. Possible values: <KBD
CLASS="userinput"
>true</KBD
>, <KBD
CLASS="userinput"
>false</KBD
></TD
></TR
><TR
><TD
>non-empty</TD
><TD
>No</TD
><TD
>Whether the directory must be non-empty. Possible values: <KBD
CLASS="userinput"
>true</KBD
>, <KBD
CLASS="userinput"
>false</KBD
></TD
></TR
><TR
><TD
>mimetype</TD
><TD
>No</TD
><TD
>The mimetype for the file at path</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
>
<KBD
CLASS="userinput"
>treematch</KBD
> elements can be nested, meaning that both the outer and the inner <KBD
CLASS="userinput"
>treematch</KBD
>
must be satisfied for a "match".
</P
></LI
></UL
>
Applications may also define their own elements, provided they are namespaced to prevent collisions.
Unknown elements are copied directly to the output XML files like <KBD
CLASS="userinput"
>comment</KBD
>
elements. A typical use for this would be to indicate the default handler
application for a particular desktop
("Galeon is the GNOME default text/html browser"). Note that this doesn't
indicate the user's preferred application, only the (fixed) default.
</P
><P
> Here is an example source file, named <TT
CLASS="filename"
>diff.xml</TT
>:
<PRE
CLASS="programlisting"
> <?xml version="1.0"?>
<mime-info xmlns='http://www.freedesktop.org/standards/shared-mime-info'>
<mime-type type="text/x-diff">
<comment>Differences between files</comment>
<comment xml:lang="af">verskille tussen lĂȘers</comment>
...
<magic priority="50">
<match type="string" offset="0" value="diff\t"/>
<match type="string" offset="0" value="***\t"/>
<match type="string" offset="0" value="Common subdirectories: "/>
</magic>
<glob pattern="*.diff"/>
<glob pattern="*.patch"/>
</mime-type>
</mime-info>
</PRE
>
</P
><P
> In practice, common types such as text/x-diff are provided by the freedesktop.org shared
database. Also, only new information needs to be provided, since this information will be merged
with other information about the same type.
</P
></DIV
><DIV
CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="AEN290"
>2.3. The MEDIA/SUBTYPE.xml files</A
></H2
><P
> These files have a <KBD
CLASS="userinput"
>mime-type</KBD
> element as the root node. The format is
as described above. They are created by merging all the <KBD
CLASS="userinput"
>mime-type</KBD
>
elements from the source files and creating one output file per MIME type. Each file may contain
information from multiple source files. The <KBD
CLASS="userinput"
>magic</KBD
>,
<KBD
CLASS="userinput"
>glob</KBD
> and <KBD
CLASS="userinput"
>root-XML</KBD
> elements will
have been removed.
</P
><P
> The example source file given above would (on its own) create an output file called
<TT
CLASS="filename"
><MIME>/text/x-diff.xml</TT
> containing the following:
<PRE
CLASS="programlisting"
> <?xml version="1.0" encoding="utf-8"?>
<mime-type xmlns="http://www.freedesktop.org/standards/shared-mime-info" type="text/x-diff">
<!--Created automatically by update-mime-database. DO NOT EDIT!-->
<comment>Differences between files</comment>
<comment xml:lang="af">verskille tussen lĂȘers</comment>
...
</mime-type>
</PRE
>
</P
></DIV
><DIV
CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="AEN301"
>2.4. The glob files</A
></H2
><P
> The globs2 file is a simple list of lines containing weight, MIME type and pattern, separated by a colon.
The lines are ordered by glob weight.
For example:
<PRE
CLASS="programlisting"
> # This file was automatically generated by the
# update-mime-database command. DO NOT EDIT!
...
55:text/x-diff:*.patch
50:text/x-diff:*.diff
50:text/x-c++src:*.C:cs
...
</PRE
>
</P
><P
> The glob file is a simple list of lines containing a MIME type and pattern, separated by a colon. It is
deprecated in favour of the globs2 file which also lists the weight of the glob rule.
The lines are ordered by glob weight.
For example:
<PRE
CLASS="programlisting"
> # This file was automatically generated by the
# update-mime-database command. DO NOT EDIT!
...
text/x-diff:*.patch
text/x-diff:*.diff
...
</PRE
>
</P
><P
> Applications MUST match globs case-insensitively, except when the case-sensitive attribute
is set to true.
This is so that e.g. <TT
CLASS="filename"
>main.C</TT
> will be seen as a C++ file,
but <TT
CLASS="filename"
>IMAGE.GIF</TT
> will still use the *.gif pattern.
</P
><P
> If several patterns of the same weight match then the longest pattern SHOULD be used.
In particular, files with multiple extensions (such as
<TT
CLASS="filename"
>Data.tar.gz</TT
>) MUST match the longest sequence of extensions
(eg '*.tar.gz' in preference to '*.gz'). Literal patterns (eg, 'Makefile') must
be matched before all others. It is suggested that patterns beginning with `*.'
and containing no other special characters (`*?[') should be placed in a hash
table for efficient lookup, since this covers the majority of the patterns. Thus,
patterns of this form should be matched before other wildcarded patterns.
</P
><P
> If a matching pattern is provided by two or more MIME types, applications
SHOULD not rely on one of them. They are instead supposed to use magic data
(see below) to detect the actual MIME type. This is for instance required to
deal with container formats like Ogg or AVI, that map various video and/or
audio-encoded data to one extension.
</P
><P
> There may be several rules mapping to the same type. They should all be merged.
If the same pattern is defined twice, then they MUST be ordered by the
directory the rule came from, as described above.
</P
><P
> The <KBD
CLASS="userinput"
>glob-deleteall</KBD
> element, which means that implementations
SHOULD discard information from previous directories, is written out into the globs2 file using
__NOGLOBS__ as the pattern. For instance:
<PRE
CLASS="programlisting"
> 0:text/x-diff:__NOGLOBS__
50:text/x-diff:*.diff
...
</PRE
>
</P
><P
> In the above example, the mimetype text/x-diff is redefined (for instance in a user's
~/.local/share/mime) to only be associated with the pattern *.diff, so the other patterns
like *.patch were removed. The weight in front of the __NOGLOBS__ line is ignored.
In a given globs2 file, the __NOGLOBS__ line for a given mimetype is always written
out before any other globs for this mimetype.
</P
><P
> Lines beginning with `#' are comments and should be ignored. Everything from
the `:' character to the newline is part of the pattern; spaces should not be
stripped. The file is in the UTF-8 encoding. The format of the glob pattern
is as for fnmatch(3). The format does not allow a pattern to contain a literal
newline character, but this is not expected to be a problem.
</P
><P
> Common types (such as MS Word Documents) will be provided in the X Desktop
Group's package, which MUST be required by all applications using this
specification. Since each application will then only be providing information
about its own types, conflicts should be rare.
</P
><P
> The fourth field ("cs" in the first globs2 example) contains a list of comma-separated flags.
The flags currently defined are: cs (for case-sensitive). Implementations should ignore
unknown flags.
</P
><P
> Implementations should also ignore further fields, so that the syntax of the globs2 file
can be extended in the future. Example: "50:text/x-c++src:*.C:cs,newflag:newfeature:somethingelse"
should currently be parsed as "50:text/x-c++src:*.C:cs".
</P
></DIV
><DIV
CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="AEN322"
>2.5. The magic files</A
></H2
><P
> The magic data is stored in a binary format for ease of parsing. The old magic database
had complex escaping rules; these are now handled by <B
CLASS="command"
>update-mime-database</B
>.
</P
><P
> The file starts with the magic string "MIME-Magic\0\n".
There is no version number in the file. Incompatible changes will be handled by
creating both the current `magic' file and a newer `magic2' in the new format.
Where possible, compatible changes only will be made.
All numbers are big-endian, so need to be byte-swapped on little-endian machines.
</P
><P
> The rest of the file is made up of a sequence of small sections.
Each section is introduced by giving the priority and type in brackets, followed by
a newline character. Higher priority entries come first. Example:
<PRE
CLASS="screen"
>[50:text/x-diff]\n</PRE
>
Each line in the section takes the form:
<PRE
CLASS="screen"
>[ indent ] ">" start-offset "=" value
[ "&" mask ] [ "~" word-size ] [ "+" range-length ] "\n"</PRE
>
<DIV
CLASS="informaltable"
><P
></P
><A
NAME="AEN330"
></A
><TABLE
BORDER="1"
CLASS="CALSTABLE"
><COL><COL><COL><THEAD
><TR
><TH
>Part</TH
><TH
>Example</TH
><TH
>Meaning</TH
></TR
></THEAD
><TBODY
><TR
><TD
>indent</TD
><TD
>1</TD
><TD
>The nesting
depth of the rule, corresponding to the number of '>' characters in the traditional file format.</TD
></TR
><TR
><TD
>">" start-offset</TD
><TD
>>4</TD
><TD
>The offset into the
file to look for a match.</TD
></TR
><TR
><TD
>"=" value</TD
><TD
>=\0x0\0x2\0x55\0x40</TD
><TD
> Two bytes giving the (big-endian) length of the value, followed by the value itself.
</TD
></TR
><TR
><TD
>"&" mask</TD
><TD
>&\0xff\0xf0</TD
><TD
> The mask, which (if present) is exactly the same length as the value.
</TD
></TR
><TR
><TD
>"~" word-size</TD
><TD
>~2</TD
><TD
>On little-endian machines, the
size of each group to byte-swap.</TD
></TR
><TR
><TD
>"+" range-length</TD
><TD
>+8</TD
><TD
>The length of the region
in the file to check.
</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
>
</P
><P
> Note that the value, value length and mask are all binary, whereas everything
else is textual. Each of the elements begins with a single character to
identify it, except for the indent level.
</P
><P
> The word size is used for byte-swapping. Little-endian systems should reverse
the order of groups of bytes in the value and mask if this is greater than one.
This only affects `host' matches (`big32' entries still have a word size of 1,
for example, because no swapping is necessary, whereas `host32' has a word size
of 4).
</P
><P
> The indent, range-length, word-size and mask components are optional. If
missing, indent defaults to 0, range-length to 1, the word-size to 1, and the
mask to all 'one' bits.
</P
><P
> Indent corresponds to the nesting depth of the rule. Top-level rules have an
indent of zero. The parent of an entry is the preceding entry with an indent
one less than the entry.
</P
><P
> If an unknown character is found where a newline is expected then the whole
line should be ignored (there will be no binary data after the new
character, so the next line starts after the next "\n" character). This is for
future extensions.
</P
><P
> The text/x-diff above example would (on its own) create this magic file:
<PRE
CLASS="programlisting"
> 00000000 4d 49 4d 45 2d 4d 61 67 69 63 00 0a 5b 35 30 3a |MIME-Magic..[50:|
00000010 74 65 78 74 2f 78 2d 64 69 66 66 5d 0a 3e 30 3d |text/x-diff].>0=|
00000020 00 05 64 69 66 66 09 0a 3e 30 3d 00 04 2a 2a 2a |..diff..>0=..***|
00000030 09 0a 3e 30 3d 00 17 43 6f 6d 6d 6f 6e 20 73 75 |..>0=..Common su|
00000040 62 64 69 72 65 63 74 6f 72 69 65 73 3a 20 0a |bdirectories: .|
</PRE
>
</P
><P
> The <KBD
CLASS="userinput"
>magic-deleteall</KBD
> attribute, which means that implementations
SHOULD discard information from previous directories, is written out into the magic file using
__NOMAGIC__ as the value:
<PRE
CLASS="screen"
>>0=__NOMAGIC__\n</PRE
>
This can be followed by other magic rules for the mimetype.
</P
></DIV
><DIV
CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="AEN372"
>2.6. The XMLnamespaces files</A
></H2
><P
> Each <TT
CLASS="filename"
>XMLnamespaces</TT
> file is a list of lines in the form:
<PRE
CLASS="screen"
>namespaceURI " " localName " " MIME-Type "\n"</PRE
>
For example:
<PRE
CLASS="screen"
> http://www.w3.org/1999/xhtml html application/xhtml+xml
</PRE
>
The lines are sorted (using strcmp in the C locale) and there are no lines with the same namespaceURI and
localName in one file. If the localName was empty then there will be two spaces following
the namespaceURI.
</P
></DIV
><DIV
CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="AEN378"
>2.7. The icon files</A
></H2
><P
> The <TT
CLASS="filename"
>icons</TT
> and <TT
CLASS="filename"
>generic-icons</TT
> files are list of lines in the form:
<PRE
CLASS="screen"
>MIME-Type ":" icon-name "\n"</PRE
>
For example:
<PRE
CLASS="screen"
> application/msword:x-office-document
</PRE
>
</P
></DIV
><DIV
CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="AEN385"
>2.8. The treemagic files</A
></H2
><P
> The tree magic data is stored in a file with a format that is very similar to the magic file format.
</P
><P
> The file starts with the magic string "MIME-TreeMagic\0\n". There is no version number in the file.
Incompatible changes will be handled by creating both the current `treemagic' and a newer `treemagic2'
in the new format. Where possible, changes will be made in a compatible fashion.
</P
><P
> The rest of the file is made up of a sequence of small sections. Each section is introduced by giving
the priority and type in brackets, followed by a newline character. Higher priority entries come
first. Example:
<PRE
CLASS="screen"
>[50:x-content/image-dcf]\n</PRE
>
Each line in the section takes the form:
<PRE
CLASS="screen"
>[ indent ] ">" "\"" path "\"" "=" type [ "," option ]* "\n"</PRE
>
<DIV
CLASS="informaltable"
><P
></P
><A
NAME="AEN392"
></A
><TABLE
BORDER="1"
CLASS="CALSTABLE"
><COL><COL><THEAD
><TR
><TH
>Part</TH
><TH
>Meaning</TH
></TR
></THEAD
><TBODY
><TR
><TD
>indent</TD
><TD
>The nesting depth of the rule.</TD
></TR
><TR
><TD
>path</TD
><TD
>The path to match.</TD
></TR
><TR
><TD
>type</TD
><TD
>The required file type, one of "file", "directory", "link" or "any"</TD
></TR
><TR
><TD
>option</TD
><TD
>Optional for the optional attributes of <KBD
CLASS="userinput"
>treematch</KBD
> elements.
Possible values are "executable", "match-case", "non-empty", or a MIME type</TD
></TR
></TBODY
></TABLE
><P
></P
></DIV
>
</P
><P
> </P
></DIV
><DIV
CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="AEN413"
>2.9. The mime.cache files</A
></H2
><P
> The <TT
CLASS="filename"
>mime.cache</TT
> files contain the same information as the
<TT
CLASS="filename"
>globs2</TT
>, <TT
CLASS="filename"
>magic</TT
>, <TT
CLASS="filename"
>subclasses</TT
>,
<TT
CLASS="filename"
>aliases</TT
> and <TT
CLASS="filename"
>XMLnamespaces</TT
> files, in a binary,
mmappable format:
</P
><PRE
CLASS="programlisting"
> Header:
2 CARD16 MAJOR_VERSION 1
2 CARD16 MINOR_VERSION 2
4 CARD32 ALIAS_LIST_OFFSET
4 CARD32 PARENT_LIST_OFFSET
4 CARD32 LITERAL_LIST_OFFSET
4 CARD32 REVERSE_SUFFIX_TREE_OFFSET
4 CARD32 GLOB_LIST_OFFSET
4 CARD32 MAGIC_LIST_OFFSET
4 CARD32 NAMESPACE_LIST_OFFSET
4 CARD32 ICONS_LIST_OFFSET
4 CARD32 GENERIC_ICONS_LIST_OFFSET
AliasList:
4 CARD32 N_ALIASES
8*N_ALIASES AliasListEntry
AliasListEntry:
4 CARD32 ALIAS_OFFSET
4 CARD32 MIME_TYPE_OFFSET
ParentList:
4 CARD32 N_ENTRIES
8*N_ENTRIES ParentListEntry
ParentListEntry:
4 CARD32 MIME_TYPE_OFFSET
4 CARD32 PARENTS_OFFSET
Parents:
4 CARD32 N_PARENTS
4*N_PARENTS CARD32 MIME_TYPE_OFFSET
LiteralList:
4 CARD32 N_LITERALS
12*N_LITERALS LiteralEntry
LiteralEntry:
4 CARD32 LITERAL_OFFSET
4 CARD32 MIME_TYPE_OFFSET
4 CARD32 WEIGHT in lower 8 bits
FLAGS in rest:
0x100 = case-sensitive
GlobList:
4 CARD32 N_GLOBS
12*N_GLOBS GlobEntry
GlobEntry:
4 CARD32 GLOB_OFFSET
4 CARD32 MIME_TYPE_OFFSET
4 CARD32 WEIGHT in lower 8 bits
FLAGS in rest:
0x100 = case-sensitive
ReverseSuffixTree:
4 CARD32 N_ROOTS
4 CARD32 FIRST_ROOT_OFFSET
ReverseSuffixTreeNode:
4 CARD32 CHARACTER
4 CARD32 N_CHILDREN
4 CARD32 FIRST_CHILD_OFFSET
ReverseSuffixTreeLeafNode:
4 CARD32 0
4 CARD32 MIME_TYPE_OFFSET
4 CARD32 WEIGHT in lower 8 bits
FLAGS in rest:
0x100 = case-sensitive
MagicList:
4 CARD32 N_MATCHES
4 CARD32 MAX_EXTENT
4 CARD32 FIRST_MATCH_OFFSET
Match:
4 CARD32 PRIORITY
4 CARD32 MIME_TYPE_OFFSET
4 CARD32 N_MATCHLETS
4 CARD32 FIRST_MATCHLET_OFFSET
Matchlet:
4 CARD32 RANGE_START
4 CARD32 RANGE_LENGTH
4 CARD32 WORD_SIZE
4 CARD32 VALUE_LENGTH
4 CARD32 VALUE_OFFSET
4 CARD32 MASK_OFFSET (0 if no mask)
4 CARD32 N_CHILDREN
4 CARD32 FIRST_CHILD_OFFSET
NamespaceList:
4 CARD32 N_NAMESPACES
12*N_NAMESPACES NamespaceEntry
NamespaceEntry:
4 CARD32 NAMESPACE_URI_OFFSET
4 CARD32 LOCAL_NAME_OFFSET
4 CARD32 MIME_TYPE_OFFSET
GenericIconsList:
IconsList:
4 CARD32 N_ICONS
8*N_ICONS IconListEntry
IconListEntry:
4 CARD32 MIME_TYPE_OFFSET
4 CARD32 ICON_NAME_OFFSET
</PRE
><P
> Lists in the file are sorted, to enable binary searching. The list of
aliases is sorted by alias, the list of literal globs is sorted by the
literal. The SuffixTreeNode siblings are sorted by character.
The list of namespaces is sorted by namespace uri. The list of icons
is sorted by mimetype.
</P
><P
> Mimetypes are stored in the suffix tree by appending suffix
tree leaf nodes with '\0' as character. These nodes appear at the
beginning of the list of children.
</P
><P
> All offsets are in bytes from the beginning of the file.
</P
><P
> Strings are zero-terminated.
</P
><P
> All numbers are in network (big-endian) order. This is necessary because the data will be stored in
arch-independent directories like <TT
CLASS="filename"
>/usr/share/mime</TT
> or even in user's home directories.
</P
><P
> Cache files have to be written atomically - write to a temporary name, then move over the old file - so
that clients that have the old cache file open and mmap'ed won't get corrupt data.
</P
></DIV
><DIV
CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="AEN430"
>2.10. Storing the MIME type using Extended Attributes</A
></H2
><P
> An implementation MAY also get a file's MIME type from the
<KBD
CLASS="userinput"
>user.mime_type</KBD
> extended attribute. The type given here should normally be used in
preference to any guessed type, since the user is able to set it explicitly.
Applications MAY choose to set the type when saving files. Since many
applications and filesystems do not support extended attributes,
implementations MUST NOT rely on this method being available.
</P
></DIV
><DIV
CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="subclassing"
>2.11. Subclassing</A
></H2
><P
> A type is a subclass of another type if any instance of the first type is
also an instance of the second. For example, all image/svg+xml files are also
application/xml, text/plain and application/octet-stream files. Subclassing is about
the format, rather than the category of the data (for example, there is no
'generic spreadsheet' class that all spreadsheets inherit from).
</P
><P
> Some subclass rules are implicit:
<P
></P
><UL
><LI
><P
>All text/* types are subclasses of text/plain.</P
></LI
><LI
><P
>All streamable types (ie, everything except the inode/* types)
are subclasses of application/octet-stream.</P
></LI
></UL
>
In addition to these rules, explicit subclass information may be given using
the <KBD
CLASS="userinput"
>sub-class-of</KBD
> element.
</P
><P
> Note that some file formats are also compressed files (application/x-jar files
are also application/zip files). However, this is different to a case such as a
compressed postscript file, which is not a valid postscript file itself (so
application/x-gzpostscript does not inherit from application/postscript,
because an application that can handle the latter may not cope with the
former).
</P
><P
> Some types may or may not be instances of other types. For example, a
spreadsheet file may be compressed or not. It is a valid spreadsheet file
either way, but only inherits from application/gzip in one case. This
information cannot be represented statically; instead an application
interested in this information should run all of the magic rules, and
use the list of types returned as the subclasses.
</P
></DIV
><DIV
CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="AEN446"
>2.12. Recommended checking order</A
></H2
><P
> Because different applications have different requirements, they may choose to
use the various methods provided by this specification in any order. However, the
RECOMMENDED order to perform the checks is:
<P
></P
><UL
><LI
><P
> If a MIME type is provided explicitly (eg, by a ContentType HTTP header, a MIME
email attachment, an extended attribute or some other means) then that should
be used instead of guessing.
</P
></LI
><LI
><P
> Otherwise, start by doing a glob match of the filename. Keep only globs with the biggest weight.
If the patterns are different, keep only globs with the longest pattern, as previously discussed.
If after this, there is one or more matching glob, and all the matching globs
result in the same mimetype, use that mimetype as the result.
</P
></LI
><LI
><P
> If the glob matching fails or results in multiple conflicting mimetypes, read the
contents of the file and do magic sniffing on it. If no magic rule matches the data (or if
the content is not available), use the default type of application/octet-stream for
binary data, or text/plain for textual data. If there was no glob match, use the magic match
as the result.
</P
><P
> Note: Checking the first 32 bytes of the file for ASCII control characters is
a good way to guess whether a file is binary or text, but note that files with high-bit-set
characters should still be treated as text since these can appear in UTF-8 text,
unlike control characters.
</P
></LI
><LI
><P
> If any of the mimetypes resulting from a glob match is equal to or a subclass of
the result from the magic sniffing, use this as the result. This allows us for example to
distinguish text files called "foo.doc" from MS-Word files with the same name, as the
magic match for the MS-Word file would be application/x-ole-storage which the MS-Word type
inherits.
</P
></LI
><LI
><P
> Otherwise use the result of the glob match that has the highest weight.
</P
></LI
></UL
>
</P
><P
> There are several reasons for checking the glob patterns before the magic.
First of all doing magic sniffing is very expensive as reading the contents of the files
causes a lot of seeks, which is very expensive. Secondly, some applications don't check
the magic at all (sometimes the content is not available or too slow to read), and this
makes it more likely that both will get the same type.
</P
><P
> Also, users can easily understand why calling their
text file <TT
CLASS="filename"
>README.mp3</TT
> makes the system think it's an MP3,
whereas they have trouble understanding why their computer thinks
<TT
CLASS="filename"
>README.txt</TT
> is a PostScript file. If the system guesses wrongly,
the user can often rename the file to fix the problem.
</P
></DIV
><DIV
CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="AEN465"
>2.13. Non-regular files</A
></H2
><P
> Sometimes it is useful to assign MIME types to other objects in the filesystem,
such as directories, sockets and device files. This could be useful when looking up
an icon for a type, or for providing a textual description of one of these objects.
The media type 'inode' is provided for this purpose, with the following types corresponding
to the standard types of object found in a Unix filesystem:
</P
><P
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
>inode/blockdevice</TD
></TR
><TR
><TD
>inode/chardevice</TD
></TR
><TR
><TD
>inode/directory</TD
></TR
><TR
><TD
>inode/fifo</TD
></TR
><TR
><TD
>inode/mount-point</TD
></TR
><TR
><TD
>inode/socket</TD
></TR
><TR
><TD
>inode/symlink</TD
></TR
></TBODY
></TABLE
><P
></P
><P
> An inode/mount-point is a subclass of inode/directory. It can be useful when adding extra
actions for these directories, such as 'mount' or 'eject'. Mounted directories can be
detected by comparing the 'st_dev' of a directory with that of its parent. If
they differ, they are from different devices and the directory is a mount
point.
</P
></DIV
><DIV
CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="AEN477"
>2.14. Content types for volumes</A
></H2
><P
> Traditional MIME types apply to individual files or bytestreams. It is often useful
to apply the same methodologies when classifying the content of mountable volumes or
filesystems. The x-content type has been introduced for this purpose. Typical examples
are x-content/audio-dvd, x-content/blank-cd or x-content/image-dcf.
</P
><P
> Matching of content types works with <KBD
CLASS="userinput"
>treemagic</KBD
> elements, which
are analogous to the <KBD
CLASS="userinput"
>magic</KBD
> elements used for MIME type matching.
Instead of looking for byte sequences in files, <KBD
CLASS="userinput"
>treemagic</KBD
> elements
allow to look for files with certain names, permissions or mime types in a directory
hierarchy.
</P
></DIV
><DIV
CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="AEN484"
>2.15. URI scheme handlers</A
></H2
><P
> URI scheme handling (such as a movie player handling mms:// URIs, or a Podcast program
handling feed:// URIs) are handled through applications handling the x-scheme-handler/foo
mime-type, where foo is the URI scheme in question.
</P
><P
> This scheme allows URI scheme handling to enjoy the same benefits as mime-type handlers,
such as the ability to change the default handler, the cross-desktop support, and
easier application launching.
</P
><P
> Note that this virtual mime-type is not for listing URI schemes that an application
can load files from. For example, a movie player would not list x-scheme-handler/http
in its supported mime-types, but it would list x-scheme-handler/rtsp if it supported
playing back from RTSP locations.
</P
></DIV
><DIV
CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="AEN489"
>2.16. Security implications</A
></H2
><P
> The system described in this document is intended to allow different programs
to see the same file as having the same type. This is to help interoperability.
The type determined in this way is only a guess, and an application MUST NOT
trust a file based simply on its MIME type. For example, a downloader should
not pass a file directly to a launcher application without confirmation simply
because the type looks `harmless' (eg, text/plain).
</P
><P
> Do not rely on two applications getting the same type for the same file, even
if they both use this system. The spec allows some leeway in implementation,
and in any case the programs may be following different versions of the spec.
</P
></DIV
><DIV
CLASS="sect2"
><H2
CLASS="sect2"
><A
NAME="AEN493"
>2.17. User modification</A
></H2
><P
> The MIME database is NOT intended to store user preferences. Users should never
edit the database. If they wish to make corrections or provide MIME entries for
software that doesn't provide these itself, they should do so by means of the
Override.xml mentioned in <A
HREF="x34.html#s2_layout"
>Section 2.1</A
>. Information such as
"text/html files need to be opened with Mozilla" should NOT go in the database.
</P
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="x497.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Shared MIME-info Database</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
> </TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Contributors</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
|