man-pages/man1/ispell-wrapper.1.html
2021-03-31 01:06:50 +01:00

181 lines
4.8 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of ISPELL-WRAPPER</TITLE>
</HEAD><BODY>
<H1>ISPELL-WRAPPER</H1>
Section: (1)<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">&nbsp;</A>
<H2>NAME</H2>
ispell-wrapper - smart wrapper for ispell
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<PRE>
ispell-wrapper [--emacs=name] [--language=regexp] [--dry-run] [ispell options] file
Options (all long only options):
--emacs=name Set the language to use by emacs dict name
--language=regexp Set the language to use by name
--dry-run Only show what would have done
</PRE>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<B>ispell-wrapper</B> is a wrapper script for ispell intended to be used
in a Debian system in conjunction with the infrastructure introduced by
the dictionaries-common package. Option --dry-run will show the string
to be run without doing anything else.
<P>
It automatically sets the <B>-d</B>, <B>-w</B>, and <B>-T</B> options to ispell as a
function of the chosen language. Of course, this only works for dictionary
packages that comply with the above mentioned Policy.
<P>
Here is how the language is defined (in order of priority):
<DL COMPACT>
<DT id="1">1)<DD>
By matching the emacs dict name given in --emacs option to the name of
one of the emacs dicts names provided by installed languages in the
system. This match must be exact (although is case insensitive).
Note that this will override any value given in the --language option.
<DT id="2">2)<DD>
By matching the regexp given in option --language to the list of
installed languages in the system.
<DT id="3">3)<DD>
By matching the regexp stored in the environment variable
<FONT SIZE="-1">ISPELLDEFAULT</FONT> to the list of installed languages in the system.
<DT id="4">4)<DD>
By using the value stored in the user-specific file ~/.ispell-default
(use <B><A HREF="/cgi-bin/man/man2html?1+select-default-iwrap">select-default-iwrap</A></B>(1) to set it).
<DT id="5">5)<DD>
By using the value stored in the site-wide file
/etc/dictionaries-common/ispell-default (use <B><A HREF="/cgi-bin/man/man2html?8+select-default-ispell">select-default-ispell</A></B>(8)
as superuser to set it).
</DL>
<P>
Note: regexp matches are case-insensitive and the <FONT SIZE="-1">ISO-8859-1</FONT> special
characters are transformed into their <FONT SIZE="-1">ASCII</FONT> equivalents. German
ess-zet is equivalent to the character ``s'' and the ae ligature to the
character ``e''.
<A NAME="lbAE">&nbsp;</A>
<H2>EXAMPLE</H2>
Let us say that the following dictionaries are installed in the system
(as appearing in the Debconf question at installation time):
<P>
<PRE>
castellano (Spanish TeX mode)
castellano8 (Spanish 8 bit)
portugu&ecirc;s (European Portuguese)
portugu&ecirc;s brasileiro (Brazilian Portuguese)
</PRE>
<P>
Choosing the regexp (either in the --language option or in the
environment variable <FONT SIZE="-1">ISPELLDEFAULT</FONT>) to be ``span'' will yield an error,
since two languages will match (``castellano'' and ``castellano8'').
However, if the regexp is ``span.*8'', the language ``castellano8
(Spanish 8 bit)'' will be chosen.
<A NAME="lbAF">&nbsp;</A>
<H2>ENVIRONMENT</H2>
<DL COMPACT>
<DT id="6"><FONT SIZE="-1">ISPELLDEFAULT</FONT><DD>
Regexp that matches the name of the default language to use, if no
--language option is given.
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>FILES</H2>
<DL COMPACT>
<DT id="7">$HOME/.ispell-default<DD>
Contains the name of the language to use, if no --language option is
given or if the <FONT SIZE="-1">ISPELLDEFAULT</FONT> environment variable is not set. This
is a user-specific choice.
<DT id="8">/etc/dictionaries-common/ispell-default<DD>
Name of the language to use when everything above is not set. This is
a system-wide setting.
</DL>
<A NAME="lbAH">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?8+select-default-ispell">select-default-ispell</A></B>(8), <B><A HREF="/cgi-bin/man/man2html?1+select-default-iwrap">select-default-iwrap</A></B>(1)
<A NAME="lbAI">&nbsp;</A>
<H2>AUTHORS</H2>
Rafael Laboissiere
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="9"><A HREF="#lbAB">NAME</A><DD>
<DT id="10"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="11"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="12"><A HREF="#lbAE">EXAMPLE</A><DD>
<DT id="13"><A HREF="#lbAF">ENVIRONMENT</A><DD>
<DT id="14"><A HREF="#lbAG">FILES</A><DD>
<DT id="15"><A HREF="#lbAH">SEE ALSO</A><DD>
<DT id="16"><A HREF="#lbAI">AUTHORS</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:17 GMT, March 31, 2021
</BODY>
</HTML>