duel.1

.TH duel 1
.SH NAME
\fBduel\fR - Stages a duel using two opposing instances of \fBbishbosh\fR
.SH SYNOPSIS
\fBbishbosh\fR [\fIOPTIONS\fR]
.SH DESCRIPTION
.PP
An application which automatically plays chess, by forking two independently configured instances of \fBbishbosh\fR.
One instance automates the moves of White & the other automates the moves of Black.
This application merely acts as an intermediary, passing moves between these instances to synchronise their positions, while collating the game-results to permit comparison of the fitness of their respective configurations.
.PP
This process facilitates optimisation of the complex configuration of \fBbishbosh\fR.
.SH OPTIONS
.TP
\fB--verbosity=\fR(\fBSilent\fR|\fBNormal\fR|\fBVerbose\fR|\fBDeafening\fR), defaulting to "\fBNormal\fR".
Defines the quantity of ancillary output required.
.TP
\fB-n\fR \fIInt\fR, \fB--nGames=\fR\fIInt\fR, defaulting to "\fB1\fR".
The number of games to be played before presenting the results.
.TP
\fB-t\fR \fIInt\fR, \fB--readTimeout=\fR\fIInt\fR, defaulting to \fIindefinitely\fR.
The number of seconds to wait for a move before aborting.
CAVEAT: the period typically required depends on;
.IP \(bu
the machine's speed,
.IP \(bu
what else is running on the machine,
.IP \(bu
the search-depth,
.IP \(bu
the fitness-evaluation criteria.
.TP
\fB-i\fR \fIFile-path\fR, \fB--appendInputConfigFilePath=\fR\fIFile-path\fR; there is no default.
Define the path to a configuration-file to forward to \fBbishbosh\fR.
Two such paths are required, the first will be passed to the instance playing White & the second to the instance playing Black.
.SS "Generic Program-information"
.TP
\fB-v\fR, \fB--version\fR
Outputs version-information & then exits.
.TP
\fB-?\fR, \fB--help\fR
Displays a usage-message & then exits.
.SH EXIT-STATUS
\fB0\fR on success, & >\fB0\fR if an error occurs.
.SH EXAMPLES
.nf
.B duel --verbosity='Verbose' --nGames=128 -i 'config/Raw/bishbosh_duel_white.xml' -i 'config/Raw/bishbosh_duel_black.xml'
.fi
.IP \(bu
The application has been instructed to provide a relatively large amount of feedback.
.IP \(bu
Two packaged configuration-files have been referenced, the first referring to the instance playing White, as required.
.IP \(bu
CAVEAT: assumes that the executable exists on \fB$PATH\fR, otherwise an explicit path will be required.
.PP
.nf
.B make duel
.fi
.IP \(bu
The same as above.
.IP \(bu
The current working directory must be \fBbishbosh\fR's installation-directory where the required \fBmakefile\fR is defined.
.SH FILES
.TS
lb	lb
l	l
lb	l	.
File-name	Contents
=========	========
config/Raw/bishbosh_duel_{black,white}.xml	Sample configuration-files.
makefile	Facilitates common tasks.
man/man1/bishbosh.1	The man-page for \fBbishbosh\fR.
.TE
.SH AUTHOR
Written by Dr. Alistair Ward.
.SH BUGS
.IP \(bu
The comparison between the configurations of the two instances doesn't factor the time taken by each instance.
.SS "REPORTING BUGS"
Report bugs to "\fBbishbosh@functionalley.com\fR".
.SH COPYRIGHT
Copyright \(co 2021 Dr. Alistair Ward
.PP
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
.PP
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License along with this program. If not, see <\fBhttps://www.gnu.org/licenses/\fR>.
.SH "SEE ALSO"
.IP \(bu
Home-page: <\fBhttps://functionalley.com/BishBosh/bishbosh.html\fR>.
.IP \(bu
<\fBhttps://hackage.haskell.org/package/bishbosh\fR>.
.IP \(bu
<\fBhttps://github.com/functionalley/BishBosh\fR>.
.IP \(bu
Source-documentation is generated by "\fBHaddock\fR", & is available in the distribution.
.IP \(bu
<\fBhttps://www.haskell.org/haddock/\fR>.