5 dh_installman - install man pages into package build directories
11 use Debian::Debhelper::Dh_Lib;
15 B<dh_installman> [S<I<debhelper options>>] [S<I<manpage ...>>]
19 dh_installman is a debhelper program that handles installing
20 man pages into the correct locations in package build directories. You tell
21 it what man pages go in your packages, and it figures out where to
22 install them based on the section field in their .TH line and their filename
23 extension. It also supports translated man pages, by looking for extensions
24 like .ll.8 and .ll_LL.8
26 If dh_installman seems to install a man page into the wrong section or with
27 the wrong extension, this is because the man page has the wrong section
28 listed in its .TH line. Edit the man page and correct the section, and
29 dh_installman will follow suit. See to L<man(7)> for details about the .TH
30 section. If dh_installman seems to install a man page into a directory
31 like /usr/share/man/pl/man1/, that is because your program has a
32 name like "foo.pl", and dh_installman assumes that means it is translated
33 into Polish. There is currently no support for resolving this ambiguity;
34 programs in debian should proably not have extensions like that anyway.
36 Any man page filenames specified as parameters will be installed into the
37 first package dh_installman is told to act on. By default, this is the
38 first binary package in debian/control, but if you use -p, -i, or -a flags,
39 it will be the first package specified by those flags.
41 Files named debian/package.manpages can list other man pages to be
44 After the man page installation step, dh_installman will check to see if
45 any of the man pages in the temporary directories of any of the packages it
46 is acting on contain ".so" links. If so, it changes them to symlinks.
54 Install all files specified by command line parameters in ALL packages
59 Install these man pages into the first package acted on. (Or in all
60 packages if -A is specified).
66 An older version of this program, L<dh_installmanpages(1)>, is still used
67 by some packages, and so is still included in debhelper.
68 It is, however, deprecated, due to its counterintuitive and inconsistent
69 interface. Use this program instead.
78 foreach my $package (@{$dh{DOPACKAGES}}) {
79 my $tmp=tmpdir($package);
80 my $file=pkgfile($package,"manpages");
84 @manpages=filearray($file, ".");
87 if (($package eq $dh{FIRSTPACKAGE} || $dh{PARAMS_ALL}) && @ARGV) {
88 push @manpages, @ARGV;
91 foreach my $page (@manpages) {
92 my $basename=basename($page);
94 # Support compressed pages.
96 if ($basename=~m/(.*)(\.gz)/) {
102 # See if there is a .TH entry in the man page. If so,
103 # we'll pull the section field from that.
105 open (IN, "zcat $page|") or die "$page: $!";
108 open (IN, $page) or die "$page: $!";
111 if (/^\.TH\s+\S+\s+(\d+\S*)\s/) {
116 # Failing that, we can try to get it from the filename.
118 ($section)=$basename=~m/.*\.([1-9]\S*)/;
121 # Now get the numeric component of the section.
122 my ($realsection)=$section=~m/^(\d)/ if defined $section;
124 # If there is no numeric section, bail.
125 if (! $realsection) {
126 error("Could not determine section for $page");
129 # Get the man page's name -- everything up to the last dot.
130 my ($instname)=$basename=~m/^(.*)\./;
132 my $destdir="$tmp/usr/share/man/man$realsection/";
133 # Translated man pages are typically specified by adding the
134 # language code to the filename, so detect that and
135 # redirect to appropriate directory, stripping the code.
136 my ($langcode)=$basename=~m/.*\.([a-z][a-z](?:_[A-Z][A-Z])?)\.(?:[1-9]|man)/;
137 if (defined $langcode && $langcode ne '') {
138 $destdir="$tmp/usr/share/man/$langcode/man$section/";
139 # Strip the language code from the instname.
140 $instname=~s/\.$langcode$//;
142 $destdir=~tr:/:/:s; # just for looks
144 if (! -e "$destdir/$instname.$section" &&
145 ! -l "$destdir/$instname.$section") {
147 doit "install","-d",$destdir;
149 doit "install","-p","-m644",$page,
150 "$destdir$instname.$section$gz";
155 # Now the .so conversion.
156 @sofiles=@sodests=();
157 foreach my $dir (qw{usr/share/man usr/X11R6/man}) {
158 if (-e "$tmp/$dir") {
159 find(\&find_so_man, "$tmp/$dir");
162 foreach my $sofile (@sofiles) {
163 my $sodest=shift(@sodests);
164 doit "rm","-f",$sofile;
165 doit "ln","-sf",$sodest,$sofile;
169 # Check if a file is a .so man page, for use by File::Find.
171 # The -s test is becuase a .so file tends to be small. We don't want
172 # to open every man page. 1024 is arbitrary.
173 if (! -f $_ || -s $_ > 1024 || -s == 0) {
177 # Test first line of file for the .so thing.
178 open (SOTEST,$_) || die "$_: $!";
181 if ($l=~m/\.so\s+(.*)/) {
183 # This test is here to prevent links like ... man8/../man8/foo.8
184 if (basename($File::Find::dir) eq
186 $solink=basename($solink);
189 $solink="../$solink";
192 push @sofiles,"$File::Find::dir/$_";
193 push @sodests,$solink;
201 This program is a part of debhelper.
205 Joey Hess <joeyh@debian.org>