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