]> git.donarmstrong.com Git - debhelper.git/blob - dh_installmanpages.1
r348: * Fixes for perl 5.6.
[debhelper.git] / dh_installmanpages.1
1 .TH DH_INSTALLMANPAGES 1 "" "Debhelper Commands" "Debhelper Commands"
2 .SH NAME
3 dh_installmanpages \- install man pages into package build directories
4 .SH SYNOPSIS
5 .B dh_installmanpages
6 .I "[debhelper options] [file ...]"
7 .SH "DESCRIPTION"
8 dh_installmanpages is a debhelper program that is responsible for
9 automatically installing man pages into usr/share/man/ and usr/X11R6/man/ in
10 package build directories.
11 .P
12 dh_installmanpages scans the current directory and all subdirectories for
13 filenames that look like man pages. (Note that only real files are looked
14 at; symlinks are ignored.) It uses
15 .BR file (1)
16 to verify that the files are in the correct format. Then, based on the
17 files' extensions, it installs them into the correct man directory.
18 .P
19 All filenames specified as parameters will be skipped by dh_installmanpages.
20 This is useful if by default it installs some man pages that you do not want
21 to be installed.
22 .P
23 After the man page installation step, dh_installmanpages will check to see if
24 any of the man pages are ".so" links. If so, it changes them to symlinks.
25 .SH OPTIONS
26 .TP
27 .B debhelper options
28 See
29 .BR debhelper (1)
30 for a list of options common to all debhelper commands.
31 .TP
32 .B file ...
33 Do not install these files as man pages, even if they look like valid man
34 pages.
35 .SH NOTES
36 dh_installmanpages will install the man pages it finds into
37 .B all
38 packages you tell it to act on, since it can't tell what package the man
39 pages belong in.
40 .SH ENVIRONMENT
41 See
42 .BR debhelper (1)
43 for a list of environment variables that affect all debhelper commands.
44 .SH "SEE ALSO"
45 .BR debhelper (1)
46 .SH BUGS
47 Man pages with the extension
48 .B .man
49 are not automatically installed. 
50 .P
51 Files specified as parameters that contain spaces in their filenames will
52 not be processed properly.
53 .P
54 By default, all man pages are installed into all binary packages, which is
55 almost never what you really want (use -p to work around this).
56 .P
57 This is a "Do what I Mean" type program - you have been warned!
58 .SH AUTHOR
59 Joey Hess <joeyh@debian.org>