blob: 9724635edeead7729720ec54ebd3ad98f1229b67 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
.TH DH_INSTALLDOCS 1
.SH NAME
dh_installdocs \- install documentation into package build directories
.SH SYNOPSIS
.B dh_installdocs
.I "[-v] [-a] [-i] [-ppackage] [-Ptmpdir] [file ...]"
.SH "DESCRIPTION"
dh_installdocs is a debhelper program that is responsible for installing
documentation into usr/doc/package in package build directories.
.P
dh_installdocs automatically installs debian/copyright if it exists. If
dh_installdocs is acting on multiple packages, debian/copyright files will be
installed into all packages.
.P
Any filenames specified as parameters, as well as debian/README.Debian (or
debian/README.debian) and debian/TODO, if they exist, will be installed into
the first binary package listed in debian/control, if dh_installdocs is acting
on that package. Note that debian/TODO will be installed named TODO.Debian,
if the package is not a debian native package.
.P
A file named debian/docs (for the first binary package in debian/control),
or debian/package.docs (for each additional package in debian/control) can
list other files to be installed.
.SH OPTIONS
.TP
.B \-v
Verbose mode; show all commands that modify the package build directory.
.TP
.B \-a
Install files for all architecture dependent packages.
.TP
.B \-i
Install files for all architecture independent packages.
.TP
.B \-ppackage
Install files for the package named "package".
.TP
.B \-Ptmpdir
Use "tmpdir" for package build directory.
.TP
.B file ...
Install these files as documentation into the first binary package listed in
debian/control, if we are acting on that package.
.SH NOTES
The
.B \-a
.B \-i
and
.B \-p
arguments are cumulative. If none are specified, then all packages listed in
the control file will be effected.
.P
Note that dh_installdocs will happily copy entire directory hierarchies if
you ask it to (it uses cp -a internally). If it is asked to install a
directory, it will install the complete contents of the directory.
.SH ENVIRONMENT
.TP
.I DH_VERBOSE
Enables verbose mode
.SH "SEE ALSO"
.BR /usr/doc/debhelper/README
.SH BUGS
Filenames with spaces in them will not currently be installed.
.SH "CONFORMS TO"
Debian policy, version 2.3.0.0
.SH AUTHOR
Joey Hess <joeyh@master.debian.org>
|
