r75: Initial Import

[debhelper.git] / dh_installmanpages.1

diff --git a/dh_installmanpages.1 b/dh_installmanpages.1
index 7687ed9c7dff96a277503252a1671d0422798822..7053dbc6a8ebc995fba8318c983859480d5db7d7 100644 (file)
--- a/dh_installmanpages.1
+++ b/dh_installmanpages.1
@@ -3,14 +3,15 @@
 dh_installmanpages \- install man pages into package build directories
 .SH SYNOPSIS
 .B dh_installmanpages
-.I "[-v] [-a] [-i] [-ppackage] [-Ptmpdir] [file ...]"
+.I "[-v] [-a] [-i] [--no-act] [-ppackage] [-Ptmpdir] [file ...]"
 .SH "DESCRIPTION"
 dh_installmanpages is a debhelper program that is responsible for
 automatically installing man pages into usr/man/ and usr/X11R6/man/ in
 package build directories.
 .P
 dh_installmanpages scans the current directory and all subdirectories for
-filenames that look like man pages. It uses
+filenames that look like man pages. (Note that only real files are looked
+at; symlinks are ignored.) It uses
 .BR 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.
@@ -18,21 +19,28 @@ files' extensions, it installs them into the correct man directory.
 All filenames specified as parameters will be skipped by dh_installmanpages.
 This is useful if by default it installs some man pages that you do not want
 to be installed.
+.P
+After the man page installation step, dh_installmanpages will check to see if
+any of the man pages are ".so" links. If so, it changes them to symlinks.
 .SH OPTIONS
 .TP
-.B \-v
+.B \-v, \--verbose
 Verbose mode; show all commands that modify the package build directory.
 .TP
-.B \-a
+.B \-a, \--arch
 Install man pages into all architecture dependent packages.
 .TP
-.B \-i
+.B \-i, \--indep
 Install man pages into all architecture independent packages.
 .TP
-.B \-ppackage
+.B \--no-act
+Do not really do anything. If used with -v, the result is that this command
+will output a list of what it would have done.
+.TP
+.B \-ppackage, \--package=package
 Install man pages into the package named "package".
 .TP
-.B \-Ptmpdir
+.B \-Ptmpdir, \--tmpdir=tmpdir
 Use "tmpdir" for package build directory. 
 .TP
 .B file ...
@@ -55,6 +63,9 @@ pages belong in.
 .TP
 .I DH_VERBOSE
 Enables verbose mode
+.TP
+.I DH_NO_ACT
+Enables no-act mode (see above).
 .SH "SEE ALSO"
 .BR /usr/doc/debhelper/README
 .SH BUGS
@@ -65,6 +76,9 @@ are not automatically installed.
 Files specified as parameters that contain spaces in their filenames will
 not be processed properly.
 .P
+By default, all man pages are installed into all binary packages, which is
+almost never what you really want (use -p to work around this).
+.P
 This is a "Do what I Mean" type program - you have been warned!
 .SH AUTHOR
 Joey Hess <joeyh@master.debian.org>