4
<IMG SRC="debian.jpg" ALT="Debian GNU/Linux"><p>
8
dhelp is an online help system for Debian GNU/Linux. A Debian package
9
can register its HTML documents and dhelp builds an index of
12
The user doesn't need a WWW server to browse the HTML tree.
14
<H2>How to use dhelp</H2>
15
If you have installed a WWW server on your system simply browse
16
<BLOCKQUOTE><TT><A HREF="http://localhost/doc/HTML/index.html">
17
http://localhost/doc/HTML/index.html</A></TT></BLOCKQUOTE><P>
19
If you haven't installed a WWW server use the dhelp command:
21
<BLOCKQUOTE>$ dhelp</BLOCKQUOTE>
23
<H2>The .dhelp file</H2>
25
Programs supporting dhelp have to install a <tt>.dhelp</tt> file
26
in every directory under <tt>/usr/share/doc</tt>. For every HTML file that
27
should appear in the dhelp index the <tt>.dhelp</tt> file have to contain
28
the following section:<P>
31
<DT><TT><item></TT>
32
<DT><TT><directory></TT>
33
<DD>Defines in which section of the index the document should be linked.
34
I suggest that you use the same names like in <em>Section:</em>
35
in <tt>control</tt>. For example for a game you would use
36
<tt>games</tt>. A German document should linked to <tt>de/games</tt>
38
You can find all supported sections in
39
<tt><A HREF=".dhelp">.dhelp</A></tt>. You can create additional
40
sections if necessary.
41
<DT><TT><dirtitle></TT>
42
<DD>Defines the title of a new section.
43
<DT><TT><linkname></TT>
44
<DD>This short text appears as link text in the index. This
45
is typical the filename without the <tt>.html suffix</tt>.
46
<DT><TT><filename></TT>
47
<DD>The filename of the HTML file with a path relative to the
48
<tt>.dhelp</tt> file. If your document is called
49
<tt>/usr/share/doc/dhelp/test.html</tt> and the <tt>.dhelp</tt>
50
is installed in <tt>/usr/share/doc/dhelp</tt> you must use
58
A long description of the content of the document (optional).
59
<DT><TT></item></TT>
62
You can have only one tag per line! Something like the following will
66
<item><directory>de/foo
67
<dirtitle>The foo section
69
<filename>foo.html
70
<descrip>foo foo foo</descrip></item>
73
You have to use this:<P>
77
<directory>de/foo
78
<dirtitle>The foo section
80
<filename>foo.html
87
You can have several <item> sections in one <tt>.dhelp</tt>
91
<H2>Add a .dhelp file to the index</H2>
93
To add a <tt>.dhelp</tt> file to the document index you have
94
to call <tt>dhelp_parse</tt>:<P>
96
<BLOCKQUOTE># dhelp_parse -a /usr/share/doc/directory</BLOCKQUOTE>
98
I would suggest to add the following to your package <tt>postinst</tt>
102
if [ -f /usr/sbin/dhelp_parse ]; then
103
/usr/sbin/dhelp_parse -a /usr/share/doc/directory
105
</PRE></BLOCKQUOTE><P>
107
In <tt>prerm</tt> you should use:<P>
110
if [ -f /usr/sbin/dhelp_parse ]; then
111
/usr/sbin/dhelp_parse -d /usr/share/doc/directory
113
</PRE></BLOCKQUOTE><P>
116
If your package conforms to the latest policy, the <tt>postinst</tt>
117
script should look like this:<P>
120
if [ -f /usr/sbin/dhelp_parse ]; then
121
/usr/sbin/dhelp_parse -a /usr/share/doc/directory
124
if [ -f /usr/sbin/dhelp_parse_fsstnd ]; then
125
/usr/sbin/dhelp_parse_fsstnd -a /usr/doc/directory
127
</PRE></BLOCKQUOTE><P>
129
In <tt>prerm</tt> you should use:<P>
132
if [ -f /usr/sbin/dhelp_parse ]; then
133
/usr/sbin/dhelp_parse -d /usr/share/doc/directory
136
if [ -f /usr/sbin/dhelp_parse_fsstnd ]; then
137
/usr/sbin/dhelp_parse_fsstnd -d /usr/doc/directory
139
</PRE></BLOCKQUOTE><P>
142
Or you can use the script <tt>dh_dhelp</tt>. This script installs
143
the <tt>debian/dhelp</tt> file in <tt>/usr/share/doc/package</tt> and
144
creates the <tt>postinst</tt> and <tt>prerm</tt> scripts of all
145
<tt>.dhelp</tt> files found in <tt>/usr/share/doc</tt>.
148
<H2>Scripts for .dhelp file</H2>
152
If the HTML files were produced by the sgml-tools (linuxdoc-sgml)
153
you can use the script <tt><a href="sgml2dhelp.pl">sgml2dhelp.pl</a></tt>.
154
This script produces a <tt>.dhelp</tt>, a <tt>.dwww-index</tt>,
155
and a <tt>index.html</tt> file.<P>
157
Run this script in every directory containing HTML files.
158
You have to call the script with to options:<P>
161
<b>sgml2dhelp</b> <i><dhelp section> <dwww section></i>
164
If your documents should go in the German HOWTO section for example, you
167
<BLOCKQUOTE><TT># dhelp.build de/HOWTO general</TT></BLOCKQUOTE> <P>
171
If you have written a <tt>.dhelp</tt>, you can convert it to
172
a <tt>.dwww-index</tt> file with the script
173
<tt><a href="dhelp2dwww.pl">dhelp2dwww.pl</a></tt>.<p>
176
<b>dhelp2dwww</b> <i><dwww section></i>
179
<H2>What can I do for dhelp?</H2>
181
If you like dhelp please ask maintainers of Debian packages including
182
HTML documentation to add dhelp support.<P>
184
If you have any comments or problems please feel free to send
185
an email to the dhelp package maintainer:
186
<A HREF="mailto:dhelp@packages.debian.org">dhelp@packages.debian.org</A>
b'\\ No newline at end of file'
added
removed
doc/dhelp.html
