.\"
.\" Sccsid @(#)spell.1	2.2 (gritter) 6/22/05
.\" Derived from spell(1), Unix 7th edition:
.\" Copyright(C) Caldera International Inc. 2001-2002. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\"   Redistributions of source code and documentation must retain the
.\"    above copyright notice, this list of conditions and the following
.\"    disclaimer.
.\"   Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"   All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"      This product includes software developed or owned by Caldera
.\"      International, Inc.
.\"   Neither the name of Caldera International, Inc. nor the names of
.\"    other contributors may be used to endorse or promote products
.\"    derived from this software without specific prior written permission.
.\"
.\" USE OF THE SOFTWARE PROVIDED FOR UNDER THIS LICENSE BY CALDERA
.\" INTERNATIONAL, INC. AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL CALDERA INTERNATIONAL, INC. BE
.\" LIABLE FOR ANY DIRECT, INDIRECT INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
.\" BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
.\" OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
.\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.TH SPELL 1 "6/22/05" "Heirloom Toolchest" "User Commands"
.SH NAME
spell \- find spelling errors
.SH SYNOPSIS
\fBspell\fR [\fB\-v\fR] [\fB\-b\fR] [\fB\-x\fR] [\fB\-i\fR] [\fB\-l\fR]
[\fB+\fIlocal_file\fR] [\fIfile\fR\ ...]
.br
\fB/usr/5lib/spell/spellin\fR [\fIlist\fR]
.br
\fB/usr/5lib/spell/hashcheck\fR
.br
\fB/usr/5lib/spell/hashmake\fR
.br
\fB/usr/5lib/spell/compress\fR
.SH DESCRIPTION
.I Spell
collects words from the named documents,
and looks them up in a spelling list.
Words that neither occur among nor are derivable
(by applying certain inflections,
prefixes or suffixes) from words in the spelling list
are printed on the standard output.
If no files are named,
words are collected from the standard input.
.PP
.I Spell
ignores most
.I troff,
.I tbl
and
.IR  eqn (1)
constructions.
.PP
Under the
.B \-v
option, all words not literally in the spelling list are printed,
and plausible derivations from spelling list words are indicated.
.PP
Under the 
.B \-b
option, British spelling is checked.
Besides preferring
.ft I
centre, colour, speciality, travelled,
.ft R
etc.,
this option insists upon
.I -ise
in words like
.I standardise,
Fowler and the OED to the contrary
notwithstanding.
.PP
Under the 
.B \-x
option, every plausible stem is printed with `=' for each word.
.PP
The
.B \-i
option is passed to
.IR deroff (1).
.PP
With the
.B \-l
option, all chains of included files are followed.
.PP
If the \fB+\fIlocal_file\fR argument is present,
words present in \fIlocal_file\fR (one word per line)
are removed from the output as additional correctly spelled words.
.PP
The spelling list is based on many sources,
and while more haphazard than an ordinary
dictionary, is also more effective in respect to
proper names and popular technical words.
Coverage of
the specialized vocabularies of biology,
medicine and chemistry is light.
.PP
Pertinent auxiliary files may be specified by
name arguments, indicated below with their
default settings.
Copies of all output
are accumulated in the history file.
The stop list filters out misspellings (e.g. thier=thy\-y+ier)
that would otherwise pass.
.PP
Four routines help maintain the hash lists used by
.I spell.
.I Hashmake
expects a list of words, one per line,
from the standard input,
and writes the hash value for each word
to standard output.
.I Spellin
adds the hash values on the standard input to the
preexisting
.I list
and places a new binary list on the standard output.
If no 
.I list
is specified, the new list is created from scratch.
.I Hashcheck
reads a binary list from standard input
and prints the hash values contained in it.
.I Compress
removes duplicate entries from the history file.
.SH FILES
.TP
\fBD_SPELL\fR=\fB/usr/5lib/spell/hlist\fR[\fBab\fR]
hashed spelling lists, American & British
.TP
\fBS_SPELL\fR=\fB/usr/5lib/spell/hstop\fR
hashed stop list
.TP
\fBH_SPELL\fR=\fB/var/adm/spellhist\fR
history file
.TP
.B /usr/5lib/spell/spellprog
.SH "SEE ALSO"
deroff(1),
sort(1),
tee(1),
sed(1)
.SH NOTES
The spelling list's coverage is uneven;
new installations will probably wish to 
monitor the output for several months to gather
local additions.
.sp
British spelling was done by an American.