xref: /netbsd/games/boggle/boggle/boggle.6 (revision c4a72b64)
1.\"	$NetBSD: boggle.6,v 1.5 2002/09/26 18:31:59 wiz Exp $
2.\"
3.\" Copyright (c) 1993
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" This code is derived from software contributed to Berkeley by
7.\" Barry Brachman.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\" 3. All advertising materials mentioning features or use of this software
18.\"    must display the following acknowledgement:
19.\"	This product includes software developed by the University of
20.\"	California, Berkeley and its contributors.
21.\" 4. Neither the name of the University nor the names of its contributors
22.\"    may be used to endorse or promote products derived from this software
23.\"    without specific prior written permission.
24.\"
25.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35.\" SUCH DAMAGE.
36.\"
37.\"	@(#)boggle.6	8.1 (Berkeley) 6/11/93
38.\"
39.Dd April 1, 2001
40.Dt BOGGLE 6
41.Os
42.Sh NAME
43.Nm boggle
44.Nd word search game
45.Sh SYNOPSIS
46.Nm
47.Op Fl bd
48.Op Fl s Ar seed
49.Op Fl t Ar time
50.Op Fl w Ar length
51.Op + Op +
52.Op boardspec
53.Sh DESCRIPTION
54The object of
55.Nm
56is to find as many words as possible on the Boggle board within the three
57minute time limit.
58A Boggle board is a four by four arrangement of Boggle cubes, each side of
59each cube displaying a letter of the alphabet or `qu'.
60Words are formed by finding a sequence of cubes (letters) that are in the
61game's dictionary.
62The (N+1)th cube in the word must be horizontally,
63vertically, or diagonally adjacent to the Nth cube.
64Cubes cannot be reused.
65Words consist solely of lower case letters and must be at least 3 letters long.
66.Pp
67Command line flags can be given to change the rules of the game.
68.Bl -tag -width boardspec
69.It Fl b
70Run
71.Nm
72in batch mode.
73A
74.Ar boardspec
75must also be given.
76The dictionary is read from stdin and a list of words appearing in
77.Ar boardspec
78is printed to stdout.
79.It Fl d
80Enable debugging output.
81.It Fl s Ar seed
82Specify a seed
83.Ar seed
84other than the time of day.
85.It Fl t Ar time
86Set the time limit for each game from the default 3 minutes to
87.Ar time
88seconds.
89.It Fl w Ar length
90Change the minimum word length from 3 letters to
91.Ar length .
92.It Ar +
93This flag allows a cube to be used multiple times, but not in succession.
94.It Ar ++
95This flag allows the same cubes to be considered adjacent to itself.
96.It Ar boardspec
97A starting board position can be specified on the command line by
98listing the board left to right and top to bottom.
99.El
100.Pp
101Help is available during play by typing
102.Ic Sq ? .
103More detailed information on the game is given there.
104.Sh BUGS
105If there are a great many words in the cube the final display of the words
106may scroll off of the screen.
107(On a 25 line screen about 130 words can be displayed.)
108.Pp
109No word can contain a
110.Sq q
111that is not immediately followed by a
112.Sq u .
113.Pp
114When using the
115.Ar +
116or
117.Ar ++
118options the display of words found in the board doesn't indicate reused cubes.
119.Sh AUTHOR
120Boggle is a trademark of Parker Brothers.
121.Pp
122Barry Brachman
123.br
124Dept. of Computer Science
125.br
126University of British Columbia
127