]> git.donarmstrong.com Git - debhelper.git/blobdiff - dh_installinfo
Fix typo in French translation, about debian/package.README.Debian files.
[debhelper.git] / dh_installinfo
index 702f4ee8af78fecbc99dfaf12bbdbaf7f24eae17..3e6ce87aed9e75442c9739cac0b4d638f53dad83 100755 (executable)
@@ -1,10 +1,67 @@
 #!/usr/bin/perl -w
-#
-# Reads debian/info, installs all files listed there into /usr/share/info
-# and puts appropriate commands into the postinst.
+
+=head1 NAME
+
+dh_installinfo - install and register info files
+
+=cut
 
 use strict;
 use Debian::Debhelper::Dh_Lib;
+
+=head1 SYNOPSIS
+
+B<dh_installinfo> [S<I<debhelper options>>] [B<-A>] [B<-n>] [S<I<file ...>>]
+
+=head1 DESCRIPTION
+
+dh_installinfo is a debhelper program that is responsible for installing
+info files and registering the files it installs with install-info.
+
+Note that install-info 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, updating the info dir. These
+commands are inserted into the maintainer scripts by dh_installdeb.
+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. 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();
 
 foreach my $package (@{$dh{DOPACKAGES}}) {
@@ -34,29 +91,23 @@ foreach my $package (@{$dh{DOPACKAGES}}) {
                # Only register with install-info if this is a head file in
                # a tree of info files.
                if ($file !~ /-\d+$/ && ! $dh{NOSCRIPTS}) {
-                       # Figure out what section this file goes in.
-                       my $section='';
-                       open (IN, "<$file") || die "$file: $!";
-                       while (<IN>) {
-                               if (/INFO-DIR-SECTION\s+(.*)/) {
-                                       $section=$1;
-                                       last;
-                               }
-                       }
-                       close IN;
-                       
                        my $fn="/usr/share/info/".basename($file);
                        
-                       if ($section ne '') {
-                               $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",
-                                       "s:#FILE#:$fn:");
-                       }
+                       autoscript($package,"postinst","postinst-info",
+                               "s:#FILE#:$fn:");
                        autoscript($package,"prerm","prerm-info", "s:#FILE#:$fn:");
                }
        }
 }
+
+=head1 SEE ALSO
+
+L<debhelper(7)>
+
+This program is a part of debhelper.
+
+=head1 AUTHOR
+
+Joey Hess <joeyh@debian.org>
+
+=cut