From fb6bc38118dc03877da9b3392e794d48e174d0c8 Mon Sep 17 00:00:00 2001 From: H.G. Muller Date: Sat, 26 Oct 2013 23:10:17 +0200 Subject: [PATCH] Add man page --- hachu.pod | 77 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 77 insertions(+), 0 deletions(-) create mode 100644 hachu.pod diff --git a/hachu.pod b/hachu.pod new file mode 100644 index 0000000..9faf905 --- /dev/null +++ b/hachu.pod @@ -0,0 +1,77 @@ +=head1 NAME + +hachu - xboard-compatible engine for Chu Shogi and other variants + + +=head1 SYNOPSIS + +B + + +=head1 DESCRIPTION + +B is a program that plays several shogi and chess variants, +currently sho shogi, chu shogi, dai shogi, makruk and shatranj. +In the future it might play more, and still larger shogi variants, +in particular tenjiku shogi. + +HaChu uses the xboard/winboard chess-engine protocol to communicate. +It thus can use XBoard as a graphical interface for the variants also supported by the latter. +Only XBoard 4.8 and later support chu shogi, +but sho shogi should already work under XBoard 4.7, +and Makruk and Shatranj under much older versions. +Dai shogi is not supported by XBoard yet. + +See xboard(6) for instructions about how to use B through xboard. +To start up quickly, you just need the command: B. +You can then use XBoard's New Variant dialog to select the variant you want to play. +To play chu shogi, it is essential that XBoard's 'show target squares' option is switched on; +otherwise the two-step lion moves can not be entered. + +Normally XBoard will use western-style chess symbols to represent the pieces. +But HaChu comes with a set of piece images in the shape of the Japenese kanji +for the names of the chu-shogi pieces. +These can be used in XBoard to get an oriental-style board display. +A settings file for configuring XBoard to use these pieces is also included with HaChu, +so that you can use the command B to start XBoard with HaChu for oriental-style chu-shogi. + +=head1 OPTIONS + +=over 8 + +=item B + +HaChu supports some options that can only be set interactively, +though XBoard's engine settings menu dialog. +These include an option for solving tsume problems +(checkmate problems where the winning side is only allowed to play checking moves). +There are also options to adapt it to various versions of the chu-shogi rules: +whether you can only promote on entering the promotion zone, +or whether moves inside or out of the zone (after one move delay) can also be used for promotion, +and whether repeats should be strictly forbidden, or only avoided like other losing moves. + + + +=back + +=head1 AVAILABILITY + +At http://hgm.nubati.net/cgi-bin/gitweb.cgi the source code can be obtained. + +=head1 SEE ALSO + +xboard(6) + +game rules: http://hgm.nubati.net/rules + +XBoard: http://hgm.nubati.net + +=head1 STANDARDS + +WinBoard, B(6) interface ("Chess Engine Communication Protocol") + +=head1 AUTHOR + +H.G.Muller . + +This manual page was generated with pod2man(1). -- 1.7.0.4