From: H.G.Muller <hgm@hgm-xboard.(none)>
Date: Sat, 3 Jun 2017 20:09:36 +0000 (+0200)
Subject: Add source for man page
X-Git-Url: http://winboard.nl/cgi-bin?a=commitdiff_plain;h=9de36292b369f287006c831924144ce8fada62cf;p=crazywa.git

Add source for man page

A .pod file is added, to generate a manual page from.
---

diff --git a/crazywa.pod b/crazywa.pod
new file mode 100644
index 0000000..af816e8
--- /dev/null
+++ b/crazywa.pod
@@ -0,0 +1,55 @@
+=head1 NAME
+
+crazywa - xboard-compatible engine for chess and shogi variants with piece drops
+
+
+=head1 SYNOPSIS
+
+B<crazywa>
+
+
+=head1 DESCRIPTION
+
+B<crazywa> is a program that plays several shogi and chess variants with piece drops,
+on boards of sizes up to 11 x 11, and with maximally 32 piece types.
+Currently it can play mini-shogi, Judkin's shogi, tori shogi, regular shogi, wa shogi and crazyhouse.
+In the future it might play more shogi variants.
+
+CrazyWa 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.
+For wa shogi the use of XBoard 4.9.1 is recommended
+
+See xboard(6) for instructions about how to use B<crazywa> through xboard.
+To start up quickly, you just need the command: B<xboard -fcp crazywa>.
+You can then use XBoard's New Variant dialog to select the variant you want to play.
+
+Normally XBoard will use western-style chess symbols to represent the pieces.
+XBoard's board themes is configurable, though,
+and can use externally provided png or svg images for the pieces.
+Piece sets for traditional oriental pieces for shogi and various shogi variants are available.
+Some of these make use of XBoard's capability to write unicode inscriptions on the piece images,
+to synthesize arbitrary kanji pieces 'on the fly' from just a few images of blank shogi tiles.
+A 'mnemonic' piece theme of geometric shapes is also available.
+
+
+=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<xboard>(6) interface ("Chess Engine Communication Protocol")
+
+=head1 AUTHOR
+
+H.G.Muller <h.g.muller@hccnet.nl>.
+
+This manual page was generated with pod2man(1).