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