NAME
ispell-autobuildhash - Autobuilding the ispell hash file for some dicts
SYNOPSIS
ispell-autobuildhash [--force]
Options:
--debug Show some extra information.
--force Rebuild the hash file for all dicts providing a
compat file skipping the test.
DESCRIPTION
ispell-autobuildhash is a script that will manage ispell hash files
autobuild, intended to be called from the dictionaries-common tools.
Depending on the ispell
compatibility level and on the compatibility level used for the hash file
if present, will decide whether it must be rebuilt or not. This script will
only work on ispell packages prepared to use it, it will do nothing for other
ispell dict packages.
OPTIONS
--debug Show some extra information.
--force Rebuild the hash file for all dicts providing a compat
file regardless of the compatibility levels found.
PACKAGE MAINTAINERS
To use this system, just provide a $dict.compat file in /var/lib/ispell
($dict stands or the hash or affix file basename). Put a “0” in it or just
create an empty one with touch. The way things are done depends on whether
your dict has a single source or a multiple source like ipolish has.
The most common case is having a single source. In this case you must put
the $dict.aff file at /usr/lib/$dict.aff as usual and the munched
wordlist compressed with gzip at /usr/share/ispell/$dict.mwl.gz.
This script supports the way ipolish allows selection of subdictionaries
to be put in the hash file. It will detect the presence of the main
language .desc file and call update-ipolish-hash as appropriate.
Although this script looks for the existence of a update-ispell-hash script
with supposedly similar functionality to update-ipolish-hash, this latter
does not really exists, although it might be added at some time to ispell or
to the dictionaries-common system, if enough demand is found.
If your package provides more than one ispell dictionary you will need to
do the steps above for each dictionary.
Dictionaries-common scripts will call internally this script and create a
hash file at /var/lib/ispell/$dict.hash. You must set a symlink to that
file from /usr/lib/ispell/$dict.hash. You are also suggested to create
an empty file at /var/lib/ispell/$dict.hash in the install target of
your package build process. This empty file will be overwritten when the
real hash is created, but will make the hash be removed at package
removal without any magic being done in the postrm and will also help to
keep track about which package owns that file.
ispell maintainer should also call this script from package postinst.
When comparing versions it will get the ispell version from file
/usr/share/ispell/ispell.compat, or if it does not exists, from the
upstream version as given in the first line of 'ispell -vv output.
AUTHORS
Agustin Martin <agmartin@debian.org>
