xref: /netbsd/games/gomoku/gomoku.6 (revision bf9ec67e)
1.\"	$NetBSD: gomoku.6,v 1.6 1999/03/22 18:49:12 garbled Exp $
2.\"
3.\" Copyright (c) 1994
4.\"	The Regents of the University of California.  All rights reserved.
5.\"
6.\" This code is derived from software contributed to Berkeley by
7.\" Ralph Campbell.
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.\"     @(#)gomoku.6	8.2 (Berkeley) 8/4/94
38.\"
39.Dd August 4, 1994
40.Dt GOMOKU 6
41.Os
42.Sh NAME
43.Nm gomoku
44.Nd game of 5 in a row
45.Sh SYNOPSIS
46.Nm
47.Op Fl bcdu
48.Op Fl D Ar debugfile
49.Op Ar inputfile
50.Sh DESCRIPTION
51.Nm
52is a two player game were the object is to get 5 in a row horizontally,
53vertically or diagonally on a 19 by 19 grid. By convention, black always
54moves first.
55With no arguments,
56.Nm
57will display a playing board and prompt for moves from the user.
58Valid moves are a letter for the column and a number for the row of an empty
59board location. Entering ``quit" or ``resign" will end the game.
60You can save the current state of the game by entering ``save" and
61supplying a file name when prompted.
62The optional file
63.Ar inputfile
64can be used to restore a saved game.
65.Pp
66The options are:
67.Bl -tag -width Ds
68.It Fl b
69This option sets background mode. Input moves are read from standard input,
70the computer picks a move, and prints it to standard output. The first
71input line should be either ``black" or ``white" to specify whether
72.Nm
73has the first move or not respectively. This
74option was intended for game tournaments where a referee program handles
75the board display and pits one program against another.
76.It Fl c
77Computer verses computer.
78.Nm
79will play a game against itself. This is mostly used for testing.
80.It Fl d
81Print debugging information. Repeating this option more than
82once yields more detailed information.
83.It Fl D Ar debugfile
84Print the debug information to
85.Ar debugfile
86instead of to the standard output.
87.It Fl u
88User verses user. This is mostly used for testing.
89.El
90.Sh AUTHOR
91Ralph Campbell
92.Sh ACKNOWLEDGEMENTS
93The board display routines were based on the
94.Nm goref
95program written by Peter Langston.
96