175 lines
5.9 KiB
HTML
175 lines
5.9 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of ISPELL-AUTOBUILDHASH</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>ISPELL-AUTOBUILDHASH</H1>
|
|
Section: (8)<BR>Updated: 2018-11-15<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
ispell-autobuildhash - Autobuilding the ispell hash file for some dicts
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
ispell-autobuildhash [--force]
|
|
|
|
Options:
|
|
--debug Show some extra ispell-autobuildhash information.
|
|
--dry-run Show what would be done, but do nothing real.
|
|
--force Rebuild the hash file for all dicts providing a
|
|
compat file skipping the test.
|
|
--triggered Tell the script that is run in the triggers stage.
|
|
|
|
</PRE>
|
|
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
|
|
|
|
<B>ispell-autobuildhash</B> 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.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>OPTIONS</H2>
|
|
|
|
|
|
|
|
|
|
|
|
<PRE>
|
|
--debug Show some extra ispell-autobuildhash information.
|
|
--dry-run Show what would be done, but do nothing real.
|
|
--force Rebuild the hash file for all dicts providing a compat
|
|
file regardless of the compatibility levels found.
|
|
--triggered Tell the script that is run in the triggers stage. When
|
|
run under dpkg control, do not try to set the
|
|
'ispell-autobuildhash' trigger, but run real
|
|
B<ispell-autobuildhash> code. When not run under dpkg
|
|
control, real code will always be run and '--triggered'
|
|
option has no real effect.
|
|
|
|
</PRE>
|
|
|
|
|
|
<A NAME="lbAF"> </A>
|
|
<H2>PACKAGE MAINTAINERS</H2>
|
|
|
|
|
|
|
|
To use this system, <B>ispell-autobuildhash</B> expects a <I></I>$dict<I>.compat</I> file
|
|
in <I>/var/lib/ispell</I> (<I></I>$dict<I></I> stands for the hash or affix file basename)
|
|
containing ispell major or compatibility version for last successful build
|
|
or ``0'' or en empty file if hash is to be rebuild, as is for dictionary
|
|
installation and upgrades.
|
|
<P>
|
|
|
|
When upgrading <B>ispell</B>, script will check if version in <I></I>$dict<I>.compat</I>
|
|
is different from <I>ispell.compat</I> and rebuild if so, updating
|
|
<I></I>$dict<I>.compat</I> with the new value. The particular way things are done depends
|
|
on whether your dict has a single source or a multiple source like ipolish has.
|
|
<P>
|
|
|
|
The most common case is having a single source. In this case you must put
|
|
the <I></I>$dict<I>.aff</I> file at <I>/usr/lib/ispell/$dict.aff</I> as usual and the munched
|
|
wordlist compressed with gzip at <I>/usr/share/ispell/$dict.mwl.gz</I>.
|
|
<P>
|
|
|
|
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.
|
|
<P>
|
|
|
|
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.
|
|
<P>
|
|
|
|
If your package provides more than one ispell dictionary you will need to
|
|
do the steps above for each dictionary.
|
|
<P>
|
|
|
|
Dictionaries-common scripts will call internally this script and create a
|
|
hash file at <I>/var/lib/ispell/$dict.hash</I>. You must set a symlink to that
|
|
file from <I>/usr/lib/ispell/$dict.hash</I>.
|
|
<P>
|
|
|
|
Ispell dictionary packages using this script must make sure that
|
|
<I></I>$dict<I>.compat</I> is reset on every new install/upgrade, so hash is rebuilt.
|
|
They must also make sure that <I></I>$dict<I>.compat</I> and <I>/var/lib/ispell/$dict.hash</I>
|
|
are removed on package removal
|
|
<P>
|
|
|
|
As of version <TT>1.10</TT>, <B>installdeb-ispell</B> script will understand
|
|
<TT>'auto-compat'</TT> field in <I></I>$dict<I>.info-ispell</I> file to help with this by
|
|
adding needed debhelper snippets. Put in that entry the base name(s) of
|
|
your compat file(s) and check resulting maintainer scripts after build.
|
|
<P>
|
|
|
|
Note that you are no longer suggested to ship empty files at
|
|
<I>/var/lib/ispell/$dict.compat</I> and <I>/var/lib/ispell/$dict.hash</I> to help
|
|
with reset/removal of those files, but explicitly create/update them on
|
|
install and explicitly remove them on removal.
|
|
<P>
|
|
|
|
<B>ispell</B> maintainer should also call this script from package postinst.
|
|
When comparing versions it will get the ispell version from file
|
|
<I>/usr/share/ispell/ispell.compat</I>, or if it does not exists, from the
|
|
upstream version as given in the first line of '<B>ispell -vv</B> output.
|
|
<A NAME="lbAG"> </A>
|
|
<H2>AUTHOR</H2>
|
|
|
|
|
|
|
|
Agustin Martin <<A HREF="mailto:agmartin@debian.org">agmartin@debian.org</A>>
|
|
<A NAME="lbAH"> </A>
|
|
<H2>COPYRIGHT</H2>
|
|
|
|
|
|
|
|
Copyright (C) 2003-2013 Agustin Martin <<A HREF="mailto:agmartin@debian.org">agmartin@debian.org</A>>
|
|
<P>
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the <FONT SIZE="-1">GNU</FONT> General Public License as published by
|
|
the Free Software Foundation; either version 3 of the License, or
|
|
(at your option) any later version.
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="1"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="2"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="3"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="4"><A HREF="#lbAE">OPTIONS</A><DD>
|
|
<DT id="5"><A HREF="#lbAF">PACKAGE MAINTAINERS</A><DD>
|
|
<DT id="6"><A HREF="#lbAG">AUTHOR</A><DD>
|
|
<DT id="7"><A HREF="#lbAH">COPYRIGHT</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:06:13 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|