Debian Codegraph @

upstream/debian-unstable/man6/boggle.6

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