Update the changelog for the next release
[Sloppy.git] / sloppy.conf.5
blobf5882e15e962778bbebd6ea806623639ca87d31e
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.CONF 5
21 .Os
22 .Sh NAME
23 .Nm sloppy.conf
24 .Nd Sloppy chess engine configuration file
25 .Sh SYNOPSIS
26 .Nm
27 .Sh DESCRIPTION
28 .Nm
29 is the configuration file for the
30 .Xr sloppy 6
31 chess engine.
32 .Pp
33 Comments can be put anywhere in the file using a hash mark
34 .Pq Sq # ,
35 and extend to the end of the current line.
36 .Pp
37 The syntax of
38 .Nm
39 is described below.
40 .Bl -tag -width Ds
41 .It Ic hash = Ar size
42 Hash table size in megabytes.
43 The default is 36.
44 .It Ic egbb_5men = on | off
45 Use 5-men bitbases.
46 The default is off.
47 .It Ic egbb_load_type = 4men | 5men | smart | none | off
48 Endgame bitbase load type.
49 .Pp
50 .Bl -tag -width "XXXXXX" -offset indent -compact
51 .It 4men
52 Load 3-men and 4-men bitbases to RAM.
53 .It 5men
54 Load 3-men, 4-men and 5-men bitbases to RAM.
55 .It smart
56 Load a smart selection of bitbases to RAM.
57 .It none
58 Load nothing to RAM.
59 .It off
60 Disable bitbases completely (default).
61 .El
62 .Pp
63 Note: even if this option is set off, Xboard can still load the bitbases
64 with the egtpath command.
65 .It Ic egbb_cache = Ar size
66 Endgame bitbase cache size in megabytes.
67 The default is 4.
68 .It Ic egbb_path = Ar path
69 Endgame bitbase path.
70 Leave this empty if you want Xboard to set the path.
71 .It Ic bookmode = disk | mem | off
72 Book mode.
73 The default is mem.
74 .It Ic learn = on | off
75 Book learning.
76 The default is off.
77 .It Ic logfile = on | off
78 Write logfile(s).
79 The default is off.
80 .It Ic threads = Ar count
81 The number of threads to use.
82 Currently for perft only.
83 The default is to autodetect the best value.
84 .El
85 .Sh FILES
86 .Bl -tag -width $XDG_CONFIG_HOME/sloppy/sloppy.conf -compact
87 .It Pa $XDG_CONFIG_HOME/sloppy/sloppy.conf
88 .It Pa ~/.config/sloppy/sloppy.conf
89 .It Pa sloppy.conf
90 .El
91 .Sh SEE ALSO
92 .Xr sloppy 6