=head1 SYNOPSIS
- dh_installman [debhelper options] [manpage ...]
+B<dh_installman> [S<I<debhelper options>>] [S<I<manpage ...>>]
=head1 DESCRIPTION
-dh_installman is a debhelper program that is responsible for installing
+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 package(s), and it figures out where to
-install them based on the section field in their .TH line and their filename
-extention.
+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. 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
+extension of ".3perl"). If your .TH line is incorrect or missing, the program
+may guess wrong based on the file extension.
+
+It also supports translated man pages, by looking for extensions
+like .ll.8 and .ll_LL.8, or by use of the --language switch.
+
+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. Use --language=C to avoid this.
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
Install all files specified by command line parameters in ALL packages
acted on.
+=item B<--language>=ll
+
+Use this to specify that the man pages being acted on are written in the
+specified language.
+
=item I<manpage ...>
Install these man pages into the first package acted on. (Or in all
my @sodests;
foreach my $package (@{$dh{DOPACKAGES}}) {
+ next if is_udeb($package);
+
my $tmp=tmpdir($package);
my $file=pkgfile($package,"manpages");
my @manpages;
}
foreach my $page (@manpages) {
- my $basename=Debian::Debhelper::Dh_Lib::basename($page);
+ my $basename=basename($page);
# Support compressed pages.
my $gz='';
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;
}
error("Could not determine section for $page");
}
+ # Get the man page's name -- everything up to the last dot.
+ my ($instname)=$basename=~m/^(.*)\./;
+
my $destdir="$tmp/usr/share/man/man$realsection/";
- # Translated man pages are typically specified by adding the
- # language code to the filename, so detect that and
- # redirect to appropriate directory.
- my ($langcode)=$basename=~m/.*\.([a-z][a-z](?:_[A-Z][A-Z])?)\.(?:[1-9]|man)/;
+ my $langcode;
+ if (! exists $dh{LANGUAGE}) {
+ # Translated man pages are typically specified by adding the
+ # language code to the filename, so detect that and
+ # redirect to appropriate directory, stripping the code.
+ ($langcode)=$basename=~m/.*\.([a-z][a-z](?:_[A-Z][A-Z])?)\.(?:[1-9]|man)/;
+ # Strip the language code from the instname.
+ $instname=~s/\.$langcode$//;
+ }
+ elsif ($dh{LANGUAGE} ne 'C') {
+ $langcode=$dh{LANGUAGE};
+ ($instname)=$basename=~m/(.*?)\./;
+ }
+
if (defined $langcode && $langcode ne '') {
- $destdir="$tmp/usr/share/man/$langcode/man$section/";
+ $destdir="$tmp/usr/share/man/$langcode/man$realsection/";
}
$destdir=~tr:/:/:s; # just for looks
- # Get the man page's name -- everything up to the last dot.
- my ($instname)=$basename=~m/^(.*)\./;
-
if (! -e "$destdir/$instname.$section" &&
! -l "$destdir/$instname.$section") {
if (! -d $destdir) {
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;
}
# Test first line of file for the .so thing.
- open (SOTEST,$_);
+ if (/\.gz$/) {
+ open (SOTEST, "zcat $_|") or die "$_: $!";
+ }
+ else {
+ open (SOTEST,$_) || die "$_: $!";
+ }
my $l=<SOTEST>;
close SOTEST;
- if ($l=~m/\.so\s+(.*)/) {
+ if ($l=~m/\.so\s+(.*)\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";
=head1 SEE ALSO
-L<debhelper(1)>
+L<debhelper(7)>
This program is a part of debhelper.
projects / debhelper.git / blobdiff