BSD 4_4 release

[unix-history] / usr / src / usr.bin / spell / spell.1

diff --git a/usr/src/usr.bin/spell/spell.1 b/usr/src/usr.bin/spell/spell.1
index fda1c74..8f3d2ef 100644 (file)
--- a/usr/src/usr.bin/spell/spell.1
+++ b/usr/src/usr.bin/spell/spell.1
@@ -1,39 +1,37 @@
-.\" Copyright (c) 1990 Regents of the University of California.
-.\" All rights reserved.  The Berkeley software License Agreement
-.\" specifies the terms and conditions for redistribution.
+.\" Copyright (c) 1985, 1993
+.\"    The Regents of the University of California.  All rights reserved.

 .\"
 .\"

-.\"     @(#)spell.1    6.2 (Berkeley) 6/24/90
+.\" This module is believed to contain source code proprietary to AT&T.
+.\" Use and redistribution is subject to the Berkeley Software License
+.\" Agreement and your Software Agreement with AT&T (Western Electric).

 .\"
 .\"

-.TH SPELL 1 "June 24, 1990"
-.AT 3
-.SH NAME
-spell, spellin, spellout \- find spelling errors
-.SH SYNOPSIS
-.B spell
-[
-.B \-v
-] [
-.B \-b
-] [
-.B \-x
-] [
-.B \-d
-hlist ] [
-.B \-s
-hstop ] [
-.B \-h
-spellhist
-] [ file ] ...
-.PP
-.B spellin
-[ list ]
-.PP
-.B spellout
-[
-.B \-d
-] list
-.SH DESCRIPTION
-.I Spell
+.\"    @(#)spell.1     8.1 (Berkeley) 6/6/93
+.\"
+.Dd June 6, 1993
+.Dt SPELL 1
+.Os ATT 7th
+.Sh NAME
+.Nm spell ,
+.Nm spellin ,
+.Nm spellout
+.Nd find spelling errors
+.Sh SYNOPSIS
+.Nm spell
+.Op Fl v
+.Op Fl b
+.Op Fl x
+.Op Fl d Ar hlist
+.Op Fl s Ar hstop
+.Op Fl h Ar spellhist
+.Op Ar file
+.Ar ...
+.Nm spellin
+.Op Ar list
+.Nm spellout
+.Op Fl d
+Ar list
+.Sh DESCRIPTION
+.Nm Spell

 collects words from the named documents,
 and looks them up in a spelling list.
 Words that neither occur among nor are derivable
 collects words from the named documents,
 and looks them up in a spelling list.
 Words that neither occur among nor are derivable


@@ -42,38 +40,36 @@ 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.
 are printed on the standard output.
 If no files are named,
 words are collected from the standard input.

-.PP
-.I Spell
+.Pp
+.Nm Spell

 ignores most
 ignores most

-.I troff,
-.I tbl
+.Xr troff 1 ,
+.Xr tbl 1

 and
 and

-.IR  eqn (1)
+.Xr eqn 1

 constructions.
 constructions.

-.PP
+.Pp

 Under the
 Under the

-.B \-v
+.Fl v

 option, all words not literally in the spelling list are printed,
 and plausible derivations from spelling list words are indicated.
 option, all words not literally in the spelling list are printed,
 and plausible derivations from spelling list words are indicated.

-.PP
+.Pp

 Under the 
 Under the 

-.B \-b
+.Fl b

 option, British spelling is checked.
 Besides preferring
 option, British spelling is checked.
 Besides preferring

-.ft I
-centre, colour, speciality, travelled,
-.ft R
+.Em centre , colour , speciality , travelled ,

 etc.,
 this option insists upon
 etc.,
 this option insists upon

-.I -ise
+.Fl ise

 in words like
 in words like

-.I standardise,
+.Em standardise,

 Fowler and the OED to the contrary notwithstanding.
 Fowler and the OED to the contrary notwithstanding.

-.PP
+.Pp

 Under the 
 Under the 

-.B \-x
+.Fl x

 option, every plausible stem is printed with `=' for each word.
 option, every plausible stem is printed with `=' for each word.

-.PP
+.Pp

 The spelling list is based on many sources.
 While it is more haphazard than an ordinary
 dictionary, it is also more effective with
 The spelling list is based on many sources.
 While it is more haphazard than an ordinary
 dictionary, it is also more effective with


