Update the changelog for the next release
[Sloppy.git] / sloppy.6
blob5b36e3d75bc7729f5353514155545fb6498d5573
1 .\"
2 .\" Copyright (c) 2014 Ilari Pihlajisto <ilari.pihlajisto@mbnet.fi>
3 .\" Copyright (c) 2014 Arto Jonsson <artoj@iki.fi>
4 .\"
5 .\" Sloppy is free software; you can redistribute it and/or modify
6 .\" it under the terms of the GNU General Public License as published by
7 .\" the Free Software Foundation; either version 3 of the License, or
8 .\" (at your option) any later version.
9 .\"
10 .\" Sloppy is distributed in the hope that it will be useful,
11 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
12 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 .\" GNU General Public License for more details.
14 .\"
15 .\" You should have received a copy of the GNU General Public License
16 .\" along with this program.  If not, see <http://www.gnu.org/licenses/>.
17 .\"
18 .\"
19 .Dd January 10, 2014
20 .Dt SLOPPY 6
21 .Os
22 .Sh NAME
23 .Nm sloppy
24 .Nd Xboard compatible chess engine
25 .Sh SYNOPSIS
26 .Nm
27 .Sh DESCRIPTION
28 .Nm
29 is a chess engine that uses the Xboard chess engine communication protocol version 2.
30 A graphical user interface (GUI) is recommended but not required to play.
31 .Pp
32 .Nm
33 does not accept any options but is instead configured using a configuration file.
34 See
35 .Xr sloppy.conf 5
36 for more information.
37 .Sh COMMANDS
38 In addition to all Xboard input,
39 .Nm
40 accepts the following input commands:
41 .Bl -tag -width Ds
42 .It Ic bench
43 Run internal benchmark.
44 .It Ic debug
45 Toggles debugging mode.
46 .It Ic divide Ar depth
47 Perft to the given
48 .Ar depth .
49 Prints a node count for every mode.
50 .It Ic help
51 Show list of available commands.
52 .It Ic perft Ar depth
53 Runs the perft test to the given
54 .Ar depth .
55 .It Ic printboard
56 Prints a text representation of the chess board and the FEN string.
57 .It Ic printeval
58 Prints the static evaluation.
59 .It Ic printkey
60 Prints the hash key.
61 .It Ic printmat
62 Prints the material each player has on the board.
63 .It Ic printmoves
64 Prints a list of legal moves.
65 .It Ic quit
66 Quits the program.
67 .It Ic readpgn Ar file
68 Imports the given PGN
69 .Ar file
70 to the book.
71 .It Ic readpgnlist Ar file
72 Imports a list of PGN files from the given
73 .Ar file
74 to the book.
75 .It Ic test Ar sec Ar fen
76 Runs a test position (e.g. WAC, WCSAC).
77 .It Ic testsee Ar fen Ar move
78 Tests the static exchange evaluator.
79 .It Ic testsuite Ar sec Ar file
80 Runs a list of test positions from the given
81 .Ar file .
82 .It Ic xboard
83 Switches to Xboard / Winboard mode.
84 .El
85 .Sh SEE ALSO
86 .Xr sloppy.conf 5
87 .Sh AUTHORS
88 .Nm
89 was written by
90 .An Ilari Pihlajisto ,
91 .Mt ilari.pihlajisto@mbnet.fi .