Fix build system auto-selection breakage.

[debhelper.git] / dh_installemacsen

diff --git a/dh_installemacsen b/dh_installemacsen
index a0b827813c18372db428589df32ede1513e07f14..08dd97a4b663b2e05c1d35b03f2211c5017a9d2b 100755 (executable)
--- a/dh_installemacsen
+++ b/dh_installemacsen
@@ -1,10 +1,80 @@
 #!/usr/bin/perl -w
-#
-# Registration with emacsen-common.
+
+=head1 NAME
+
+dh_installemacsen - register an emacs add on package
+
+=cut
 
 use strict;
 use Debian::Debhelper::Dh_Lib;
-init();
+
+=head1 SYNOPSIS
+
+B<dh_installemacsen> [S<I<debhelper options>>] [B<-n>] [B<--priority=>I<n>] [B<--flavor=>I<foo>]
+
+=head1 DESCRIPTION
+
+dh_installemacsen is a debhelper program that is responsible for installing
+files used by the debian emacsen-common package into package build
+directories.
+
+It also automatically generates the postinst and prerm commands needed to
+register a package as an emacs add on package. The commands are added to
+the maintainer scripts by dh_installdeb. See L<dh_installdeb(1)>
+for an explanation of how this works.
+
+=head1 FILES
+
+=over 4
+
+=item debian/I<package>.emacsen-install
+
+Installed into usr/lib/emacsen-common/packages/install/package in the
+package build directory.
+
+=item debian/I<package>.emacsen-remove
+
+Installed into usr/lib/emacsen-common/packages/remove/package in the
+package build directory.
+
+=item debian/I<package>.emacsen-startup
+
+Installed into etc/emacs/site-start.d/50I<package>.el in the package
+build directory. Use --priority to use a different priority than 50.
+
+=back
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-n>, B<--noscripts>
+
+Do not modify postinst/prerm scripts.
+
+=item B<--priority=>I<n>
+
+Sets the priority number of a site-start.d file. Default is 50.
+
+=item B<--flavor=>I<foo>
+
+Sets the flavor a site-start.d file will be installed in. Default is
+"emacs", alternatives include "xemacs" and "emacs20".
+
+=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(options => {
+       "flavor=s" => \$dh{FLAVOR},
+});
 
 if (! defined $dh{PRIORITY}) {
        $dh{PRIORITY}=50;
@@ -49,4 +119,16 @@ foreach my $package (@{$dh{DOPACKAGES}}) {
                                "s/#PACKAGE#/$package/");
                }
        }
-}      
+}
+
+=head1 SEE ALSO
+
+L<debhelper(7)>
+
+This program is a part of debhelper.
+
+=head1 AUTHOR
+
+Joey Hess <joeyh@debian.org>
+
+=cut