X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=dh_installmanpages;h=cc6a6f6f2c59c8f4330a51f44a6cc8c92cdfe96f;hb=18a0da8092ea9f3dc48bca92b36f592af25a608d;hp=5d4b3e30307f1d0c1bb4985c48532cc123336966;hpb=e446e8308e654785721d8036a1d53633207053f0;p=debhelper.git

diff --git a/dh_installmanpages b/dh_installmanpages
index 5d4b3e3..cc6a6f6 100755
--- a/dh_installmanpages
+++ b/dh_installmanpages
@@ -1,14 +1,69 @@
 #!/usr/bin/perl -w
-#
-# Automatically find and install man pages. However, do not install any man 
-# pages listed on the command line.
-# Also change man pages with .so commands in them into symlinks.
-#
-# This is a little bit (hah!) DWIMish, but still very handy.
+
+=head1 NAME
+
+dh_installmanpages - old-style man page installer (deprecated)
+
+=cut
 
 use strict;
 use File::Find;
 use Debian::Debhelper::Dh_Lib;
+
+=head1 SYNOPSIS
+
+B<dh_installmanpages> [S<I<debhelper options>>] [S<I<file> ...>]
+
+=head1 DESCRIPTION
+
+B<dh_installmanpages> is a debhelper program that is responsible for
+automatically installing man pages into F<usr/share/man/>
+in package build directories.
+
+This is a DWIM-style program, with an interface unlike the rest of
+debhelper. It is deprecated, and you are encouraged to use
+L<dh_installman(1)> instead.
+
+B<dh_installmanpages> scans the current directory and all subdirectories for
+filenames that look like man pages. (Note that only real files are looked
+at; symlinks are ignored.) It uses L<file(1)> to verify that the files are
+in the correct format. Then, based on the files' extensions, it installs 
+them into the correct man directory.
+
+All filenames specified as parameters will be skipped by B<dh_installmanpages>.
+This is useful if by default it installs some man pages that you do not
+want to be installed.
+
+After the man page installation step, B<dh_installmanpages> will check to see
+if any of the man pages are F<.so> links. If so, it changes them to symlinks.
+
+=head1 OPTIONS
+
+=over 4
+
+=item I<file> ...
+
+Do not install these files as man pages, even if they look like valid man
+pages.
+
+=back
+
+=head1 BUGS
+
+B<dh_installmanpages> will install the man pages it finds into B<all> packages
+you tell it to act on, since it can't tell what package the man
+pages belong in. This is almost never what you really want (use B<-p> to work
+around this, or use the much better L<dh_installman(1)> program instead).
+
+Files ending in F<.man> will be ignored.
+
+Files specified as parameters that contain spaces in their filenames will
+not be processed properly.
+
+=cut
+
+warning("This program is deprecated, switch to dh_installman.");
+
 init();
 
 # Check if a file is a man page, for use by File::Find.
@@ -60,9 +115,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";
@@ -74,11 +129,13 @@ sub find_so_man {
 }
 
 foreach my $package (@{$dh{DOPACKAGES}}) {
+	next if is_udeb($package);
+
 	my $tmp=tmpdir($package);
 
 	# Find all filenames that look like man pages.
 	@manpages=();
-	@allpackages=GetPackages('');
+	@allpackages=getpackages('');
 	find(\&find_man,'.'); # populates @manpages
 	
 	foreach my $page (@manpages) {
@@ -90,7 +147,7 @@ foreach my $package (@{$dh{DOPACKAGES}}) {
 		my $install=1;
 		foreach my $skip (@ARGV) {
 			# Look at basename of what's on connect line
-			# for backwards compatability.
+			# for backwards compatibility.
 			if ($basename eq basename($skip)) {
 				$install=undef;
 				last;
@@ -99,10 +156,6 @@ foreach my $package (@{$dh{DOPACKAGES}}) {
 		
 		if ($install) {
 			my $extdir="share";
-			# Handle X man pages specially.
-			if ($basename=~/x$/) {
-				$extdir="X11R6";
-			}
 			
 			my ($section)=$basename=~m/.*\.([1-9])/;
 			
@@ -129,7 +182,7 @@ foreach my $package (@{$dh{DOPACKAGES}}) {
 	
 	# Now the .so conversion.
 	@sofiles=@sodests=();
-	foreach my $dir (qw{usr/share/man usr/X11R6/man}) {
+	foreach my $dir (qw{usr/share/man}) {
 		if (-e "$tmp/$dir") {
 			find(\&find_so_man, "$tmp/$dir");
 		}
@@ -140,3 +193,15 @@ foreach my $package (@{$dh{DOPACKAGES}}) {
 		doit "ln","-sf",$sodest,$sofile;
 	}
 }
+
+=head1 SEE ALSO
+
+L<debhelper(7)>
+
+This program is a part of debhelper.
+
+=head1 AUTHOR
+
+Joey Hess <joeyh@debian.org>
+
+=cut