{"id":7083,"date":"2024-08-24T03:00:00","date_gmt":"2024-08-24T07:00:00","guid":{"rendered":"https:\/\/www.both.org\/?p=7083"},"modified":"2024-08-16T12:33:39","modified_gmt":"2024-08-16T16:33:39","slug":"check-spelling-at-the-command-line","status":"publish","type":"post","link":"https:\/\/www.both.org\/?p=7083","title":{"rendered":"Check spelling at the command line"},"content":{"rendered":"
\r\n
\r\n \r\n <\/i>\r\n <\/a>\r\n <\/span>\r\n<\/div><\/div>\n

I like to write a lot of articles about Linux, FreeDOS, programming, and open source software. I am pretty confident of my spelling and grammar, but sometimes it\u2019s nice to run a quick spell-check to see if I have any spelling errors in my document. When I write documents in LibreOffice, I can use the spell-checker that\u2019s built into LibreOffice, or I can rely on the \u201cred squiggle underline\u201d to catch spelling errors as I type.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

But I write most of my articles in Markdown. If I\u2019m using Vim, I can turn on the automatic inline spell-checker using this Vim command:<\/p>\n\n\n\n

:set spell spelllang=en_us<\/code><\/pre>\n\n\n\n
And that does a great job of catching spelling errors as I type. But I prefer to type without distraction, and capture my thoughts quickly. Going back to fix typos while I type<\/em> is very distracting for me. Instead, I wanted to have a command line tool where I could run a quick command to check for any spelling errors in my document after I\u2019d finished writing it<\/em>.<\/p>\n\n\n\n
Original spell-checkers<\/h2>\n\n\n\n
The original Unix introduced the typo<\/code> command in Unix 3rd Edition. The spell<\/code> command was added in its place starting with Unix 6th Edition. Each command does basically the same thing: checks every word in a document, and prints a sorted list of unique misspelled words.<\/p>\n\n\n\n
As an undergraduate, our campus lab of Sun computers had ispell<\/code>, which was an interactive version of spell<\/code> that showed any misspelled words in context<\/em> in the text document, and suggested correct spellings. These days, GNU Aspell<\/a> replaces ispell<\/code> for checking spelling at the command line on Linux and other Unix-like systems.<\/p>\n\n\n\n
Building your own spell-checker<\/h2>\n\n\n\n
You can build your own version of the original typo<\/code> command using a few Linux commands. At a high level, you can do this by breaking apart a document into words<\/em>, sorting that list of words and removing duplicates, then comparing that list to a list of correctly spelled words<\/em>.<\/p>\n\n\n\n
It\u2019s easiest to convert all words to lowercase, and that\u2019s how the original typo<\/code> command worked. To convert all text to lowercase, use the tr<\/code> (transliterate) command, replacing all uppercase letters with lowercase letters:<\/p>\n\n\n\n
tr 'A-Z' 'a-z'<\/code><\/pre>\n\n\n\n
Next, remove all punctuation from the input. You can also use tr<\/code> to do this, with the -d<\/code> (delete) option:<\/p>\n\n\n\n
tr -d '.,:;\"?!@()'<\/code><\/pre>\n\n\n\n
Then, break up the text so that each word appears on its own line. A simple way to do this is with the tr<\/code> command, and convert spaces to newlines:<\/p>\n\n\n\n
tr ' ' '\\n'<\/code><\/pre>\n\n\n\n
From there, you can use sort<\/code> to sort the list, and uniq<\/code> to remove any duplicates:<\/p>\n\n\n\n
sort | uniq<\/code><\/pre>\n\n\n\n
The last step uses the comm<\/code> (common lines) command to compare two files: the list of words from the document<\/em> with another list of correctly spelled words<\/em>. The comm<\/code> program assumes both lists are sorted in the same way, and it produces output where the lines unique to the first file are in one column, lines unique to the second fiel are in a second column, and the lines common to both appear in a third column.<\/p>\n\n\n\n
When comparing lists of words, that means the correctly spelled words (words that appear in both<\/em> the document and<\/em> the list of correctly spelled words) will be in column 3, while misspelled words (words that appear only<\/em> in the document) will be in column 1. To display only column 1 (misspelled words) we need to disable columns 2 and 3 with the -2<\/code> and -3<\/code> options:<\/p>\n\n\n\n
comm -2 -3 - $words<\/code><\/pre>\n\n\n\n
To put that all together, the full command line looks like this:<\/p>\n\n\n\n
cat \"$@\" | tr 'A-Z' 'a-z' | tr -d '.,:;\"?!@()' | tr ' ' '\\n' | sort | uniq | comm -2 -3 - $words<\/code><\/pre>\n\n\n\n
This requires a sorted list of correctly spelled words. Every Unix-like system should have this list saved as \/usr\/share\/dict\/words<\/code>, but the list may not be sorted in the same way that the sort<\/code> command would generate, so I like to work with a local copy. My full typo<\/code> script looks like this:<\/p>\n\n\n\n
#!\/bin\/bash\nwords=$HOME\/lib\/words.tmp\n\n[ -f $words ] || sort \/usr\/share\/dict\/words > $words\n\ncat \"$@\" | tr 'A-Z' 'a-z' | tr -d '.,:;\"?!@()' | tr ' ' '\\n' | sort | uniq | comm -2 -3 - $words<\/code><\/pre>\n\n\n\n
Let\u2019s test it! Let\u2019s say I had this one-line document called test.md<\/code> that had a single misspelled word:<\/p>\n\n\n\n
This is a sample document with a mspelled word.<\/code><\/pre>\n\n\n\n
If I run the typo<\/code> script against this file, I get the one misspelled word as the only output:<\/p>\n\n\n\n
$ typo test.md\nmspelled<\/code><\/pre>\n\n\n\n
A streamlined version<\/h2>\n\n\n\n
That typo<\/code> script works well for me, but I\u2019ve experimented with other ways to implement it. The basic steps remain the same, but I wanted to use the character class<\/em> model from GNU tr<\/code> to do the same thing. One way is to start is with the -c<\/code> (complement) option to convert any character that is not<\/em> a letter into a newline character:<\/p>\n\n\n\n
tr -c '[:alpha:]' '\\n'<\/code><\/pre>\n\n\n\n
Then I wanted to immediately reduce the work for following steps by removing the blank lines. The grep<\/code> command can do this easily:<\/p>\n\n\n\n
grep -v '^$'<\/code><\/pre>\n\n\n\n
The remaining steps are much as they were in the original. The script converts uppercase letters to lowercase letters, this time using the [:upper:]<\/code> and [:lower:]<\/code> character classes instead of A-Z<\/code> and a-z<\/code>:<\/p>\n\n\n\n
tr '[:upper:]' '[:lower:]'<\/code><\/pre>\n\n\n\n
Finally, sort the words with sort<\/code> and remove duplicates with uniq<\/code> before comparing the output with comm<\/code>:<\/p>\n\n\n\n
sort | uniq | comm -2 -3 - $words<\/code><\/pre>\n\n\n\n
The full command line looks like this:<\/p>\n\n\n\n
cat \"$@\" | tr -c '[:alpha:]' '\\n' | grep -v '^$' | \\\n tr '[:upper:]' '[:lower:]' | sort | uniq | comm -2 -3 - $words<\/code><\/pre>\n\n\n\n
I followed the same basic steps to prepare the sorted list of correctly spelled words, based on the \/usr\/share\/dict\/words<\/code> file. To accommodate any words that I use but aren\u2019t in the system list, such as when I write about FreeDOS, I combine a list of my own words saved in mywords<\/code>:<\/p>\n\n\n\n
cat \/usr\/share\/dict\/words $HOME\/lib\/mywords | \\\n tr '[:upper:]' '[:lower:]' | sort | uniq > $words<\/code><\/pre>\n\n\n\n
My new typo<\/code> script looks like this:<\/p>\n\n\n\n
#!\/bin\/bash\nwords=$HOME\/lib\/words.tmp\n\nif [ ! -f $words ] ; then\n cat \/usr\/share\/dict\/words $HOME\/lib\/mywords | \\\n  tr '[:upper:]' '[:lower:]' | sort | uniq > $words\nfi\n\ncat \"$@\" | tr -c '[:alpha:]' '\\n' | grep -v '^$' | \\\n tr '[:upper:]' '[:lower:]' | sort | uniq | comm -2 -3 - $words<\/code><\/pre>\n\n\n\n
The script does mostly<\/em> the same job as the previous typo<\/code> script. For example, it finds the same misspelled word from the previous example:<\/p>\n\n\n\n
$ typo test.md \nmspelled<\/code><\/pre>\n\n\n\n
The limitation in this \u201cimproved\u201d version is that the tr -c<\/code> command removes hyphenation and apostrophes, so words like hadn't<\/code> will get split up into hadn<\/code> and t<\/code>, resulting in hadn<\/code> being identified as a \u201cmisspelled\u201d word, despite the original word being listed in the correctly spelled words. However, as a quick spell-check tool, this works well enough for me.<\/p>\n","protected":false},"excerpt":{"rendered":"
Check spelling at the command line like old-school Unix with this cool script.<\/p>\n","protected":false},"author":33,"featured_media":3868,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_lmt_disableupdate":"","_lmt_disable":"","footnotes":""},"categories":[100,5],"tags":[104,91],"class_list":["post-7083","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-command-line","category-linux","tag-command-line","tag-linux"],"modified_by":"David Both","_links":{"self":[{"href":"https:\/\/www.both.org\/index.php?rest_route=\/wp\/v2\/posts\/7083","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.both.org\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.both.org\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.both.org\/index.php?rest_route=\/wp\/v2\/users\/33"}],"replies":[{"embeddable":true,"href":"https:\/\/www.both.org\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=7083"}],"version-history":[{"count":4,"href":"https:\/\/www.both.org\/index.php?rest_route=\/wp\/v2\/posts\/7083\/revisions"}],"predecessor-version":[{"id":7089,"href":"https:\/\/www.both.org\/index.php?rest_route=\/wp\/v2\/posts\/7083\/revisions\/7089"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.both.org\/index.php?rest_route=\/wp\/v2\/media\/3868"}],"wp:attachment":[{"href":"https:\/\/www.both.org\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=7083"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.both.org\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=7083"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.both.org\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=7083"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}