version 1, including all changes.
.
| Rev |
Author |
# |
Line |
| 1 |
perry |
1 |
DH_UNDOCUMENTED |
| |
|
2 |
!!!DH_UNDOCUMENTED |
| |
|
3 |
NAME |
| |
|
4 |
SYNOPSIS |
| |
|
5 |
DESCRIPTION |
| |
|
6 |
OPTIONS |
| |
|
7 |
SEE ALSO |
| |
|
8 |
AUTHOR |
| |
|
9 |
---- |
| |
|
10 |
!!NAME |
| |
|
11 |
|
| |
|
12 |
|
| |
|
13 |
dh_undocumented - make symlinks to undocumented.7.gz man page |
| |
|
14 |
!!SYNOPSIS |
| |
|
15 |
|
| |
|
16 |
|
| |
|
17 |
__dh_undocumented__ [[''debhelper options''] |
| |
|
18 |
[[__-A__] [[''manpage ...''] |
| |
|
19 |
!!DESCRIPTION |
| |
|
20 |
|
| |
|
21 |
|
| |
|
22 |
dh_undocumented is a debhelper program that is responsible |
| |
|
23 |
for making symlinks to undocumented(7) for man pages |
| |
|
24 |
that are not present in your package. |
| |
|
25 |
|
| |
|
26 |
|
| |
|
27 |
The program takes a list of man pages that should be |
| |
|
28 |
symlinked to undocumented(7). It examines the |
| |
|
29 |
extension to see what section the man page belongs in. After |
| |
|
30 |
figuring this out, it generates the necessary |
| |
|
31 |
symlinks. |
| |
|
32 |
|
| |
|
33 |
|
| |
|
34 |
The lists of man pages that need symlinks can be specified |
| |
|
35 |
in two ways. Any man page names specified as parameters will |
| |
|
36 |
be set up in the first package dh_undocumented is told to |
| |
|
37 |
act on. By default, this is the first binary package in |
| |
|
38 |
debian/control, but if you use -p, -i, or -a flags, it will |
| |
|
39 |
be the first package specified by those flags. |
| |
|
40 |
|
| |
|
41 |
|
| |
|
42 |
Also, a file named debian/package.undocumented can list |
| |
|
43 |
other man page names to set up. |
| |
|
44 |
!!OPTIONS |
| |
|
45 |
|
| |
|
46 |
|
| |
|
47 |
__-A__, __--all__ |
| |
|
48 |
|
| |
|
49 |
|
| |
|
50 |
Install undocumented man page symlinks for any man pages |
| |
|
51 |
specified by command line parameters in ALL |
| |
|
52 |
packages acted on. I doubt anyone will find this useful, |
| |
|
53 |
it's here for consitency with other debhelper |
| |
|
54 |
programs. |
| |
|
55 |
|
| |
|
56 |
|
| |
|
57 |
''manpage ...'' |
| |
|
58 |
|
| |
|
59 |
|
| |
|
60 |
Install undocumented man page symlinks for each of these man |
| |
|
61 |
pages into the first package acted on. (Or in all packages |
| |
|
62 |
acted on if -A is specified.) |
| |
|
63 |
|
| |
|
64 |
|
| |
|
65 |
Note that Debian policy prohibits links to |
| |
|
66 |
undocumented(7) unless the package has an open bug |
| |
|
67 |
report stating that it has no man page. You should really |
| |
|
68 |
just write a man page instead; this program is an easy way |
| |
|
69 |
out. |
| |
|
70 |
!!SEE ALSO |
| |
|
71 |
|
| |
|
72 |
|
| |
|
73 |
debhelper(1) |
| |
|
74 |
|
| |
|
75 |
|
| |
|
76 |
This program is a part of debhelper. |
| |
|
77 |
!!AUTHOR |
| |
|
78 |
|
| |
|
79 |
|
| |
|
80 |
Joey Hess |
| |
|
81 |
---- |
