.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "INSTALLDEB-ISPELL 1"
.TH INSTALLDEB-ISPELL 1 "2021-2-22" "1.28.4" " "
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
installdeb\-ispell \- debhelper\-like utility for
maintainers of ispell dictionary Debian packages
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& installdeb\-ispell [debhelper options] [options]
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBinstalldeb-ispell\fR is a debhelper like program that is
responsible for installing appropriate debconf config and templates
files and debhelper snippets in
an ispell dictionary package,
according to the Debian Spell Dictionaries and Tools Policy.
.PP
For more details, see
 /usr/share/doc/dictionaries\-common\-dev/dsdt\-policy.txt.gz
.PP
The actions executed by \fBinstalldeb-ispell\fR are the
following:
.IP "\(bu" 4
Maintainer Scripts
.Sp
\&\fBinstalldeb-ispell\fR installs the necessary
scraps of code in the \fIpostinst\fR and \fIpostrm\fR scripts.
.IP "\(bu" 4
Language info file
.Sp
\&\fBinstalldeb-ispell\fR also checks a file containing
ispell dictionary information, called
\&\fIdebian/info\-ispell\fR or
\&\fIdebian/package.info\-ispell\fR.  If this file is
successfully parsed, it is installed in the
\&\fI/var/lib/dictionaries\-common/ispell\fR directory.
.IP "\(bu" 4
Substvars substitutions
.Sp
This script will populate a \fIsubstvars\fR file, so Depends line in
control file can contain
${ispell:Depends} to
automatically care for dictionaries-common dependencies.
.Sp
This requires \f(CW\*(C`Build\-Depends\*(C'\fR on at least dictionaries-common-dev
1.23.0 and is highly recommended.
.IP "\(bu" 4
Debconf files
.RS 4
.IP "o templates and config files" 4
.IX Item "o templates and config files"
\&\fBinstalldeb-ispell\fR installs the Policy compliant
Debconf files from the information contained in the
\&\fIinfo-ispell\fR file.  These files are created as
\&\fIdebian/config\fR (or \fIdebian/package.config\fR) and \fIdebian/templates\fR
(or \fIdebian/package.templates\fR).  No intervention is needed here,
since \fBinstalldeb-ispell\fR will make a call to
\&\fBdh_installdebconf\fR\|(1).
.Sp
If the package needs to have special code in the \fIconfig\fR file, the maintainer
should supply files called \fIdebian/config.in\fR (or
\&\fIdebian/package.config.in\fR). In the \fIconfig.in\fR file, the string
\&\f(CW\*(C`#DEBHELPER#\*(C'\fR must appear alone in one line and start at the first
column.  \fBinstalldeb-ispell\fR will replace that
token with the necessary Policy compliant code (this works with
\&\fIconfig.in\fR is either a Bourne shell or Perl script).
.Sp
If the package needs to define its own questions via the \fItemplates\fR
file the maintainer should either supply files \fIdebian/po\-master.templates\fR
(or \fIdebian/package.po\-master.templates\fR) together with the appropriate
po files if the package handles template localization through po-debconf,
or \fIdebian/templates.in\fR (or \fIdebian/package.templates.in\fR) otherwise.
See the \fBpo\-debconf\fR\|(7) manual page for more details and remember that the
master templates name is now different.
.Sp
The templates defined in the \fItemplates.in\fR or \fIpo\-master.templates\fR files
are merged into the Policy compliant templates by
installdeb-ispell and a call to \fBdh_installdebconf\fR\|(1)
is internally done.
.IP "o The elanguages template field" 4
.IX Item "o The elanguages template field"
This field is useful if you want to override the debconf languages string
with something different (since the master string remains the same, this
will not trigger a new debconf call) or if you really think that the
languages string should be internationalized for your package. Note that
for most packages the poor man default localization should be enough, and
translators should have another priorities.
.Sp
installdeb-ispell default behavior is not adding an
\&\f(CW\*(C`elanguages\*(C'\fR field to the templates file. If you want it added you have
to call the script with the explicit \fB\-\-write\-elanguages\fR option.
.Sp
This field will be added with value taken from the \f(CW\*(C`Elanguage\*(C'\fR entry in
the info file if present, or after the \f(CW\*(C`Language\*(C'\fR value otherwise. Note
that this is useful only if:
.RS 4
.IP "\- You want to fix a buggy entry" 4
.IX Item "- You want to fix a buggy entry"
In this case just fill the \f(CW\*(C`Elanguage\*(C'\fR field in the info file with the
new value. This will be shown at the debconf prompt.
.IP "\- You want to fully internationalize your entries" 4
.IX Item "- You want to fully internationalize your entries"
In this case some black magic is needed at first time for smooth use,
.RS 4
.IP "(a) Run \fBinstalldeb\-{ispell,wordlist} \-\-no\-installdebconf \-\-write\-elanguages\fR for every package whose string should be internationalized. Edit the created \fI.templates\fR files and remove the leading underscores in the elanguages entry if present." 4
.IX Item "(a) Run installdeb-{ispell,wordlist} --no-installdebconf --write-elanguages for every package whose string should be internationalized. Edit the created .templates files and remove the leading underscores in the elanguages entry if present."
.PD 0
.IP "(b) Run \fBdebconf-gettextize templates_to_be_internationalized\fR. Check that all the desired \fI.templates\fR files are in \fIdebian/po/POTFILES.in\fR and remove old \fI.config\fR and \fI.templates\fR files." 4
.IX Item "(b) Run debconf-gettextize templates_to_be_internationalized. Check that all the desired .templates files are in debian/po/POTFILES.in and remove old .config and .templates files."
.ie n .IP "(c) Run again \fBinstalldeb\-{ispell,wordlist} \-\-no\-installdebconf \-\-write\-elanguages\fR and \fBdebconf-updatepo\fR (no edit here) to remove references to non-translatable strings. Check that the desired strings are in the po master file (\fIdebian/po/templates.pot\fR) and remove \fI.config\fR and \fI.templates\fR files. You are done. If the master ""Elanguages"" string is changed, repeat (c) afterward." 4
.el .IP "(c) Run again \fBinstalldeb\-{ispell,wordlist} \-\-no\-installdebconf \-\-write\-elanguages\fR and \fBdebconf-updatepo\fR (no edit here) to remove references to non-translatable strings. Check that the desired strings are in the po master file (\fIdebian/po/templates.pot\fR) and remove \fI.config\fR and \fI.templates\fR files. You are done. If the master \f(CWElanguages\fR string is changed, repeat (c) afterward." 4
.IX Item "(c) Run again installdeb-{ispell,wordlist} --no-installdebconf --write-elanguages and debconf-updatepo (no edit here) to remove references to non-translatable strings. Check that the desired strings are in the po master file (debian/po/templates.pot) and remove .config and .templates files. You are done. If the master Elanguages string is changed, repeat (c) afterward."
.RE
.RS 4
.RE
.RE
.RS 4
.RE
.RE
.RS 4
.RE
.IP "\(bu" 4
.PD
Extra installdeb-ispell options in Language info file
.Sp
For benefit of ispell dictionaries using \fBispell-autobuildhash\fR,
\&\fBinstalldeb-ispell\fR script will look for \f(CW\*(Aqauto\-compat\*(Aq\fR fields in
\&\fI\f(CI$dict\fI.info\-ispell\fR, containing base name(s) of your compat file(s).
If \f(CW\*(Aqauto\-compat\*(Aq\fR entry is found two debhelper snippets are added,
one to create/reset compatfile(s) in postinst and the other to remove
files in a removal list from postrm.
Removal list will contain compat file(s) and associated hash(es) with
the same basename.
.Sp
\&\fI/usr/lib/ispell/$dict.hash \-> /var/lib/ispell/$dict.hash\fR
symlinks are no longer created automatically by this script.
They are now created by new ispell-autobuildhash together with the
relevant hashes.
Make sure to depend on at least dictionaries-common 1.23
(See \fIdictionaries\-common.checklist\fR).
.SH "OPTIONS"
.IX Header "OPTIONS"
The usual \fBdephelper\fR\|(1) options are accepted. Options below are specific
to \fBinstalldeb-ispell\fR
.IP "\fB\-\-no\-installdebconf\fR" 4
.IX Item "--no-installdebconf"
Do not run \fBdh_installdebconf\fR nor remove templates and config file.
.IP "\fB\-\-no\-pre\-post\fR" 4
.IX Item "--no-pre-post"
Do not install {pre,post}{inst,rm} snippets.
.IP "\fB\-\-write\-elanguages\fR" 4
.IX Item "--write-elanguages"
Create the elanguages stuff.
.IP "\fB\-\-debug\fR" 4
.IX Item "--debug"
Show some extra info.
.SH "NOTES"
.IX Header "NOTES"
This program is not part of debhelper, although it is intended to be used
in ispell dictionary packages using debhelper in its
building.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBdebhelper\fR\|(1),
dictionaries\-common.checklist,
dsdt\-policy.txt
.PP
This program is part of the dictionaries-common-dev package. It is
intended to be used by maintainers of
ispell dictionary
packages for Debian. See the documentation
under /usr/share/doc/dictionaries\-common\-dev.
.SH "AUTHORS"
.IX Header "AUTHORS"
Rafael Laboissiere, Agustin Martin