r506: * Introduced the debian/compat file. This is the new, preferred way to say

[debhelper.git] / dh_installdeb

diff --git a/dh_installdeb b/dh_installdeb
index d0af6b50555866e1c71dab46652c276e1f744e61..69c66ddc15fbd536705302bf3812ff1a20e91c87 100755 (executable)
--- a/dh_installdeb
+++ b/dh_installdeb
@@ -1,9 +1,47 @@
 #!/usr/bin/perl -w
-#
-# Install files from debian/ into the package's DEBIAN directory.
+
+=head1 NAME
+
+dh_installdeb - install files into the DEBIAN directory
+
+=cut
 
 use strict;
 use Debian::Debhelper::Dh_Lib;
+
+=head1 SYNOPSIS
+
+B<dh_installdeb> [S<I<debhelper options>>]
+
+=head1 DESCRIPTION
+
+dh_installdeb is a debhelper program that is responsible for installing
+files into the DEBIAN directories in package build directories with the
+correct permissions.
+
+dh_installdeb automatically installs the following files from debian/ into
+the DEBIAN directory:
+  package.postinst
+  package.preinst
+  package.postrm
+  package.prerm
+  package.shlibs
+  package.conffiles
+
+The postinst, preinst, postrm, and prerm are handled specially: If a
+corresponding file named debian/script.debhelper exists, the contents of that
+file are merged into the script as follows: If the script exists, then
+anywhere in it that "#DEBHELPER#" appears, the text of the .debhelper file is
+inserted. If the script does not exist, then a script is generated from
+the .debhelper file. The .debhelper files are created by other debhelper
+programs, such as L<dh_installmenu(1)>, and are shell script fragments.
+
+In V3 compatability mode and higher, all files in the etc/ directory in a
+package will automatically be flagged as conffiles by this program, so
+there is no need to list them manually in package.conffiles.
+
+=cut
+
 init();
 
 foreach my $package (@{$dh{DOPACKAGES}}) {
@@ -37,7 +75,7 @@ foreach my $package (@{$dh{DOPACKAGES}}) {
                        # Auto-generate script header and add .debhelper
                        # content to it.
                        if (-f "debian/$ext$file.debhelper") {
-                               complex_doit("echo '#!/bin/sh -e' > $tmp/DEBIAN/$file");
+                               complex_doit("printf '#!/bin/sh\nset -e\n' > $tmp/DEBIAN/$file");
                                complex_doit("cat debian/$ext$file.debhelper >> $tmp/DEBIAN/$file");
                                doit("chown","0.0","$tmp/DEBIAN/$file");
                                doit("chmod",755,"$tmp/DEBIAN/$file");
@@ -56,7 +94,7 @@ foreach my $package (@{$dh{DOPACKAGES}}) {
        # Automatic conffiles registration: If it is in /etc, it is a
        # conffile.
        if (! compat(2) && -d "$tmp/etc") {
-               complex_doit("find $tmp/etc -type f |sed 's~^$tmp~~' >> $tmp/DEBIAN/conffiles");
+               complex_doit("find $tmp/etc -type f -printf '/etc/%P\n' >> $tmp/DEBIAN/conffiles");
                # Anything found?
                if (-z "$tmp/DEBIAN/conffiles") {
                        doit("rm", "-f", "$tmp/DEBIAN/conffiles");
@@ -66,3 +104,15 @@ foreach my $package (@{$dh{DOPACKAGES}}) {
                }
        }
 }
+
+=head1 SEE ALSO
+
+L<debhelper(1)>
+
+This program is a part of debhelper.
+
+=head1 AUTHOR
+
+Joey Hess <joeyh@debian.org>
+
+=cut