home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 January / usenetsourcesnewsgroupsinfomagicjanuary1994.iso / sources / games / volume13 / okbridge / part05 / okbridge.help < prev    next >
Text File  |  1992-01-12  |  11KB  |  314 lines
  1. # okbridge.help -- help file for the okbridge program
  2. #  
  3. # Copyright (C) 1990,1991 by Matthew Clegg
  4. # 
  5. # This program may be copied and distributed freely.  Please do not
  6. # charge money for this program or for any program derived from it.
  7. # If you modify this program, then include a notice stating plainly
  8. # that your program is derived from the okbridge program and is not
  9. # the same as the official okbridge program.
  10. #
  11. # I welcome any suggestions for improvement to okbridge, and 
  12. # I would be especially happy to receive improved source code.
  13. # If you have comments or suggestions, or if you would like to
  14. # join the okbridge mailing list, then write to
  15. #
  16. #   mclegg@cs.ucsd.edu
  17. #
  18. #
  19. # The help information in this file is organized as a series of topics.
  20. # The first entry in the file is interpreted to be the main topic, 
  21. # i.e., it is the entry which is displayed if no particular keyword 
  22. # is given.  Each topic entry has a header line which contains an 
  23. # identifying keyword and a descriptive phrase.  This is followed 
  24. # by the body of the entry and is terminated by an end-of-entry line.  
  25. #
  26. # The format of an entry is
  27. #
  28. # <keyword> <phrase>
  29. # help text
  30. # more help text
  31. # ...
  32. # last help text
  33. # --
  34. #
  35. # Comment lines such as this one are not printed in the help display.
  36. # A page break is given by placing the '^' character on a line by itself.
  37. #
  38. main          A general description of the program
  39.  
  40.                     Welcome to OKBRIDGE, version 1.3
  41.  
  42.  
  43.      This is a computer-moderated bridge program.  It allows four
  44. people at different locations on the Internet to play bridge together.
  45. The computer shuffles the cards and communicates bids and plays between
  46. the players.
  47.  
  48.  
  49.      The help system is organized as a series of topics, each
  50. identified by a keyword.  To obtain information on a particular topic,
  51. just type '/HELP topic'.  The information displayed on the screen
  52. reflects the current state of the game and is meant to be
  53. self-explanatory.  The input to the program is command-oriented.  See
  54. the topic '/help input' for more information on this subject.
  55.  
  56.  
  57.      Good luck at the bridge table!
  58.  
  59. --
  60. bidding     information on how to enter a bid
  61.  
  62.               Information about Bidding
  63.                       ----------- ----- -------
  64.  
  65. The format of a bid is one of the following:
  66.  
  67.      <level> <trump>
  68.      DOUBLE               (or X)
  69.      REDOUBLE             (or XX)
  70.      PASS                 (or P)
  71.  
  72. where 
  73.      <level> is either 1, 2, 3, 4, 5, 6, or 7
  74.  
  75.      <suit>  is one of
  76.          NOTRUMP  (or NT      or N)
  77.          SPADES   (or SPADE   or S)
  78.          HEARTS   (or HEART   or H)
  79.          DIAMONDS (or DIAMOND or D)
  80.          CLUBS    (or CLUB    or C)
  81. examples
  82.      P, 1C, 1 CLUB, 1N, 1NT, 1 NOTRUMP, 2H, 2 HEARTS, X, DOUBLE, XX
  83. --
  84. commands      Commands for controlling the program
  85.  
  86.      /BELL [ON|OFF]
  87.        By default, the okbridge program rings the terminal's bell whenever
  88.        it requests input from you.  However, this can be disabled by
  89.        typing '/BELL OFF'.  The state of the bell can be toggled with ^G.
  90.  
  91.      /CLAIM [n]
  92.        This command 'claims' n additional tricks for the declarer.
  93.        If n is omitted, then all remaining tricks are claimed.
  94.        The other players are shown the declarer's hand and are
  95.        asked whether or not they agree to the declarer's request.
  96.        If both agree, then the hand is ended early.  This command can
  97.        be used only by the declarer and only when it is declarer's or
  98.        dummy's turn to play.
  99.  
  100.      /DEFAULT [ON | OFF]
  101.        This command controls whether or not defaults will be provided
  102.        for bids, plays and questions.  This mode can be toggled with ^D.
  103.  
  104. ^
  105.      /HELP [topic]
  106.        Type '/HELP' alone to obtain general help, or type
  107.        '/HELP topic' to obtain help about a particular topic.
  108.  
  109.      /LOG [filename]
  110.        Typing '/LOG filename' causes this hand and subsequent hands
  111.        to be written to the file with name 'filename'.  Omitting
  112.        'filename' causes the current log file to be closed.
  113.  
  114.      /PING
  115.        Sends an invisible message to each of the other players, which is
  116.        automatically echoed.  Reports the round-trip communication time.
  117.  
  118.      /PROMPT [ON|OFF]
  119.        By default, the dummy is asked to press RETURN after the end
  120.        of each trick.  This allows the dummy to see each trick as
  121.        it is played.  This prompting can be disabled by typing
  122.        '/PROMPT OFF' (convenient if you need to run to the wc :-)
  123.        The prompt mode can be toggled with ^P.
  124.  
  125. ^
  126.      /QUIT
  127.        Terminates the program.
  128.  
  129.      /REVIEW
  130.        Displays the bidding for review.  This is intended to be used
  131.        during the playing mode.  This command can be abbreviated with ^B.
  132.  
  133.      /TALK message
  134.        Sends a short message to the other players.  This command can be used
  135.        when the program is waiting for you to enter a bid or a play.  
  136.        Not needed if the word 'TALK' is displayed to the left of the cursor.
  137.  
  138. --
  139. controls    Special control characters recognized by the program
  140. Special control characters recognized by the program
  141. ------- ------- ---------- ---------- -- --- -------
  142.  
  143.  ^B   When used during the play of a hand, the bidding is displayed
  144.       for review.
  145.  
  146.  ^C   Quits the program.  (The program requests confirmation first.)
  147.  
  148.  ^D   Toggles the default input mode.  See the /DEFAULT command.
  149.  
  150.  ^G   Toggles the bell.  See the /BELL command.
  151.  
  152.  ^P   Toggles the prompt.  See the /PROMPT command.
  153.  
  154.  ^R   Refreshes the screen.
  155.  
  156.  ^T   Returns to talk mode if you have been asked to bid or play.
  157.  
  158.  ESC  Erases the input which has been typed so far.
  159.  
  160. In addition, if you press RETURN without typing anything, the program will
  161. supply a default input, which can then be entered by pressing RETURN again.
  162.  
  163. --
  164. copyright     Copyright notice for the program
  165.                 Copyright Notice
  166.                     --------- ------
  167.  
  168. Copyright (C) 1990,1991 by Matthew Clegg
  169.  
  170. This program may be copied and distributed freely.  Please do not
  171. charge money for this program or for any program derived from it.
  172. If you modify this program, then include a notice stating plainly
  173. that your program is derived from the okbridge program and is not
  174. the same as the official okbridge program.
  175.  
  176. I welcome any suggestions for improvement to okbridge, and I would be
  177. especially happy to receive improved source code.  If you have
  178. comments or suggestions, or if you would like to join the okbridge
  179. mailing list, then write to
  180.  
  181.    mclegg@cs.ucsd.edu
  182.  
  183. --
  184. email        Commands specific to email duplicate bridge
  185.      /DEAL [nhands]
  186.        This command can only be used by north when playing Email
  187.        duplicate bridge.  It causes nhands boards to be dealt and
  188.        played.  After they have been played, the results can be
  189.        /SAVEd and emailed to another foursome for play.
  190.  
  191.      /LOAD filename
  192.        This command can only be used by north when playing Email
  193.        duplicate bridge.  It causes a series of boards to be read
  194.        from the file "filename".  
  195.  
  196.      /SAVE filename
  197.        This command causes the set of boards which have been played
  198.        so far to be saved to the file with name filename.  These
  199.        boards can then be emailed to another foursome for competitive
  200.        play.  Note that the /SAVE command can be used by any player
  201.        at any time.  However, the previous results of play by other
  202.        foursomes will only be recorded if /SAVE is used by north.
  203.  
  204.      /REPLAY filename
  205.        First /LOAD's "filename".  After the boards have been played,
  206.        automatically saves them along with the results back to "filename".
  207. --
  208. input         General info about entering input
  209.  
  210.               How to Enter Input
  211.               --- -- ----- -----
  212.  
  213. During normal operation, the bridge program is always in one of
  214. three 'input modes'.  The input which you type is interpreted according
  215. to the input mode, which is displayed at the beginning of the line 
  216. containing the cursor.  The input modes are
  217.  
  218. Mode       Interpretation
  219. ----       --------------
  220. BID       The program is expecting you to enter your bid.
  221. PLAY       The program is expecting you to enter the card you wish to play.
  222. TALK       Any text that you enter will be transmitted to the other players.
  223.  
  224. As you type your text, you may use the backspace key to erase the last
  225. character.  The ESC key will erase all of the text you have typed.
  226.  
  227. There are number of commands which can be given to the program in any 
  228. input mode.  For information on these commands, type '/help commands'.
  229.  
  230. Also, there are a number of special control-characters which are
  231. recognized by the program.  For information about these, type 
  232. '/help controls.'
  233.  
  234. --
  235. maillist        Information about the okbridge mailing lists
  236.  
  237.               The Okbridge Mailing Lists
  238.                       --- -------- ------- -----
  239.  
  240. okbridge@cs.ucsd.edu
  241.   This list is intended for arranging bridge games.
  242.  
  243. okbridge-pgm@cs.ucsd.edu
  244.   This list is intended for announcing new bridge playing software and
  245.   updates to old bridge software and for discussing issues in computer
  246.   moderated bridge.
  247.  
  248. To join either list, send a message to the corresponding email address
  249. whose body contains the single line
  250.  
  251.   ADD <list-name>
  252.  
  253. where <list-name> is okbridge or okbridge-pgm, as appropriate.
  254.  
  255. --
  256. network       Setting up the network communications
  257.  
  258.              Network Information
  259.              ------- -----------
  260.  
  261. Before the game can begin, the players must agree that one person will
  262. act as the 'server'.  All messages transmitted by the program are then
  263. mediated through this server.  When starting the program, the internet
  264. name of the server must be specified on the command line.
  265.  
  266. If you usually play with the same four people, then you may want to
  267. put the name of the server and your usual position into the .okbridgerc
  268. file.  The .okbridgerc file contains default information which is read
  269. by the program before it starts.
  270.  
  271.  
  272. --
  273. playing   Information about how to enter a play
  274.               Information about Playing
  275.               ----------- ----- -------
  276.  
  277. A card is played by writing
  278.      <suit> <rank>
  279.  
  280. where
  281.      <suit>  is one of
  282.          SPADES   (or SPADE   or S)
  283.          HEARTS   (or HEART   or H)
  284.          DIAMONDS (or DIAMOND or D)
  285.              CLUBS    (or CLUB    or C)
  286.  
  287.      <rank>  is one of
  288.          2, 3, ..., 9, TEN (or T), JACK (or J), QUEEN (or Q),
  289.          KING (or K), ACE (or A)
  290.  
  291. Some examples of cards are
  292.      CT, C T, C TEN, CLUB T, CLUB TEN, S3, SPADE3, SPADE 3
  293.  
  294. Note that the order <suit> <rank> used in playing is reversed 
  295. from the order <level> <trumpsuit> used in bidding.
  296. --
  297. slam          A special message when a slam is made
  298.  
  299.  
  300.  
  301.  
  302.      Oh, what a beautiful mornin'!
  303.      Oh, what a beautiful day!
  304.      I got a beautiful feelin'
  305.      Ev'rything's goin' my way.
  306.      Oh, what a beautiful day.
  307.  
  308.      ...
  309.  
  310.               
  311.           words by Oscar Hammerstein II
  312.               from the musical, _Oklahoma_
  313.  
  314.