1TMISPELL.CONF(5) File Formats Manual TMISPELL.CONF(5)
2
3
4
6 tmispell.conf - configuration file for tmispell
7
9 This manual page describes the configuration file for tmispell(1).
10
12 /etc/tmispell.conf
13 The configuration file that contains spell-checker entries and
14 options.
15
16 Syntax of configuration file
17
18 option=value
19
20 The value string, if enclosed between quotes, may span multiple
21 lines; “#” is a comment character and everything on a line after
22 it is ignored.
23
24 Options
25
26 ispell The location of the Ispell executable to be called as a
27 fall-back. The full path to the Ispell executable must be
28 given. This option is mandatory.
29
30 tex-command-filter
31 A list of TeX commands and their parameter lists to use
32 when filtering TeX input. The syntax is
33 "cmdname oOpP, ...", where oOpP is a string of characters
34 denoting the type of command's parameters. Uppercase
35 letter means that a parameter should be spell-checked,
36 lowercase that it should not. O and o denote optional
37 parameters, P and p normal parameters.
38
39 tex-environment-filter
40 A list of environments to skip when filtering TeX input.
41
42 sgml-attributes-to-check
43 A list of SGML or HTML tag attributes to spell-check.
44
45 The spell-checker module specification consists of seven strings
46 on the same line, separated by whitespace(s) (i.e. space or tab)
47 and possibly enclosed in double (") or single (') quotes. Back‐
48 slash (\) can be used to escape quote characters inside quotes.
49 The meanings of the strings are:
50
51 1. The name by which the dictionary is known, similar to the
52 name of an Ispell hash file name without the extension
53 .hash. This is mandatory.
54
55 2. This option is not used in current version of Tmispell.
56
57 3. This option is not used in current version of Tmispell.
58
59 4. The input encoding this module uses (e.g. UTF-8). This is
60 mandatory.
61
62 5. The value of the locale variable LC_CTYPE that should be
63 used with this module. This determines the default set of
64 characters that are considered to belong to a word. If
65 empty or not given, the value of a suitable environment
66 variable is used.
67
68 6. The set of additional word characters not specified by
69 the locale. If not given, no additional word characters
70 are assumed.
71
72 7. The set of word boundary characters. They are considered
73 to be a part of a word only when occurring inside one. If
74 not given, no boundary characters are assumed.
75
77 Example configuration file
78
79 ispell=/usr/bin/ispell.real
80 suomi "/dev/null" "/dev/null" "UTF-8" "fi_FI.UTF-8" ".-" "':"
81 tex-command-filter="begin po, end p, usepackage op, newcommand
82 poOP"
83 tex-environment-filter="equation $ eqnarray displaymath math"
84
85 The first line specifies the location of the fall-back ispell program
86 to use.
87
88 The second line defines spell-checking settings for Finnish language.
89 Language is identified by the name “suomi”. Following two options are
90 not used in the current version of Tmispell. The input encoding to use
91 is UTF-8. Only the letters specified by the locale fi_FI.UTF-8 as well
92 as period (.) and dash (-) are considered word characters. Boundary
93 characters are ASCII apostrophe (') and colon (:).
94
95 Every time Tmispell is invoked with “-d suomi” or “-d
96 /usr/lib/ispell/suomi.hash” as arguments, the Voikko spell-checking
97 system is used for spell-checking. Otherwise the real Ispell is start‐
98 ed.
99
100 The third line specifies that in TeX filter mode the parameters to com‐
101 mands begin{}, end{} and usepackage{} should not be spell-checked,
102 whereas the second optional and second obligatory parameters to
103 “newcommand” should.
104
105 The fourth line specifies that in TeX filter mode no math environment
106 should be spell-checked.
107
109 The original Tmispell was programmed by Pauli Virtanen
110 <pauli.virtanen@hut.fi>.
111 Modifications and integration with Voikko spell-checking system by Har‐
112 ri Pitkänen <hatapitk@iki.fi>.
113
115 tmispell(1), ispell(1)
116
117 Voikko homepage: http://voikko.sourceforge.net/
118
119
120
121 2006-07-30 TMISPELL.CONF(5)