Typo. Closes: #653339

[debhelper.git] / dh_installwm

diff --git a/dh_installwm b/dh_installwm
index 7bc98aaed585bed829e3509e8e46a946ce431aec..a0f5f704481b30a0b6815baeac06dd7e6e81b044 100755 (executable)
--- a/dh_installwm
+++ b/dh_installwm
@@ -1,8 +1,64 @@
 #!/usr/bin/perl -w
-#
-# Add to postinst and postrm to register a window manager.
 
+=head1 NAME
+
+dh_installwm - register a window manager
+
+=cut
+
+use strict;
 use Debian::Debhelper::Dh_Lib;
+
+=head1 SYNOPSIS
+
+B<dh_installwm> [S<I<debhelper options>>] [B<-n>] [B<--priority=>I<n>] [S<I<wm> ...>]
+
+=head1 DESCRIPTION
+
+B<dh_installwm> is a debhelper program that is responsible for
+generating the F<postinst> and F<prerm> commands that register a window manager
+with L<update-alternatives(8)>. The window manager's man page is also 
+registered as a slave symlink (in v6 mode and up), if it is found in 
+F<usr/share/man/man1/> in the package build directory.
+
+=head1 FILES
+
+=over 4
+
+=item debian/I<package>.wm
+
+List window manager programs to register.
+
+=back
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<--priority=>I<n>
+
+Set the priority of the window manager. Default is 20, which is too low for
+most window managers; see the Debian Policy document for instructions on
+calculating the correct value.
+
+=item B<-n>, B<--noscripts>
+
+Do not modify F<postinst>/F<prerm> scripts. Turns this command into a no-op.
+
+=item I<wm> ...
+
+Window manager programs to register.
+
+=back
+
+=head1 NOTES
+
+Note that this command is not idempotent. L<dh_prep(1)> 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();
 
 if (! defined $dh{PRIORITY}) {
@@ -10,30 +66,53 @@ if (! defined $dh{PRIORITY}) {
 }
 
 if (@ARGV) {
-       # This is here for backwards comatability. If the filename doesn't
-       # include a path, assume it's in /usr/X11R6/bin.
+       # This is here for backwards compatibility. If the filename doesn't
+       # include a path, assume it's in /usr/bin.
        if ($ARGV[0] !~ m:/:) {
-               $ARGV[0]="/usr/X11R6/bin/$ARGV[0]";
+               $ARGV[0]="/usr/bin/$ARGV[0]";
        }
 }
 
-foreach $PACKAGE (@{$dh{DOPACKAGES}}) {
-       $TMP=tmpdir($PACKAGE);
-       $file=pkgfile($PACKAGE,"wm");
+foreach my $package (@{$dh{DOPACKAGES}}) {
+       my $tmp=tmpdir($package);
+       my $file=pkgfile($package,"wm");
 
+       my @wm;
        if ($file) {
-               @wm=filearray($file, $TMP);
+               @wm=filearray($file, '.');
        }
 
-       if (($PACKAGE eq $dh{FIRSTPACKAGE} || $dh{PARAMS_ALL}) && @ARGV) {
+       if (($package eq $dh{FIRSTPACKAGE} || $dh{PARAMS_ALL}) && @ARGV) {
                push @wm, @ARGV;
        }
 
-       if (@wm && ! $dh{NOSCRIPTS}) {
-               foreach (@wm) {
-                       autoscript($PACKAGE,"postinst","postinst-wm","s:#WM#:$_:;s/#PRIORITY#/$dh{PRIORITY}/",);
-                       autoscript($PACKAGE,"postrm","postrm-wm","s:#WM#:$_:");
+       if (! $dh{NOSCRIPTS}) {
+WM:            foreach my $wm (@wm) {
+                       autoscript($package,"prerm","prerm-wm","s:#WM#:$wm:");
+
+                       my $wmman;
+                       if (! compat(5)) {
+                               foreach my $ext (".1", ".1x") {
+                                       $wmman="/usr/share/man/man1/".basename($wm).$ext;
+                                       if (-e "$tmp$wmman" || -e "$tmp$wmman.gz") {
+                                               autoscript($package,"postinst","postinst-wm","s:#WM#:$wm:;s:#WMMAN#:$wmman.gz:;s/#PRIORITY#/$dh{PRIORITY}/",);
+                                               next WM;
+                                       }
+                               }
+                       }
+                       autoscript($package,"postinst","postinst-wm-noman","s:#WM#:$wm:;s/#PRIORITY#/$dh{PRIORITY}/",);
                }
        }
 }
 
+=head1 SEE ALSO
+
+L<debhelper(7)>
+
+This program is a part of debhelper.
+
+=head1 AUTHOR
+
+Joey Hess <joeyh@debian.org>
+
+=cut