| blob | 5aaf1d5929203f030f35b27b4f0cea1588c8a3dc |
1 '\" te
2 .\" Copyright 1989 AT&T Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved Portions Copyright (c) 1992, X/Open Company Limited All Rights Reserved
3 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
4 .\" http://www.opengroup.org/bookstore/.
5 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
6 .\" This notice shall appear on any product containing this material.
7 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
9 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
10 .TH SPELL 1 "Sep 15, 2011"
11 .SH NAME
12 spell, hashmake, spellin, hashcheck \- report spelling errors
13 .SH SYNOPSIS
14 .LP
15 .nf
16 \fBspell\fR [\fB-bilvx\fR] [+ \fIlocal_file\fR] [\fIfile\fR] ...
17 .fi
19 .LP
20 .nf
21 \fB/usr/lib/spell/hashmake\fR
22 .fi
24 .LP
25 .nf
26 \fB/usr/lib/spell/spellin\fR \fIn\fR
27 .fi
29 .LP
30 .nf
31 \fB/usr/lib/spell/hashcheck\fR \fIspelling_list\fR
32 .fi
34 .SH DESCRIPTION
35 .sp
36 .LP
37 The \fBspell\fR command collects words from the named \fBfile\fRs and looks
38 them up in a spelling list. Words that neither occur among nor are derivable
39 (by applying certain inflections, prefixes, or suffixes) from words in the
40 spelling list are written to the standard output.
41 .sp
42 .LP
43 If there are no \fBfile\fR arguments, words to check are collected from the
44 standard input. \fBspell\fR ignores most \fBtroff\fR(1), \fBtbl\fR(1), and
45 \fBeqn\fR(1) constructs. Copies of all output words are accumulated in the
46 history file (\fBspellhist\fR), and a \fBstop\fR list filters out misspellings
47 (for example, \fBtheir=thy\(miy+ier\fR) that would otherwise pass.
48 .sp
49 .LP
50 By default, \fBspell\fR (like \fBderoff\fR(1)) follows chains of included files
51 (\fB\&.so\fR and \fB\&.nx\fR \fBtroff\fR(1) requests), unless the names of such
52 included files begin with \fB/usr/lib\fR.
53 .sp
54 .LP
55 The standard spelling list is based on many sources, and while more haphazard
56 than an ordinary dictionary, is also more effective in respect to proper names
57 and popular technical words. Coverage of the specialized vocabularies of
58 biology, medicine and chemistry is light.
59 .sp
60 .LP
61 Three programs help maintain and check the hash lists used by \fBspell\fR:
62 .sp
63 .ne 2
64 .na
65 \fB\fBhashmake\fR\fR
66 .ad
67 .RS 13n
68 Reads a list of words from the standard input and writes the corresponding
69 nine-digit hash code on the standard output.
70 .RE
72 .sp
73 .ne 2
74 .na
75 \fB\fBspellin\fR\fR
76 .ad
77 .RS 13n
78 Reads \fIn\fR hash codes from the standard input and writes a compressed
79 spelling list on the standard output.
80 .RE
82 .sp
83 .ne 2
84 .na
85 \fB\fBhashcheck\fR\fR
86 .ad
87 .RS 13n
88 Reads a compressed \fIspelling_list\fR and recreates the nine-digit hash codes
89 for all the words in it. It writes these codes on the standard output.
90 .RE
92 .SH OPTIONS
93 .sp
94 .LP
95 The following options are supported:
96 .sp
97 .ne 2
98 .na
99 \fB\fB-b\fR\fR
100 .ad
101 .RS 15n
102 Check British spelling. Besides preferring \fBcentre\fR, \fBcolour\fR,
103 \fBprogramme\fR, \fBspeciality\fR, \fBtravelled\fR, and so forth, this option
104 insists upon \fI\(miise\fR in words like \fBstandardise\fR.
105 .RE
107 .sp
108 .ne 2
109 .na
110 \fB\fB-i\fR\fR
111 .ad
112 .RS 15n
113 Cause \fBderoff\fR(1) to ignore \fB\&.so\fR and \fB\&.nx\fR commands. If
114 \fBderoff\fR(1) is not present on the system, then this option is ignored.
115 .RE
117 .sp
118 .ne 2
119 .na
120 \fB\fB-l\fR\fR
121 .ad
122 .RS 15n
123 Follow the chains of \fIall\fR included files.
124 .RE
126 .sp
127 .ne 2
128 .na
129 \fB\fB-v\fR\fR
130 .ad
131 .RS 15n
132 Print all words not literally in the spelling list, as well as plausible
133 derivations from the words in the spelling list.
134 .RE
136 .sp
137 .ne 2
138 .na
139 \fB\fB-x\fR\fR
140 .ad
141 .RS 15n
142 Print every plausible stem, one per line, with \fB=\fR preceding each word.
143 .RE
145 .sp
146 .ne 2
147 .na
148 \fB\fB+\fR\fIlocal_file\fR\fR
149 .ad
150 .RS 15n
151 Specify a set of words that are correct spellings (in addition to \fBspell\fR's
152 own spelling list) for each job. \fIlocal_file\fR is the name of a
153 user-provided file that contains a sorted list of words, one per line. Words
154 found in \fIlocal_file\fR are removed from \fBspell\fR's output. Use
155 \fBsort\fR(1) to order \fIlocal_file\fR in ASCII collating sequence. If this
156 ordering is not followed, some entries in \fIlocal_file\fR might be ignored.
157 .RE
159 .SH OPERANDS
160 .sp
161 .LP
162 The following operands are supported:
163 .sp
164 .ne 2
165 .na
166 \fB\fBfile\fR\fR
167 .ad
168 .RS 8n
169 A path name of a text file to check for spelling errors. If no files are named,
170 words are collected from the standard input.
171 .RE
173 .SH ENVIRONMENT VARIABLES
174 .sp
175 .LP
176 See \fBenviron\fR(5) for descriptions of the following environment variables
177 that affect the execution of \fBspell\fR: \fBLC_CTYPE\fR, \fBLC_MESSAGES\fR,
178 and \fBNLSPATH\fR.
179 .SH EXIT STATUS
180 .sp
181 .LP
182 The following exit values are returned:
183 .sp
184 .ne 2
185 .na
186 \fB\fB0\fR\fR
187 .ad
188 .RS 6n
189 Successful completion.
190 .RE
192 .sp
193 .ne 2
194 .na
195 \fB\fB>0\fR\fR
196 .ad
197 .RS 6n
198 An error occurred.
199 .RE
201 .SH FILES
202 .sp
203 .ne 2
204 .na
205 \fB\fBD_SPELL=/usr/lib/spell/hlist[ab]\fR\fR
206 .ad
207 .sp .6
208 .RS 4n
209 hashed spelling lists, American & British
210 .RE
212 .sp
213 .ne 2
214 .na
215 \fB\fBS_SPELL=/usr/lib/spell/hstop\fR\fR
216 .ad
217 .sp .6
218 .RS 4n
219 hashed stop list
220 .RE
222 .sp
223 .ne 2
224 .na
225 \fB\fBH_SPELL=/var/adm/spellhist\fR\fR
226 .ad
227 .sp .6
228 .RS 4n
229 history file
230 .RE
232 .sp
233 .ne 2
234 .na
235 \fB\fB/usr/share/lib/dict/words\fR\fR
236 .ad
237 .sp .6
238 .RS 4n
239 master dictionary
240 .RE
242 .SH SEE ALSO
243 .sp
244 .LP
245 \fBderoff\fR(1), \fBeqn\fR(1), \fBsort\fR(1), \fBtbl\fR(1), \fBtroff\fR(1),
246 \fBattributes\fR(5), \fBenviron\fR(5)
247 .SH NOTES
248 .sp
249 .LP
250 \fBspell\fR works only on English words defined in the U.S. \fBASCII\fR
251 codeset.
252 .sp
253 .LP
254 Because copies of all output are accumulated in the \fBspellhist\fR file,
255 \fBspellhist\fR might grow quite large and require purging.
256 .SH BUGS
257 .sp
258 .LP
259 The spelling list's coverage is uneven. New installations might wish to monitor
260 the output for several months to gather local additions.
261 .sp
262 .LP
263 British spelling was done by an American.