'\" t
.\"     Title: cutechess-cli
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\"      Date: 11/14/2011
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "CUTECHESS\-CLI" "6" "11/14/2011" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
cutechess-cli \- A command\-line tool for chess engines matches
.SH "SYNOPSIS"
.sp
\fBcutechess\-cli\fR \-fcp [\fIENGINE OPTIONS\fR] \-scp [\fIENGINE OPTIONS\fR] [\fIOPTIONS\fR]
.sp
\fBcutechess\-cli\fR \-both [\fIENGINE OPTIONS\fR] [\fIOPTIONS\fR]
.SH "DESCRIPTION"
.sp
Runs chess matches from the command line\&.
.SH "OPTIONS"
.PP
\-\-version
.RS 4
Display the version information\&.
.RE
.PP
\-\-help
.RS 4
Display help information\&.
.RE
.PP
\-\-engines
.RS 4
Display a list of configured engines and exit\&.
.RE
.PP
\-\-protocols
.RS 4
Display a list of supported chess protocols and exit\&.
.RE
.PP
\-\-variants
.RS 4
Display a list of supported chess variants and exit\&.
.RE
.PP
\-fcp <options>
.RS 4
Apply <options> to the first engine\&.
.RE
.PP
\-scp <options>
.RS 4
Apply <options> to the second engine\&.
.RE
.PP
\-both <options>
.RS 4
Apply <options> to both engines\&.
.RE
.PP
\-variant <arg>
.RS 4
Set chess variant to <arg>\&.
.RE
.PP
\-concurrency <n>
.RS 4
Set the maximum number of concurrent games to <n>\&.
.RE
.PP
\-draw <n> <score>
.RS 4
Adjudicate the game as a draw if the score of both engines is within <score> centipawns from zero after <n> full moves have been played\&.
.RE
.PP
\-resign <n> <score>
.RS 4
Adjudicate the game as a loss if an engine\(cqs score is at least <score> centipawns below zero for at least <n> consecutive moves\&.
.RE
.PP
\-event <arg>
.RS 4
Set the event name to <arg>\&.
.RE
.PP
\-games <n>
.RS 4
Play <n> games\&.
.RE
.PP
\-debug
.RS 4
Display all engine input and output\&.
.RE
.PP
\-pgnin <file>
.RS 4
Use <file> as the opening book in PGN format\&.
.RE
.PP
\-pgndepth <n>
.RS 4
Set the maximum depth for PGN input to <n> plies\&.
.RE
.PP
\-pgnout <file> [min]
.RS 4
Save the games to <file> in PGN format\&. Use the
\fImin\fR
argument to save in a minimal PGN format\&.
.RE
.PP
\-recover
.RS 4
Restart crashed engines instead of stopping the match\&.
.RE
.PP
\-repeat
.RS 4
Play each opening twice so that both players get to play it on both sides\&.
.RE
.PP
\-site <arg>
.RS 4
Set the site / location to <arg>\&.
.RE
.PP
\-srand <n>
.RS 4
Set the random seed for the book move selector to <n>\&.
.RE
.PP
\-wait <n>
.RS 4
Wait <n> milliseconds between games\&. The default is 0\&.
.RE
.SH "ENGINE OPTIONS"
.PP
conf=<arg>
.RS 4
Use an engine with the name <arg> from Cute Chess\e\*(Aq configuration file\&.
.RE
.PP
name=<arg>
.RS 4
Set the name to <arg>\&.
.RE
.PP
cmd=<arg>
.RS 4
Set the command to <arg>\&.
.RE
.PP
dir=<arg>
.RS 4
Set the working directory to <arg>\&.
.RE
.PP
arg=<arg>
.RS 4
Pass <arg> to the engine as a command line argument\&.
.RE
.PP
initstr=<arg>
.RS 4
Send <arg> to the engine\(cqs standard input at startup\&.
.RE
.PP
restart=<arg>
.RS 4
Set the restart mode to <arg> which can be:
\fIauto\fR: the engine decides whether to restart (default)
\fIon\fR: the engine is always restarted between games
\fIoff\fR: the engine is never restarted between games
.RE
.PP
proto=<arg>
.RS 4
Set the chess protocol to <arg>\&.
.RE
.PP
tc=<arg>
.RS 4
Set the time control to <arg>\&. The format is moves/time+increment, where
\fImoves\fR
is the number of moves per tc,
\fItime\fR
is time per tc (either seconds or minutes:seconds), and
\fIincrement\fR
is time increment per move in seconds\&. Infinite time control can be set with
\fItc=inf\fR\&.
.RE
.PP
st=<n>
.RS 4
Set the time limit for each move to <n> seconds\&. This option can\(cqt be used in combination with "tc"\&.
.RE
.PP
timemargin=<n>
.RS 4
Let engines go <n> milliseconds over the time limit\&.
.RE
.PP
book=<file>
.RS 4
Use <file> (Polyglot book file) as the opening book\&.
.RE
.PP
bookdepth=<n>
.RS 4
Set the maximum book depth (in fullmoves) to <n>\&.
.RE
.PP
whitepov
.RS 4
Invert the engine\(cqs scores when it plays black\&. This option should be used with engines that always report scores from white\(cqs perspective\&.
.RE
.PP
depth=<n>
.RS 4
Set the search depth limit to <n> plies\&.
.RE
.PP
nodes=<n>
.RS 4
Set the node count limit to <n> nodes\&.
.RE
.PP
option\&.<name>=<arg>
.RS 4
Set custom engine option <name> to value <arg>\&.
.RE
.SH "EXAMPLES"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Play ten games between two Sloppy engines with a time control of 40 moves in 60 seconds\&.
.RE
.sp
.if n \{\
.RS 4
.\}
.nf
$ cutechess\-cli \-both cmd=sloppy proto=xboard tc=40/60 \-games 10
.fi
.if n \{\
.RE
.\}
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Use the
\fIname=Atak\fR
parameter because it\(cqs a Xboard protocol 1 engine and doesn\(cqt tell its name\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Use the
\fIdir=C:\eatak\fR
parameter to point the location of the executable\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Glaurung can tell its name and is in the PATH variable so only the command is needed\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Set Glaurung to use 1 thread\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Set the time control to 40 moves in one minute and 30 seconds with a one second increment\&.
.RE
.sp
.if n \{\
.RS 4
.\}
.nf
$ cutechess\-cli \-fcp name=Atak cmd=Atak32\&.exe dir=C:\eatak proto=xboard \-scp cmd=glaurung proto=uci option\&.Threads=1 \-both tc=40/1:30+1
.fi
.if n \{\
.RE
.\}
.SH "AUTHOR"
.sp
Written by Ilari Pihlajisto <ilari\&.pihlajisto@mbnet\&.fi> and Arto Jonsson <ajonsson@kapsi\&.fi>\&.
.SH "RESOURCES"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Source code:
http://repo\&.or\&.cz/w/sloppygui\&.git
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Mailing list:
https://list\&.kapsi\&.fi/listinfo/cutechess
.RE
.SH "COPYING"
.sp
Copyright (C) 2008\-2011 Ilari Pihlajisto and Arto Jonsson\&. Free use of this software is granted under the terms of GNU General Public License (GPL)\&.