home *** CD-ROM | disk | FTP | other *** search
/ ftp.whtech.com / ftp.whtech.com.tar / ftp.whtech.com / utilities / raggums.txt < prev    next >
Text File  |  2006-10-19  |  13KB  |  485 lines
  1. .lm10;rm70;pl60;fi;ad
  2. .SP8;CE
  3. @RAG^SOFTWARE
  4. .SP3;ce
  5. @G^U^M^S
  6. .sp3;ce
  7. @GRAM^User^Menu^System
  8. .sp10;ce
  9. CONTENTS
  10. .SP;IN+13
  11. INTRODUCTION ................^^1
  12. FAIRWARE ....................^^1
  13. GUMS OPERATION ..............^^1
  14. DISK CONTENTS ...............^^2
  15. GETTING STARTED .............^^3
  16. GUMS MENUS ..................^^4
  17. GUMS DATA ENTRY .............^^4
  18. TAILORING GUMS ..............^^5
  19. FILE AND DISK MAINTENANCE ...^^7
  20. PROGRAMMING NOTES ...........^^8
  21. .IN+0;SP12
  22. (c) Copyright 1991, R.^A.^Green.
  23. .HE ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^-%-
  24. .PA1;BP
  25. @INTRODUCTION
  26.  
  27. The RAG Software GRAM User Menu System,
  28. GUMS, extends the cartridge menu
  29. concept of the TI 99/4A to provide a
  30. user built menu of disk based programs.
  31. GUMS provides you with fast menu access
  32. to all your favorite programs on disk,
  33. and provides you with a convenient menu
  34. driven file and disk maintenance
  35. package.
  36.  
  37. You must have a fully expanded system
  38. including a GRAM device.  GUMS was
  39. built and tested on:
  40. .sp;in+5
  41. PGRAM+ Card from Horizon, 
  42. GRAM KRACKER from Miller's Graphics,
  43. .sp;in+0
  44. it should also work on:
  45. .SP;IN+5
  46. PGRAM Card from Horizon,
  47. GRAMULATOR from CaDD Electronics.
  48. .sp;in+0
  49. These devices have one feature in
  50. common, that is, each GRAM block is 8K
  51. bytes.  All TI cartridges use only 6K
  52. GROMS.  This leaves 2K bytes in each
  53. GRAM block unused, for a total of 10K
  54. bytes of unused GRAM.  GUMS uses these
  55. 2K blocks.  This means that GUMS can
  56. share your GRAM device with almost any
  57. other cartridge.  GUMS has some special
  58. features when it is sharing the GRAMS
  59. with TI Extended BASIC.  It also has
  60. special features for the multi level
  61. GRAMS of the PGRAM+ Card.
  62. .sp2;cp5
  63. @FAIRWARE
  64.  
  65. This package is a FAIRWARE release,
  66. please feel free to copy it and
  67. distribute it to your friends.  Make
  68. sure each copy you make is complete.
  69. Fairware contributions of $10 can be
  70. made to:
  71. .sp;in+15
  72. R.^A.^Green
  73. 1032 Chantenay Dr.
  74. Gloucester, ONT. CANADA
  75. K1C 2K9
  76. .in+0;sp2;cp5
  77. @GUMS^OPERATION
  78.  
  79. GUMS makes use of the builtin
  80. capabilities of the TI 99/4A GROM
  81. Operating System to take control of the
  82. system on power up or reset.  GUMS
  83. bypasses the usual colour bar screen
  84. and presents its main selection menu
  85. immediately.  The GUMS menu has four
  86. selections of its own plus all the
  87. usual entries for the cartridge that
  88. GUMS is sharing the GRAM device with.
  89. For example, if GUMS is loaded with
  90. Extended BASIC, the main menu would be
  91. as shown below.
  92. .sp;in+5
  93. A^^PROGRAM LIBRARY
  94. B^^UTILITY LIBRARY
  95. C^^FILE MAINTENANCE
  96. D^^DISK MAINTENANCE
  97. E^^TI BASIC
  98. F^^TI EXTENDED BASIC
  99. .SP;IN+0
  100. If your GRAM device is a PGRAM+ Card
  101. the main menu will have entries for all
  102. the cartridges loaded into all four
  103. levels of GRAM.
  104.  
  105. The "Program Library" and "Utility
  106. Library" are the items that provide you
  107. with easy access to your disk based
  108. programs.  Selecting either of these
  109. entries will present you with another
  110. selection menu of up to 13 of your
  111. programs.  Building these menus is
  112. described later.  You provide the text
  113. to be displayed on the menu and the
  114. device/filename of the program to be
  115. loaded and run when the item is
  116. selected.
  117.  
  118. Your programs may be E/A Option 5 type
  119. programs or may be TI Extended BASIC
  120. programs.  If the program is XB then
  121. GUMS must be sharing the GRAM device
  122. with XB.
  123.  
  124. The "File Maintenance" and "Disk
  125. Maintenance" items provide you with a
  126. convenient disk manager that uses only
  127. operations defined by the disk ROM.  It
  128. should work for all compatible disk
  129. controller cards and for most RAM
  130. disks.
  131.  
  132. Each of these four sub-menus have the
  133. following selections displayed at the
  134. bottom of the screen.
  135. .sp;in+5
  136. 1^^RUN E/A OPTION 5
  137. 2^^RUN E/A OPTION 5 (XB ENV)
  138. 3^^RUN XB PROGRAM
  139. .SP;IN+0
  140. Selecting one of these will cause GUMS
  141. to prompt you for the filename of the
  142. program to be run.  Item 2 is the same
  143. as item 1 except for the VDP setup.
  144. Item 2 is provided because some popular
  145. E/A programs are designed to be run
  146. from the Extended BASIC environment.
  147. .SP2;CP5
  148. @DISK^CONTENTS
  149.  
  150. The GUMS distribution disk contains the
  151. following files.
  152. .sp;in+5
  153. 1ST/README^^^^Getting started file
  154. EDITA1^^^^^^^^TIW Editor Segment 1
  155. EDITA2^^^^^^^^TIW Editor Segment 2
  156. FORMA1^^^^^^^^TIW Formatter
  157. GUMS^^^^^^^^^^GUMS Segment 1
  158. GUMS1^^^^^^^^^GUMS Segment 2
  159. GUMS2^^^^^^^^^GUMS Segment 3
  160. GUMS3^^^^^^^^^GUMS Segment 4
  161. GUMS4^^^^^^^^^GUMS Segment 5
  162. GUMS5^^^^^^^^^GUMS Segment 6
  163. GUMS/DOC^^^^^^GUMS Documentation
  164. GUMS/GK^^^^^^^GUMS GRAM KRACKER Overlay
  165. GUMS/PG^^^^^^^GUMS PGRAM Card Overlay
  166. GUMS/STD^^^^^^Patch file for tailoring
  167. GUMS/XB^^^^^^^GUMS XBASIC Overlay
  168. Segment 1
  169. GUMS/XB1^^^^^^GUMS XBASIC Overlay
  170. Segment 2
  171. Z-PATCHDOC^^^^Documentation for
  172. RAGPATCH
  173. Z-RAGPATCH^^^^Patch program
  174. Z-XBPATCH^^^^^XB loader for RAGPATCH
  175. .IN+0;SP;CP5
  176. @GETTING^STARTED
  177.  
  178. First, make a working copy of the GUMS
  179. distribution disk.  Make sure the
  180. distribution disk has a write protect
  181. tab and use it &only to make working
  182. copies.
  183.  
  184. In this manual it is assumed that you
  185. know how to use your GRAM device and
  186. the software provided with it.
  187.  
  188. If your GRAM device is the PGRAM+ Card,
  189. you must load GUMS into page 1.
  190.  
  191. The use of GUMS is quite intuitive, so
  192. at this point you might like to load it
  193. all up and try it out.  Just follow the
  194. steps below.
  195. .sp;lm+5;in-3
  196. 1.^Load your favorite saved cartridge
  197. into the GRAM device.
  198. 2.^Load file "GUMS" into the GRAM
  199. device on top of your cartridge.
  200. 3.^If the saved cartridge you loaded in
  201. step 1 was TI Extended BASIC, then load
  202. file "GUMS/XB" on top of all the
  203. previous stuff.
  204. 4.^Now load the GRAM device dependent
  205. code: file "GUMS/PG" for the PGRAM or
  206. PGRAM+ Card, or "GUMS/GK" for the GRAM
  207. KRACKER.  This code gives you entry A
  208. on the Utilities Menu.
  209. 5.^Try it out by restarting the system.
  210. 6.^Save the GRAM device to disk, this
  211. is your GUMS saved cartridge.
  212. .SP;LM-5;IN+0
  213. Now, if you had fun in step 5 above,
  214. you can study the rest of this manual,
  215. especially the section on how to add
  216. your programs to the Program and
  217. Utility menus, and to tailor other
  218. values in GUMS to your configuration.
  219. .sp2;cp5
  220. @GUMS^MENUS
  221.  
  222. All of the menus presented by GUMS are
  223. similar and follow the usual TI
  224. programming standards.  The items in
  225. the menus have letters rather than
  226. numbers because there may be more than
  227. nine entries.  A menu item is selected
  228. by touching the corresponding key with
  229. Alpha Lock either on or off.  Pressing
  230. BACK (FCTN 9) takes you to the previous
  231. level menu.  Pressing QUIT (FCTN =)
  232. resets the system and begins again with
  233. the main menu.
  234.  
  235. Note that if, during a system reset,
  236. the space bar is pressed and held, GUMS
  237. will exit to the normal TI colour bar
  238. and first level menu.
  239. .sp2;cp5
  240. @GUMS^DATA^ENTRY
  241.  
  242. During input to any of the GUMS
  243. provided routines, the function keys
  244. all work in their usual way.  In
  245. particular,
  246. .sp;lm+25;in-20
  247. FCTN 1 ^INS^^^^^^^^^Insert Character
  248. FCTN 2 ^DEL^^^^^^^^^Delete Character
  249. FCTN 3 ^ERASE^^^^^^^Erase to end of
  250. field
  251. FCTN 4 ^CLEAR^^^^^^^Erace entire field
  252. FCTN 5 ^BEGIN^^^^^^^Begin again at first
  253. field
  254. FCTN 6 ^PROC'D^^^^^^Begin execution with
  255. all data as is
  256. FCTN 7 ^AID^^^^^^^^^***
  257. FCTN 8 ^REDO^^^^^^^^Same as BEGIN
  258. FCTN 9 ^BACK^^^^^^^^Go back to previous
  259. level menu
  260. FCTN = ^QUIT^^^^^^^^Reset system
  261. ^^^^^^^^ENTER^^^^^^^Enter data for this
  262. field and continue with next field, or
  263. if this was the last field, execute
  264. function
  265. FCTN S ^Left^Arrow^^Move cursor left
  266. FCTN D ^Right^Arrow^Move cursor right
  267. FCTN X ^Down^Arrow^^Same as ENTER
  268. FCTN E ^Up^Arrow^^^^Go to previous
  269. field
  270. .lm-25;in+0;sp
  271. When single character inputs, such as
  272. "menu selections", "disk numbers" or
  273. "Yes/No" are expected then touching the
  274. single key is sufficient and ENTER need
  275. not be pressed.
  276.  
  277. Where possible, previous inputs are
  278. retained and are presented for
  279. modification when a similar input is
  280. required.  This is especially true in
  281. the file and disk maintenance sections.
  282.  
  283. You can move between the four GUMS
  284. selection menus, Program Library,
  285. Utility Library, File Maintenance and
  286. Disk Maintenance, by pressing Up or
  287. Down Arrow.  This is especially useful
  288. between the File  and Disk Maintenance
  289. menus as inputs will be retained
  290. between menus using this method.
  291. .sp2;cp5
  292. @TAILORING^GUMS
  293.  
  294. There are four areas of GUMS that must
  295. be tailored to your environment.
  296. .sp;in+3
  297. 1.^The Library and Utility Menus
  298. 2.^The printer filename
  299. 3.^The printer setup values
  300. 4.^The file/disk values
  301. .sp;in+0
  302. You can make your modifications using
  303. either program RAGPATCH (on the
  304. distribution disk) or using the GRAM
  305. memory editor supplied with your GRAM
  306. device.
  307.  
  308. The advantage of using RAGPATCH is that
  309. you have a record of your modifications
  310. in a file and can easily change and
  311. reapply them.  A patch file, GUMS/STD,
  312. is supplied on the distribution disk
  313. which you can modify to suit your
  314. needs.  The values in GUMS/STD are
  315. those which are already in the
  316. distributed version of GUMS.
  317.  
  318. &Tailoring^GUMS^Menus
  319.  
  320. There are two identical GUMS menus in
  321. GRAM: the Program Library menu
  322. beginning at GRAM address >9814, and
  323. the Utility Library menu beginning at
  324. GRAM address >9A30.  Remember that the
  325. first entry in the Utility Library may
  326. already be used if you have loaded
  327. GUMS/PG or GUMS/GK.
  328.  
  329. Each menu entry is 40 bytes (hex >28)
  330. long.  The entry contains:
  331. .sp;in+5
  332. ^1 byte^^-^entry type
  333. 19 bytes^-^menu text
  334. 20 bytes^-^filename of program
  335. .sp;in+0
  336. The types of entries are:
  337. .sp;in+5
  338. blank^-^unused entry
  339. ^^E^^^-^E/A Option 5 program, VDP as
  340. per E/A
  341. ^^X^^^-^E/A Option 5 program, VDP as
  342. per XB
  343. ^^G^^^-^E/A Option 5 program, VDP as
  344. per GPL
  345. ^^B^^^-^Extended BASIC program
  346. ^^I^^^-^Internal GPL program
  347. .sp;in+0
  348. The type for an E/A Option 5 program
  349. can be selected by trying E, X or G and
  350. see how the program reacts.  A garbled
  351. screen is an indication that the
  352. program wants a different type.
  353.  
  354. For a type I entry, the filename area
  355. contains a 2 byte GRAM address of the
  356. GPL program and a 2 byte "GRAM read
  357. data address".  The "GRAM read data
  358. addresses" are >9800, >9804, >9808 and
  359. >980C for the four pages of GRAM in the
  360. PGRAM+ Card.  The other GRAM devices
  361. have only one page of GRAM with "read
  362. data address" of >9800.
  363.  
  364. Below is a map of both menus.
  365. .lm+5;sp;ai
  366. Menu   Program Menu   Utility Menu
  367. Item     Address        Address
  368. ----- -------------- --------------
  369.  A       >9814          >9A30
  370.  B       >983C          >9A58
  371.  C       >9864          >9A80
  372.  D       >988C          >9AA8
  373.  E       >98B4          >9AD0
  374.  F       >98DC          >9AF8
  375.  G       >9904          >9B20
  376.  H       >992C          >9B48
  377.  I       >9954          >9B70
  378.  J       >997C          >9B98
  379.  K       >99A4          >9BC0
  380.  L       >99CC          >9BE8
  381.  M       >99F4          >9C10
  382. .FI;LM-5;SP
  383. &Printer^Name
  384.  
  385. The printer name begins at GRAM address
  386. >7809.  Its format is:
  387. .sp;in+5
  388. ^1^byte^^-^name length
  389. 28^bytes^-^printer name
  390. .sp;in+0;sp
  391. &Printer^Setup^Values
  392.  
  393. The printer setup values, used by
  394. "Printer Setup" of the "File
  395. Maintenance" menu are located beginning
  396. at GRAM address >F800.  Each entry is 3
  397. bytes.  Entries shorter than 3 bytes
  398. should be padded with >00.  The entries
  399. are in the same order as the menu
  400. items.
  401. .sp;in+5
  402. >F800^^Select Elite Mode
  403. >F803^^Select Pica Mode
  404. >F806^^Condensed Printing On
  405. >F809^^Condensed Printing Off
  406. >F80C^^Expanded Printing On
  407. >F80F^^Expanded Printing Off
  408. >F812^^Emphasized Printing On
  409. >F815^^Emphasized Printing Off
  410. >F818^^Double Strike On
  411. >F81B^^Double Strike Off
  412. >F81E^^Select 8 lines per inch
  413. >F821^^Select 6 lines per inch
  414. >F824^^Select Skip over Perforation
  415. >F827^^Form Feed
  416. .sp;in+0
  417. The printer setup values in the
  418. distributed system are for a STAR
  419. NX1000 printer.
  420.  
  421. &File/Disk^Values
  422.  
  423. The values for file and disk
  424. maintenance are located beginning at
  425. GRAM address >F82A (immediately
  426. following the printer setup values).
  427. The values are:
  428. .sp;lm+5;ai
  429. Address   Length   Function
  430. -------   ------   ---------------
  431.  >F82A      15     FROM default
  432.  >F839      15     TO default
  433.  >F848       1     Sides on disk,
  434.                    S=single, D=double
  435.  >F849       1     Disk density,
  436.                    S=single, D=double
  437.  >F84A       3     Print margin
  438.  >F84D       3     Print lines per page
  439.  >F850       1     Print line numbers,
  440.                    Y=yes, N=no
  441. .fi;lm-5;sp2;cp5
  442. @FILE^AND^DISK^MAINTENANCE
  443.  
  444. Most of the file/disk maintenance
  445. operations are fairly obvious, only a
  446. few items need extra explaination.
  447.  
  448. In "Copy File" a "to" filename of
  449. asterisk means use the "from" filename.
  450.  
  451. In "Selective Copy" and "Selective
  452. Delete" the entire disk catalog is read
  453. at the beginning.  As the file names
  454. are presented, 
  455. .sp;in+5
  456. ENTER^^^^^^-^means do the operation
  457. Up^Arrow^^^-^means go back to the
  458. previous file
  459. Down^Arrow^-^means skip to the next
  460. file
  461. .in+0;sp
  462. "Box Format" assigns disk names in
  463. sequence.  It reads the "Sides" and the
  464. "Density" and then it loops awaiting
  465. entry of a disk number.  You can flip
  466. from disk to disk, using all your
  467. drives.  This allows getting one drive
  468. ready while another is formatting.
  469. .sp2;cp5
  470. @PROGRAMMING^NOTES
  471.  
  472. TI Extended BASIC does not use the GRAM
  473. block at >E000.  GUMS uses the 2K
  474. beginning at >F800.  This leaves 6K of
  475. GRAM that could be used by some other
  476. GPL program.
  477.  
  478. For those interested in programming in
  479. GPL, RAG Software produces two fairware
  480. products to help you.  A GPL Macro
  481. Assembler and a GPL Disassembler.  Both
  482. of these packages come with a GPL
  483. Language Manual on disk.
  484. ÇåÇ¡å╒╒╒╒╒╒╒╒╒╒╒╒╒╒╒Çå
  485.