home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 October / usenetsourcesnewsgroupsinfomagicoctober1994disk2.iso / misc / volume18 / notation / part02 / notation.doc < prev   
Text File  |  1991-04-13  |  12KB  |  463 lines
  1.  
  2.  
  3.  
  4. notation(n)       MISC. REFERENCE MANUAL PAGES        notation(n)
  5.  
  6.  
  7.  
  8. NAME
  9.      notation - transform chess notation
  10.  
  11.  
  12. SYNOPSYS
  13.      notation [input file] [-o output file] [options...]
  14.  
  15.  
  16. DESCRIPTION
  17.      This program reads chess games,  either  full  algebraic  or
  18.      shortened (ie Nf1-g3 or Ng3) and is able to ouptut the board
  19.      after any move, in either ascii , postscript,  nroff,  latex
  20.      or  xchess  save format. This program is also multi-lingual:
  21.      it handles english, french,  spanish,  german,  italian  and
  22.      dutch symbols.
  23.  
  24.  
  25. OPTIONS
  26.      Command line options:
  27.  
  28.         -a
  29.              algebraic move notation output
  30.  
  31.         -s
  32.              shortened move notation output
  33.  
  34.      -f <language>
  35.              specifies  the  chess  symbol  input  language.  The
  36.              language   can  be  any of french, english, italian,
  37.              spanish, german, dutch.
  38.  
  39.         -t <language>
  40.              specifies the chess  symbol  output  language.  Same
  41.              options as input language.
  42.  
  43.      <inputfile>
  44.              specifies the  input  file.  If  none,  keyboard  is
  45.              assumed.
  46.  
  47.         -o <outputfile>
  48.              specifies  the  output  file.  If  none,  screen  is
  49.              assumed.
  50.  
  51.      -c <number>[,<number]
  52.              specifies the number  of  the  moves  at  which   to
  53.              display  the  board.  If none, board is displayed at
  54.              end of file. Several numbers may be specified, as  a
  55.              comma-separated list.
  56.  
  57.      -e <number>
  58.              display the board at the move number and then stops
  59.  
  60.  
  61.  
  62.  
  63. Sun Release 4.1   Last change: 10 December 1990                 1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. notation(n)       MISC. REFERENCE MANUAL PAGES        notation(n)
  71.  
  72.  
  73.  
  74.         -b
  75.              display only the board, not the moves
  76.  
  77.         -d <drivername>
  78.              specifies the output driver. It can be  any  of  the
  79.              following:  ascii,  postscript,  tex,  roff,  xchess
  80.              (xchess or xboard save  format),  gnu  (gnuan  input
  81.              format).
  82.  
  83.         -h
  84.              displays help screen
  85.  
  86.  
  87. INPUT LANGUAGE
  88.            The input language has four  types  of  input:  moves,
  89.      move numbers, comments and keywords. All these are separated
  90.      by blanks, TAB or RC.  Commas are not accepted.
  91.  
  92.  
  93.      move format:
  94.              The moves are accepted  in  algebraic  or  shortened
  95.              algebraic  notation.  That  means that the following
  96.              are equivalent and accepted  Nf1-g3  N-f1xg3,  Nxg3,
  97.              Ng3.  The  ugly  english notation P-K4 is not under-
  98.              stood, neither by the program nor me.
  99.  
  100.              Nota: provided you  remove  the  three  first  line,
  101.              xchess  save  format is accepted.  Also you can have
  102.              trailing comments to  move,  provided  there  is  no
  103.              blanks. So Kg4!!, Ra5++ are correct, but not Kg4 !!,
  104.              Ra5 ++ because of the  separating  blank.  A  future
  105.              version might handle these move comments, as well as
  106.              + ++, mate, white resigns etc... Castling is  recog-
  107.              nized  with the following 0-0 O-O o-o 0-0-0 O-O-O o-
  108.              o-o. "En passant" and promotion  are  now  correctly
  109.              handled.  For  "en  passant", you just indicate them
  110.              move and it is correctly parsed ex:  "d5-d7  e5xd6".
  111.              Promotion is indicated with the "=" sign followed by
  112.              the new piece name. So you just write  "a7-a8=Q"  or
  113.              "d8=K".
  114.  
  115.              For  example,  see  the  files   algebraic.txt   and
  116.              shortened.txt
  117.  
  118.  
  119.      move numbers:
  120.              move numbers are in the form 23.  or  36.  The  full
  121.              point  is optional. Move numbers are checked against
  122.              internal move counter.
  123.  
  124.  
  125.      comments:
  126.  
  127.  
  128.  
  129. Sun Release 4.1   Last change: 10 December 1990                 2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. notation(n)       MISC. REFERENCE MANUAL PAGES        notation(n)
  137.  
  138.  
  139.  
  140.              anything else, except keywords, must be enclosed  in
  141.              brackets  or  parenthesis  [Here  Karpov made a very
  142.              bright move ...] (this is also a comment).  Comments
  143.              are  skipped out.  A future version might incorporte
  144.              them in the output.
  145.  
  146.  
  147.      keywords:
  148.              you can insert keywords in the input  text  to  pre-
  149.              cisely  define  what you want: displaying the board,
  150.              configuring it... Keywords are detailled in the next
  151.              section.
  152.  
  153.  
  154. KEYWORDS
  155.      All keywords are prefixed with @
  156.  
  157.      @startplay
  158.              begins the play. Obligatory after a @configxxx  key-
  159.              word.
  160.  
  161.      @clearboard
  162.              clears the board. Used prior to any @configxxx.
  163.  
  164.      @showboard
  165.              displays the board. Can be used anywhere
  166.  
  167.      @whitesmove
  168.              tells the program that is the white's turn of  play.
  169.              Useful after a @configxxx and @startplay
  170.  
  171.      @blacksmove
  172.              tells the program that it is black's turn
  173.  
  174.      @configwhite
  175.              initializes configuration of white side. Pieces  are
  176.              then  expected, in form of (optional for Pawn) name,
  177.              the position. Example @configwhite Ke3 Rg8 e4.
  178.  
  179.      @configblack
  180.              initializes configuration of black side. Pieces  are
  181.              then  expected, in form of (optional for Pawn) name,
  182.              the position. Example: @configblack Ka8 Nf6 e6.
  183.  
  184.              Note that black pieces are given in uppercase!
  185.  
  186.      @default
  187.              resets the board to the default start configuration.
  188.  
  189.      @special
  190.              all following text up to the next cariage return  is
  191.              not  processed,  but  instead  directly  print. This
  192.  
  193.  
  194.  
  195. Sun Release 4.1   Last change: 10 December 1990                 3
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. notation(n)       MISC. REFERENCE MANUAL PAGES        notation(n)
  203.  
  204.  
  205.  
  206.              allows to insert comments in  ascii  files,  or  tex
  207.              commands when tex output is selected.
  208.  
  209.      @null   Null keyword. Does nothing. Used for convenience  in
  210.              programming.
  211.  
  212.  
  213.              See the file keywords.txt for an example of keywords
  214.              use.
  215.  
  216.  
  217. NATIONAL LANGUAGES
  218.      Here are the symbols used in the  differents  languages.  ()
  219.      mean optional in the input.
  220.  
  221.  
  222.      english-name   King Queen     Rook Bishop    Knight    Pawn
  223.      english        K    Q    R    B    N    (P)
  224.      french         R    D    T    F    C    (P)
  225.      italian        R    D    T    A    C    (P)
  226.      spanish        R    D    T    A    C    (P)
  227.      german         K    D    T    L    S    (B)
  228.      dutch          K    D    T    L    P    (O)
  229.  
  230.  
  231.  
  232. DRIVERS
  233.      ascii   this is the default  driver,  it  outputs  move  and
  234.              boards.
  235.  
  236.      postscript
  237.              it  generates  a  file  using  the  font  file  Cheq
  238.              licensed  for  free  by  Adobe.  It  is only able to
  239.              display one board per run. Move are  not  displayed.
  240.              You  need  the  font  "Cheq",  freely distributed by
  241.              Adobe.  Send a  mail  to  "ps-file-server@adobe.com"
  242.              with  the body "send Programs chessfont.ps". For use
  243.              with "notation", rename the file "Cheq".
  244.  
  245.      tex     this is a latex driver. It uses the TeX/LaTeX  chess
  246.              macros designed by Piet Tutalaers "rcpt@urc.tue.nl".
  247.              The   complete   distribution   is   available    on
  248.              sol.cs.ruu.nl      (131.211.80.5)      with     path
  249.              TEX/chess.tar.Z chesscls, provided in  the  library.
  250.              Refer to your local latex guru to install it.
  251.  
  252.      roff    this is a driver for nroff output. It is crude,  but
  253.              it works. Moves and boards are displayed.
  254.  
  255.      xchess  This driver generates compatible xchess/xboard  save
  256.              files,  thus  allowing  you  to  replay  a game with
  257.              xchess.
  258.  
  259.  
  260.  
  261. Sun Release 4.1   Last change: 10 December 1990                 4
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. notation(n)       MISC. REFERENCE MANUAL PAGES        notation(n)
  269.  
  270.  
  271.  
  272.      gnu     This driver completely "bare" file,  with  only  the
  273.              algebraic  move.  It  is  suitable for any low-level
  274.              analyser, such as gnuan.
  275.  
  276.  
  277. EXAMPLES
  278.           Try the following commands:
  279.  
  280.      notation algebraic.txt
  281.              this will read the  Karpov-Kasparov  game  13  (Lyon
  282.              1990)  in  algebraic form, display move in algebraic
  283.              and display board at end of game.
  284.  
  285.      notation algebraic.txt -a
  286.              this will do the same thing, as -a stands for  alge-
  287.              braic output.
  288.  
  289.      notation algebraic.txt -s
  290.              the game will now be output in shortened algebraic
  291.  
  292.      notation shortened.txt
  293.              there is no problem to read shortened algebraic.
  294.  
  295.      notation shortened -s -o result
  296.              the moves and board will be directed to file result
  297.  
  298.      notation shortened.txt -s -t french
  299.              output will use french notation
  300.  
  301.      notation a_dutch_file -f dutch -t spanish
  302.              game will be translated form dutch to spanish
  303.  
  304.      notation shortened -c 2
  305.              board after move 2 will  be  displayed,  along  with
  306.              moves and end-of-game board
  307.  
  308.      notation shortened -e 2
  309.              board after move 2 will  be  displayed,  along  with
  310.              moves. The program will then stops
  311.  
  312.      notation shortened -c 2,5,20
  313.              board after moves 2, 5 and  20  will  be  displayed,
  314.              along with moves and end-of-game board
  315.  
  316.      notation shortened -c 2,5,20 -b
  317.              board after moves 2, 5 and  20  will  be  displayed,
  318.              with end-of-game board, but no moves.
  319.  
  320.      notation shortened -c 2,5,20 -d tex
  321.              the output will be formatted to use with latex.  You
  322.              can directly latex the output file.
  323.  
  324.  
  325.  
  326.  
  327. Sun Release 4.1   Last change: 10 December 1990                 5
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334. notation(n)       MISC. REFERENCE MANUAL PAGES        notation(n)
  335.  
  336.  
  337.  
  338.      notation shortened -c 2,5,20 -d gnu
  339.              you can now replay  the  game  by  using  xchess  -r
  340.              out.gnu.
  341.  
  342.      notation shortened -e 5 -d postscript
  343.              Now issue cat lib/Cheq out.ps | lpr to display on  a
  344.              Laser  Printer  the  board  at  move 5. You can also
  345.              issue sh print-ps out-ps.  The postcript driver does
  346.              not support the -c option.
  347.  
  348.  
  349. FILES
  350.      algebraic.txt shortened.txt keywords.txt
  351.              these are examples of input files
  352.  
  353.  
  354.      ./lib/HELPFILE
  355.              this is the on-line helpfile
  356.  
  357.  
  358.      ./lib/(Cheq Header.ps Footer.ps)
  359.              these files are needed by the postscript driver
  360.  
  361.  
  362.      ./lib/Header.tex
  363.              these file is needed by the (la)tex driver
  364.  
  365.  
  366.      ./lib/chesscls.mf
  367.              this file is used the generate the tex font
  368.  
  369.  
  370. SEE ALSO
  371.      xchess(1), chess(6), gnuchess(1), latex(1), nroff(1), lpr(1)
  372.  
  373.  
  374. DIAGNOSTICS
  375.      Errors messages are hoped to be self-explanative.
  376.  
  377.  
  378. COMMENTS
  379.      The program is quite large, due to the large use  of  tables
  380.      and  variables to control its features. The advantage is you
  381.      only need the modify  these  tables  to  customize  it:  for
  382.      instance  adding  a new language or tuning the output format
  383.      to your own needs.
  384.  
  385.  
  386. BUGS
  387.      Too many. Report them to Henry.Thomas@irisa.fr.
  388.  
  389.      The postscript driver *might* fais if you try to display the
  390.  
  391.  
  392.  
  393. Sun Release 4.1   Last change: 10 December 1990                 6
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400. notation(n)       MISC. REFERENCE MANUAL PAGES        notation(n)
  401.  
  402.  
  403.  
  404.      board  two times. Anyway, it is not designed to do this. Use
  405.      -e option to specify the move at which you want  to  display
  406.      board.
  407.  
  408.  
  409. AUTHOR
  410.      Henry    Thomas    IRISA-Rennes,    FRANCE.    E-mail     to
  411.      Henry.Thomas@irisa.fr or hthomas@irisa.fr.
  412.  
  413. THANKS
  414.      Thanks to Jacques Schuurman for  the  piece  description  in
  415.      Dutch,  Dr.  Z.   Rubinstein,  University  of  Haifa for the
  416.      Metafont files, Philippe Louarn for implementing these  mac-
  417.      ros and explaining me how to use them, Adobe Systems for the
  418.      font Cheq, and Jean-Luc Scharbarg for introducing me in  the
  419.      world of chess.
  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. Sun Release 4.1   Last change: 10 December 1990                 7
  460.  
  461.  
  462.  
  463.