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. If you have a
23 properly formatted .TH line, your man page will be installed into the right
24 directory, with the right name (this includes proper handling of pages
25 with a subsection, like "3perl", which are placed in man3, and given an
26 extension of ".3perl"). If your .TH line is incorrect or missing, the program
27 may guess wrong based on the file extension.
29 It also supports translated man pages, by looking for extensions
30 like .ll.8 and .ll_LL.8, or by use of the --language switch.
32 If dh_installman seems to install a man page into the wrong section or with
33 the wrong extension, this is because the man page has the wrong section
34 listed in its .TH line. Edit the man page and correct the section, and
35 dh_installman will follow suit. See to L<man(7)> for details about the .TH
36 section. If dh_installman seems to install a man page into a directory
37 like /usr/share/man/pl/man1/, that is because your program has a
38 name like "foo.pl", and dh_installman assumes that means it is translated
39 into Polish. Use --language=C to avoid this.
41 Any man page filenames specified as parameters will be installed into the
42 first package dh_installman is told to act on. By default, this is the
43 first binary package in debian/control, but if you use -p, -i, or -a flags,
44 it will be the first package specified by those flags.
46 Files named debian/package.manpages can list other man pages to be
49 After the man page installation step, dh_installman will check to see if
50 any of the man pages in the temporary directories of any of the packages it
51 is acting on contain ".so" links. If so, it changes them to symlinks.
59 Install all files specified by command line parameters in ALL packages
62 =item B<--language>=ll
64 Use this to specify that the man pages being acted on are written in the
69 Install these man pages into the first package acted on. (Or in all
70 packages if -A is specified).
76 An older version of this program, L<dh_installmanpages(1)>, is still used
77 by some packages, and so is still included in debhelper.
78 It is, however, deprecated, due to its counterintuitive and inconsistent
79 interface. Use this program instead.
88 foreach my $package (@{$dh{DOPACKAGES}}) {
89 next if is_udeb($package);
91 my $tmp=tmpdir($package);
92 my $file=pkgfile($package,"manpages");
96 @manpages=filearray($file, ".");
99 if (($package eq $dh{FIRSTPACKAGE} || $dh{PARAMS_ALL}) && @ARGV) {
100 push @manpages, @ARGV;
103 foreach my $page (@manpages) {
104 my $basename=basename($page);
106 # Support compressed pages.
108 if ($basename=~m/(.*)(\.gz)/) {
114 # See if there is a .TH entry in the man page. If so,
115 # we'll pull the section field from that.
117 open (IN, "zcat $page|") or die "$page: $!";
120 open (IN, $page) or die "$page: $!";
123 if (/^\.TH\s+\S+\s+"?(\d+[^"\s]*)"?/) {
128 # Failing that, we can try to get it from the filename.
130 ($section)=$basename=~m/.*\.([1-9]\S*)/;
133 # Now get the numeric component of the section.
134 my ($realsection)=$section=~m/^(\d)/ if defined $section;
136 # If there is no numeric section, bail.
137 if (! $realsection) {
138 error("Could not determine section for $page");
141 # Get the man page's name -- everything up to the last dot.
142 my ($instname)=$basename=~m/^(.*)\./;
144 my $destdir="$tmp/usr/share/man/man$realsection/";
146 if (! defined $dh{LANGUAGE} || ! exists $dh{LANGUAGE}) {
147 # Translated man pages are typically specified by adding the
148 # language code to the filename, so detect that and
149 # redirect to appropriate directory, stripping the code.
150 ($langcode)=$basename=~m/.*\.([a-z][a-z](?:_[A-Z][A-Z])?)\.(?:[1-9]|man)/;
151 if (defined $langcode && $langcode ne '') {
152 # Strip the language code from the instname.
153 $instname=~s/\.$langcode$//;
156 elsif ($dh{LANGUAGE} ne 'C') {
157 $langcode=$dh{LANGUAGE};
158 ($instname)=$basename=~m/(.*?)\./;
161 if (defined $langcode && $langcode ne '') {
162 $destdir="$tmp/usr/share/man/$langcode/man$realsection/";
164 $destdir=~tr:/:/:s; # just for looks
166 if (! -e "$destdir/$instname.$section" &&
167 ! -l "$destdir/$instname.$section") {
169 doit "install","-d",$destdir;
171 doit "install","-p","-m644",$page,
172 "$destdir$instname.$section$gz";
177 # Now the .so conversion.
178 @sofiles=@sodests=();
179 foreach my $dir (qw{usr/share/man usr/X11R6/man}) {
180 if (-e "$tmp/$dir") {
181 find(\&find_so_man, "$tmp/$dir");
184 foreach my $sofile (@sofiles) {
185 my $sodest=shift(@sodests);
186 doit "rm","-f",$sofile;
187 doit "ln","-sf",$sodest,$sofile;
191 # Check if a file is a .so man page, for use by File::Find.
193 # The -s test is becuase a .so file tends to be small. We don't want
194 # to open every man page. 1024 is arbitrary.
195 if (! -f $_ || -s $_ > 1024 || -s == 0) {
199 # Test first line of file for the .so thing.
201 open (SOTEST, "zcat $_|") or die "$_: $!";
204 open (SOTEST,$_) || die "$_: $!";
208 if ($l=~m/\.so\s+(.*)\s*/) {
210 # This test is here to prevent links like ... man8/../man8/foo.8
211 if (basename($File::Find::dir) eq
213 $solink=basename($solink);
216 $solink="../$solink";
219 push @sofiles,"$File::Find::dir/$_";
220 push @sodests,$solink;
228 This program is a part of debhelper.
232 Joey Hess <joeyh@debian.org>