Updated French man page translation. Closes: #685560

[debhelper.git] / dh_installmenu

diff --git a/dh_installmenu b/dh_installmenu
index d6050febcfb6edf7f83d796aca9c2143a8288a29..689c0b2a7b49dcd75f3f4804da845d60e06616fc 100755 (executable)
--- a/dh_installmenu
+++ b/dh_installmenu
@@ -1,44 +1,99 @@
 #!/usr/bin/perl -w
-#
-# Integration with debian menu system:
-#
-# If debian/menu file exists, save it to $TMP/usr/lib/menu/$PACKAGE
-# If debian/menu-method file exists, save it to 
-# $TMP/etc/menu-methods/$PACKAGE
-#
-# Also, add to postinst and postrm.
 
+=head1 NAME
+
+dh_installmenu - install Debian menu files into package build directories
+
+=cut
+
+use strict;
 use Debian::Debhelper::Dh_Lib;
+
+=head1 SYNOPSIS
+
+B<dh_installmenu> [S<B<debhelper options>>] [B<-n>]
+
+=head1 DESCRIPTION
+
+B<dh_installmenu> is a debhelper program that is responsible for installing
+files used by the Debian B<menu> package into package build directories.
+
+It also automatically generates the F<postinst> and F<postrm> commands needed to
+interface with the Debian B<menu> package. These commands are inserted into
+the maintainer scripts by L<dh_installdeb(1)>.
+
+=head1 FILES
+
+=over 4
+
+=item debian/I<package>.menu
+
+Debian menu files, installed into usr/share/menu/I<package> in the package
+build directory. See L<menufile(5)> for its format.
+
+=item debian/I<package>.menu-method
+
+Debian menu method files, installed into etc/menu-methods/I<package>
+in the package build directory.
+
+=back
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-n>, B<--noscripts>
+
+Do not modify F<postinst>/F<postrm> scripts.
+
+=back
+
+=cut
+
 init();
 
-foreach $PACKAGE (@{$dh{DOPACKAGES}}) {
-       $TMP=tmpdir($PACKAGE);
-       $menu=pkgfile($PACKAGE,"menu");
-       $menu_method=pkgfile($PACKAGE,"menu-method");
+foreach my $package (@{$dh{DOPACKAGES}}) {
+       my $tmp=tmpdir($package);
+       my $menu=pkgfile($package,"menu");
+       my $menu_method=pkgfile($package,"menu-method");
        
        if ($menu ne '') {
-               if (! -d "$TMP/usr/lib/menu") {
-                       doit("install","-d","$TMP/usr/lib/menu");
+               if (! -d "$tmp/usr/share/menu") {
+                       doit("install","-d","$tmp/usr/share/menu");
                }
-               doit("install","-p","-m644",$menu,"$TMP/usr/lib/menu/$PACKAGE");
+               doit("install","-p","-m644",$menu,"$tmp/usr/share/menu/$package");
                
                # Add the scripts if a menu-method file doesn't exist.
                # The scripts for menu-method handle everything these do, too.
                if ($menu_method eq "" && ! $dh{NOSCRIPTS}) {
-                       autoscript($PACKAGE,"postinst","postinst-menu");
-                       autoscript($PACKAGE,"postrm","postrm-menu")
+                       autoscript($package,"postinst","postinst-menu");
+                       autoscript($package,"postrm","postrm-menu")
                }
        }
 
        if ($menu_method ne '') {
-               if (!-d "$TMP/etc/menu-methods") {
-                       doit("install","-d","$TMP/etc/menu-methods");
+               if (!-d "$tmp/etc/menu-methods") {
+                       doit("install","-d","$tmp/etc/menu-methods");
                }
-               doit("install","-p",$menu_method,"$TMP/etc/menu-methods/$PACKAGE");
+               doit("install","-p","-m644",$menu_method,"$tmp/etc/menu-methods/$package");
 
                if (! $dh{NOSCRIPTS}) {
-                       autoscript($PACKAGE,"postinst","postinst-menu-method","s/#PACKAGE#/$PACKAGE/");
-                       autoscript($PACKAGE,"postrm","postrm-menu-method","s/#PACKAGE#/$PACKAGE/");
+                       autoscript($package,"postinst","postinst-menu-method","s/#PACKAGE#/$package/");
+                       autoscript($package,"postrm","postrm-menu-method","s/#PACKAGE#/$package/");
                }
        }
 }
+
+=head1 SEE ALSO
+
+L<debhelper(7)>
+L<update-menus(1)>
+L<menufile(5)>
+
+This program is a part of debhelper.
+
+=head1 AUTHOR
+
+Joey Hess <joeyh@debian.org>
+
+=cut