TMISPELL.CONF(5)

TMISPELL.CONF(5) 💖

okay bestie, this is the File Formats Manual page for tmispell.conf, and it's genuinely so cute once you get the vibe. grab a boba, we're doing config files 🧋✨

---

✨ NAME ✨

tmispell.conf — the configuration file for tmispell, no cap 💅

---

🌸 DESCRIPTION 🌸

So like. This manual page describes the configuration file for tmispell(1). That's it, that's the whole intro. Short queen energy. 👑

---

🎀 FILES 🎀

📁 /etc/tmispell.conf

This is the file, the main character. It holds all your spell-checker entries and your options. 🫶

🦋 Syntax of configuration file

The whole format is literally just:

option=value

And here's the tea: the value string, if you wrap it in quotes, can span multiple lines like a little paragraph. Also # is a comment character — everything on a line after a # just gets ignored. ghosted. 💀

⭐ Options

• ispell — the location of the Ispell executable that gets called as a fall-back. You must give the full path to the Ispell executable. This option is mandatory, so don't skip it, bestie. 🚨
• tex-command-filter — a list of TeX commands plus their parameter lists, used when filtering TeX input. The syntax is "cmdname oOpP, ..." where oOpP is a string of characters denoting the type of the command's parameters. Uppercase letter = that parameter should be spell-checked. lowercase = it should not be. And O and o mean optional parameters, while P and p mean normal parameters. iykyk 📝
• tex-environment-filter — a list of environments to skip when filtering TeX input. bye felicia, not checking those 🚫
• sgml-attributes-to-check — a list of SGML or HTML tag attributes to spell-check. yes we're checking your <a href> bestie, sorry 🏷️

💜 The spell-checker module specification

Okay so this part is seven strings, all on the same line, separated by whitespace (space or tab, either one), and possibly wrapped in double (") or single (') quotes. And \ (backslash) can escape quote characters inside quotes. iconic little escape hatch 🐚

The meanings of the strings are:

1. The name the dictionary is known by — similar to the name of an Ispell hash file name without the .hash extension. This one is mandatory. 🔥
2. This option is not used in the current version of Tmispell. (just sitting there, chilling)
3. This option is not used in the current version of Tmispell either. (twins 💀)
4. The input encoding this module uses (e.g. UTF-8). This is mandatory. 🌈
5. The value of the locale variable LC_CTYPE that should be used with this module. This determines the default set of characters that count as belonging to a word. If it's empty or just not given, the value of a suitable environment variable gets used instead. 💫
6. The set of additional word characters that the locale doesn't specify. If you don't give it, no additional word characters are assumed. 🍓
7. The set of word boundary characters. These only count as part of a word when they show up inside one. If you don't give it, no boundary characters are assumed. 🧚

---

🔥 EXAMPLES 🔥

Example configuration file

ispell=/usr/bin/ispell.real
suomi "/dev/null" "/dev/null" "UTF-8" "fi_FI.UTF-8" ".-" "':"
tex-command-filter="begin po, end p, usepackage op, newcommand poOP"
tex-environment-filter="equation $ eqnarray displaymath math"

So let's break it down, bestie, line by line:

The first line says where the fall-back ispell program lives. 📍

The second line defines the spell-checking settings for the Finnish language. The language is identified by the name suomi. The following two options are not used in the current version of Tmispell. The input encoding to use is UTF-8. Only the letters that the locale fi_FI.UTF-8 specifies, plus period (.) and dash (-), are considered word characters. The boundary characters are the ASCII apostrophe (') and colon (:). 🇫🇮✨

Every single time Tmispell gets invoked with -d suomi or -d /usr/lib/ispell/suomi.hash as arguments, the Voikko spell-checking system is what does the spell-checking. Otherwise, the real Ispell gets started instead. slay 💅

The third line says that in TeX filter mode, the parameters to the commands begin{}, end{} and usepackage{} should not be spell-checked, whereas the second optional and second obligatory parameters to newcommand absolutely should be. 🎯

The fourth line says that in TeX filter mode, no math environment should be spell-checked. not a single one. math stays unbothered 🧮

---

👑 AUTHORS 👑

The original Tmispell was programmed by Pauli Virtanen <pauli.virtanen@hut.fi>.

Modifications and the integration with the Voikko spell-checking system were done by Harri Pitkänen <hatapitk@iki.fi>.

two legends fr fr 🙌

---

🦋 SEE ALSO 🦋

• tmispell(1)
• ispell(1)

Voikko homepage: http://voikko.sourceforge.net/ 🌐

---

💖 okay that's the whole page bestie, go forth and configure, you're gonna eat 💖

Much love from the File Formats Manual, dated 2006-07-30, signed TMISPELL.CONF(5) — yes she's been iconic since 2006 and she's still serving. periodt. 💅✨