r475: * dh_gencontrol: Added a documented interface for specifying substvars

[debhelper.git] / dh_installinfo

diff --git a/dh_installinfo b/dh_installinfo
index 55deb3625310a63b2e7c363d1b4c0ff75be9cfc4..1fde4c53273beea88cf55391284d29f6e42237fa 100755 (executable)
--- a/dh_installinfo
+++ b/dh_installinfo
@@ -1,39 +1,95 @@
 #!/usr/bin/perl -w
-#
-# Reads debian/info, installs all files listed there into /usr/share/info
-# and puts appropriate commands into the postinst.
 
-BEGIN { push @INC, "debian", "/usr/share/debhelper" }
-use Dh_Lib;
+=head1 NAME
+
+dh_installinfo - install and register info files
+
+=cut
+
+use strict;
+use Debian::Debhelper::Dh_Lib;
+
+=head1 SYNOPSIS
+
+  dh_installinfo [debhelper options] [-A] [-n] [file ...]
+
+=head1 DESCRIPTION
+
+dh_installinfo is a debhelper program that is responsible for installing
+info files and registering them with install-info.
+
+It determines some information about the info files by parsing them, in
+particular, it looks at the INFO-DIR-SECTION line to determine what section
+the info file belongs in.
+
+Any filenames specified as parameters will be installed into the first
+package dh_installinfo is told to act on. By default, this is the first
+binary package in debian/control, but if you use -p, -i, or -a flags, it
+will be the first package specified by those flags.
+
+Files named debian/package.info can list other files to be installed.
+
+dh_installinfo will automatically generate the postinst and prerm commands
+needed to interface with install-info. See L<dh_installdeb(1)> for an
+explanation of how this works.
+
+=head1 OPTIONS
+
+=over 4
+
+=item B<-A>, B<--all>
+
+Install all files specified by command line parameters in ALL packages
+acted on.
+
+=item B<-n>, B<--noscripts>
+
+Do not modify postinst/prerm scripts.
+
+=item I<file ...>
+
+Install these info files into the first package acted on. (Or in
+all packages if -A is specified).
+
+=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);
-       $file=pkgfile($PACKAGE,"info");
+foreach my $package (@{$dh{DOPACKAGES}}) {
+       my $tmp=tmpdir($package);
+       my $file=pkgfile($package,"info");
 
-       undef @info;
+       my @info;
        
        if ($file) {
-               @info=filearray($file);
+               @info=filearray($file, ".");
        }
 
-       if (($PACKAGE eq $dh{FIRSTPACKAGE} || $dh{PARAMS_ALL}) && @ARGV) {
+       if (($package eq $dh{FIRSTPACKAGE} || $dh{PARAMS_ALL}) && @ARGV) {
                push @info, @ARGV;
        }
 
        if (@info) {
-               if ( ! -d "$TMP/usr/share/info") {
-                       doit("install","-d","$TMP/usr/share/info");
+               if ( ! -d "$tmp/usr/share/info") {
+                       doit("install","-d","$tmp/usr/share/info");
                }
-               doit("cp",@info,"$TMP/usr/share/info");
-               doit("chmod","-R", "go=rX","$TMP/usr/share/info/");
-               doit("chmod","-R", "u+rw","$TMP/usr/share/info/");
+               doit("cp",@info,"$tmp/usr/share/info");
+               doit("chmod","-R", "go=rX","$tmp/usr/share/info/");
+               doit("chmod","-R", "u+rw","$tmp/usr/share/info/");
        }
 
        foreach $file (@info) {
                # Only register with install-info if this is a head file in
                # a tree of info files.
-               if ($file=~/\.info$/ && ! $dh{NOSCRIPTS}) {
+               if ($file !~ /-\d+$/ && ! $dh{NOSCRIPTS}) {
                        # Figure out what section this file goes in.
                        my $section='';
                        open (IN, "<$file") || die "$file: $!";
@@ -45,17 +101,30 @@ foreach $PACKAGE (@{$dh{DOPACKAGES}}) {
                        }
                        close IN;
                        
-                       my $fn="/usr/share/info/".Dh_Lib::basename($file);
+                       my $fn="/usr/share/info/".basename($file);
                        
                        if ($section ne '') {
-                               autoscript($PACKAGE,"postinst","postinst-info",
+                               $section=~s:/:\\/:g; # allow / in section.
+                               autoscript($package,"postinst","postinst-info",
                                        "s/#SECTION#/$section/g;s:#FILE#:$fn:");
                        }
                        else {
-                               autoscript($PACKAGE,"postinst","postinst-info-nosection",
+                               autoscript($package,"postinst","postinst-info-nosection",
                                        "s:#FILE#:$fn:");
                        }
-                       autoscript($PACKAGE,"prerm","prerm-info", "s:#FILE#:$fn:");
+                       autoscript($package,"prerm","prerm-info", "s:#FILE#:$fn:");
                }
        }
 }
+
+=head1 SEE ALSO
+
+L<debhelper(1)>
+
+This program is a part of debhelper.
+
+=head1 AUTHOR
+
+Joey Hess <joeyh@debian.org>
+
+=cut