From 4cf0442df5a83d28ef6089888438730241b9ccc3 Mon Sep 17 00:00:00 2001 From: Yann Dirson Date: Tue, 8 Oct 2013 22:12:02 +0200 Subject: [PATCH] Critical texinfo doc formatting fixes. * "@sp 1" everywhere look ugly today * ASCII rendering of boards requires @verbatim --- doc/gnushogi.texinfo | 210 +++++++++----------------------------------------- 1 files changed, 37 insertions(+), 173 deletions(-) diff --git a/doc/gnushogi.texinfo b/doc/gnushogi.texinfo index d84d522..d363f82 100644 --- a/doc/gnushogi.texinfo +++ b/doc/gnushogi.texinfo @@ -132,9 +132,7 @@ Vanier, the current maintainer of GNU shogi. My email address is @email{mvanier@@cs.caltech.edu}. -GNU shogi is actually two programs: - -@sp 1 +GNU Shogi is actually two programs: @table @samp @@ -146,8 +144,6 @@ is the X-windows graphical interface to gnushogi. @end table -@sp 1 - Since xshogi invokes gnushogi, most players will just type ``xshogi'' and start playing. @@ -169,24 +165,18 @@ game... it is at least as interesting.'' --- Alexander Alekhine @* (quoted in David Pritchard, @cite{The Encyclopedia of Chess Variants}) -@sp 1 - ``... shogi [is] by far the most complex form of chess that has ever achieved widespread popularity.'' --- R. Wayne Schmittberger, @cite{New Rules for Classic Games} @end quotation -@sp 1 - Shogi is the version of chess played in Japan. It is strikingly different from standard chess (which I shall refer to henceforth as ``international chess'') and also to all other regional variants, because captured pieces can re-enter play on the side of the capturer. This has several interesting effects on the play of the game: -@sp 1 - @enumerate @item Shogi is much more complex than international chess, at least in @@ -215,8 +205,6 @@ Most importantly: it's more fun than other forms of chess :-) @end enumerate -@sp 1 - Shogi is extremely popular in Japan; it has been estimated that 20 million Japanese can play shogi, of which perhaps 1 million are active players. It is even more popular there than the game of go, Japan's @@ -367,26 +355,28 @@ promoted pawn is usually known as a ``Tokin''. The opening setup for shogi is as follows: @ifnottex +@verbatim 9 8 7 6 5 4 3 2 1 -+---------------------------------------------+ @* -| wL | wN | wS | wG | wK | wG | wS | wN | wL | a @* -+---------------------------------------------+ @* -| | wR | | | | | | wB | | b @* -+---------------------------------------------+ @* -| wP | wP | wP | wP | wP | wP | wP | wP | wP | c @* -+---------------------------------------------+ @* -| | | | | | | | | | d @* -+---------------------------------------------+ @* -| | | | | | | | | | e @* -+---------------------------------------------+ @* -| | | | | | | | | | f @* -+---------------------------------------------+ @* -| bP | bP | bP | bP | bP | bP | bP | bP | bP | g @* -+---------------------------------------------+ @* -| | bB | | | | | | bR | | h @* -+---------------------------------------------+ @* -| bL | bN | bS | bG | bK | bG | bS | bN | bL | i @* +---------------------------------------------+ +| wL | wN | wS | wG | wK | wG | wS | wN | wL | a ++---------------------------------------------+ +| | wR | | | | | | wB | | b ++---------------------------------------------+ +| wP | wP | wP | wP | wP | wP | wP | wP | wP | c ++---------------------------------------------+ +| | | | | | | | | | d ++---------------------------------------------+ +| | | | | | | | | | e ++---------------------------------------------+ +| | | | | | | | | | f ++---------------------------------------------+ +| bP | bP | bP | bP | bP | bP | bP | bP | bP | g ++---------------------------------------------+ +| | bB | | | | | | bR | | h ++---------------------------------------------+ +| bL | bN | bS | bG | bK | bG | bS | bN | bL | i ++---------------------------------------------+ +@end verbatim @end ifnottex @c The following TeX macros are taken with permission from @@ -430,8 +420,6 @@ The opening setup for shogi is as follows: \endVerbatim @end tex -@sp 1 - Here, ``b'' stands for ``black'' and ``w'' stands for ``white'', so that, for instance, ``bL'' means ``black lance''. The numbers above the files and the letters to the right of the ranks represent the most @@ -481,8 +469,6 @@ does not promote. @end table -@sp 1 - The three ranks furthest away from each player constitute his/her ``promotion zone''. A player may, but is not required to, promote a piece after making a move in which the piece begins and/or ends in the @@ -490,8 +476,6 @@ promotion zone. Thus you can promote a piece when moving the piece into the promotion zone, out of the promotion zone, or entirely within the promotion zone. Promotion is mandatory in these cases: -@sp 1 - @enumerate @item You must promote a pawn or a lance after moving it to the last rank. @@ -501,8 +485,6 @@ two ranks. @end enumerate -@sp 1 - These forced promotions ensure that a piece cannot be moved to a square from which it would have no further move. @@ -592,8 +574,6 @@ depleted as in chess, because captured pieces are constantly re-entering play as a consequence of the drop rule. In fact, most of the ways a game can be drawn in chess are not allowed in shogi: -@sp 1 - @itemize @bullet @item Draws cannot be offered. @@ -607,12 +587,8 @@ if you can't move, you lose. @end itemize -@sp 1 - There are only two legal ways in which a draw can occur: -@sp 1 - @enumerate @item A position (including the pieces in hand) occurs 4 times with the same @@ -643,8 +619,6 @@ zone. @end enumerate -@sp 1 - @c Handicaps. @node Handicaps, Notes for chess players, Draws, The rules of shogi @@ -679,8 +653,6 @@ which the handicap is appropriate. These rules are taken from the books Tony Hoskings (@pxref{References and links}) and, I believe, represent current Japanese practice. -@sp 1 - @enumerate @item @@ -723,8 +695,6 @@ and both silvers. This is called an ``eight-piece'' handicap. @end enumerate -@sp 1 - Another advantage of playing handicap games is that the handicaps alter the optimal strategy for both players. For instance, handicaps all have their own opening lines which may bear little or no resemblance to those @@ -747,8 +717,6 @@ pieces will soon even out. Here are a few miscellaneous things that may confuse chess players. Some of these have been mentioned elsewhere, but they bear repeating. -@sp 1 - @enumerate @item There is no queen. @@ -764,8 +732,6 @@ them. @end enumerate -@sp 1 - @c @c Sample game. @c @@ -948,27 +914,24 @@ check), your opponent moves, and you move to give checkmate is called a three-mover. Here is a really trivial three-mover: @ifnottex - - - 3 2 1 @* -----------------+ @* -| | | | a @* -----------------+ @* -| | | wK | b @* -----------------+ @* -| | | | c @* -----------------+ @* -| bN | | | d @* -----------------+ @* -| | | | e @* -----------------+ @* -| | bN | | f @* -----------------+ @* - -@sp 1 +@verbatim + 3 2 1 +----------------+ +| | | | a +----------------+ +| | | wK | b +----------------+ +| | | | c +----------------+ +| bN | | | d +----------------+ +| | | | e +----------------+ +| | bN | | f +----------------+ Black in hand: S, G - +@end verbatim @end ifnottex @@ -1005,8 +968,6 @@ Black in hand: 2G \endVerbatim @end tex -@sp 1 - Here, Black plays G*2b, White plays K1c, and Black plays G*1d mate. More typical tsume problems range from 5 moves to arbitrarily high numbers of moves, and they can be quite brain-busting. Tsume problems @@ -1056,8 +1017,6 @@ information about them on the internet (@pxref{References and links}). The historical variants include: -@sp 1 - @enumerate @item @@ -1128,8 +1087,6 @@ playable, assuming one has the time. @end enumerate -@sp 1 - @c @c Differences between shogi and chess. @c @@ -1151,8 +1108,6 @@ with many people who don't particularly like chess. Here are the significant differences between chess and shogi: -@sp 1 - @enumerate @item @@ -1216,12 +1171,8 @@ chess does not. @end enumerate -@sp 1 - The effects of all these differences on play include (in my opinion): -@sp 1 - @enumerate @item @@ -1247,8 +1198,6 @@ dropping a piece. @end enumerate -@sp 1 - @c -------------------- @c gnushogi. @@ -1260,22 +1209,14 @@ dropping a piece. This section describes how to run the ``gnushogi'' program. -@sp 1 - SYNOPSIS -@sp 1 - gnushogi [ [[-]a] [-b bookfile] [-B binbookfile] [-C] [-h langfile] [-L langfile] [-r length] [-R] [-s pathname] [-l pathname] [-S binbooksize] [-t] [-c size] [-T size] [-v] [-x] [-X] arg1 arg2 ] -@sp 1 - DESCRIPTION -@sp 1 - GNU shogi (gnushogi) plays a game of japanese chess (shogi) against the user or it plays against itself. @@ -1290,8 +1231,6 @@ under X windows. The program gets its opening moves from the file gnushogi.bbk which is located in a directory specified in the Makefile. To invoke the program type: -@sp 1 - @table @samp @item gnushogi -C @@ -1304,12 +1243,8 @@ xshogi compatible version raw test display version @end table -@sp 1 - TIME CONTROLS -@sp 1 - If one argument is given, it is the search time per move in [minutes:]seconds. So gnushogi 30 will generate one move every 30 seconds, while gnushogi 5:00 will generate one move every 5 minutes. @@ -1331,14 +1266,10 @@ play. For use with xshogi see the documentation on that program. @xref{xshogi}. -@sp 1 - @page BOOK -@sp 1 - The book gnushogi.tbk consists of a sequence of openings. An opening begins with a line starting with a # (the rest of the line is a comment). Following this is a series of moves in algebraic notation alternating @@ -1347,12 +1278,8 @@ after it indicating this move should never be made in this position. Moves are stored as position:move so transpositions between openings can take place. -@sp 1 - HASHFILE -@sp 1 - The hashfile if created should be on the order of 4 megabytes; you can create such a hashfile by typing ``gnushogi -c 22'' (see below). This file contains positions and moves learned from previous games. If a @@ -1361,12 +1288,8 @@ past games. Tests run so far show that it plays no worse with the hashfile than without, but it is not clear yet whether it provides a real advantage. -@sp 1 - LEGAL MOVES -@sp 1 - Note: Piece letters are determined by the language file. What is specified here is the default (English). @@ -1379,12 +1302,8 @@ to use the notation P7f where the first letter indicates the piece type the move, as in 2d2c+ or P2c+. Note that you must use capital letters for the pieces by default. -@sp 1 - COMMAND-LINE OPTIONS -@sp 1 - @table @samp @item -a @@ -1454,12 +1373,9 @@ Use xshogi display mode (the default). @end table -@sp 1 COMMANDS -@sp 1 - In addition to legal moves, the following commands can be entered at the gnushogi prompt. Note: command names are determined by the language file and may vary with the implementation. The default language is @@ -1683,8 +1599,6 @@ separate. @end table -@sp 1 - @c -------------------- @c xshogi. @@ -1696,20 +1610,12 @@ separate. This section describes how to run the ``xshogi'' program. -@sp 1 - SYNOPSIS -@sp 1 - xshogi [ options ] -@sp 1 - DESCRIPTION -@sp 1 - 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. @@ -1726,17 +1632,11 @@ 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. -@sp 1 - COMMAND-LINE OPTIONS -@sp 1 - The following command line options also correspond to X resources that you can set in your .Xdefaults file. -@sp 1 - @table @samp @item [standard Xt options] @@ -1872,14 +1772,10 @@ Turns on debugging printout. @end table -@sp 1 - @page OTHER X RESOURCES -@sp 1 - @table @samp @item initString @@ -1929,12 +1825,8 @@ If you are using a grayscale monitor, try setting the colors to: @end table -@sp 1 - COMMAND BUTTONS AND KEYS -@sp 1 - @table @samp @item Quit @@ -2041,12 +1933,8 @@ iconifies xshogi. @end table -@sp 1 - LIMITATIONS -@sp 1 - If you press the Pause button during GNU Shogi's turn, xshogi will stop the clocks, but gnushogi will still make a move. @@ -2057,12 +1945,8 @@ back up with the Backward button, the clocks are reset The game parser recognizes only algebraic notation. -@sp 1 - AUTHORS -@sp 1 - Original authors of XBoard: Chris Sears and Dan Sears. Enhancements for XBoard (Version 2.0): Tim Mann. @@ -2071,12 +1955,8 @@ Conversion to XShogi (Version 1.1): Matthias Mutz. Current maintainer: Mike Vanier. -@sp 1 - COPYRIGHT INFORMATION -@sp 1 - XShogi borrows its piece bitmaps from CRANES Shogi. Copyright 1991 by Digital Equipment Corporation, Maynard, Massachusetts. @@ -2139,8 +2019,6 @@ notice and this notice must be preserved on all copies. There are very few English-language books for people learning shogi. The two I recommend are: -@sp 1 - @enumerate @item @@ -2158,8 +2036,6 @@ from Amazon.com's UK branch (@uref{http://www.amazon.co.uk}). @end enumerate -@sp 1 - Another book you may find is @cite{Shogi: Japan's Game of Strategy} by Trevor Leggett. This book is very elementary and is somewhat outdated, having been published first in 1966. However, it does feature a paper @@ -2175,8 +2051,6 @@ did the translation from Japanese to English. Shogi sets are available from: -@sp 1 - @quotation George F. Hodges @* P.O. Box 77 @* @@ -2184,8 +2058,6 @@ Bromley, Kent @* United Kingdom BR1 2WT @end quotation -@sp 1 - George also sells equipment for all the historical shogi variants (@pxref{Shogi variants}) (except for Kyoku tai shogi) and also sells back issues of the magazine ``Shogi'' which he published for 70 issues @@ -2195,8 +2067,6 @@ find anywhere else. Here are some useful URLs: -@sp 1 - @table @asis @item Pieter Stouten's shogi page: @uref{http://www.shogi.net} @@ -2222,8 +2092,6 @@ chess variants, including many shogi variants (historical and non-historical). @end table -@sp 1 - @c ----------------- @c Acknowledgements. @c ----------------- @@ -2234,8 +2102,6 @@ chess variants, including many shogi variants (historical and non-historical). I would like to thank the following people: -@sp 1 - @itemize @bullet @item @@ -2270,8 +2136,6 @@ program. @end itemize -@sp 1 - @c ----- @c Bugs. @c ----- -- 1.7.0.4