manual/bsd-games/original/man6/boggle.6

   1 .\"     $NetBSD: boggle.6,v 1.3 2001/04/02 22:46:18 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
  54 The object of
  55 .Nm
  56 is to find as many words as possible on the Boggle board within the three
  57 minute time limit.
  58 A Boggle board is a four by four arrangement of Boggle cubes, each side of
  59 each cube displaying a letter of the alphabet or `qu'.
  60 Words are formed by finding a sequence of cubes (letters) that are in the
  61 game's dictionary.
  62 The (N+1)th cube in the word must be horizontally,
  63 vertically, or diagonally adjacent to the Nth cube.
  64 Cubes cannot be reused.
  65 Words consist solely of lower case letters and must be at least 3 letters long.
  66 .Pp
  67 Command line flags can be given to change the rules of the game.
  68 .Bl -tag -width boardspec
  69 .It Fl b
  70 Run
  71 .Nm
  72 in batch mode.
  73 A
  74 .Ar boardspec
  75 must also be given.
  76 The dictionary is read from stdin and a list of words appearing in
  77 .Ar boardspec
  78 is printed to stdout.
  79 .It Fl d
  80 Enable debugging output.
  81 .It Fl s Ar seed
  82 Specify a seed
  83 .Ar seed
  84 other than the time of day.
  85 .It Fl t Ar time
  86 Set the time limit for each game from the default 3 minutes to
  87 .Ar time
  88 seconds.
  89 .It Fl w Ar length
  90 Change the minimum word length from 3 letters to
  91 .Ar length .
  92 .It Ar +
  93 This flag allows a cube to be used multiple times, but not in succession.
  94 .It Ar ++
  95 This flag allows the same cubes to be considered adjacent to itself.
  96 .It Ar boardspec
  97 A starting board position can be specified on the command line by
  98 listing the board left to right and top to bottom.
  99 .El
 100 .Pp
 101 Help is available during play by typing
 102 .Ic Sq ? .
 103 More detailed information on the game is given there.
 104 .Sh BUGS
 105 If there are a great many words in the cube the final display of the words
 106 may scroll off of the screen.  (On a 25 line screen about 130 words can be
 107 displayed.)
 108 .Pp
 109 No word can contain a
 110 .Sq q
 111 that is not immediately followed by a
 112 .Sq u .
 113 .Pp
 114 When using the
 115 .Ar +
 116 or
 117 .Ar ++
 118 options the display of words found in the board
 119 doesn't indicate reused cubes.
 120 .Sh AUTHOR
 121 Boggle is a trademark of Parker Brothers.
 122 .Pp
 123 Barry Brachman
 124 .br
 125 Dept. of Computer Science
 126 .br
 127 University of British Columbia