@@ -81,74 +77,85 @@ proper names and popular technical words.
 Coverage of
 the specialized vocabularies of biology,
 medicine and chemistry is light.
 Coverage of
 the specialized vocabularies of biology,
 medicine and chemistry is light.

-.PP
+.Pp

 The auxiliary files used for the spelling list,
 stop list, and history file may be specified by
 arguments following the
 The auxiliary files used for the spelling list,
 stop list, and history file may be specified by
 arguments following the

-.BR \-d ,
-.BR \-s ,
+.Fl d ,
+.Fl s ,

 and
 and

-.B \-h
+.Fl h

 options.
 The default files are indicated below.
 Copies of all output
 may be accumulated in the history file.
 The stop list filters out misspellings (e.g. thier=thy\-y+ier)
 that would otherwise pass.
 options.
 The default files are indicated below.
 Copies of all output
 may be accumulated in the history file.
 The stop list filters out misspellings (e.g. thier=thy\-y+ier)
 that would otherwise pass.

-.PP
+.Pp

 Two routines help maintain the hash lists used by
 Two routines help maintain the hash lists used by

-.I spell.
+.Nm spell.

 Both expect a set of words, one per line,
 from the standard input.
 Both expect a set of words, one per line,
 from the standard input.

-.I Spellin
+.Nm Spellin

 combines the words from the standard input and the
 preexisting
 combines the words from the standard input and the
 preexisting

-.I list
+.Ar list

 file and places a new list on the standard output.
 If no 
 file and places a new list on the standard output.
 If no 

-.I list
+.Ar list

 file is specified, the new list is created from scratch.
 file is specified, the new list is created from scratch.

-.I Spellout
+.Nm Spellout

 looks up each word from the standard input and prints
 on the standard output
 those that are missing from (or present on, with
 option
 looks up each word from the standard input and prints
 on the standard output
 those that are missing from (or present on, with
 option

-.BR \-d )
+.Fl d )

 the hashed
 the hashed

-.I list
+.Ar list

 file.
 For example, to verify that
 file.
 For example, to verify that

-.I hookey
+.Em hookey

 is not on the default spelling list, add it to your own
 private list, and then use it with
 is not on the default spelling list, add it to your own
 private list, and then use it with

-.IR spell ,
-.PP
-.RS
-.nf
+.Nm spell ,
+.Pp
+.Bd -literal -offset indent -compact

 echo  hookey  |  spellout  /usr/share/dict/hlista
 echo  hookey  |  spellin  /usr/share/dict/hlista  >  myhlist
 spell  \-d  myhlist  huckfinn
 echo  hookey  |  spellout  /usr/share/dict/hlista
 echo  hookey  |  spellin  /usr/share/dict/hlista  >  myhlist
 spell  \-d  myhlist  huckfinn

-.RE
-.SH FILES
-/usr/dict/hlist[ab]    hashed spelling lists, American & British, default for
-.B \-d
-.br
-/usr/dict/hstop                hashed stop list, default for
-.B \-s
-.br
-/dev/null              history file, default for
-.B \-h
-.br
-/tmp/spell.$$\(**              temporary files
-.br
-/usr/libexec/spell
-.br
-.SH SEE ALSO
-deroff(1), sort(1), tee(1), sed(1)
-.SH BUGS
+.Ed
+.Sh FILES
+.Bl -tag -width /usr/dict/hlist[ab]xx -compact
+.It Pa /usr/dict/hlist[ab]
+Hashed spelling lists, American & British, default for
+.Fl d .
+.It Pa /usr/dict/hstop
+Hashed stop list, default for
+.Fl s .
+.It Pa /dev/null
+History file, default for
+.Fl h .
+.It Pa /tmp/spell.$$\(**
+Temporary files.
+.It Pa /usr/libexec/spell
+Binary exectuted by the
+shell script
+.Pa /usr/bin/spell .
+.El
+.Sh SEE ALSO
+.Xr deroff 1 ,
+.Xr sort 1 ,
+.Xr tee 1 ,
+.Xr sed 1
+.Sh BUGS

 The spelling list's coverage is uneven;
 new installations will probably wish to 
 monitor the output for several months to gather
 local additions.
 The spelling list's coverage is uneven;
 new installations will probably wish to 
 monitor the output for several months to gather
 local additions.

-.br
+.Pp

 British spelling was done by an American.
 British spelling was done by an American.

+.Sh HISTORY
+The
+.Nm spell
+command appeared in
+.At v6 .