blob: 0c16252e5c83e5e0056cc883342d9e97f60cd4ca (
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
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
.TH dhelp_parse 8 "10 April 1998" Debian "Debian Linux manual"
.SH NAME
dhelp_parse \- Debian online help parser
.SH SYNOPSIS
.B dhelp_parse
.IR "[ -r | -a | -d ] [ directories ]"
.SH DESCRIPTION
This program is used by package developers to register the
HTML documents included in a package.
In most cases it is called by the postinst and prerm scripts
of a Debian package.
An index of the registered documents is written in the
directory
.I /usr/doc/HTML
.SH OPTIONS
.TP
.B \-a
Add the
.I .dhelp
files in the given directories to the dhelp database.
.TP
.B \-d
Delete the
.I .dhelp
files in the given directories from the dhelp database.
.TP
.B \-r
Add all
.I .dhelp
files in
.I /usr/doc
to the database.
.SH PACKAGE DEVELOPERS
To register HTML documents included in a Debian package you
have to call dhelp_parse like that:
.SS postinst
if [ -f /usr/sbin/dhelp_parse ]; then
.br
dhelp_parse -a /usr/doc/foo
.br
fi
.SS prerm
if [ -f /usr/sbin/dhelp_parse ]; then
.br
dhelp_parse -d /usr/doc/foo
.br
fi
Or you can use
.B dh_dhelp
in your
.I debian/rules
This script installs the
.I debian/dhelp
file in
.I debian/tmp/usr/doc/foo
and creates the postinst and prerm scripts for all
.I dhelp
files found in
.I debian/tmp/usr/doc
You have to install a
.I .dhelp
file in
.I /usr/doc/foo
- the format of
.I .dhelp
is described in
.I /usr/doc/dhelp/dhelp.html
If you want to support not only dhelp but also dwww, change in the
directory with the installed
.I .dhelp
file and run
.B dhelp2dwww
This creates the needed
.I .dwww-index
file.
.SH SEE ALSO
dhelp(1)
.SH AUTHOR
This package was written by Marco Budde (Budde@tu-harburg.de).
|
