]> git.donarmstrong.com Git - debhelper.git/blobdiff - dh_installman
r592: * dh_installman: Don't require trailing whitespace after the seciton number
[debhelper.git] / dh_installman
index 7d4c349c8f8fcf523114ca8a85779cdd47fe75af..59db6838742178fac5d234f3d3095816cb3741b2 100755 (executable)
@@ -19,10 +19,26 @@ B<dh_installman> [S<I<debhelper options>>] [S<I<manpage ...>>]
 dh_installman is a debhelper program that handles installing
 man pages into the correct locations in package build directories. You tell
 it what man pages go in your packages, and it figures out where to
-install them based on the section field in their .TH line and their filename
-extention. It also supports translated man pages, by looking for extensions
+install them based on the section field in their .TH line. If you have a
+properly formatted .TH line, your man page will be installed into the right
+directory, with the right name (this includes proper handling of pages
+with a subsection, like "3perl", which are placed in man3, and given an
+extention of ".3perl"). If your .TH line is incorrect or missing, the program
+may guess wrong based on the file extention.
+
+It also supports translated man pages, by looking for extensions
 like .ll.8 and .ll_LL.8
 
+If dh_installman seems to install a man page into the wrong section or with
+the wrong extension, this is because the man page has the wrong section
+listed in its .TH line. Edit the man page and correct the section, and
+dh_installman will follow suit.  See to L<man(7)> for details about the .TH
+section. If dh_installman seems to install a man page into a directory
+like /usr/share/man/pl/man1/, that is because your program has a
+name like "foo.pl", and dh_installman assumes that means it is translated
+into Polish. There is currently no support for resolving this ambiguity;
+programs in debian should proably not have extensions like that anyway.
+
 Any man page filenames specified as parameters will be installed into the
 first package dh_installman 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,
@@ -79,7 +95,7 @@ foreach my $package (@{$dh{DOPACKAGES}}) {
        }
 
        foreach my $page (@manpages) {
-               my $basename=Debian::Debhelper::Dh_Lib::basename($page);
+               my $basename=basename($page);
 
                # Support compressed pages.
                my $gz='';
@@ -98,7 +114,7 @@ foreach my $package (@{$dh{DOPACKAGES}}) {
                        open (IN, $page) or die "$page: $!";
                }
                while (<IN>) {
-                       if (/^\.TH\s+\S+\s+(\d+\S*)\s/) {
+                       if (/^\.TH\s+\S+\s+(\d+\S*)/) {
                                $section=$1;
                                last;
                        }
@@ -125,7 +141,7 @@ foreach my $package (@{$dh{DOPACKAGES}}) {
                # redirect to appropriate directory, stripping the code.
                my ($langcode)=$basename=~m/.*\.([a-z][a-z](?:_[A-Z][A-Z])?)\.(?:[1-9]|man)/;
                if (defined $langcode && $langcode ne '') {
-                       $destdir="$tmp/usr/share/man/$langcode/man$section/";
+                       $destdir="$tmp/usr/share/man/$langcode/man$realsection/";
                        # Strip the language code from the instname.
                        $instname=~s/\.$langcode$//;
                }
@@ -160,7 +176,7 @@ foreach my $package (@{$dh{DOPACKAGES}}) {
 sub find_so_man {
        # The -s test is becuase a .so file tends to be small. We don't want
        # to open every man page. 1024 is arbitrary.
-       if (! -f $_ || -s $_ > 1024) {
+       if (! -f $_ || -s $_ > 1024 || -s == 0) {
                return;
        }
 
@@ -171,9 +187,9 @@ sub find_so_man {
        if ($l=~m/\.so\s+(.*)/) {
                my $solink=$1;
                # This test is here to prevent links like ... man8/../man8/foo.8
-               if (Debian::Debhelper::Dh_Lib::basename($File::Find::dir) eq
-                   Debian::Debhelper::Dh_Lib::dirname($solink)) {
-                       $solink=Debian::Debhelper::Dh_Lib::basename($solink);
+               if (basename($File::Find::dir) eq
+                   dirname($solink)) {
+                       $solink=basename($solink);
                }
                else {
                        $solink="../$solink";
@@ -186,7 +202,7 @@ sub find_so_man {
 
 =head1 SEE ALSO
 
-L<debhelper(1)>
+L<debhelper(7)>
 
 This program is a part of debhelper.