NAME

spell, hashmake, spellin, hashcheck − find spelling errors

SYNOPSIS

spell [ −blvx ] [ −d hlist ] [ −s hstop ] [ +local_file ] [ filename]...

/usr/lib/spell/hashmake

/usr/lib/spell/spellin n

/usr/lib/spell/hashcheck spelling_list

AVAILABILITY

SUNWesu

DESCRIPTION

spell collects words from the named filenames and looks them up in a spelling list. Words that neither occur among nor are derivable (by applying certain inflections, prefixes, and/or suffixes) from words in the spelling list are printed on the standard output. If no filenames are named, words are collected from the standard input.

spell ignores most troff(1), tbl(1), and eqn(1) constructions. 

By default, spell (like deroff(1)) follows chains of included files (.so and .nx troff(1) requests), unless the names of such included files begin with /usr/lib.  (See the −l option below.)  Following the chains of included files means that spell is run on all included files within a file. 

The spelling list is based on many sources, and while more haphazard than an ordinary dictionary, is also more effective with respect to proper names and popular technical words.  Coverage of the specialized vocabularies of biology, medicine, and chemistry is light. 

Alternate auxiliary files (spelling lists, stop list, history file) may be specified on the command line by using environment variables.  These variables and their default settings are shown in the FILES section. 

There are three routines which help to maintain and check the hash lists used by spell.  These three routines are hashmake, spellin, and hashcheck. 

hashmake reads a list of words from the standard input and writes the corresponding nine-digit hash code on the standard output.  This is the first step in creating a new spelling list or adding words to an existing list; it must be used prior to using spellin. 

spellin reads n hash codes (created by hashmake) from the standard input and writes a compressed spelling list on the standard output.  Use spellin to add words to an existing spelling list or create a new spelling list. 

hashcheck reads a compressed spelling_list and recreates the nine-digit hash codes for all the words in it; it writes these codes on the standard output.  It takes as input an existing spelling list (hlista or hlistb) or a list created or modified by spellin.  By using hashcheck on an existing compressed spelling_list and hashmake on a file of selected words, you can compare the two output files to determine if the selected words are present in the existing spelling_list.

OPTIONS

−b British spelling is checked.  Besides preferring centre, colour, programme, speciality, travelled, and so forth, this option insists upon −ise in words like standardise, Fowler and the OED (Oxford English Dictionary) to the contrary notwithstanding. 

−l Follow the chains of all included files. 

−v All words not literally in the spelling list are printed, and plausible derivations from the words in the spelling list are indicated. 

−x Every plausible stem is displayed, one per line, with = preceding each word. 

−d hlist Use the file hlist as the hashed spelling list. 

−s hstop Use hstop as the hashed stop list.  The stop list is a group of words that would be spelled correctly according to the spell program’s suffix and prefix algorithms, but in fact these words are incorrect.  The words accessable, accidently, and admited are examples of such words that would be found in the stop file. 

+local_file Words found in local_file are removed from spell’s output.  local_file is the name of a user-provided file that contains a sorted list of words, one per line.  The list must be sorted with the ordering used by sort(1) (for example, upper case preceding lower case).  If this ordering is not followed, some entries in local_file may be ignored.  With this option, the user can specify a set of words that are correct spellings (in addition to spell’s own spelling list) for each job.  Copies of all output are accumulated in the history file.  The stop list filters out misspellings (for example, thier=thy−y+ier) that would otherwise pass. 

FILES

D_SPELL=/usr/share/lib/spell/hlist[ab]
hashed spelling lists, American & British

S_SPELL=/usr/share/lib/spell/hstop
hashed stop list

H_SPELL=/var/adm/spellhist history file

/usr/lib/spell/spellprog program

/usr/ucblib/dict/words master dictionary

SEE ALSO

deroff(1), eqn(1), sed(1), sort(1), tbl(1), tee(1), troff(1)

NOTES

The spelling list’s coverage is uneven; new installations will probably wish to monitor the output for several months to gather local additions; typically, these are kept in a separate local file that is added to the hashed spelling_list via spellin or they can be added to a local_file to allow specialization within each discipline. 

SunOS 5.1/SPARC  —  Last change: 14 Sep 1992