Updating to version 1.3, release made by Mike Vanier (mvanier@bbb.caltech.edu).
[gnushogi.git] / doc / gnushogi.info-2
blobaf2563b4bb5e75c6f1e82a656d7f257b1c504505
1 This is gnushogi.info, produced by Makeinfo version 3.12h from
2 gnushogi.texinfo.
4    This file describes how to use GNU shogi, a program which plays
5 Shogi (Japanese chess).
7    Copyright (C) 1999 Michael C. Vanier and the Free Software
8 Foundation, Inc.
10    Permission is granted to make and distribute verbatim copies of this
11 manual provided the copyright notice and this permission notice are
12 preserved on all copies.
14    Permission is granted to copy and distribute modified versions of
15 this manual under the conditions for verbatim copying, provided that
16 the entire resulting derived work is distributed under the terms of a
17 permission notice identical to this one.
19    Permission is granted to copy and distribute translations of this
20 manual into another language, under the above conditions for modified
21 versions, except that this permission notice may be stated in a
22 translation approved by the Free Software Foundation.
24 \x1f
25 File: gnushogi.info,  Node: Mating problems,  Next: Shogi variants,  Prev: Sample game,  Up: About shogi
27 Mating problems
28 ===============
30    One good way to improve at shogi is to solve mating problems.  There
31 are several types of these problems, but the most common is called a
32 "tsume-shogi" problem, or "tsume" problem for short.  In a tsume
33 problem, all pieces that are not on the board are assumed to be in the
34 opponent's hand (except for your King, which is usually not shown).
35 Every move you make must be check until the final checkmate.  Your
36 opponent may play any piece on the board or drop any of his pieces in
37 hand in order to prevent the mate.  In a properly constructed tsume
38 problem, all of your pieces on the board and in hand must be essential
39 to the solution.  One consequence of this is that all of your pieces in
40 hand must be played during the solution.  There should only be one
41 correct solution for the given number of moves.  Tsume problems use
42 Japanese-style move numbering; thus, a problem where you move (and give
43 check), your opponent moves, and you move to give checkmate is called a
44 three-mover.  Here is a really trivial three-mover:
47    3    2    1
48 ---------------+
49 |    |    |    |  a
50 ---------------+
51 |    |    | wK |  b
52 ---------------+
53 |    |    |    |  c
54 ---------------+
55 | bN |    |    |  d
56 ---------------+
57 |    |    |    |  e
58 ---------------+
59 |    | bN |    |  f
60 ---------------+
62 Black in hand: S, G
65    Here, Black plays G*2b, White plays K1c, and Black plays S*1d mate.
66 More typical tsume problems range from 5 moves to arbitrarily high
67 numbers of moves, and they can be quite brain-busting.  Tsume problems
68 may seem artificial, but in the closing stages of the game where both
69 players have a lot of pieces in hand, it is often necessary to give
70 check at every move, or else your opponent will start a counterattack
71 and will mate you before you mate him.  A tsume problem is a worst-case
72 scenario for the attacker: you have to mate your opponent even though he
73 has every piece not on the board in hand, which means you have to
74 develop sharp attacking skills.  Many more tsume problems can be found
75 on the internet; I particularly recommend Patrick Davin's "Shogi Nexus"
76 (*note References and links::.).
78 \x1f
79 File: gnushogi.info,  Node: Shogi variants,  Next: Differences between shogi and chess,  Prev: Mating problems,  Up: About shogi
81 Shogi variants
82 ==============
84    Several historical variants of shogi exist.  Most of these were
85 invented before modern shogi (in some cases hundreds of years before),
86 are much larger than modern shogi and are not played with drops.  Thus,
87 in many ways they are really more like giant chess games than like
88 modern shogi.  The only one of these games to have survived in Japan is
89 Chu (middle) shogi, which is still played a little bit.  Thanks to the
90 efforts of George Hodges and John Fairbairn of the Shogi Association
91 (two British shogi enthusiasts), these games were resurrected and rules
92 and sets for them can still be purchased from George Hodges (*note
93 References and links::.).  I hope to eventually extend GNU shogi so
94 that it can play at least some of these games.  There are also several
95 non-historical variants of shogi; I don't know much about them but you
96 can find information about them on the internet (*note References and
97 links::.).
99    The historical variants include:
102   1. Tori (bird) shogi, played on a 7x7 board with 32 pieces in all;
103      this is the only variant that is known to have been played with
104      drops.
106   2. Wa shogi, played on an 11x11 board with 54 pieces.  This game can
107      be played with or without drops but the historical evidence favors
108      the view that it was played without drops.  However, most people
109      who have tried it claim it is a much better game with drops, being
110      even more intricate than standard shogi.
112   3. Chu (middle) shogi, played on a 12x12 board with 92 pieces.  This
113      was (and is) by far the most popular of the variants, and has 21
114      different kinds of pieces in the starting line-up alone (along
115      with several others that appear upon promotion).  Unlike modern
116      shogi, there are a tremendous number of ranging pieces and the
117      game is definitely not played with drops.  There is also an
118      amazing piece called the Lion which has a double king move and can
119      capture two pieces at once!  Chu shogi has a small but fanatical
120      following, some of whom consider it better than modern shogi.
122   4. Dai (great) shogi, played on a 15x15 board with 130 pieces.  Other
123      than the larger board, this game is very similar to Chu shogi.
125   5. Tenjiku (exotic) shogi, played on a 16x16 board with 176 pieces.
126      This game is possibly the most complex tactical game in existence.
127      There are many astoundingly powerful pieces, including one (the
128      Fire Demon) that can capture up to eight opposing pieces in a
129      single move!  Despite the size of the game, checkmates can occur
130      very suddenly (and often very early on) if one player makes a
131      wrong move.  Tenjiku also has a small but fanatical following, one
132      of whom (Colin Adams) has written a book on the game which is
133      available for download at
134      `http://www.colina.demon.co.uk/tenjiku.html'.
136   6. Dai-dai (great-great) shogi, played on a 17x17 board with 192
137      pieces.  The opening setup alone has 64 different kinds of pieces!
138      This game and the larger ones that follow sound pretty
139      outlandish, but they have actually been played; a game of Dai-dai
140      can supposedly be played in about 12 hours.
142   7. Maka-dai-dai (great-great-great) shogi, played on a 19x19 board
143      with 192 pieces.  For those for whom Dai-dai shogi is just too
144      small :-)
146   8. Tai (grand) shogi, played on a 25x25 board with 377 pieces!  Until
147      recently, this was thought to be the biggest chess game ever
148      devised, but now there is...
150   9. Kyoku tai (extremely grand?) shogi, played on a 36x36 board with
151      402 pieces.  The rules for this have just been unearthed in an old
152      Japanese book.  Hopefully someone will soon organize a postal
153      Kyoku tai shogi championship; maybe their distant ancestors could
154      finish it :-)
156      It is thought that the really huge games (Dai-dai and up) were
157      never really played to any significant extent (gee, wonder why?)
158      and were devised merely so that the creators could have the fun of
159      inventing enormous games, amazing their friends and confounding
160      their enemies.  However, the games up to Tenjiku shogi at least
161      appear to be quite playable, assuming one has the time.
165 \x1f
166 File: gnushogi.info,  Node: Differences between shogi and chess,  Prev: Shogi variants,  Up: About shogi
168 Differences between shogi and chess
169 ===================================
171    Some differences between shogi and international chess have been
172 mentioned elsewhere in this document; I summarize them here for people
173 who are interested in game comparisons.  I won't try to deal with the
174 thorny question of which game is "better" although my bias may have
175 already come through :-) In fact, the drop rule makes the two games so
176 different in character that arguing over which game is better is like
177 comparing apples to oranges (you'd be better off comparing chess to Chu
178 shogi (*note Shogi variants::.).  However, I believe that if you are a
179 chess fan you'll really like shogi as well, and shogi is also popular
180 with many people who don't particularly like chess.
182    Here are the significant differences between chess and shogi:
185   1. In shogi, captured pieces become the property of the capturer and
186      can re-enter play by being dropped onto almost any vacant square.
187      In chess, captured pieces are out of the game.  Thus, in shogi,
188      piece exchanges complicate the play significantly while in chess
189      they simplify it.
191   2. The shogi board is 9x9; the chess board is 8x8.
193   3. Shogi has five pieces with no counterpart in chess: the gold and
194      silver generals, the lance, the promoted rook and the promoted
195      bishop.  Chess has one piece with no counterpart in shogi: the
196      queen.  The knight's move in shogi is much more restrictive than
197      in chess.  Pieces in shogi generally have a much smaller range of
198      movement than in chess (unless they are in hand).
200   4. In shogi, all pieces except the gold general and the king can
201      promote, but only to one kind of piece.  Promotion is easier in
202      shogi because the promotion zone is closer to the starting
203      position of the pieces (especially pawns).  In chess, only the
204      pawn can promote, but it can promote to any other piece except the
205      king.
207   5. In shogi, pawns capture the same way they move.  There is no
208      initial two-space pawn move and hence no _en-passant_ captures.
209      In chess, pawns capture diagonally which means that opposing pawns
210      can block each other.
212   6. In shogi, you only have one rook and one bishop.  Note that the
213      bishop is not restricted to only one "color" square (squares in
214      shogi aren't colored, but never mind) because promoted bishops can
215      also move one square orthogonally.
217   7. There is no special castling move in shogi.  The term "castle" is
218      used in shogi to denote a defensive formation consisting of
219      (usually) three generals which protect the king.  There are many
220      such castles (about 40 or so have names).  *Note Sample game::.
222   8. Draws are much rarer in shogi than in chess.  Perpetual check is
223      not allowed.  Stalemate is a virtual impossibility, and is a loss
224      for the stalematee.
226   9. Since pieces are never out of play in shogi, chess-type endgames
227      involving only a few pieces do not occur.
229  10. Shogi games are generally longer than chess games (about 60-70
230      moves is typical).
232  11. Shogi has a well-developed handicap system which is in general use;
233      chess does not.
237    The effects of all these differences on play include (in my opinion):
240   1. Piece/pawn structures in chess are more rigid than in shogi.  Pawns
241      block each other and pawns, once advanced, cannot ever retreat.  In
242      shogi, you can repair the hole caused by a pawn advance by
243      exchanging the pawn and dropping it back where you want it.  Thus
244      shogi is more fluid than chess and less "structural".
246   2. Counterattack is MUCH more common in shogi than in chess.  Games
247      typically end in mutual mating attacks, where each player is
248      trying to checkmate the other player before being checkmated
249      himself.  This makes tempo incredibly important and also makes
250      sacrificial play quite common.
252   3. Attacks involving only ranging pieces are more a feature of chess
253      than of shogi.  A shogi attack typically uses a ranging piece or
254      pieces to support an attack by short-range pieces (especially
255      generals).  It is very rare to mate a king with a non-adjacent
256      ranging piece in shogi since the player whose king is threatened
257      can almost always interpose by dropping a piece.
261 \x1f
262 File: gnushogi.info,  Node: gnushogi,  Next: xshogi,  Prev: About shogi,  Up: Top
264 gnushogi
265 ********
267    This section describes how to run the "gnushogi" program.
270    SYNOPSIS
273    gnushogi [ [[-]a] [-b bookfile] [-B binbookfile] [-C] [-h langfile]
274 [-L langfile] [-r length] [-R] [-s pathname] [-l pathname] [-S
275 binbooksize] [-t] [-c size] [-T size] [-v] [-x] [-X] arg1 arg2 ]
278    DESCRIPTION
281    GNU shogi (gnushogi) plays a game of japanese chess (shogi) against
282 the user or it plays against itself.
284    At startup gnushogi reads the binbook file if it is present.  It then
285 looks for a book file.  If it is present it adds its contents to the
286 binbook data.  If the binbook file is writable a new combined binbook
287 file is written.
289    Gnushogi is a modified version of the gnuchess program.  It has a
290 simple alphanumeric board display, or it can be used with the xshogi
291 program under X windows.  The program gets its opening moves from the
292 file gnushogi.bbk which is located in a directory specified in the
293 Makefile.  To invoke the program type:
296 `gnushogi -C'
297      simple curses based version
299 `gnushogi -X (or just gnushogi)'
300      xshogi compatible version
302 `gnushogi -R'
303      raw test display version
306    TIME CONTROLS
309    If one argument is given, it is the search time per move in
310 [minutes:]seconds.  So gnushogi 30 will generate one move every 30
311 seconds, while gnushogi 5:00 will generate one move every 5 minutes.
313    If two or more arguments are given, they will be used to set
314 tournament time controls with the first argument of each pair being the
315 number of moves and the second being the total clock time in
316 minutes[:seconds].  Thus, entering gnushogi 60 5 will set the clocks
317 for 5 minutes (300 seconds) for the first 60 moves, and gnushogi 30
318 3:30 will allow 3 minutes and 30 seconds for 30 moves.
320    gnushogi 30 5 1 :30 will allow 5 minutes for the first 30 moves and
321 30 seconds for each move after that.  Up to 4 pairs of controls may be
322 specified.
324    If no argument is given the program will prompt the user for level of
325 play.
327    For use with xshogi see the documentation on that program.  *Note
328 xshogi::.
331    BOOK
334    The book gnushogi.tbk consists of a sequence of openings.  An opening
335 begins with a line starting with a # (the rest of the line is a
336 comment).  Following this is a series of moves in algebraic notation
337 alternating black and white separated by white space.  A move may have a
338 ? after it indicating this move should never be made in this position.
339 Moves are stored as position:move so transpositions between openings can
340 take place.
343    HASHFILE
346    The hashfile if created should be on the order of 4 megabytes; you
347 can create such a hashfile by typing "gnushogi -c 22" (see below).  This
348 file contains positions and moves learned from previous games.  If a
349 hashfile is used the computer makes use of the experience it gained in
350 past games.  Tests run so far show that it plays no worse with the
351 hashfile than without, but it is not clear yet whether it provides a
352 real advantage.
355    LEGAL MOVES
358    Note: Piece letters are determined by the language file.  What is
359 specified here is the default (English).
361    Once gnushogi is invoked, the program will display the board and
362 prompt the user for a move.  To enter a move, use the notation 7g7f
363 where the first letter-number pair indicates the origin square and the
364 second letter-number pair indicates the destination square.  An
365 alternative is to use the notation P7f where the first letter indicates
366 the piece type (P,L,N,S,G,B,R,K).  To promote append a + the type of
367 the new piece to the move, as in 2d2c+ or P2c+. Note that you must use
368 capital letters for the pieces by default.
371    COMMAND-LINE OPTIONS
374 `-a'
375      Do not search on opponent's time.
378      Do search on opponent's time.
380 `-b BOOKFILE'
381      Use bookfile for opening book.
383 `-B BINBOOKFILE'
384      Use binbookfile for binary opening book.
386 `-c SIZE'
387      Create a new HASHFILE.  File size is 2^size entries of
388      approximately 65+?  bytes.
390 `-C'
391      Use curses-based display mode.
393 `-h'
394      Do not use hashfile.
397      Do use hashfile.
399 `-l PATHNAME'
400      Pathname of the loadfile used with get or xget.
402 `-L LANG'
403      Use language lang from the file gnushogi.lang.  If -L is not
404      specified it uses the first language in the file.
406 `-P PLYLEVELS'
407      Number of plys to include in the binbookfile.  For generating a
408      binbookfile.
410 `-r LENGTH'
411      Rehash _length_ times in searching entries for position in
412      transposition table.
414 `-R'
415      Use raw text display mode.  This can be used for dumb terminals or
416      for systems that don't have curses.
418 `-s PATHNAME'
419      Pathname of the save file to use with the save command.
421 `-S SIZE'
422      Size of binbookfile for memory based books.  For creating a
423      binbookfile.
425 `-t'
426      Show statistics for HASHFILE.
428 `-T SIZE'
429      Set the transposition table size to 2^size entries.
431 `-v'
432      Show version and patchlevel.
434 `-x VALUE'
435      Use value as the evaluation window xwndw.
437 `-X'
438      Use xshogi display mode (the default).
441    COMMANDS
444    In addition to legal moves, the following commands can be entered at
445 the gnushogi prompt.  Note: command names are determined by the language
446 file and may vary with the implementation.  The default language is
447 English.
449 `alg'
450      allow algebraic input (not implemented).
452 `Awindow'
453      change Alpha window (default score + 90).
455 `Bwindow'
456      change Beta window (default score - 90).
458 `beep'
459      toggles beeping after each move (default: on).
461 `bd'
462      updates the current board position on the display.
464 `book'
465      turns off use of the opening library.
467 `both'
468      causes the computer to play both sides of a shogi game.
470 `black'
471      causes the computer to take the white pieces, if the computer is
472      to move first.
474 `bsave'
475      saves a game to disk as a book textfile.  The program will prompt
476      the user for a file name.
478 `gamein'
479      toggles game mode time control.  Assumes the time specified for
480      time control is the time for a complete game.  Input with the
481      level command should be the game time and the expected number of
482      moves in a game.  go command must be given.
484 `coords'
485      show coordinates on the display (visual only).
487 `contempt'
488      allows the value of _contempt_ to be modified.
490 `debug'
491      asks for a piece as color piece, as wb or bn, and shows its
492      calculated value on each square.
494 `debuglevel'
495      sets level of debugging output if compiled with debug options.
497 `depth'
498      allows the user to change the search depth of the program.  The
499      maximum depth is 29 ply.  Normally the depth is set to 29 and the
500      computer terminates its search based on elapsed time rather than
501      depth.  If depth is set to (say) 4 ply, the program will search
502      until all moves have been examined to a depth of 4 ply (with
503      extensions up to 11 additional ply for sequences of checks and
504      captures).  If you set a maximum time per move and also use the
505      depth command, the search will stop at the specified time or the
506      specified depth, whichever comes first.
508 `easy'
509      toggles easy mode (thinking on opponents time) on and off. The
510      default is easy mode ON.  If easy mode is disabled, the keyboard
511      is polled for input every so often and when input is seen the
512      search is terminated. It may also be terminated with a sigint.
514 `edit'
515      allows the user to set up a board position.
516         - # clear the board.
518         - c toggle piece color.
520         - .  command will exit setup mode.
522         - p3b place a pawn on 3b
524         - p3b+ place a promoted pawn on 3b
526         - p* place a pawn in hand (among the captured pieces)
529      Pieces are entered by typing a letter (p,l,n,s,g,b,r,k)  for the
530      piece followed by the coordinate.  Here, letter case is ignored.
532      The usual warning about the language file applies.
534 `exit'
535      exits gnushogi.
537 `first'
538      tells the computer to move first.  Computer begins searching for a
539      move.  (same as "go").
541 `force'
542      allows the user to enter moves for both sides.  To get the program
543      to play after a sequence of moves has been entered use the "black"
544      or "white" commands.
546 `get'
547      retrieves a game from disk.  The program will prompt the user for
548      a file name.
550 `go'
551      tells the computer to move first.  Computer begins searching for a
552      move.  (same as "first").
554 `hash'
555      use/don't use hashfile.
557 `hashdepth'
558      allows the user to change the minimum depth for using the hashfile
559      and the number of moves from the beginning of the game to use it.
561 `help'
562      displays a short description of the commands and the current
563      status of options.
565 `hint'
566      causes the program to supply the user with its predicted move.
568 `level'
569      allows the user to set time controls such as 60 moves in 5 minutes
570      etc.  In tournament mode, the program will vary the time it takes
571      for each move depending on the situation.  If easy mode is
572      disabled (using the "easy" command), the program will often
573      respond with its move immediately, saving time on its clock for
574      use later on.
576 `list'
577      writes the game moves and some statistics on search depth, nodes,
578      and time to the file "shogi.lst".
580 `material'
581      toggle material flag - draws on no pawns and both sides < rook.
583 `new'
584      starts a new game.
587      evaluates the board and shows the point score for each piece.  The
588      total score for a position is the sum of these individual piece
589      scores.
591 `post'
592      causes the program to display the principal variation and the score
593      during the search.  A score of 100 is equivalent to a 1 pawn
594      advantage for the computer.
596 `quit'
597      exits the game.
599 `random'
600      causes the program to randomize its move selection slightly.
602 `rcptr'
603      set recapture mode.
605 `remove'
606      backout the last level for both sides.  Equal to 2 undo's.
608 `reverse'
609      causes the board display to be reversed.  That is, the black
610      pieces will now appear at the top of the board.
612 `rv'
613      reverse board display.
615 `save'
616      saves a game to disk.  The program will prompt the user for a file
617      name.
619 `switch'
620      causes the program to switch places with the opponent and begin
621      searching.
623 `test'
624      performs some speed tests for MoveList and CaptureList generation,
625      and ScorePosition position scoring for the current board.
627 `time'
628      set computer's time remaining, intended for synchronizing clocks
629      among multiple players.
631 `tsume'
632      toggle tsume mode. In tsume mode, not all possible moves will be
633      generated. If a king is in check, only moves that get the king out
634      of check are generated.  If the king is not in check, only moves
635      that give check to the opponent's king are generated.
637 `undo'
638      undoes the last move whether it was the computer's or the human's.
639      You may also type "remove".  This is equivalent to two "undo"'s
640      (e.g. retract one move for each side).
642 `white'
643      causes the computer to take the black pieces, if the computer is
644      to move first the go command must be given.
646 `xget'
647      read an xshogi position file.
649 `xsave'
650      save as an xshogi position file.
652 `xwndw'
653      change X window. The window around alpha/beta used to determine
654      whether the position should be scored or just estimated.  Note:
655      this has _nothing_ to do with xshogi or X windows; the terms are
656      completely separate.
659 \x1f
660 File: gnushogi.info,  Node: xshogi,  Next: References and links,  Prev: gnushogi,  Up: Top
662 xshogi
663 ******
665    This section describes how to run the "xshogi" program.
668    SYNOPSIS
671    xshogi [ options ]
674    DESCRIPTION
677    xshogi provides an X11/Xt/Athena Widgets user interface for gnushogi.
678 With xshogi you can play gnushogi, set up arbitrary positions, force
679 variations, or watch xshogi manage a game between two shogi programs.
680 Furthermore, it can be used as an interface between two players on
681 different displays.
683    xshogi can also be used as a shogi board to play out games.  It will
684 read through a game file or allow a player to play through a variation
685 manually (force mode).  This is useful for keeping track of email postal
686 games or browsing games off the net.
688    After starting xshogi, you can make moves by pressing mouse button 1
689 while the cursor is over a square with your piece on it and dragging the
690 mouse to another square.  If the move is illegal, gnushogi will not
691 allow it.  xshogi will then retract the move.
694    COMMAND-LINE OPTIONS
697    The following command line options also correspond to X resources
698 that you can set in your .Xdefaults file.
701 `[standard Xt options]'
702      xshogi accepts standard Xt options like -display, -geometry, and
703      -iconic.
705 `-tc or -timeControl minutes[:seconds]'
706      Amount of time for a set of moves determined by movesPerSession.
707      If this number of moves is played within the time control period,
708      xshogi resets the time clocks.  Default: 5 minutes.
710 `-mps or -movesPerSession moves'
711      Number of moves in a time control period.  Default: 40 moves.
713 `-st or -searchTime minutes[:seconds]'
714      Tell gnushogi to spend at most the given amount of time searching
715      for each of its moves.  Without this option, gnushogi chooses its
716      search time based on the number of moves and amount of time
717      remaining until the next time control.  Setting this option also
718      sets -clockMode to False.
720 `-sd or -searchDepth number'
721      Tell gnushogi to look ahead at most the given number of moves when
722      searching for a move to make.  Without this option, gnushogi
723      chooses its search depth based on the number of moves and amount
724      of time remaining until the next time control.  Setting this
725      option also sets -clockMode to False.
727 `-clock or -clockMode (True | False)'
728      Determines whether or not to use the clock.  If clockMode is
729      False, the clock does not run, but the side that is to play next
730      is still highlighted.
732 `-td or -timeDelay seconds'
733      Time delay between moves during "Load Game".  This doesn't have to
734      be a round number.  Try -td 0.4.  Default: 1 second.
736 `-nsp or -noShogiProgram (True | False)'
737      If this option is True, xshogi acts as a passive shogi board; it
738      does not try to start a shogi program, not even to check whether
739      moves made in Force mode are legal.  It also sets -clockMode to
740      False.  Default: False.
742 `-fsp or -firstShogiProgram program'
743      Name of first shogi program.  In matches between two machines, this
744      program plays white.  Default: "gnushogi".
746 `-ssp or -secondShogiProgram program'
747      Name of second shogi program, if needed.  In matches between two
748      machines, this program plays black; otherwise it is not started.
749      Default: "gnushogi".
751 `-fh or -firstHost host'
752      Name of host the first shogi program plays on.  Default:
753      "localhost".
755 `-sh or -secondHost host'
756      Name of host the second shogi program plays on.  Default:
757      "localhost".
759 `-rsh or -remoteShell shell_name'
760      Some systems do not use rsh as the remote shell.  This option
761      allows a user to name the remote shell command.  This should be
762      done in the resource file.
764 `-mm or -matchMode (False | Init | Position | Opening)'
765      Automatically run a game between firstShogiProgram and
766      secondShogiProgram.  If matchMode is set to Init, xshogi will
767      start the game with the initial shogi position.  If matchMode is
768      set to Position, xshogi will start the game with the position
769      specified by the loadPositionFile resource.  If matchMode is set
770      to Opening, xshogi will play out the opening moves specified by
771      the -loadGameFile resource.  If the -saveGameFile resource is set,
772      a move record for the match will be saved in the specified file.
773      Default: "False".
775 `-lgf or -loadGameFile file'
776      Name of file to read a game record from.  Game files are found in
777      the directory named by the SHOGIDIR environment variable.  If this
778      variable is not set, the current directory is used unless the file
779      name starts with a /.
781 `-lpf or -loadPositionFile file'
782      Name of file to read a game position from.  Position files are
783      found in the directory named by the SHOGIDIR environment variable.
784      If this variable is not set, the current directory is used unless
785      the file name starts with a /.
787 `-sgf or -saveGameFile file'
788      Name of file to save a game record to.  Game files are saved in the
789      directory named by the SHOGIDIR environment variable.  If this
790      variable is not set, the current directory is used unless the file
791      name starts with a /.
793 `-spf or -savePositionFile file'
794      Name of file to save a game position to.  Position files are saved
795      in the directory named by the SHOGIDIR environment variable.  If
796      this variable is not set, the current directory is used unless the
797      file name starts with a /.
799 `-coords or -showCoords (True | False)'
800      If this option is True, xshogi displays algebraic coordinates
801      along the board's left and bottom edges.  The default is False.
802      The coordFont resource specifies what font to use.
804 `-mono or -monoMode (True | False)'
805      Determines whether xshogi displays its pieces and squares with two
806      colors or four.  You shouldn't have to specify monochrome.  xshogi
807      will determine if this is necessary.
809 `-wpc or -blackPieceColor color'
810      Color specification for black pieces suitable for
811      XParseColor(3X11).  Default: #FFFFCC.  These colors look good on a
812      DEC workstation.  If you need different colors, try using the
813      xcolors application.  Source for xcolors can be found in the X11
814      contrib directory.
816 `-bpc or -whitePieceColor color'
817      Same for white pieces.  Default: #202020.
819 `-lsc or -lightSquareColor color'
820      Same for light squares.  Default: #C8C365.
822 `-dsc or -darkSquareColor color'
823      Same for dark squares.  Default: #77A26D.
825 `-wps or -westernPieceSet (True | False)'
826      Choose the Western style piece set.
828 `-npb or -normalPawnBitmap file'
830 `-nnb or -normalKnightBitmap file'
832 `-nbb or -normalBishopBitmap file'
834 `-nrb or -normalRookBitmap file'
836 `-nkb or -normalKingBitmap file'
837      Names of the bitmap files for the bitmap piece icons.
839 `-rpb or -reversePawnBitmap file'
841 `-rnb or -reverseKnightBitmap file'
843 `-rbb or -reverseBishopBitmap file'
845 `-rrb or -reverseRookBitmap file'
847 `-rkb or -reverseKingBitmap file'
848      Names of the bitmap files for the outline piece icons.
850 `-debug or -debugMode (True | False)'
851      Turns on debugging printout.
854    OTHER X RESOURCES
857 `initString'
858      The actual string that is sent to initialize the shogi program can
859      be set from .Xdefaults.  It can't be set from the command line
860      because of syntax problems.  The default value is
861      "new\nbeep\nrandom\neasy\n".  The "new" and "beep" commands are
862      required. You can remove the "random" command if you like;
863      including it causes gnushogi to randomize its move selection
864      slightly so that it doesn't play the same moves in every game.
865      Even without "random", gnushogi randomizes its choice of moves
866      from its opening book.  You can also remove "easy" if you like;
867      including it toggles easy mode off, causing gnushogi to think on
868      your time.  That is, if "easy" is included in the initString, GNU
869      Shogi thinks on your time; if not, it does not.  (Yes, this does
870      seem backwards, doesn't it.)  You can also try adding other
871      commands to the initString; see the gnushogi documentation (*note
872      gnushogi::.) for details.
874 `blackString and whiteString'
875      These resources control what is sent when the Machine Black and
876      Machine White buttons are selected.  This is mostly for
877      compatibility with obsolete versions of gnushogi.
879      Alternate bitmaps for piece icons can be specified either by
880      choosing one of the built-in sets or with the file name resources
881      described above.  There are three built-in sets of piece bitmaps
882      available, large (the default), medium, or small.  It is easiest
883      to select the set you prefer in the .Xdefaults file:
885      XShogi*boardSize:   Medium
887      The font used for button labels and comments can be changed in the
888      .Xdefaults file.  You may want to choose a smaller font if you are
889      using the small pieces:
891      XShogi*font:    helvetica_oblique12
893      The font used for coordinates (when the showCoords option is True)
894      can be set similarly:
896      XShogi*coordFont:    helvetica_10
898      If you are using a grayscale monitor, try setting the colors to:
900      XShogi*blackPieceColor:     gray100
901      XShogi*whitePieceColor:     gray0
902      XShogi*lightSquareColor:    gray60
903      XShogi*darkSquareColor:     gray40
906    COMMAND BUTTONS AND KEYS
909 `Quit'
910      Quits xshogi.  Q or q is a keyboard equivalent.
912 `Reset'
913      Resets xshogi to the beginning of a shogi game.  It also deselects
914      any game or position files.
916 `Flip View'
917      inverts the view of the shogi board.
919 `Hint'
920      displays a move hint from gnushogi.
922 `Load Game'
923      plays a game from a record file.  If no file is specified a popup
924      dialog asks for a filename.  Game files are found in the directory
925      named by the SHOGIDIR environment variable.  If this variable is
926      not declared then the current directory is used unless the file
927      name starts with a /.  G or g is a keyboard equivalent.  The game
928      file parser will accept almost any file that contains moves in
929      algebraic notation.  If the first line begins with `#', it is
930      assumed to be a title and is displayed.  Text enclosed in
931      parentheses or square brackets is assumed to be commentary and is
932      displayed in a pop-up window.  Any other text in the file is
933      ignored.
935 `Load Position'
936      sets up a position from a position file.  If no file is specified a
937      popup dialog asks for a filename.  Position files are found in the
938      directory named by the SHOGIDIR environment variable.  If this
939      variable is not declared then the current directory is used unless
940      the file name starts with a /.  Position files must be in the
941      format that the Save Position command writes.
943 `Save Game'
944      saves a game to a record file.  If no file is specified a popup
945      dialog asks for a filename.  If the filename exists, the user is
946      asked whether the current game record is be appended to this file
947      or if the file should be replaced.  Game files are saved in the
948      directory named by the SHOGIDIR environment variable.  If this
949      variable is not declared then the current directory is used unless
950      the file name starts with a /.  Game files are human-readable, and
951      can also be read back by the Load Game command. Furthermore, they
952      are accepted as gnushogi text bookfiles.
954 `Save Position'
955      saves a position to a position file.  If no file is specified a
956      popup dialog asks for a filename.  Position files are saved in the
957      directory named by the SHOGIDIR environment variable.  If this
958      variable is not declared then the current directory is used unless
959      the file name starts with a /.  Position files are human-readable,
960      and can also be read back by the Load Position command.
962 `Machine White'
963      forces gnushogi to play white.
965 `Machine Black'
966      forces gnushogi to play black.
968 `Force Moves'
969      forces a series of moves.  That is, gnushogi stops playing and
970      xshogi allows you to make moves for both white and black.
972 `Two Machines'
973      plays a game between two computer programs.
975 `Forward'
976      moves forward through a series of remembered moves.  F or f is a
977      keyboard equivalent.
979 `Backward'
980      moves backward through a series of remembered moves.  As a side
981      effect, puts xshogi into Force Moves mode.  B or b is a keyboard
982      equivalent.
984 `Pause'
985      pauses the clocks or (in Load Game mode) pauses the game being
986      loaded.  Press Pause again to continue.  P or p is a keyboard
987      equivalent.
989 `Edit Position'
990      lets you set up an arbitrary board position.  Use mouse button 1
991      to drag pieces to new squares, or to delete a piece by dragging it
992      off the board or dragging an empty square on top of it.  To drop a
993      new piece on a square, press mouse button 2 or 3 over the square.
994      This brings up a menu of black pieces (button 2) or white pieces
995      (button 3).  Additional menu choices let you empty the square or
996      clear the board.  You can set the side to play next by clicking on
997      the Black or White indicator at the top of the screen.
999 `Challenge'
1000      allows to make a two display game between two human players.
1001      Enter the display you want to connect to.  If you are allowed to
1002      connect, a new board is displayed at the remote display.
1003      Challenge mode can only be stopped by pressing "quit".
1005 `Select Level'
1006      allows to reset the clocks for both players.  Enter the number of
1007      moves and the number of minutes in which the moves should be done.
1009 `Move NOW'
1010      force computer to stop thinking and to make the current best move.
1012 `Iconify I, i, C or c'
1013      iconifies xshogi.
1016    LIMITATIONS
1019    If you press the  Pause  button  during  GNU  Shogi's  turn, xshogi
1020 will stop the clocks, but gnushogi will still make a move.
1022    After a mate or draw when playing against gnushogi, if  you back  up
1023 with  the  Backward  button,  the clocks are reset (because gnushogi
1024 has exited and must be restarted).
1026    The game parser recognizes only algebraic notation.
1029    AUTHORS
1032    Original authors of XBoard:  Chris Sears and Dan Sears.
1034    Enhancements for XBoard (Version 2.0):  Tim Mann.
1036    Conversion to XShogi (Version 1.1):  Matthias Mutz.
1038    Current maintainer: Mike Vanier.
1041    COPYRIGHT INFORMATION
1044    XShogi borrows its piece bitmaps from CRANES Shogi.
1046    Copyright 1991 by Digital Equipment Corporation, Maynard,
1047 Massachusetts.  Enhancements Copyright 1992 Free Software Foundation,
1048 Inc.  Enhancements Copyright 1993 Matthias Mutz.  Further enhancements
1049 copyright 1999 by Michael Vanier and the Free Software Foundation, Inc.
1051    The following terms apply to Digital Equipment Corporation's
1052 copyright interest in XBoard:
1054    All Rights Reserved
1056    Permission to use, copy, modify, and distribute this software and its
1057 documentation for any purpose and without fee is hereby granted,
1058 provided that the above copyright notice appear in all copies and that
1059 both that copyright notice and this permission notice appear in
1060 supporting documentation, and that the name of Digital not be used in
1061 advertising or publicity pertaining to distribution of the software
1062 without specific, written prior permission.
1064    DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1065 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1066 EVENT SHALL DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1067 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
1068 USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
1069 OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1070 PERFORMANCE OF THIS SOFTWARE.
1072    The following terms apply to the enhanced version of XShogi
1073 distributed by the Free Software Foundation:
1075    This file is part of XSHOGI.
1077    XSHOGI is distributed in the hope that it will be useful, but WITHOUT
1078 ANY WARRANTY.  No author or distributor accepts responsibility to anyone
1079 for the consequences of using it or for whether it serves any particular
1080 purpose or works at all, unless he says so in writing.  Refer to the
1081 XSHOGI General Public License for full details.
1083    Everyone is granted permission to copy, modify and redistribute
1084 XSHOGI, but only under the conditions described in the XSHOGI General
1085 Public License. A copy of this license is supposed to have been given
1086 to you along with XSHOGI so you can know your rights and
1087 responsibilities.  It should be in a file named COPYING.  Among other
1088 things, the copyright notice and this notice must be preserved on all
1089 copies.
1091 \x1f
1092 File: gnushogi.info,  Node: References and links,  Next: Acknowledgements,  Prev: xshogi,  Up: Top
1094 References and links
1095 ********************
1097    There are very few English-language books for people learning shogi.
1098 The two I recommend are:
1101   1. `Shogi for Beginners, 2nd. Edition', by John Fairbairn.  This is a
1102      superb beginner's book in every way, covering all phases of the
1103      game.  It was out of print for a long time, but has now been
1104      reprinted and is available either from Kiseido
1105      (`http://www.labnet.or.jp/~kiseido') or from George Hodges (see
1106      below).
1108   2. `The Art of Shogi', by Tony Hoskings.  This is one step up from the
1109      Fairbairn book.  It covers a lot of ground, and is especially
1110      noteworthy for its detailed treatment of opening lines.  You can
1111      order this book from Amazon.com's UK branch
1112      (`http://www.amazon.co.uk').
1116    Another book you may find is `Shogi: Japan's Game of Strategy' by
1117 Trevor Leggett.  This book is very elementary and is somewhat outdated,
1118 having been published first in 1966.  However, it does feature a paper
1119 shogi board and punch-out pieces, so if you want a really cheap shogi
1120 set you might pick this book up.  It is still in print.
1122    Two books that are no longer in print but are definitely worth
1123 getting if you find them are `Guide to Shogi Openings' and `Better
1124 Moves for Better Shogi', both by Aono Teriuchi.  They are published in a
1125 bilingual edition (English/Japanese) and are the only books on shogi in
1126 English written by a Japanese professional shogi player.  John Fairbairn
1127 did the translation from Japanese to English.
1129    Shogi sets are available from:
1132      George F. Hodges
1133      P.O. Box 77
1134      Bromley, Kent
1135      United Kingdom BR1 2WT
1138    George also sells equipment for all the historical shogi variants
1139 (*note Shogi variants::.) (except for Kyoku tai shogi) and also sells
1140 back issues of the magazine "Shogi" which he published for 70 issues in
1141 the late 70's to late 80's.  This magazine is STRONGLY recommended; it
1142 contains more information about shogi in English than you will ever
1143 find anywhere else.
1145    Here are some useful URLs:
1148 Pieter Stouten's shogi page: `http://www.halcyon.com/stouten/shogi.html'
1149      This is the main shogi-related site on the internet, with links to
1150      almost all the other sites.
1152 Roger Hare's shogi page: `http://www.ed.ac.uk/~rjhare/shogi'
1153      This has lots of information, including full rules to most of the
1154      shogi variants.
1156 Patrick Davin's Shogi Nexus: `http://www.vega.or.jp/~patrick/shogi/'
1157      There's lots of cool stuff on this site; my favorite is the
1158      extensive collection of Tsume-shogi (mating) problems, both for
1159      beginners and more advanced players.
1161 Steve Evans' shogi page: `http://www.netspace.net.au/~trout/index.html'
1162      Steve has written a program that plays almost all of the shogi
1163      variants, unfortunately it only runs on Windows :-(
1165 Hans Bodlaender's chess variant pages: `http://www.cs.ruu.nl/~hansb/d.chessvar'
1166      This page has an almost unimaginable variety of rules for different
1167      chess variants, including many shogi variants (historical and
1168      non-historical).
1171 \x1f
1172 File: gnushogi.info,  Node: Acknowledgements,  Next: Bugs,  Prev: References and links,  Up: Top
1174 Acknowledgements
1175 ****************
1177    I would like to thank the following people:
1180    * Matthias Mutz, who originally developed GNU shogi as a spin-off of
1181      GNU chess and who very kindly let me take over the maintenance of
1182      this very interesting project.
1184    * Richard Stallman and the Free Software Foundation, for creating an
1185      organization where anyone can contribute software for the common
1186      good of all, for making GNU/Linux possible, and especially for
1187      writing emacs and gcc, without which my working life would be
1188      intolerable.
1190    * Georges Hodges, for starting the Shogi Association in England,
1191      without which I would probably never have heard of shogi, for
1192      supplying shogi equipment, for publishing the excellent magazine
1193      "Shogi" (now sadly defunct), for personally answering all my silly
1194      questions by mail, and for being the ambassador of shogi to the
1195      West.
1197    * Pieter Stouten, for having the most comprehensive shogi site on the
1198      World Wide Web `http://www.halcyon.com/stouten/shogi.html', and for
1199      maintaining the shogi-l mailing list.  Go to Pieter's web site for
1200      more information on subscribing to the list.  Also thanks to
1201      everyone who contributes and has contributed to that list.
1203    * Matt Casters, for testing GNU shogi.  Matt and I will be working
1204      together on improving the solution engine in future versions of
1205      this program.
1209 \x1f
1210 File: gnushogi.info,  Node: Bugs,  Next: Index,  Prev: Acknowledgements,  Up: Top
1212 Bugs
1213 ****
1215    The motto of GNU shogi is "100% bug-free or you don't pay!" :-)  In
1216 the extremely unlikely case (*ahem*) that you do find a bug, please
1217 send me (Mike Vanier) an email at <mvanier@bbb.caltech.edu>.  Also, feel
1218 free to send me comments, complaints, out-and-out raves, suggestions,
1219 plane tickets to Hawaii, and/or large suitcases filled with unmarked,
1220 untraceable hundred-dollar bills.
1222 \x1f
1223 File: gnushogi.info,  Node: Index,  Prev: Bugs,  Up: Top
1225 Index
1226 *****
1228 * Menu:
1230 * Acknowledgements:                      Acknowledgements.
1231 * Books:                                 References and links.
1232 * Chu Shogi:                             Shogi variants.
1233 * Dai Shogi:                             Shogi variants.
1234 * Dai-dai Shogi:                         Shogi variants.
1235 * Draws:                                 Draws.
1236 * Drops:                                 Drops.
1237 * GPL:                                   License.
1238 * Handicaps:                             Handicaps.
1239 * Introduction:                          Introduction.
1240 * Kyoku Tai Shogi:                       Shogi variants.
1241 * License:                               License.
1242 * Mailing lists:                         References and links.
1243 * Maka-dai-dai Shogi:                    Shogi variants.
1244 * Opening setup:                         The opening setup.
1245 * Piece moves:                           The moves of the pieces.
1246 * Piece promotion:                       Promotion of pieces.
1247 * References:                            References and links.
1248 * Rules:                                 The rules of shogi.
1249 * Sample game:                           Sample game.
1250 * Shogi variants:                        Shogi variants.
1251 * Shogi vs. Chess:                       Differences between shogi and chess.
1252 * Tai Shogi:                             Shogi variants.
1253 * Tenjiku Shogi:                         Shogi variants.
1254 * Tori Shogi:                            Shogi variants.
1255 * Variants:                              Shogi variants.
1256 * Wa Shogi:                              Shogi variants.
1257 * Web sites:                             References and links.
1258 * Winning the game:                      Winning the game.
1259 * gnushogi:                              gnushogi.
1260 * xshogi:                                xshogi.