uci2wb.pod

   1 =head1 NAME
   2
   3 uci2wb - Protocol adapter for UCI dialects to XBoard
   4
   5
   6 =head1 SYNOPSIS
   7
   8 B<uci2wb> [debug] [-c|-s|-x] engine [directory]
   9
  10
  11 =head1 DESCRIPTION
  12
  13 B<uci2wb> is a protocol adapter, i.e. it can be used to run AI plugins ('engines')
  14 that communicate in one protocol in a GUI that communicates in another.
  15 In this case uci2wb can make appear the engine specified in its argument,
  16 which must use a protocol similar to UCI ('Universal Chess Interface'),
  17 to the GUI as an engine using XBoard protocol
  18 ('Chess Engine Communication Protocol', CECP).
  19
  20 The protocols for which it can mediate are UCI
  21 (both the official standard, as well as the 'Cyclone dialect' that is commonly used
  22 by Chinese-Chess engines),
  23 USI ('Universal Shogi Interface', used by some Shogi engines)
  24 and UCCI ('Universal Chinese-Chess Interface').
  25 When set to UCI, it automatically uses Cyclone dialect when playing xiangqi games.
  26
  27
  28 =head1 OPTIONS
  29
  30 =over 8
  31
  32 =item B<-c -s -x>
  33
  34 The flag arguments B<-c> (default), B<-s> or B<-x> set uci2wb to use UCI, USI or UCCI, respectively.
  35 If there is more than one character in the flag argument,
  36 all characters but the first are ignored.
  37 This can be used by passing uci2wb the full variant name ('shogi' or 'xiangqi') as a flag,
  38 to make it automatically choose the appropriate protocol (USI or UCCI).
  39
  40 =item B<debug>
  41
  42 Makes uci2wb report to the GUI everything it receives from the engine,
  43 as a CECP engine comment (i.e. prefixed with '#').
  44 This would make it appear in the GUI's log of the engine communication.
  45 Some critical commands it sends to the engine
  46 (such as the 'position-moves' and 'go' commands)
  47 will be reported as well.
  48
  49
  50 =item B<directory>
  51
  52 If a directory is specified, the engine is started
  53 with that directory set as current directory.
  54
  55
  56 =back
  57
  58 =head1 AVAILABILITY
  59
  60 At http://hgm.nubati.net/cgi-bin/gitweb.cgi the source code can be obtained.
  61
  62 =head1 SEE ALSO
  63
  64 xboard(6)
  65
  66 =head1 STANDARDS
  67
  68 WinBoard, B<xboard>(6) interface ("Chess Engine Communication Protocol")
  69
  70 UCI specs: http://www.shredderchess.com/chess-info/features/uci-universal-chess-interface.html
  71
  72 USI specs: http://www.glaurungchess.com/shogi/usi.html
  73
  74 UCCI specs: http://www.xqbase.com/protocol/cchess_ucci.htm
  75
  76 =head1 AUTHOR
  77
  78 H.G.Muller <h.g.muller@hccnet.nl>.
  79
  80 This manual page was generated with pod2man(1).