version 1, including all changes.
.
| Rev |
Author |
# |
Line |
| 1 |
perry |
1 |
DH_INSTALLDOCS |
| |
|
2 |
!!!DH_INSTALLDOCS |
| |
|
3 |
NAME |
| |
|
4 |
SYNOPSIS |
| |
|
5 |
DESCRIPTION |
| |
|
6 |
OPTIONS |
| |
|
7 |
NOTES |
| |
|
8 |
SEE ALSO |
| |
|
9 |
AUTHOR |
| |
|
10 |
---- |
| |
|
11 |
!!NAME |
| |
|
12 |
|
| |
|
13 |
|
| |
|
14 |
dh_installdocs - install documentation into package build directories |
| |
|
15 |
!!SYNOPSIS |
| |
|
16 |
|
| |
|
17 |
|
| |
|
18 |
__dh_installdocs__ [[''debhelper options''] [[__-A__] |
| |
|
19 |
[[__-n__] [[__-X__''item''] [[''file |
| |
|
20 |
...''] |
| |
|
21 |
!!DESCRIPTION |
| |
|
22 |
|
| |
|
23 |
|
| |
|
24 |
dh_installdocs is a debhelper program that is responsible |
| |
|
25 |
for installing documentation into usr/share/doc/package in |
| |
|
26 |
package build directories. |
| |
|
27 |
|
| |
|
28 |
|
| |
|
29 |
dh_installdocs automatically installs debian/copyright if it |
| |
|
30 |
exists. If dh_installdocs is acting on multiple packages, |
| |
|
31 |
debian/copyright files will be installed into all packages. |
| |
|
32 |
However, if you need to have seperate copyright files for |
| |
|
33 |
different binary packages, you can use files named |
| |
|
34 |
debian/package.copyright. |
| |
|
35 |
|
| |
|
36 |
|
| |
|
37 |
Any filenames specified as parameters will be installed into |
| |
|
38 |
the first package dh_installdocs is told to act on. By |
| |
|
39 |
default, this is the first binary package in debian/control, |
| |
|
40 |
but if you use __-p__, __-i__, or __-a__ flags, it |
| |
|
41 |
will be the first package specified by those |
| |
|
42 |
flags. |
| |
|
43 |
|
| |
|
44 |
|
| |
|
45 |
Also, debian/README.Debian (or debian/README.debian) and |
| |
|
46 |
debian/TODO, if they exist, will be installed into the first |
| |
|
47 |
binary package listed in debian/control, if dh_installdocs |
| |
|
48 |
is acting on that package. Note that debian/TODO will be |
| |
|
49 |
installed named TODO .Debian, if the package |
| |
|
50 |
is not a debian native package. Also note that |
| |
|
51 |
README .debian is installed as |
| |
|
52 |
README .Debian, for consistency. Note that |
| |
|
53 |
debian/package.README.Debian and debian/package.TODO can be |
| |
|
54 |
used to specify files for subpackages. |
| |
|
55 |
|
| |
|
56 |
|
| |
|
57 |
Files named debian/package.docs can list other files to be |
| |
|
58 |
installed. |
| |
|
59 |
|
| |
|
60 |
|
| |
|
61 |
This program will automatically generate postinst and prerm |
| |
|
62 |
commands to maintain a compatibility symlink, |
| |
|
63 |
/usr/doc/package, to the documentation in |
| |
|
64 |
/usr/share/doc/package. See ''dh_installdeb''(1) for an |
| |
|
65 |
explanation of how this works. |
| |
|
66 |
|
| |
|
67 |
|
| |
|
68 |
Files named debian/package.doc-base, will be installed as |
| |
|
69 |
doc-base control files, and will make this program |
| |
|
70 |
automatically generate the postinst and prerm commands |
| |
|
71 |
needed to interface with the doc-base package. Note that the |
| |
|
72 |
doc-id will be determined from the ``Document:'' entry in |
| |
|
73 |
the doc-base control file in question. |
| |
|
74 |
|
| |
|
75 |
|
| |
|
76 |
If your package needs to register more than one document, |
| |
|
77 |
you need multiple files. To accomplish this, you can use |
| |
|
78 |
files named debian/package.doc-base.* |
| |
|
79 |
!!OPTIONS |
| |
|
80 |
|
| |
|
81 |
|
| |
|
82 |
__-A__, __--all__ |
| |
|
83 |
|
| |
|
84 |
|
| |
|
85 |
Install all files specified by command line parameters in |
| |
|
86 |
ALL packages acted on. |
| |
|
87 |
|
| |
|
88 |
|
| |
|
89 |
__-n__, __--noscripts__ |
| |
|
90 |
|
| |
|
91 |
|
| |
|
92 |
Do not modify postinst/prerm scripts. |
| |
|
93 |
|
| |
|
94 |
|
| |
|
95 |
__-Xitem__, __--exclude=item__ |
| |
|
96 |
|
| |
|
97 |
|
| |
|
98 |
Exclude files that contain ``item'' anywhere in their |
| |
|
99 |
filename from being installed. |
| |
|
100 |
|
| |
|
101 |
|
| |
|
102 |
''file ...'' |
| |
|
103 |
|
| |
|
104 |
|
| |
|
105 |
Install these files as documentation into the first package |
| |
|
106 |
acted on. (Or in all packages if __-A__ is |
| |
|
107 |
specified). |
| |
|
108 |
!!NOTES |
| |
|
109 |
|
| |
|
110 |
|
| |
|
111 |
Note that dh_installdocs will happily copy entire directory |
| |
|
112 |
hierarchies if you ask it to (similar to cp -a). If it is |
| |
|
113 |
asked to install a directory, it will install the complete |
| |
|
114 |
contents of the directory. |
| |
|
115 |
|
| |
|
116 |
|
| |
|
117 |
Note that this command is not idempotent. |
| |
|
118 |
-k__ |
| |
|
119 |
__ |
| |
|
120 |
!!SEE ALSO |
| |
|
121 |
|
| |
|
122 |
|
| |
|
123 |
debhelper(1) |
| |
|
124 |
|
| |
|
125 |
|
| |
|
126 |
This program is a part of debhelper. |
| |
|
127 |
!!AUTHOR |
| |
|
128 |
|
| |
|
129 |
|
| |
|
130 |
Joey Hess |
| |
|
131 |
---- |
