.\"	$NetBSD: gomoku.6,v 1.15 2010/03/29 04:00:03 dholland Exp $
.\"
.\" Copyright (c) 1994
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" This code is derived from software contributed to Berkeley by
.\" Ralph Campbell.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"     @(#)gomoku.6	8.2 (Berkeley) 8/4/94
.\"
.Dd March 28, 2010
.Dt GOMOKU 6
.Os
.Sh NAME
.Nm gomoku
.Nd game of 5 in a row
.Sh SYNOPSIS
.Nm
.Op Fl bcdu
.Op Fl D Ar debugfile
.Op Ar savefile
.Sh DESCRIPTION
.Nm
is a two player game where the object is to get 5 in a row horizontally,
vertically or diagonally on a 19 by 19 grid.
By convention, black always moves first.
.Pp
The options are:
.Bl -tag -width Ds
.It Fl b
Run in batch mode.
.Pq See below.
.It Fl c
Computer versus computer.
.Nm
will play a game against itself.
This is mostly used for testing.
.It Fl d
Print debugging information.
Repeating this option more than once yields more detailed information.
.It Fl D Ar debugfile
Print the debug information to
.Ar debugfile
instead of to the standard output.
.It Fl u
User versus user.
.Pq Play against yourself.
This is mostly used for testing.
.It Ar savefile
Load a previously saved game from
.Pa savefile .
.El
.Pp
With no arguments,
.Nm
starts a fresh user vs. computer game.
.Pp
Moves may be entered by selecting the desired board location and
pressing the space or enter key.
The cursor may be moved using the arrow keys or
.Xr vi 1
motion keys
.Em hjklyubn .
These also may be familiar from
.Xr rogue 6
and
.Xr hack 6 .
.\" Valid moves are a letter for the column and a number for the row
.\" of an empty board location.
To quit, type
.Sq Q ,
and to save the game, type
.Sq S
and supply a file name when prompted.
.Ss Batch mode
Batch mode was intended for game tournaments where a referee program
handles the board display and pits one program against another.
In this mode,
.Nm
reads moves from standard input and writes its responses to standard
output.
The first line of input should be either
.Dq black
or
.Dq white
to specify whether
.Nm
has the first move or not respectively.
.Sh AUTHORS
.An Ralph Campbell
.Sh ACKNOWLEDGEMENTS
The board display routines were based on the
.Nm goref
program written by Peter Langston.
The user interface was based on Eric S. Raymond's interface for
.\" change this when/if we import openbsd's bs(6)
.\" .Xr bs 6 .
.Nm bs .