.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "UCI2WB 6" .TH UCI2WB 6 "2020-07-14" "perl v5.30.3" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" uci2wb \- Protocol adapter for UCI dialects to XBoard .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBuci2wb\fR [debug] [\-var ] [\-nice ] [\-kill ] [\-c|\-s|\-x] [] .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fBuci2wb\fR is a protocol adapter, i.e. it can be used to run \s-1AI\s0 plugins ('engines') that communicate in one protocol in a \s-1GUI\s0 that communicates in another. In this case uci2wb can make appear the engine specified in its argument, which must use a protocol similar to \s-1UCI\s0 ('Universal Chess Interface'), to the \s-1GUI\s0 as an engine using XBoard protocol ('Chess Engine Communication Protocol', \s-1CECP\s0). .PP The protocols for which it can mediate are \s-1UCI\s0 (both the official standard, as well as the 'Cyclone dialect' that is commonly used by Chinese-Chess engines, and the 'Arena960 dialect' used by pre-standard Chess960 engines), \&\s-1USI\s0 ('Universal Shogi Interface', used by some Shogi engines) and \s-1UCCI\s0 ('Universal Chinese-Chess Interface'). When set to \s-1UCI\s0 through an explicit \fB\-c\fR argument, it uses Cyclone dialect when playing xiangqi games. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-c \-s \-x \-f\fR" 8 .IX Item "-c -s -x -f" The flag arguments \fB\-c\fR (default), \fB\-s\fR or \fB\-x\fR set uci2wb to use \s-1UCI, USI\s0 or \s-1UCCI,\s0 respectively. If there is more than one character in the flag argument, all characters but the first are ignored. This can be used by passing uci2wb the full variant name ('shogi' or 'xiangqi') as a flag, to make it automatically choose the appropriate protocol (\s-1USI\s0 or \s-1UCCI\s0). Other values also select \s-1UCI,\s0 but the value \fB\-f\fR in addition implies uci2wb should announce it supports Chess960 even for \s-1UCI\s0 engines that don't have the standard UCI_Chess960 option, and in that case causes castlings to be sent to them as O\-O or O\-O-O instead of the standard KxR notation. .IP "\fB\-var " 8 .IX Item "-var " Forces uci2wb to announce to the \s-1GUI\s0 it supports (only) the specified variant. Although a UCI_Variant option has been proposed as a way for UxI engines to announce what they can play, (and is supported by uci2wb), not many engines implement this. So if these are not the standard variants implied by the protocol choice, (but, f.e. seirawan or 6x6+6_shogi) it has to be configured on the uci2wb command line through this option. .IP "\fB\-nice " 8 .IX Item "-nice " Runs the engine processes at the requested priority; positive values lower the priority. .IP "\fB\-kill " 8 .IX Item "-kill " Increases the time between receiving a 'quit' command and killing of an engine process that somehow could not be made to exit through the normal handling of this (50 ms by default) by the specified delay. .IP "\fBdebug\fR" 8 .IX Item "debug" Makes uci2wb report to the \s-1GUI\s0 everything it receives from the engine, as a \s-1CECP\s0 engine comment (i.e. prefixed with '#'). This would make it appear in the \s-1GUI\s0's log of the engine communication. Some critical commands it sends to the engine (such as the 'position\-moves' and 'go' commands) will be reported as well. This option can also be switched interactively, through the '\s-1UCI2WB\s0 debug output' checkbox option appearing as additional engine option. .IP "\fBdirectory\fR" 8 .IX Item "directory" If a directory is specified, the engine is started with that directory set as current directory. .IP "\fBbyoyomi work-arounds\fR" 8 .IX Item "byoyomi work-arounds" Byoyomi is a mode of time control in \s-1USI\s0 not supported by \s-1CECP.\s0 Engines can be forced to run in this mode by letting the \s-1GUI\s0 use incremental or sudden-death \s-1TC,\s0 and ticking the interactive 'Floating Byoyomi' checkbox option that uci2wb pools with the engine options. An accompanying option 'Byoyomi (sec)' allows you to force a fixed value >= 0 for the byoyomi to be sent to the engine when 'Floating Byoyomi' is off. .SH "AVAILABILITY" .IX Header "AVAILABILITY" At http://hgm.nubati.net/cgi\-bin/gitweb.cgi the source code can be obtained. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBxboard\fR\|(6) .SH "STANDARDS" .IX Header "STANDARDS" WinBoard, \fBxboard\fR(6) interface (\*(L"Chess Engine Communication Protocol\*(R") .PP \&\s-1UCI\s0 specs: http://www.shredderchess.com/chess\-info/features/uci\-universal\-chess\-interface.html .PP \&\s-1USI\s0 specs: http://hgm.nubati.net/usi.html .PP \&\s-1UCCI\s0 specs: http://www.xqbase.com/protocol/cchess_ucci.htm .SH "AUTHOR" .IX Header "AUTHOR" H.G.Muller . .PP This manual page was generated with \fBpod2man\fR\|(1).