home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 1 / crawlyvol1.bin / bbs / getkey1 / getkey.doc next >
Text File  |  1994-02-23  |  3KB  |  99 lines
  1. GETKEY.TTP
  2. A utility for Tomshell users
  3. Copyright 23 February 1994 by GRUNT Software and Rich Tietjens
  4. Version 1.00 Copyright 13 June 1993, GRUNT Software and Rich Tietjens
  5.  
  6. DISCLAIMER:  If it screws up, I ain't responsible.  Period.
  7.  
  8. FREEWARE NOTICE:  This program and the documentation is freeware.  It is
  9. copyrighted and may not be sold for profit, nor modified or altered in
  10. anyway.  You may distribute the package freely (the package consists of
  11. the GETKEY.TTP program and this documentation file, GETKEY.DOC).
  12. Private BBSes which charge a fee for access may _NOT_ place this file for
  13. download.  Pay services such as but not limited to GEnie, CompuServe, and
  14. Delphi may carry this archive for download.  Public Domain and Shareware
  15. libraries may include the archive on disks and charge a nominal copying
  16. fee.
  17.  
  18. If you are a BBS sysop and you charge a fee for access, but think you may
  19. qualify as a "pay service such as GEnie," the test is simple:  If you are
  20. paying commercial telephone rates for the BBS phone line, you qualify as a
  21. pay service.  If you are paying private phone charges only, and you charge
  22. an access fee, then you do not qualify and may not make this file available
  23. for download.
  24.  
  25. OPERATION:
  26.  
  27. Place the GETKEY.TTP program anywhere you want to.  You must run it from
  28. a Tomshell (and since it's designed to work especially with Tomshell,
  29. there isn't much point in doing it any other way!).
  30.  
  31. GETKEY will accept a single keypress, write out a small Tomshell
  32. batch file to pass the value of the key to the Tomshell environmental
  33. variable "kp", and then exit.  Possible values are any of the usual
  34. letters, numbers, and punctuation, plus "RETURN", "ESC", "BS", "TAB",
  35. and "DEL".  Due to the way the ST handles keyboard input, the HELP,
  36. UNDO, INSERT, CLR/HOME, cursor, and function keys all generate a
  37. value of zero, making it impossible to determine which one was
  38. pressed using GETKEY.
  39.  
  40. You may also use GETKEY to display a menu; it accepts an optional
  41. parameter on the command line, which should be a full pathname for the
  42. menu.  GETKEY will display the menu file on the screen.  The menu file
  43. may contain VT-52 codes in addition to the usual printable characters.
  44. If no filename is passed, GETKEY will skip over that section of the
  45. code.
  46.  
  47. Here's an example command line for Tomshell:
  48.  
  49. GETKEY.TTP c:\bbs\reader.men
  50.  
  51. The menu might look like:
  52.  
  53. Select a FZDT configuration:
  54. [1]    Rich's FreezeDried Terminal
  55. [2] Paul's FizzDizz
  56. [3] Kathy's FZDT Boutique
  57.  
  58. An example output file (always named "KP.TOM") looks like:
  59.  
  60. set kp n
  61.  
  62. and you would assemble a short routine looking like the following to
  63. select from a menu of 3 items:
  64.  
  65. GETKEY.TTP c:\bbs\reader.men
  66. kp
  67. if $kp == 1 then goto RICH
  68. if $kp == 2 then goto PAUL
  69. if $kp == 3 then goto KATHY
  70. if $kp < 1 or $kp > 3 then system
  71.  
  72. :RICH
  73. rich.tom
  74.  
  75. :PAUL
  76. paul.tom
  77.  
  78. :KATHY
  79. kathy.tom
  80.  
  81. GETKEY.TTP is very fast and will overwrite the old output file each time
  82. it is run.  It takes only a second to create the file.
  83.  
  84. FEEDBACK:
  85.  
  86. If you don't understand anything in the documentation, or if you have
  87. comments or questions about the operation of this program, send feedback
  88. to:
  89.  
  90.  Rich Tietjens at
  91.  Fido node 1:3807/110
  92.  PrivacyNet node 30:1000/10
  93.  AtariNet node 51:2/10
  94.  RoverNet node 66:660/912
  95.  AdultLinks node 69:1502/10
  96.  NeST node 90:301/20
  97.  GLP-Net node 386:318/100
  98.  
  99.