From: H.G.Muller Date: Thu, 30 Oct 2014 11:46:19 +0000 (+0100) Subject: Add Linux manual page X-Git-Tag: v2.0~4 X-Git-Url: http://winboard.nl/cgi-bin?a=commitdiff_plain;h=f05d457fa43b4ff5b211626cec4884b0d849f2eb;p=uci2wb.git Add Linux manual page --- diff --git a/uci2wb.pod b/uci2wb.pod new file mode 100644 index 0000000..18e0802 --- /dev/null +++ b/uci2wb.pod @@ -0,0 +1,80 @@ +=head1 NAME + +uci2wb - Protocol adapter for UCI dialects to XBoard + + +=head1 SYNOPSIS + +B [debug] [-c|-s|-x] engine [directory] + + +=head1 DESCRIPTION + +B is a protocol adapter, i.e. it can be used to run AI plugins ('engines') +that communicate in one protocol in a GUI that communicates in another. +In this case uci2wb can make appear the engine specified in its argument, +which must use a protocol similar to UCI ('Universal Chess Interface'), +to the GUI as an engine using XBoard protocol +('Chess Engine Communication Protocol', CECP). + +The protocols for which it can mediate are UCI +(both the official standard, as well as the 'Cyclone dialect' that is commonly used +by Chinese-Chess engines), +USI ('Universal Shogi Interface', used by some Shogi engines) +and UCCI ('Universal Chinese-Chess Interface'). +When set to UCI, it automatically uses Cyclone dialect when playing xiangqi games. + + +=head1 OPTIONS + +=over 8 + +=item B<-c -s -x> + +The flag arguments B<-c> (default), B<-s> or B<-x> set uci2wb to use UCI, USI or UCCI, 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 (USI or UCCI). + +=item B + +Makes uci2wb report to the GUI everything it receives from the engine, +as a CECP engine comment (i.e. prefixed with '#'). +This would make it appear in the GUI'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. + + +=item B + +If a directory is specified, the engine is started +with that directory set as current directory. + + +=back + +=head1 AVAILABILITY + +At http://hgm.nubati.net/cgi-bin/gitweb.cgi the source code can be obtained. + +=head1 SEE ALSO + +xboard(6) + +=head1 STANDARDS + +WinBoard, B(6) interface ("Chess Engine Communication Protocol") + +UCI specs: http://www.shredderchess.com/chess-info/features/uci-universal-chess-interface.html + +USI specs: http://www.glaurungchess.com/shogi/usi.html + +UCCI specs: http://www.xqbase.com/protocol/cchess_ucci.htm + +=head1 AUTHOR + +H.G.Muller . + +This manual page was generated with pod2man(1).