mime-policy.sgml

   1 <!doctype debiandoc system [
   2 <!-- include version information so we don't have to hard code it
   3      within the document -->
   4 <!entity % versiondata SYSTEM "version.ent"> %versiondata;
   5 ]>
   6 <debiandoc>
   7   <!--
   8   Debian GNU/Linux Menu Sub-Policy Manual.
   9   Copyright (C)1999 ;
  10
  11   released under the terms of the GNU General Public License, version
  12   2 or (at your option) any later.
  13
  14   The debian-policy mailing list has taken responsibility for the
  15   contents of this document, with the package maintainers responsible
  16   for packaging adminstrivia only.
  17
  18   -->
  19
  20   <book>
  21     <titlepag>
  22       <title>The Debian MIME support sub-policy</title>
  23       <author>
  24         <name>J.H.M. Dassen (Ray)</name>
  25         <email>jdassen@debian.org</email>
  26       </author>
  27       <author>
  28         <name>The Debian Policy mailing List</name>
  29         <email>debian-policy@lists.debian.org</email>
  30       </author>
  31       <version>version &version;, &date;</version>
  32
  33       <abstract>
  34         This manual describes the policy requirements for the MIME support
  35         system used in the Debian GNU/Linux distribution. This
  36         document is part of the policy package for Debian. The policy
  37         package itself is maintained by a group of maintainers that
  38         have no editorial powers. At the moment, the list of
  39         maintainers is:
  40         <enumlist>
  41           <item>
  42             <p>Michael Alan Dorman <email>mdorman@debian.org</email></p>
  43           </item>
  44           <item>
  45             <p>Philip Hands <email>phil@hands.com</email></p>
  46           </item>
  47           <item>
  48             <p>Julian Gilbey <email>J.D.Gilbey@qmw.ac.uk</email></p>
  49           </item>
  50           <item>
  51             <p>Manoj Srivastava <email>srivasta@debian.org</email></p>
  52           </item>
  53         </enumlist>
  54       </abstract>
  55
  56
  57       <copyright>
  58         <copyrightsummary>
  59           Copyright &copy;1999 .
  60         </copyrightsummary>
  61         <p>
  62           This manual is free software; you may redistribute it and/or
  63           modify it under the terms of the GNU General Public License
  64           as published by the Free Software Foundation; either version
  65           2, or (at your option) any later version.
  66         </p>
  67
  68         <p>
  69           This is distributed in the hope that it will be useful, but
  70           <em>without any warranty</em>; without even the implied
  71           warranty of merchantability or fitness for a particular
  72           purpose.  See the GNU General Public License for more
  73           details.
  74           </p>
  75         <p>
  76           A copy of the GNU General Public License is available as
  77           <tt>/usr/share/common-licenses/GPL</tt> in the Debian GNU/Linux
  78           distribution or on the World Wide Web at
  79           <url id="http://www.gnu.org/copyleft/gpl.html"
  80           name="The GNU General Public Licence">. You can also obtain it by writing to the
  81           Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  82           Boston, MA 02111-1307, USA.
  83         </p>
  84       </copyright>
  85     </titlepag>
  86
  87     <toc detail="sect">
  88     <chapt>
  89       <heading>About this document</heading>
  90       <p>
  91         The latest copy of this document can be found on
  92         <ftpsite>ftp.debian.org</ftpsite> at
  93         <ftppath>/debian/doc/package-developer/mime_policy.txt</ftppath>
  94       </p>
  95     </chapt>
  96     <chapt>
  97       <heading>MIME support mechanism</heading>
  98       <p>
  99         If you need assistance implementing this sub-policy, please
 100         please ask for it on the debian-devel mailing list.  If you
 101         have proposals for changes or additions to this sub-policy,
 102         please bring it up on debian-policy.
 103       </p>
 104       <sect>
 105         <heading>Background</heading>
 106         <p>
 107           MIME (Multipurpose Internet Mail Extensions, RFC 1521) is
 108           a mechanism for encoding files and datastreams and providing
 109           meta-information about them, in particular their type (e.g. audio
 110           or video) and format (e.g. PNG, HTML, MP3).
 111         </p>
 112
 113         <p>
 114           Registration of MIME type handlers allows programs like mail
 115           user agents and web browsers to to invoke these handlers to
 116           view, edit or display MIME types they don't support directly.
 117         </p>
 118
 119       </sect>
 120
 121       <sect>
 122         <heading>MIME support implementation</heading>
 123         <p>
 124           The <package>mime-support</package> package provides the
 125           <prgn>update-mime</prgn> program which allows packages to
 126           register programs that can show, compose, edit or print
 127           MIME types.
 128         </p>
 129
 130         <p>
 131           Packages containing such programs must register them
 132           with <prgn>update-mime</prgn> as documented in <manref
 133           name="update-mime" section="8">. They should <em>not</em> depend
 134           on, recommend, or suggest <prgn>mime-support</prgn>. Instead,
 135           they should just put something like the following in the
 136           <tt>postinst</tt> and <tt>postrm</tt> scripts:
 137
 138           <example>
 139   if [ -x /usr/sbin/update-mime ]; then
 140       update-mime
 141   fi
 142           </example>
 143         </p>
 144       </sect>
 145     </chapt>
 146   </book>
 147 </debiandoc>