man dhelp_parse (Administration système) - Debian online help parser
NAME
dhelp_parse - Debian online help parser
SYNOPSIS
dhelp_parse [ -r | -a | -d ] [ directories ]
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 /usr/share/doc/HTML
OPTIONS
- -a
- Add the .dhelp files in the given directories to the dhelp database.
- -d
- Delete the .dhelp files in the given directories from the dhelp database.
- -r
- Add all .dhelp files in /usr/share/doc to the database.
PACKAGE DEVELOPERS
To register HTML documents included in a Debian package you have to call dhelp_parse like that:
postinst
if [ -f /usr/sbin/dhelp_parse ]; then
dhelp_parse -a /usr/share/doc/foo
fi
prerm
if [ -f /usr/sbin/dhelp_parse ]; then
dhelp_parse -d /usr/share/doc/foo
fi
Or you can use dh_dhelp in your debian/rules This script installs the debian/dhelp file in debian/tmp/usr/share/doc/foo and creates the postinst and prerm scripts for all dhelp files found in debian/tmp/usr/share/doc
You have to install a .dhelp file in /usr/share/doc/foo - the format of .dhelp is described in /usr/share/doc/dhelp/dhelp.html
If you want to support not only dhelp but also dwww, change in the directory with the installed .dhelp file and run dhelp2dwww This creates the needed .dwww-index file.
SEE ALSO
AUTHOR
This package was written by Marco Budde (Budde@tu-harburg.de).