xref: /dragonfly/games/boggle/boggle/boggle.6 (revision 335b9e93)
1.\"	$OpenBSD: boggle.6,v 1.21 2015/09/12 16:10:25 schwarze Exp $
2.\"	$NetBSD: boggle.6,v 1.2 1995/03/21 12:14:35 cgd Exp $
3.\"
4.\" Copyright (c) 1997, Jason Downs.  All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS
16.\" OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
17.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
18.\" DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT,
19.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
21.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
22.\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25.\" SUCH DAMAGE.
26.\"
27.\" Copyright (c) 1993
28.\"	The Regents of the University of California.  All rights reserved.
29.\"
30.\" This code is derived from software contributed to Berkeley by
31.\" Barry Brachman.
32.\"
33.\" Redistribution and use in source and binary forms, with or without
34.\" modification, are permitted provided that the following conditions
35.\" are met:
36.\" 1. Redistributions of source code must retain the above copyright
37.\"    notice, this list of conditions and the following disclaimer.
38.\" 2. Redistributions in binary form must reproduce the above copyright
39.\"    notice, this list of conditions and the following disclaimer in the
40.\"    documentation and/or other materials provided with the distribution.
41.\" 3. Neither the name of the University nor the names of its contributors
42.\"    may be used to endorse or promote products derived from this software
43.\"    without specific prior written permission.
44.\"
45.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
46.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
47.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
48.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
49.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
50.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
51.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
52.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
53.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
54.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
55.\" SUCH DAMAGE.
56.\"
57.\"	@(#)boggle.6	8.1 (Berkeley) 6/11/93
58.\"
59.Dd November 16, 2017
60.Dt BOGGLE 6
61.Os
62.Sh NAME
63.Nm boggle
64.Nd word search game
65.Sh SYNOPSIS
66.Nm
67.Op Fl Bbcd
68.Op Fl t Ar time
69.Op Fl w Ar length
70.Op Cm + Ns Op Cm +
71.Op Ar boardspec
72.Sh DESCRIPTION
73The object of
74.Nm
75is to find as many words as possible on the Boggle board within the three
76minute time limit.
77A Boggle board is a four by four arrangement of Boggle cubes, each side of
78each cube displaying a letter of the alphabet or
79.Sq qu .
80Words are formed by finding a sequence of cubes (letters) that are in the
81game's dictionary.
82The (N+1)th cube in the word must be horizontally,
83vertically, or diagonally adjacent to the Nth cube.
84Cubes cannot be reused.
85Words consist solely of lower case letters and must be at least 3 letters long.
86.Pp
87Command line flags can be given to change the rules of the game:
88.Bl -tag -width boardspec
89.It Fl B
90Use an alternate five by five arrangement of Boggle cubes.
91In this mode the default minimum word length is 4 letters.
92This arrangement has been marketed over the years under the names
93.Em Big Boggle ,
94.Em Super Boggle
95and
96.Em Boggle Deluxe .
97.It Fl b
98Run
99.Nm
100in batch mode.
101A
102.Ar boardspec
103must also be given.
104The dictionary is read from stdin and a list of words appearing in
105.Ar boardspec
106is printed to stdout.
107.It Fl c
108Add a so-called
109.Em challenge cube
110to the board, which contains less commonly used letters.
111The challenge cube will be displayed in boldface on the board.
112Depending on the terminal capabilities, it may be displayed in
113underline or a different color (such as red).
114.It Fl d
115Enable debugging output.
116.It Fl t Ar time
117Change the time limit for each game from the default 3 minutes to
118.Ar time
119seconds.
120.It Fl w Ar length
121Change the minimum word length from 3 letters to
122.Ar length .
123.It Cm +
124Allow a cube to be used multiple times, but not in succession.
125.It Cm ++
126Allow a cube to be considered adjacent to itself.
127.El
128.Pp
129A starting board position,
130.Ar boardspec ,
131can be specified on the command line by
132listing the board left to right and top to bottom, in lower case.
133.Pp
134Help is available during play by typing
135.Sq \&? .
136More detailed information on the game is given there.
137.Sh FILES
138.Bl -tag -width 36n -compact
139.It Pa /usr/share/games/boggle/dictionary
140compressed dictionary
141.It Pa /usr/share/games/boggle/dictindex
142dictionary index
143.It Pa /usr/share/games/boggle/helpfile
144online help file
145.El
146.Sh AUTHORS
147Boggle is a trademark of Parker Brothers.
148.Pp
149.An Barry Brachman ,
150Dept. of Computer Science, University of British Columbia
151.Sh BUGS
152No word can contain a
153.Sq q
154that is not immediately followed by a
155.Sq u .
156.Pp
157When using the
158.Cm +
159or
160.Cm ++
161options the display of words found in the board doesn't clearly indicate
162reused cubes.
163