Rework doc-handing make rules and remove generated files from version control.
[gnushogi.git] / doc / gnushogi_20.html
diff --git a/doc/gnushogi_20.html b/doc/gnushogi_20.html
deleted file mode 100644 (file)
index 56c31c5..0000000
+++ /dev/null
@@ -1,547 +0,0 @@
-<HTML>
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<!-- Created on July, 7  2004 by texi2html 1.64 -->
-<!-- 
-Written by: Lionel Cons <Lionel.Cons@cern.ch> (original author)
-            Karl Berry  <karl@freefriends.org>
-            Olaf Bachmann <obachman@mathematik.uni-kl.de>
-            and many others.
-Maintained by: Olaf Bachmann <obachman@mathematik.uni-kl.de>
-Send bugs and suggestions to <texi2html@mathematik.uni-kl.de>
--->
-<HEAD>
-<TITLE>GNU Shogi manual: xshogi</TITLE>
-
-<META NAME="description" CONTENT="GNU Shogi manual: xshogi">
-<META NAME="keywords" CONTENT="GNU Shogi manual: xshogi">
-<META NAME="resource-type" CONTENT="document">
-<META NAME="distribution" CONTENT="global">
-<META NAME="Generator" CONTENT="texi2html 1.64">
-
-</HEAD>
-
-<BODY LANG="" BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#800080" ALINK="#FF0000">
-
-<A NAME="SEC20"></A>
-<TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
-<TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="gnushogi_19.html#SEC19"> &lt; </A>]</TD>
-<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="gnushogi_21.html#SEC21"> &gt; </A>]</TD>
-<TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="gnushogi_19.html#SEC19"> &lt;&lt; </A>]</TD>
-<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="gnushogi.html#SEC_Top"> Up </A>]</TD>
-<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="gnushogi_21.html#SEC21"> &gt;&gt; </A>]</TD>
-<TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="gnushogi.html#SEC_Top">Top</A>]</TD>
-<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="gnushogi_toc.html#SEC_Contents">Contents</A>]</TD>
-<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="gnushogi_24.html#SEC24">Index</A>]</TD>
-<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="gnushogi_abt.html#SEC_About"> ? </A>]</TD>
-</TR></TABLE>
-<HR SIZE=1>
-<H1> 4. xshogi </H1>
-<!--docid::SEC20::-->
-<P>
-
-This section describes how to run the "xshogi" program.
-</P><P>
-
-SYNOPSIS
-</P><P>
-
-xshogi [ options ]
-</P><P>
-
-DESCRIPTION
-</P><P>
-
-xshogi provides an X11/Xt/Athena Widgets user interface for gnushogi.
-With xshogi you can play gnushogi, set up arbitrary positions, force
-variations, or watch xshogi manage a game between two shogi programs.
-Furthermore, it can be used as an interface between two players on
-different displays.
-</P><P>
-
-xshogi can also be used as a shogi board to play out games.  It will
-read through a game file or allow a player to play through a variation
-manually (force mode).  This is useful for keeping track of email postal
-games or browsing games off the net.
-</P><P>
-
-After starting xshogi, you can make moves by pressing mouse button 1
-while the cursor is over a square with your piece on it and dragging the
-mouse to another square.  If the move is illegal, gnushogi will not
-allow it.  xshogi will then retract the move.
-</P><P>
-
-COMMAND-LINE OPTIONS
-</P><P>
-
-The following command line options also correspond to X resources that
-you can set in your .Xdefaults file.
-</P><P>
-
-<DL COMPACT>
-
-<DT><SAMP>`[standard Xt options]'</SAMP>
-<DD>xshogi accepts standard Xt options like -display, -geometry, and
--iconic.
-<P>
-
-<DT><SAMP>`-tc or -timeControl minutes[:seconds]'</SAMP>
-<DD>Amount of time for a set of moves determined by movesPerSession.  If
-this number of moves is played within the time control period, xshogi
-resets the time clocks.  Default: 5 minutes.
-<P>
-
-<DT><SAMP>`-mps or -movesPerSession moves'</SAMP>
-<DD>Number of moves in a time control period.  Default: 40 moves.
-<P>
-
-<DT><SAMP>`-st or -searchTime minutes[:seconds]'</SAMP>
-<DD>Tell gnushogi to spend at most the given amount of time searching for
-each of its moves.  Without this option, gnushogi chooses its search
-time based on the number of moves and amount of time remaining until the
-next time control.  Setting this option also sets -clockMode to False.
-<P>
-
-<DT><SAMP>`-sd or -searchDepth number'</SAMP>
-<DD>Tell gnushogi to look ahead at most the given number of moves when
-searching for a move to make.  Without this option, gnushogi chooses
-its search depth based on the number of moves and amount of time
-remaining until the next time control.  Setting this option also sets
--clockMode to False.
-<P>
-
-<DT><SAMP>`-clock or -clockMode (True | False)'</SAMP>
-<DD>Determines whether or not to use the clock.  If clockMode is False, the
-clock does not run, but the side that is to play next is still
-highlighted.
-<P>
-
-<DT><SAMP>`-td or -timeDelay seconds'</SAMP>
-<DD>Time delay between moves during "Load Game".  This doesn't have to be
-a round number.  Try -td 0.4.  Default: 1 second.
-<P>
-
-<DT><SAMP>`-nsp or -noShogiProgram (True | False)'</SAMP>
-<DD>If this option is True, xshogi acts as a passive shogi board; it does
-not try to start a shogi program, not even to check whether moves made
-in Force mode are legal.  It also sets -clockMode to False.  Default:
-False.
-<P>
-
-<DT><SAMP>`-fsp or -firstShogiProgram program'</SAMP>
-<DD>Name of first shogi program.  In matches between two machines, this
-program plays white.  Default: "gnushogi".
-<P>
-
-<DT><SAMP>`-ssp or -secondShogiProgram program'</SAMP>
-<DD>Name of second shogi program, if needed.  In matches between two
-machines, this program plays black; otherwise it is not started.
-Default: "gnushogi".
-<P>
-
-<DT><SAMP>`-fh or -firstHost host'</SAMP>
-<DD>Name of host the first shogi program plays on.  Default: "localhost".
-<P>
-
-<DT><SAMP>`-sh or -secondHost host'</SAMP>
-<DD>Name of host the second shogi program plays on.  Default: "localhost".
-<P>
-
-<DT><SAMP>`-rsh or -remoteShell shell_name'</SAMP>
-<DD>Some systems do not use rsh as the remote shell.  This option allows a
-user to name the remote shell command.  This should be done in the
-resource file.
-<P>
-
-<DT><SAMP>`-mm or -matchMode (False | Init | Position | Opening)'</SAMP>
-<DD>Automatically run a game between firstShogiProgram and
-secondShogiProgram.  If matchMode is set to Init, xshogi will start the
-game with the initial shogi position.  If matchMode is set to Position,
-xshogi will start the game with the position specified by the
-loadPositionFile resource.  If matchMode is set to Opening, xshogi will
-play out the opening moves specified by the -loadGameFile resource.  If
-the -saveGameFile resource is set, a move record for the match will be
-saved in the specified file.  Default: "False".
-<P>
-
-<DT><SAMP>`-lgf or -loadGameFile file'</SAMP>
-<DD>Name of file to read a game record from.  Game files are found in the
-directory named by the SHOGIDIR environment variable.  If this variable
-is not set, the current directory is used unless the file name starts
-with a /.
-<P>
-
-<DT><SAMP>`-lpf or -loadPositionFile file'</SAMP>
-<DD>Name of file to read a game position from.  Position files are found in
-the directory named by the SHOGIDIR environment variable.  If this
-variable is not set, the current directory is used unless the file name
-starts with a /.
-<P>
-
-<DT><SAMP>`-sgf or -saveGameFile file'</SAMP>
-<DD>Name of file to save a game record to.  Game files are saved in the
-directory named by the SHOGIDIR environment variable.  If this variable
-is not set, the current directory is used unless the file name starts
-with a /.
-<P>
-
-<DT><SAMP>`-spf or -savePositionFile file'</SAMP>
-<DD>Name of file to save a game position to.  Position files are saved in
-the directory named by the SHOGIDIR environment variable.  If this
-variable is not set, the current directory is used unless the file name
-starts with a /.
-<P>
-
-<DT><SAMP>`-coords or -showCoords (True | False)'</SAMP>
-<DD>If this option is True, xshogi displays algebraic coordinates along the
-board's left and bottom edges.  The default is False.  The coordFont
-resource specifies what font to use.
-<P>
-
-<DT><SAMP>`-mono or -monoMode (True | False)'</SAMP>
-<DD>Determines whether xshogi displays its pieces and squares with two
-colors or four.  You shouldn't have to specify monochrome.  xshogi will
-determine if this is necessary.
-<P>
-
-<DT><SAMP>`-pc or -pieceColor color'</SAMP>
-<DD>Color specification for pieces suitable for XParseColor().
-Default: #FFFFD7.  
-<P>
-
-<DT><SAMP>`-sc or -squareColor color'</SAMP>
-<DD>Same for squares.  Default: #EBDFB0.
-<P>
-
-<DT><SAMP>`-wps or -westernPieceSet (True | False)'</SAMP>
-<DD>Choose the Western style piece set.
-<P>
-
-<DT><SAMP>`-npb or -normalPawnBitmap file'</SAMP>
-<DD><DT><SAMP>`-nnb or -normalKnightBitmap file'</SAMP>
-<DD><DT><SAMP>`-nbb or -normalBishopBitmap file'</SAMP>
-<DD><DT><SAMP>`-nrb or -normalRookBitmap file'</SAMP>
-<DD><DT><SAMP>`-nkb or -normalKingBitmap file'</SAMP>
-<DD>Names of the bitmap files for the bitmap piece icons.
-<P>
-
-<DT><SAMP>`-rpb or -reversePawnBitmap file'</SAMP>
-<DD><DT><SAMP>`-rnb or -reverseKnightBitmap file'</SAMP>
-<DD><DT><SAMP>`-rbb or -reverseBishopBitmap file'</SAMP>
-<DD><DT><SAMP>`-rrb or -reverseRookBitmap file'</SAMP>
-<DD><DT><SAMP>`-rkb or -reverseKingBitmap file'</SAMP>
-<DD>Names of the bitmap files for the outline piece icons.
-<P>
-
-<DT><SAMP>`-debug or -debugMode (True | False)'</SAMP>
-<DD>Turns on debugging printout.
-<P>
-
-</DL>
-<P>
-
-OTHER X RESOURCES
-</P><P>
-
-<DL COMPACT>
-
-<DT><SAMP>`initString'</SAMP>
-<DD>The actual string that is sent to initialize the shogi program can be
-set from .Xdefaults.  It can't be set from the command line because of
-syntax problems.  The default value is "new\nbeep\nrandom\neasy\n".
-The "new" and "beep" commands are required. You can remove the
-"random" command if you like; including it causes gnushogi to
-randomize its move selection slightly so that it doesn't play the same
-moves in every game.  Even without "random", gnushogi randomizes its
-choice of moves from its opening book.  You can also remove "easy" if
-you like; including it toggles easy mode off, causing gnushogi to think
-on your time.  That is, if "easy" is included in the initString, GNU
-Shogi thinks on your time; if not, it does not.  (Yes, this does seem
-backwards, doesn't it.)  You can also try adding other commands to the
-initString; see the gnushogi documentation (see section <A HREF="gnushogi_19.html#SEC19">3. gnushogi</A>) for
-details.
-<P>
-
-<DT><SAMP>`blackString and whiteString'</SAMP>
-<DD>These resources control what is sent when the Machine Black and Machine
-White buttons are selected.  This is mostly for compatibility with
-obsolete versions of gnushogi.
-<P>
-
-Alternate bitmaps for piece icons can be specified either by choosing
-one of the built-in sets or with the file name resources described
-above.  There are three built-in sets of piece bitmaps available, large
-(the default), medium, or small.  It is easiest to select the set you
-prefer in the .Xdefaults file:
-</P><P>
-
-     XShogi*boardSize:   Medium
-</P><P>
-
-The font used for button labels and comments can be changed in the
-.Xdefaults file.  You may want to choose a smaller font if you are using
-the small pieces:
-</P><P>
-
-     XShogi*font:    helvetica_oblique12
-</P><P>
-
-The font used for coordinates (when the showCoords option is True) can
-be set similarly:
-</P><P>
-
-     XShogi*coordFont:    helvetica_10
-</P><P>
-
-If you are using a grayscale monitor, try setting the colors to:
-</P><P>
-
-     XShogi*pieceColor:     gray100 <BR>
-     XShogi*squareColor:    gray60  <BR>
-</P><P>
-
-</DL>
-<P>
-
-COMMAND BUTTONS AND KEYS
-</P><P>
-
-<DL COMPACT>
-
-<DT><SAMP>`Quit'</SAMP>
-<DD>Quits xshogi.  Q or q is a keyboard equivalent.
-<P>
-
-<DT><SAMP>`Reset'</SAMP>
-<DD>Resets xshogi to the beginning of a shogi game.  It also deselects any
-game or position files.
-<P>
-
-<DT><SAMP>`Flip View'</SAMP>
-<DD>inverts the view of the shogi board.
-<P>
-
-<DT><SAMP>`Hint'</SAMP>
-<DD>displays a move hint from gnushogi.
-<P>
-
-<DT><SAMP>`Load Game'</SAMP>
-<DD>plays a game from a record file.  If no file is specified a popup dialog
-asks for a filename.  Game files are found in the directory named by the
-SHOGIDIR environment variable.  If this variable is not declared then
-the current directory is used unless the file name starts with a /.  G
-or g is a keyboard equivalent.  The game file parser will accept almost
-any file that contains moves in algebraic notation.  If the first line
-begins with `#', it is assumed to be a title and is displayed.  Text
-enclosed in parentheses or square brackets is assumed to be commentary
-and is displayed in a pop-up window.  Any other text in the file is
-ignored.
-<P>
-
-<DT><SAMP>`Load Position'</SAMP>
-<DD>sets up a position from a position file.  If no file is specified a
-popup dialog asks for a filename.  Position files are found in the
-directory named by the SHOGIDIR environment variable.  If this variable
-is not declared then the current directory is used unless the file name
-starts with a /.  Position files must be in the format that the Save
-Position command writes.
-<P>
-
-<DT><SAMP>`Save Game'</SAMP>
-<DD>saves a game to a record file.  If no file is specified a popup dialog
-asks for a filename.  If the filename exists, the user is asked whether
-the current game record is be appended to this file or if the file
-should be replaced.  Game files are saved in the directory named by the
-SHOGIDIR environment variable.  If this variable is not declared then
-the current directory is used unless the file name starts with a /.
-Game files are human-readable, and can also be read back by the Load
-Game command. Furthermore, they are accepted as gnushogi text bookfiles.
-<P>
-
-<DT><SAMP>`Save Position'</SAMP>
-<DD>saves a position to a position file.  If no file is specified a popup
-dialog asks for a filename.  Position files are saved in the directory
-named by the SHOGIDIR environment variable.  If this variable is not
-declared then the current directory is used unless the file name starts
-with a /.  Position files are human-readable, and can also be read back
-by the Load Position command.
-<P>
-
-<DT><SAMP>`Machine White'</SAMP>
-<DD>forces gnushogi to play white.
-<P>
-
-<DT><SAMP>`Machine Black'</SAMP>
-<DD>forces gnushogi to play black.
-<P>
-
-<DT><SAMP>`Force Moves'</SAMP>
-<DD>forces a series of moves.  That is, gnushogi stops playing and xshogi
-allows you to make moves for both white and black.
-<P>
-
-<DT><SAMP>`Two Machines'</SAMP>
-<DD>plays a game between two computer programs.
-<P>
-
-<DT><SAMP>`Forward'</SAMP>
-<DD>moves forward through a series of remembered moves.  F or f is a
-keyboard equivalent.
-<P>
-
-<DT><SAMP>`Backward'</SAMP>
-<DD>moves backward through a series of remembered moves.  As a side effect,
-puts xshogi into Force Moves mode.  B or b is a keyboard equivalent.
-<P>
-
-<DT><SAMP>`Pause'</SAMP>
-<DD>pauses the clocks or (in Load Game mode) pauses the game being loaded.
-Press Pause again to continue.  P or p is a keyboard equivalent.
-<P>
-
-<DT><SAMP>`Edit Position'</SAMP>
-<DD>lets you set up an arbitrary board position.  Use mouse button 1 to drag
-pieces to new squares, or to delete a piece by dragging it off the board
-or dragging an empty square on top of it.  To drop a new piece on a
-square, press mouse button 2 or 3 over the square.  This brings up a
-menu of black pieces (button 2) or white pieces (button 3).  Additional
-menu choices let you empty the square or clear the board.  You can set
-the side to play next by clicking on the Black or White indicator at the
-top of the screen.
-<P>
-
-<DT><SAMP>`Challenge'</SAMP>
-<DD>allows you to make a two display game between two human players.  Enter
-the display you want to connect to.  If you are allowed to connect, a
-new board is displayed at the remote display.  Challenge mode can only
-be stopped by pressing "quit".
-<P>
-
-<DT><SAMP>`Select Level'</SAMP>
-<DD>allows you to reset the clocks for both players.  Enter the number of
-moves and the number of minutes in which the moves should be done.
-<P>
-
-<DT><SAMP>`Move NOW'</SAMP>
-<DD>force computer to stop thinking and to make the current best move.
-<P>
-
-<DT><SAMP>`Iconify I, i, C or c'</SAMP>
-<DD>iconifies xshogi.
-<P>
-
-</DL>
-<P>
-
-LIMITATIONS
-</P><P>
-
-If you press the  Pause  button  during  GNU  Shogi's  turn,
-xshogi will stop the clocks, but gnushogi will still make a
-move.
-</P><P>
-
-After a mate or draw when playing against gnushogi, if  you
-back  up  with  the  Backward  button,  the clocks are reset
-(because gnushogi has exited and must be restarted).
-</P><P>
-
-The game parser recognizes only algebraic notation.
-</P><P>
-
-AUTHORS
-</P><P>
-
-Original authors of XBoard:  Chris Sears and Dan Sears.
-</P><P>
-
-Enhancements for XBoard (Version 2.0):  Tim Mann.
-</P><P>
-
-Conversion to XShogi (Version 1.1):  Matthias Mutz.
-</P><P>
-
-Current maintainer: Mike Vanier.
-</P><P>
-
-COPYRIGHT INFORMATION
-</P><P>
-
-XShogi borrows its piece bitmaps from CRANES Shogi.
-</P><P>
-
-Copyright 1991 by Digital Equipment Corporation, Maynard, Massachusetts.
-Enhancements Copyright 1992 Free Software Foundation, Inc.  Enhancements
-Copyright 1993 Matthias Mutz.  Further enhancements copyright 1999 by
-Michael Vanier and the Free Software Foundation, Inc.
-</P><P>
-
-The following terms apply to Digital Equipment Corporation's copyright
-interest in XBoard:
-</P><P>
-
-All Rights Reserved
-</P><P>
-
-Permission to use, copy, modify, and distribute this software and its
-documentation for any purpose and without fee is hereby granted,
-provided that the above copyright notice appear in all copies and that
-both that copyright notice and this permission notice appear in
-supporting documentation, and that the name of Digital not be used in
-advertising or publicity pertaining to distribution of the software
-without specific, written prior permission.
-</P><P>
-
-DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
-ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
-DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
-ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
-WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
-ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
-SOFTWARE.
-</P><P>
-
-The following terms apply to the enhanced version of XShogi distributed
-by the Free Software Foundation:
-</P><P>
-
-This file is part of XSHOGI.
-</P><P>
-
-XSHOGI is distributed in the hope that it will be useful, but WITHOUT
-ANY WARRANTY.  No author or distributor accepts responsibility to anyone
-for the consequences of using it or for whether it serves any particular
-purpose or works at all, unless he says so in writing.  Refer to the
-XSHOGI General Public License for full details.
-</P><P>
-
-Everyone is granted permission to copy, modify and redistribute XSHOGI,
-but only under the conditions described in the XSHOGI General Public
-License. A copy of this license is supposed to have been given to you
-along with XSHOGI so you can know your rights and responsibilities.  It
-should be in a file named COPYING.  Among other things, the copyright
-notice and this notice must be preserved on all copies.
-</P><P>
-
-<A NAME="References and links"></A>
-<HR SIZE=1>
-<TABLE CELLPADDING=1 CELLSPACING=1 BORDER=0>
-<TR><TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="gnushogi_19.html#SEC19"> &lt; </A>]</TD>
-<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="gnushogi_21.html#SEC21"> &gt; </A>]</TD>
-<TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="gnushogi_19.html#SEC19"> &lt;&lt; </A>]</TD>
-<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="gnushogi.html#SEC_Top"> Up </A>]</TD>
-<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="gnushogi_21.html#SEC21"> &gt;&gt; </A>]</TD>
-<TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT"> &nbsp; <TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="gnushogi.html#SEC_Top">Top</A>]</TD>
-<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="gnushogi_toc.html#SEC_Contents">Contents</A>]</TD>
-<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="gnushogi_24.html#SEC24">Index</A>]</TD>
-<TD VALIGN="MIDDLE" ALIGN="LEFT">[<A HREF="gnushogi_abt.html#SEC_About"> ? </A>]</TD>
-</TR></TABLE>
-<BR>  
-<FONT SIZE="-1">
-This document was generated
-by <I>Michael C. Vanier</I> on <I>July, 7  2004</I>
-using <A HREF="http://www.mathematik.uni-kl.de/~obachman/Texi2html
-"><I>texi2html</I></A>
-
-</BODY>
-</HTML>