xref: /openbsd/games/gomoku/gomoku.6 (revision 09467b48)
1.\"	$OpenBSD: gomoku.6,v 1.15 2014/09/08 01:27:54 schwarze 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 $Mdocdate: September 8 2014 $
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 gomoku
43.Op Fl bcdu
44.Op Fl D Ar debugfile
45.Op Ar inputfile
46.Sh DESCRIPTION
47.Nm
48is a two player game where 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.
54The interface is visual and straightforward; you move to a spot
55using the
56.Xr hack 6
57motion keys
58.Em hjklyubn
59and select it with either
60.Sq space
61or
62.Sq return .
63The game will beep if you select a location that is already occupied.
64To save the game, type
65.Sq S
66and to quit, type
67.Sq Q .
68The optional file
69.Ar inputfile
70can be used to restore a saved game.
71.Pp
72The options are:
73.Bl -tag -width Ds
74.It Fl b
75This option sets background mode.
76Input moves are read from standard input,
77the computer picks a move, and prints it to standard output.
78The first input line should be either
79.Dq black
80or
81.Dq white
82to specify whether
83.Nm
84has the first move or not respectively.
85This option was intended for game tournaments where a referee program
86handles the board display and pits one program against another.
87.It Fl c
88Computer versus computer.
89.Nm
90will play a game against itself.
91This is mostly used for testing.
92.It Fl D Ar debugfile
93Print the debug information to
94.Ar debugfile
95instead of to the standard output.
96.It Fl d
97Print debugging information.
98Repeating this option more than once yields more detailed information.
99.It Fl u
100User versus user.
101This is mostly used for testing.
102.El
103.Sh AUTHORS
104.An Ralph Campbell
105.Sh BUGS
106The program is far too slow and uses far too much memory for the quality of
107game it provides.
108.Sh ACKNOWLEDGEMENTS
109The board display routines were based on the
110.Nm goref
111program written by Peter Langston.
112The user interface was based on Eric S. Raymond's interface to
113.Xr bs 6 .
114