xref: /original-bsd/games/gomoku/gomoku.6 (revision cf2e4d33)
1.\" Copyright (c) 1994
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" This code is derived from software contributed to Berkeley by
5.\" Ralph Campbell.
6.\"
7.\" %sccs.include.redist.roff%
8.\"
9.\"     @(#)gomoku.6	8.2 (Berkeley) 08/04/94
10.\"
11.Dd
12.Dt GOMOKU 6
13.Os BSD 4.4
14.Sh NAME
15.Nm gomoku
16.Nd game of 5 in a row
17.Sh SYNOPSIS
18.Nm gomoku
19.Op Fl bcdu
20.Op Fl D Ar debugfile
21.Op Ar inputfile
22.Sh DESCRIPTION
23.Nm Gomoku
24is a two player game were the object is to get 5 in a row horizontally,
25vertically or diagonally on a 19 by 19 grid. By convention, black always
26moves first.
27With no arguments,
28.Nm gomoku
29will display a playing board and prompt for moves from the user.
30Valid moves are a letter for the column and a number for the row of an empty
31board location. Entering ``quit" or ``resign" will end the game.
32You can save the current state of the game by entering ``save" and
33supplying a file name when prompted.
34The optional file
35.Ar inputfile
36can be used to restore a saved game.
37.Pp
38The options are:
39.Bl -tag -width Ds
40.It Fl b
41This option sets background mode. Input moves are read from standard input,
42the computer picks a move, and prints it to standard output. The first
43input line should be either ``black" or ``white" to specify whether
44.Nm gomoku
45has the first move or not respectively. This
46option was intended for game tournaments where a referee program handles
47the board display and pits one program against another.
48.It Fl c
49Computer verses computer.
50.Nm Gomoku
51will play a game against itself. This is mostly used for testing.
52.It Fl d
53Print debugging information. Repeating this option more than
54once yields more detailed information.
55.It Fl D Ar debugfile
56Print the debug information to
57.Ar debugfile
58instead of to the standard output.
59.It Fl u
60User verses user. This is mostly used for testing.
61.Sh AUTHOR
62Ralph Campbell
63.Sh ACKNOWLEDGEMENTS
64The board display routines were based on the
65.Nm goref
66program written by Peter Langston.
67