r1713: releasing version 4.2.19

[debhelper.git] / dh_installmime

diff --git a/dh_installmime b/dh_installmime
index 0dbc08b41923d44a30b1cf06d465f1102d8e599c..8ffd523621e7b756daa69eeff5cfef5649f9dd2f 100755 (executable)
--- a/dh_installmime
+++ b/dh_installmime
@@ -1,23 +1,75 @@
 #!/usr/bin/perl -w
-#
-# Mime support.
 
+=head1 NAME
+
+dh_installmime - install mime files into package build directories
+
+=cut
+
+use strict;
 use Debian::Debhelper::Dh_Lib;
+
+=head1 SYNOPSIS
+
+B<dh_installmime> [S<I<debhelper options>>] [B<-n>]
+
+=head1 DESCRIPTION
+
+dh_installmime is a debhelper program that is responsible for installing
+mime files into package build directories.
+
+It also automatically generates the postinst and postrm commands needed to
+interface with the debian mime-support package. See L<dh_installdeb(1)> for
+an explanation of how this works.
+
+If a file named debian/package.mime exists, then it is installed into
+usr/lib/mime/packages/package in the package build directory.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-n>, B<--noscripts>
+
+Do not modify postinst/postrm scripts.
+
+=back
+
+=head1 NOTES
+
+Note that this command is not idempotent. "dh_clean -k" should be called
+between invocations of this command. Otherwise, it may cause multiple
+instances of the same text to be added to maintainer scripts.
+
+=cut
+
 init();
 
-foreach $PACKAGE (@{$dh{DOPACKAGES}}) {
-       $TMP=tmpdir($PACKAGE);
-       $mime=pkgfile($PACKAGE,"mime");
+foreach my $package (@{$dh{DOPACKAGES}}) {
+       my $tmp=tmpdir($package);
+       my $mime=pkgfile($package,"mime");
        
        if ($mime ne '') {
-               if (! -d "$TMP/usr/lib/mime/packages") {
-                       doit("install","-d","$TMP/usr/lib/mime/packages");
+               if (! -d "$tmp/usr/lib/mime/packages") {
+                       doit("install","-d","$tmp/usr/lib/mime/packages");
                }
-               doit("install","-p","-m644",$mime,"$TMP/usr/lib/mime/packages/$PACKAGE");
+               doit("install","-p","-m644",$mime,"$tmp/usr/lib/mime/packages/$package");
 
                if (! $dh{NOSCRIPTS}) {
-                       autoscript($PACKAGE,"postinst","postinst-mime");
-                       autoscript($PACKAGE,"postrm","postrm-mime")
+                       autoscript($package,"postinst","postinst-mime");
+                       autoscript($package,"postrm","postrm-mime")
                }
        }
 }
+
+=head1 SEE ALSO
+
+L<debhelper(7)>
+
+This program is a part of debhelper.
+
+=head1 AUTHOR
+
+Joey Hess <joeyh@debian.org>
+
+=cut