/usr/share/doc/gnushogi/html/xshogi.html is in gnushogi 1.4.1-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
<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="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Index.html#Index" rel="index" title="Index">
<link href="Index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="index.html#Top" rel="up" title="Top">
<link href="References-and-links.html#References-and-links" rel="next" title="References and links">
<link href="gnushogi.html#gnushogi" rel="prev" title="gnushogi">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.indentedblock {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
div.smalllisp {margin-left: 3.2em}
kbd {font-style:oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nocodebreak {white-space:nowrap}
span.nolinebreak {white-space:nowrap}
span.roman {font-family:serif; font-weight:normal}
span.sansserif {font-family:sans-serif; font-weight:normal}
ul.no-bullet {list-style: none}
-->
</style>
</head>
<body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
<a name="xshogi"></a>
<div class="header">
<p>
Next: <a href="References-and-links.html#References-and-links" accesskey="n" rel="next">References and links</a>, Previous: <a href="gnushogi.html#gnushogi" accesskey="p" rel="prev">gnushogi</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> [<a href="Index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
<a name="xshogi-1"></a>
<h2 class="chapter">4 xshogi</h2>
<a name="index-xshogi"></a>
<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>
<dl compact="compact">
<dt>‘<samp>[standard Xt options]</samp>’</dt>
<dd><p>xshogi accepts standard Xt options like -display, -geometry, and
-iconic.
</p>
</dd>
<dt>‘<samp>-tc or -timeControl minutes[:seconds]</samp>’</dt>
<dd><p>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>
</dd>
<dt>‘<samp>-mps or -movesPerSession moves</samp>’</dt>
<dd><p>Number of moves in a time control period. Default: 40 moves.
</p>
</dd>
<dt>‘<samp>-st or -searchTime minutes[:seconds]</samp>’</dt>
<dd><p>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>
</dd>
<dt>‘<samp>-sd or -searchDepth number</samp>’</dt>
<dd><p>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>
</dd>
<dt>‘<samp>-clock or -clockMode (True | False)</samp>’</dt>
<dd><p>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>
</dd>
<dt>‘<samp>-td or -timeDelay seconds</samp>’</dt>
<dd><p>Time delay between moves during “Load Game”. This doesn’t have to be
a round number. Try -td 0.4. Default: 1 second.
</p>
</dd>
<dt>‘<samp>-nsp or -noShogiProgram (True | False)</samp>’</dt>
<dd><p>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>
</dd>
<dt>‘<samp>-fsp or -firstShogiProgram program</samp>’</dt>
<dd><p>Name of first shogi program. In matches between two machines, this
program plays white. Default: “gnushogi”.
</p>
</dd>
<dt>‘<samp>-ssp or -secondShogiProgram program</samp>’</dt>
<dd><p>Name of second shogi program, if needed. In matches between two
machines, this program plays black; otherwise it is not started.
Default: “gnushogi”.
</p>
</dd>
<dt>‘<samp>-fh or -firstHost host</samp>’</dt>
<dd><p>Name of host the first shogi program plays on. Default: “localhost”.
</p>
</dd>
<dt>‘<samp>-sh or -secondHost host</samp>’</dt>
<dd><p>Name of host the second shogi program plays on. Default: “localhost”.
</p>
</dd>
<dt>‘<samp>-rsh or -remoteShell shell_name</samp>’</dt>
<dd><p>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>
</dd>
<dt>‘<samp>-mm or -matchMode (False | Init | Position | Opening)</samp>’</dt>
<dd><p>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>
</dd>
<dt>‘<samp>-lgf or -loadGameFile file</samp>’</dt>
<dd><p>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>
</dd>
<dt>‘<samp>-lpf or -loadPositionFile file</samp>’</dt>
<dd><p>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>
</dd>
<dt>‘<samp>-sgf or -saveGameFile file</samp>’</dt>
<dd><p>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>
</dd>
<dt>‘<samp>-spf or -savePositionFile file</samp>’</dt>
<dd><p>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>
</dd>
<dt>‘<samp>-coords or -showCoords (True | False)</samp>’</dt>
<dd><p>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>
</dd>
<dt>‘<samp>-mono or -monoMode (True | False)</samp>’</dt>
<dd><p>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>
</dd>
<dt>‘<samp>-pc or -pieceColor color</samp>’</dt>
<dd><p>Color specification for pieces suitable for XParseColor().
Default: #FFFFD7.
</p>
</dd>
<dt>‘<samp>-sc or -squareColor color</samp>’</dt>
<dd><p>Same for squares. Default: #EBDFB0.
</p>
</dd>
<dt>‘<samp>-wps or -westernPieceSet (True | False)</samp>’</dt>
<dd><p>Choose the Western style piece set.
</p>
</dd>
<dt>‘<samp>-npb or -normalPawnBitmap file</samp>’</dt>
<dt>‘<samp>-nnb or -normalKnightBitmap file</samp>’</dt>
<dt>‘<samp>-nbb or -normalBishopBitmap file</samp>’</dt>
<dt>‘<samp>-nrb or -normalRookBitmap file</samp>’</dt>
<dt>‘<samp>-nkb or -normalKingBitmap file</samp>’</dt>
<dd><p>Names of the bitmap files for the bitmap piece icons.
</p>
</dd>
<dt>‘<samp>-rpb or -reversePawnBitmap file</samp>’</dt>
<dt>‘<samp>-rnb or -reverseKnightBitmap file</samp>’</dt>
<dt>‘<samp>-rbb or -reverseBishopBitmap file</samp>’</dt>
<dt>‘<samp>-rrb or -reverseRookBitmap file</samp>’</dt>
<dt>‘<samp>-rkb or -reverseKingBitmap file</samp>’</dt>
<dd><p>Names of the bitmap files for the outline piece icons.
</p>
</dd>
<dt>‘<samp>-debug or -debugMode (True | False)</samp>’</dt>
<dd><p>Turns on debugging printout.
</p>
</dd>
</dl>
<p>OTHER X RESOURCES
</p>
<dl compact="compact">
<dt>‘<samp>initString</samp>’</dt>
<dd><p>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 <a href="gnushogi.html#gnushogi">gnushogi</a>) for
details.
</p>
</dd>
<dt>‘<samp>blackString and whiteString</samp>’</dt>
<dd><p>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>
<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>
</dd>
</dl>
<p>COMMAND BUTTONS AND KEYS
</p>
<dl compact="compact">
<dt>‘<samp>Quit</samp>’</dt>
<dd><p>Quits xshogi. Q or q is a keyboard equivalent.
</p>
</dd>
<dt>‘<samp>Reset</samp>’</dt>
<dd><p>Resets xshogi to the beginning of a shogi game. It also deselects any
game or position files.
</p>
</dd>
<dt>‘<samp>Flip View</samp>’</dt>
<dd><p>inverts the view of the shogi board.
</p>
</dd>
<dt>‘<samp>Hint</samp>’</dt>
<dd><p>displays a move hint from gnushogi.
</p>
</dd>
<dt>‘<samp>Load Game</samp>’</dt>
<dd><p>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>
</dd>
<dt>‘<samp>Load Position</samp>’</dt>
<dd><p>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>
</dd>
<dt>‘<samp>Save Game</samp>’</dt>
<dd><p>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>
</dd>
<dt>‘<samp>Save Position</samp>’</dt>
<dd><p>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>
</dd>
<dt>‘<samp>Machine White</samp>’</dt>
<dd><p>forces gnushogi to play white.
</p>
</dd>
<dt>‘<samp>Machine Black</samp>’</dt>
<dd><p>forces gnushogi to play black.
</p>
</dd>
<dt>‘<samp>Force Moves</samp>’</dt>
<dd><p>forces a series of moves. That is, gnushogi stops playing and xshogi
allows you to make moves for both white and black.
</p>
</dd>
<dt>‘<samp>Two Machines</samp>’</dt>
<dd><p>plays a game between two computer programs.
</p>
</dd>
<dt>‘<samp>Forward</samp>’</dt>
<dd><p>moves forward through a series of remembered moves. F or f is a
keyboard equivalent.
</p>
</dd>
<dt>‘<samp>Backward</samp>’</dt>
<dd><p>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>
</dd>
<dt>‘<samp>Pause</samp>’</dt>
<dd><p>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>
</dd>
<dt>‘<samp>Edit Position</samp>’</dt>
<dd><p>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>
</dd>
<dt>‘<samp>Challenge</samp>’</dt>
<dd><p>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>
</dd>
<dt>‘<samp>Select Level</samp>’</dt>
<dd><p>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>
</dd>
<dt>‘<samp>Move NOW</samp>’</dt>
<dd><p>force computer to stop thinking and to make the current best move.
</p>
</dd>
<dt>‘<samp>Iconify I, i, C or c</samp>’</dt>
<dd><p>iconifies xshogi.
</p>
</dd>
</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>
<hr>
<div class="header">
<p>
Next: <a href="References-and-links.html#References-and-links" accesskey="n" rel="next">References and links</a>, Previous: <a href="gnushogi.html#gnushogi" accesskey="p" rel="prev">gnushogi</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> [<a href="Index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>
|