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 extention. It also supports translated man pages, by looking for extentions
24 like .ll.8 and .ll_LL.8
26 Any man page filenames specified as parameters will be installed into the
27 first package dh_installman is told to act on. By default, this is the
28 first binary package in debian/control, but if you use -p, -i, or -a flags,
29 it will be the first package specified by those flags.
31 Files named debian/package.manpages can list other man pages to be
34 After the man page installation step, dh_installman will check to see if
35 any of the man pages in the temporary directories of any of the packages it
36 is acting on contain ".so" links. If so, it changes them to symlinks.
44 Install all files specified by command line parameters in ALL packages
49 Install these man pages into the first package acted on. (Or in all
50 packages if -A is specified).
56 An older version of this program, L<dh_installmanpages(1)>, is still used
57 by some packages, and so is still included in debhelper.
58 It is, however, deprecated, due to its counterintuitive and inconsistent
59 interface. Use this program instead.
68 foreach my $package (@{$dh{DOPACKAGES}}) {
69 my $tmp=tmpdir($package);
70 my $file=pkgfile($package,"manpages");
74 @manpages=filearray($file, ".");
77 if (($package eq $dh{FIRSTPACKAGE} || $dh{PARAMS_ALL}) && @ARGV) {
78 push @manpages, @ARGV;
81 foreach my $page (@manpages) {
82 my $basename=Debian::Debhelper::Dh_Lib::basename($page);
84 # Support compressed pages.
86 if ($basename=~m/(.*)(\.gz)/) {
92 # See if there is a .TH entry in the man page. If so,
93 # we'll pull the section field from that.
95 open (IN, "zcat $page|") or die "$page: $!";
98 open (IN, $page) or die "$page: $!";
101 if (/^\.TH\s+\S+\s+(\d+\S*)\s/) {
106 # Failing that, we can try to get it from the filename.
108 ($section)=$basename=~m/.*\.([1-9]\S*)/;
111 # Now get the numeric component of the section.
112 my ($realsection)=$section=~m/^(\d)/ if defined $section;
114 # If there is no numeric section, bail.
115 if (! $realsection) {
116 error("Could not determine section for $page");
119 # Get the man page's name -- everything up to the last dot.
120 my ($instname)=$basename=~m/^(.*)\./;
122 my $destdir="$tmp/usr/share/man/man$realsection/";
123 # Translated man pages are typically specified by adding the
124 # language code to the filename, so detect that and
125 # redirect to appropriate directory, stripping the code.
126 my ($langcode)=$basename=~m/.*\.([a-z][a-z](?:_[A-Z][A-Z])?)\.(?:[1-9]|man)/;
127 if (defined $langcode && $langcode ne '') {
128 $destdir="$tmp/usr/share/man/$langcode/man$section/";
129 # Strip the language code from the instname.
130 $instname=~s/\.$langcode$//;
132 $destdir=~tr:/:/:s; # just for looks
134 if (! -e "$destdir/$instname.$section" &&
135 ! -l "$destdir/$instname.$section") {
137 doit "install","-d",$destdir;
139 doit "install","-p","-m644",$page,
140 "$destdir$instname.$section$gz";
145 # Now the .so conversion.
146 @sofiles=@sodests=();
147 foreach my $dir (qw{usr/share/man usr/X11R6/man}) {
148 if (-e "$tmp/$dir") {
149 find(\&find_so_man, "$tmp/$dir");
152 foreach my $sofile (@sofiles) {
153 my $sodest=shift(@sodests);
154 doit "rm","-f",$sofile;
155 doit "ln","-sf",$sodest,$sofile;
159 # Check if a file is a .so man page, for use by File::Find.
161 # The -s test is becuase a .so file tends to be small. We don't want
162 # to open every man page. 1024 is arbitrary.
163 if (! -f $_ || -s $_ > 1024) {
167 # Test first line of file for the .so thing.
168 open (SOTEST,$_) || die "$_: $!";
171 if ($l=~m/\.so\s+(.*)/) {
173 # This test is here to prevent links like ... man8/../man8/foo.8
174 if (Debian::Debhelper::Dh_Lib::basename($File::Find::dir) eq
175 Debian::Debhelper::Dh_Lib::dirname($solink)) {
176 $solink=Debian::Debhelper::Dh_Lib::basename($solink);
179 $solink="../$solink";
182 push @sofiles,"$File::Find::dir/$_";
183 push @sodests,$solink;
191 This program is a part of debhelper.
195 Joey Hess <joeyh@debian.org>